{"openapi":"3.0.0","info":{"version":"0.0.0-set-beta","title":"87percent wellbeing"},"tags":[{"name":"sets"},{"name":"answers"},{"name":"users"},{"name":"reports"}],"paths":{"/sets":{"get":{"tags":["sets"],"summary":"List sets - for admin use","responses":{"200":{"description":"Ok"}}},"post":{"tags":["sets"],"summary":"Add a new set","responses":{"200":{"description":"Ok"}}}},"/sets/topics":{"get":{"tags":["sets"],"summary":"List all different topics used by sets","responses":{"200":{"description":"List of topics"}}}},"/sets/subcategories":{"get":{"tags":["sets"],"summary":"List all different subCategories used by sets","responses":{"200":{"description":"List of subCategories"}}}},"/sets/{setId}":{"get":{"tags":["sets"],"summary":"Get set info","parameters":[{"name":"setId","in":"path","description":"ID of set","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok"}}},"patch":{"tags":["sets"],"summary":"Update an existing set","parameters":[{"name":"setId","in":"path","description":"ID of set","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok"},"400":{"description":"Invalid ID supplied"},"404":{"description":"Question not found"}}}},"/sets/{setId}/disable":{"post":{"tags":["sets"],"summary":"Disables a set","parameters":[{"name":"setId","in":"path","description":"ID of set","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok"}}}},"/sets/{setId}/questions":{"get":{"tags":["sets"],"summary":"Get list of questions for specific set","parameters":[{"name":"setId","in":"path","description":"ID of set","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok"}}},"post":{"tags":["sets"],"summary":"Adds a new question","parameters":[{"name":"setId","in":"path","description":"ID of set","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok"}}}},"/sets/{setId}/questions/order":{"post":{"tags":["sets"],"summary":"Change the order of questions","parameters":[{"name":"order","in":"path","description":"List of all questions IDs in required order","required":true,"schema":{"type":"array"}},{"name":"setId","in":"path","description":"ID of set","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok"},"400":{"description":"Order array is not available or is empty"}}}},"/sets/{setId}/questions/{questionId}":{"get":{"tags":["sets"],"summary":"Get info about a question","parameters":[{"name":"questionId","in":"path","description":"ID of question","required":true,"schema":{"type":"string"}},{"name":"setId","in":"path","description":"ID of set","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok"}}},"patch":{"tags":["sets"],"summary":"Updates a question","parameters":[{"name":"questionId","in":"path","description":"ID of question","required":true,"schema":{"type":"string"}},{"name":"setId","in":"path","description":"ID of set","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok"}}}},"/sets/{setId}/questions/{questionId}/answers":{"get":{"tags":["sets"],"summary":"List answers for specific question","parameters":[{"name":"questionId","in":"path","description":"ID of question","required":true,"schema":{"type":"string"}},{"name":"setId","in":"path","description":"ID of set","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok"}}},"post":{"tags":["sets"],"summary":"Create an answer","parameters":[{"name":"questionId","in":"path","description":"ID of question","required":true,"schema":{"type":"string"}},{"name":"setId","in":"path","description":"ID of set","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok"}}}},"/sets/{setId}/questions/{questionId}/answers/order":{"post":{"tags":["sets"],"summary":"Change the order of answers","parameters":[{"name":"order","in":"path","description":"List of all answers IDs in required order","required":true,"schema":{"type":"array"}},{"name":"questionId","in":"path","description":"ID of question","required":true,"schema":{"type":"string"}},{"name":"setId","in":"path","description":"ID of set","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok"},"400":{"description":"Order array is not available or is empty"}}}},"/sets/{setId}/questions/{questionId}/answers/{answerId}":{"get":{"tags":["sets"],"summary":"Get info about an answer","parameters":[{"name":"answerId","in":"path","description":"ID of answer","required":true,"schema":{"type":"string"}},{"name":"questionId","in":"path","description":"ID of question","required":true,"schema":{"type":"string"}},{"name":"setId","in":"path","description":"ID of set","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok"}}},"patch":{"tags":["sets"],"summary":"Updates an answer","parameters":[{"name":"answerId","in":"path","description":"ID of answer","required":true,"schema":{"type":"string"}},{"name":"questionId","in":"path","description":"ID of question","required":true,"schema":{"type":"string"}},{"name":"setId","in":"path","description":"ID of set","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok"}}},"delete":{"tags":["sets"],"summary":"Deletes an answer","parameters":[{"name":"answerId","in":"path","description":"ID of answer","required":true,"schema":{"type":"string"}},{"name":"questionId","in":"path","description":"ID of question","required":true,"schema":{"type":"string"}},{"name":"setId","in":"path","description":"ID of set","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok"}}}},"/sets/{setId}/questions/{questionId}/disable":{"post":{"tags":["sets"],"summary":"Disable an existing question","parameters":[{"name":"questionId","in":"path","description":"ID of question","required":true,"schema":{"type":"string"}},{"name":"setId","in":"path","description":"ID of set","required":true,"schema":{"type":"string"}},{"name":"isDisabled","in":"path","description":"true to disable, false to enable","required":true,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"Ok"},"400":{"description":"Invalid ID supplied"},"404":{"description":"Question not found"}}}},"/answers/{setId}":{"post":{"parameters":[{"name":"setId","in":"path","description":"ID of question","required":true,"schema":{"type":"string"}}],"tags":["answers"],"summary":"Posts an answer for a set","responses":{"200":{"description":"Ok"}}}},"/users/sets":{"get":{"tags":["users"],"summary":"Returns list of questions that the user can answer, based on the access token","parameters":[{"name":"userId","in":"path","description":"ID of user","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"List of questions"}}}},"/users/score":{"get":{"tags":["users"],"summary":"Returns score for the user, based on the access token","parameters":[{"name":"userId","in":"path","description":"ID of user","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"List of questions"}}}},"/reports/{reportId}/{companyId}":{"get":{"tags":["reports"],"summary":"Returns a specified report","parameters":[{"name":"reportId","in":"path","description":"Report ID","required":true,"schema":{"type":"string"}},{"name":"companyId","in":"path","description":"Company's ID","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Report data"}}}}},"components":{"schemas":{"Set":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["general_wellbeing","dimenstional_wellbeing","top_up_action","top_up_selfawarness"]},"dimension":{"type":"string","enum":["general","ununquadium","ununtrium","flerovium","ununpentium","livermorium","ununseptium","ununoctium"]},"topics":{"type":"array","items":{"type":"string"}},"subCategory":{"type":"string"},"name":{"type":"string"},"isSkippable":{"type":"boolean"},"isDisabled":{"type":"boolean"},"questions":{"type":"array","items":{"$ref":"#/components/schemas/Question"}}}},"Question":{"type":"object","properties":{"id":{"type":"string"},"answerType":{"type":"string","enum":["single_choice","multiple_choice","ranking"]},"answerPresentation":{"type":"string","enum":["text","icon_text","slider"]},"answers":{"type":"array","minLength":2,"maxLength":10,"items":{"type":"object","properties":{"id":{"type":"string"},"text":{"type":"string"},"icon":{"type":"string"},"score":{"type":"integer"}}}},"text":{"type":"string","description":"Question text"},"description":{"type":"string"},"score":{"type":"integer"},"isDisabled":{"type":"boolean","description":"Being disabled means that it shouldn't be shown to the users, the calculated score remains the same"}}},"Response":{"type":"object","properties":{"id":{"type":"string"},"setId":{"type":"string"},"accountId":{"type":"string"},"answers":{"type":"array","items":{"$ref":"#/components/schemas/Answer"}}}},"Answer":{"type":"object","properties":{"id":{"type":"string"},"questionId":{"type":"string"},"answers":{"type":"array","items":{"type":"string","description":"Array of answers IDs"}},"skipped":{"type":"boolean"}}},"WellbeingScore":{"type":"object","properties":{"accountId":{"type":"string"},"scores":{"type":"object","properties":{"general":{"type":"integer"}}},"meta":{"type":"object","description":"Some meta data for faster calculations"},"company":{"type":"object","properties":{"id":{"type":"string"},"gender":{"type":"string","enum":["male","female"]},"dateOfBirth":{"type":"string"},"location":{"type":"string"},"reportingEntity":{"type":"string"},"isManager":{"type":"boolean"}}}}}}}}