{"swagger":"2.0","info":{"description":"Documented API for continuous online hearing.To use the API calls generate an Authorization JWT Tokens (user and service) which is required in the header.","version":"0.0.1","title":"Continuous Online Hearing API"},"host":"localhost:8080","basePath":"/","tags":[{"name":"decision-controller","description":"Decision Controller"},{"name":"answer-controller","description":"Answer Controller"},{"name":"online-hearing-controller","description":"Online Hearing Controller"},{"name":"question-controller","description":"Question Controller"},{"name":"question-round-controller","description":"Question Round Controller"},{"name":"conversations-controller","description":"Conversations Controller"},{"name":"event-queue-controller","description":"Event Queue Controller"},{"name":"event-forwarding-controller","description":"Event Forwarding Controller"},{"name":"deadline-controller","description":"Deadline Controller"}],"paths":{"/continuous-online-hearings":{"get":{"tags":["online-hearing-controller"],"summary":"Filter for Online Hearings","description":"A GET request with query string containing one or more instances of case_id e.g. case_id=foo&case_id=bar","operationId":"retrieveOnlineHearingsUsingGET","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"case_id","in":"query","description":"case_id","required":true,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/OnlineHearingsResponse"}},"401":{"description":"Unauthorised"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}},"post":{"tags":["online-hearing-controller"],"summary":"Create Online Hearing","description":"A POST request is used to create an online hearing","operationId":"createOnlineHearingUsingPOST","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"body","description":"body","required":true,"schema":{"$ref":"#/definitions/OnlineHearingRequest"}},{"in":"body","name":"case_id","description":"The Case id","required":true,"schema":{"type":"string"}},{"in":"body","name":"jurisdiction","description":"Accepted value is SSCS","required":true,"schema":{"type":"string"}},{"in":"body","name":"start_date","description":"ISO 8601 Start Date of Online Hearing","required":true,"schema":{"type":"string"}},{"in":"body","name":"panel","description":"Panel members","required":true,"schema":{"type":"string"}},{"in":"body","name":"panel.name","description":"Name of Panel Member","required":true,"schema":{"type":"string"}},{"in":"body","name":"panel.identity_token","description":"IDAM Token of Panel Member","required":false,"schema":{"type":"string"}},{"in":"body","name":"panel.role","description":"The role of the Panel Member","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ResponseEntity"}},"201":{"description":"Created","schema":{"$ref":"#/definitions/CreateOnlineHearingResponse"}},"401":{"description":"Unauthorised"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"409":{"description":"Duplicate case id found"},"422":{"description":"Validation error"}}}},"/continuous-online-hearings/events/register":{"post":{"tags":["event-forwarding-controller"],"summary":"Register for event notifications","description":"A POST request is used to register for event notifications","operationId":"registerForEventNotificationsUsingPOST","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"body","description":"body","required":true,"schema":{"$ref":"#/definitions/EventRegistrationRequest"}}],"responses":{"200":{"description":"Success","schema":{"type":"string"}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"409":{"description":"Conflict"},"422":{"description":"Validation error"}}},"put":{"tags":["event-forwarding-controller"],"summary":"Update event registration notification","description":"A PUT request is used to update the event registration","operationId":"updateEventNotificationsUsingPUT","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"request","description":"request","required":true,"schema":{"$ref":"#/definitions/EventRegistrationRequest"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/ResponseEntity"}},"201":{"description":"Created"},"401":{"description":"Unauthorised"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"424":{"description":"Failed dependency"}}},"delete":{"tags":["event-forwarding-controller"],"summary":"Delete event registration notification","description":"A DELETE request is used delete to update the event registration","operationId":"deleteEventNotificationsUsingDELETE","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"request","description":"request","required":true,"schema":{"$ref":"#/definitions/SessionEventRequest"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/ResponseEntity"}},"204":{"description":"No Content"},"401":{"description":"Unauthorised"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"424":{"description":"Failed dependency"}}}},"/continuous-online-hearings/events/reset":{"put":{"tags":["event-queue-controller"],"summary":"Reset session events","description":"A PUT request is used to reset the events","operationId":"resetSessionEventsUsingPUT","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"request","description":"request","required":true,"schema":{"$ref":"#/definitions/SessionEventRequest"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/ResponseEntity"}},"201":{"description":"Created"},"401":{"description":"Unauthorised"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Validation error"},"424":{"description":"Failed dependency"}}}},"/continuous-online-hearings/{onlineHearingId}":{"get":{"tags":["online-hearing-controller"],"summary":"Get Online Hearing","description":"A GET request with a request body is used to retrieve an online hearing","operationId":"retrieveOnlineHearingUsingGET","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"onlineHearingId","in":"path","description":"onlineHearingId","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/OnlineHearingResponse"}},"401":{"description":"Unauthorised"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/continuous-online-hearings/{onlineHearingId}/conversations":{"get":{"tags":["conversations-controller"],"summary":"Get a conversation","description":"A GET request to retrieve an online hearing conversation","operationId":"getConversationsUsingGET","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"onlineHearingId","in":"path","description":"onlineHearingId","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ConversationResponse"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/continuous-online-hearings/{onlineHearingId}/decisionreplies":{"get":{"tags":["decision-controller"],"summary":"Get all replies to decision","description":"A GET request is used to get all replies to a decision","operationId":"getAllDecisionRepliesUsingGET","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"onlineHearingId","in":"path","description":"onlineHearingId","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/AllDecisionRepliesResponse"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Online hearing not found"}}},"post":{"tags":["decision-controller"],"summary":"Reply to a decision","description":"A POST request is used to reply to a decision","operationId":"replyToDecisionUsingPOST","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"Authorization","in":"header","description":"Authorization","required":true,"type":"string"},{"name":"onlineHearingId","in":"path","description":"onlineHearingId","required":true,"type":"string"},{"in":"body","name":"request","description":"request","required":true,"schema":{"$ref":"#/definitions/DecisionReplyRequest"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ResponseEntity"}},"201":{"description":"Success","schema":{"$ref":"#/definitions/CreateDecisionReplyResponse"}},"401":{"description":"Unauthorised"},"403":{"description":"Forbidden"},"404":{"description":"Online hearing not found"}}}},"/continuous-online-hearings/{onlineHearingId}/decisionreplies/{decisionReplyId}":{"get":{"tags":["decision-controller"],"summary":"Get a replies to decision","description":"A GET request is used to get a reply to a decision","operationId":"getADecisionReplyUsingGET","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"onlineHearingId","in":"path","description":"onlineHearingId","required":true,"type":"string"},{"name":"decisionReplyId","in":"path","description":"decisionReplyId","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/DecisionReplyResponse"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Online hearing not found"}}}},"/continuous-online-hearings/{onlineHearingId}/decisions":{"get":{"tags":["decision-controller"],"summary":"Get decision","description":"A GET request to retrieve a decision","operationId":"retrieveDecisionUsingGET","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"onlineHearingId","in":"path","description":"onlineHearingId","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/DecisionResponse"}},"401":{"description":"Unauthorised"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}},"post":{"tags":["decision-controller"],"summary":"Create decision","description":"A POST request is used to create a decision","operationId":"createDecisionUsingPOST","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"Authorization","in":"header","description":"Authorization","required":true,"type":"string"},{"name":"onlineHearingId","in":"path","description":"onlineHearingId","required":true,"type":"string"},{"in":"body","name":"request","description":"request","required":true,"schema":{"$ref":"#/definitions/DecisionRequest"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ResponseEntity"}},"201":{"description":"Success","schema":{"$ref":"#/definitions/CreateDecisionResponse"}},"401":{"description":"Unauthorised"},"403":{"description":"Forbidden"},"404":{"description":"Online hearing not found"},"409":{"description":"Online hearing already contains a decision"},"422":{"description":"Validation error"}}},"put":{"tags":["decision-controller"],"summary":"Update a decision","description":"A PUT request to update replace a decision","operationId":"updateDecisionUsingPUT","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"Authorization","in":"header","description":"Authorization","required":true,"type":"string"},{"name":"onlineHearingId","in":"path","description":"onlineHearingId","required":true,"type":"string"},{"in":"body","name":"request","description":"request","required":true,"schema":{"$ref":"#/definitions/UpdateDecisionRequest"}}],"responses":{"200":{"description":"OK","schema":{"type":"string"}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"409":{"description":"Conflict"},"422":{"description":"Validation Error"}}}},"/continuous-online-hearings/{onlineHearingId}/questionrounds":{"get":{"tags":["question-round-controller"],"summary":"Get all question rounds","operationId":"getQuestionRoundsUsingGET","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"onlineHearingId","in":"path","description":"onlineHearingId","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/QuestionRoundsResponse"}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorised"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Validation error"}}}},"/continuous-online-hearings/{onlineHearingId}/questionrounds/{roundId}":{"get":{"tags":["question-round-controller"],"summary":"Get a question round","operationId":"getQuestionRoundUsingGET","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"onlineHearingId","in":"path","description":"onlineHearingId","required":true,"type":"string"},{"name":"roundId","in":"path","description":"roundId","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/QuestionRoundResponse"}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorised"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Validation error"}}},"put":{"tags":["question-round-controller"],"summary":"Update a question round","operationId":"updateQuestionRoundUsingPUT","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"onlineHearingId","in":"path","description":"onlineHearingId","required":true,"type":"string"},{"name":"roundId","in":"path","description":"roundId","required":true,"type":"integer","format":"int32"},{"in":"body","name":"body","description":"body","required":true,"schema":{"$ref":"#/definitions/QuestionRoundRequest"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/Question"}},"201":{"description":"Created"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorised"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Validation error"}}}},"/continuous-online-hearings/{onlineHearingId}/questions":{"get":{"tags":["question-controller"],"summary":"Get all questions for an online hearing","operationId":"getQuestionsUsingGET","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"onlineHearingId","in":"path","description":"onlineHearingId","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/AllQuestionsResponse"}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorised"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Validation error"}}},"post":{"tags":["question-controller"],"summary":"Add a new question","operationId":"createQuestionUsingPOST","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"onlineHearingId","in":"path","description":"onlineHearingId","required":true,"type":"string"},{"in":"body","name":"request","description":"request","required":true,"schema":{"$ref":"#/definitions/QuestionRequest"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ResponseEntity"}},"201":{"description":"Created","schema":{"$ref":"#/definitions/CreateQuestionResponse"}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorised"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Validation error"}}}},"/continuous-online-hearings/{onlineHearingId}/questions-deadline-extension":{"put":{"tags":["deadline-controller"],"summary":"Request deadline extension","description":"A PUT request to extend the deadline of questions.","operationId":"requestExtensionForQuestionUsingPUT","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"onlineHearingId","in":"path","description":"onlineHearingId","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/ResponseEntity"}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not found"},"424":{"description":"Failed dependency"},"500":{"description":"General request failure"}}}},"/continuous-online-hearings/{onlineHearingId}/questions/{questionId}":{"get":{"tags":["question-controller"],"summary":"Get a question","operationId":"getQuestionUsingGET","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"questionId","in":"path","description":"questionId","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/QuestionResponse"}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorised"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Validation error"}}},"put":{"tags":["question-controller"],"summary":"Edit a question","operationId":"editQuestionUsingPUT","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"onlineHearingId","in":"path","description":"onlineHearingId","required":true,"type":"string"},{"name":"questionId","in":"path","description":"questionId","required":true,"type":"string"},{"in":"body","name":"request","description":"request","required":true,"schema":{"$ref":"#/definitions/UpdateQuestionRequest"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/Question"}},"201":{"description":"Created"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorised"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Validation error"}}},"delete":{"tags":["question-controller"],"summary":"Delete a question","operationId":"deleteQuestionUsingDELETE","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"onlineHearingId","in":"path","description":"onlineHearingId","required":true,"type":"string"},{"name":"questionId","in":"path","description":"questionId","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/ResponseEntity"}},"204":{"description":"No Content","schema":{"$ref":"#/definitions/ResponseEntity"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Validation error"}}}},"/continuous-online-hearings/{onlineHearingId}/questions/{questionId}/answers":{"get":{"tags":["answer-controller"],"summary":"Get Answers","description":"A GET request without a body is used to retrieve all answers to a question","operationId":"retrieveAnswersUsingGET","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"questionId","in":"path","description":"questionId","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"type":"array","items":{"$ref":"#/definitions/AnswerResponse"}}},"401":{"description":"Unauthorised"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}},"post":{"tags":["answer-controller"],"summary":"Add Answer","description":"A POST request is used to create an answer","operationId":"createAnswerUsingPOST","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"onlineHearingId","in":"path","description":"onlineHearingId","required":true,"type":"string"},{"name":"questionId","in":"path","description":"questionId","required":true,"type":"string"},{"in":"body","name":"request","description":"request","required":true,"schema":{"$ref":"#/definitions/AnswerRequest"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/CreateAnswerResponse"}},"201":{"description":"Created"},"401":{"description":"Unauthorised"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"409":{"description":"Question already contains an answer"},"422":{"description":"Validation error"}}}},"/continuous-online-hearings/{onlineHearingId}/questions/{questionId}/answers/{answerId}":{"get":{"tags":["answer-controller"],"summary":"Get Answer","description":"A GET request with a request body is used to retrieve an answer","operationId":"retrieveAnswerUsingGET","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"answerId","in":"path","description":"answerId","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/AnswerResponse"}},"401":{"description":"Unauthorised"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}},"put":{"tags":["answer-controller"],"summary":"Update Answers","description":"A PUT request is used to update an answer","operationId":"updateAnswerUsingPUT","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"onlineHearingId","in":"path","description":"onlineHearingId","required":true,"type":"string"},{"name":"questionId","in":"path","description":"questionId","required":true,"type":"string"},{"name":"answerId","in":"path","description":"answerId","required":true,"type":"string"},{"in":"body","name":"request","description":"request","required":true,"schema":{"$ref":"#/definitions/AnswerRequest"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/ResponseEntity"}},"201":{"description":"Created"},"401":{"description":"Unauthorised"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Validation error"}}}},"/continuous-online-hearings/{onlineHearingId}/relist":{"put":{"tags":["online-hearing-controller"],"summary":"Set re-listing reason and state","description":"A PUT request with a request body is used to update re-listing of online hearing.","operationId":"setRelistingUsingPUT","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"onlineHearingId","in":"path","description":"onlineHearingId","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":true,"schema":{"$ref":"#/definitions/RelistingRequest"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ResponseEntity"}},"201":{"description":"Created"},"202":{"description":"Accepted","schema":{"$ref":"#/definitions/ResponseEntity"}},"401":{"description":"Unauthorised"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"409":{"description":"Conflict"}}}}},"definitions":{"AllDecisionRepliesResponse":{"type":"object","properties":{"decision_replies":{"type":"array","items":{"$ref":"#/definitions/DecisionReplyResponse"}}}},"AllQuestionsResponse":{"type":"object","properties":{"questions":{"type":"array","items":{"$ref":"#/definitions/QuestionResponse"}}}},"Answer":{"type":"object","properties":{"answerId":{"type":"string"},"answer_text":{"type":"string"},"current_answer_state":{"$ref":"#/definitions/AnswerState"}}},"AnswerRequest":{"type":"object","required":["answer_state","answer_text"],"properties":{"answer_state":{"type":"string","enum":["answer_drafted","answer_submitted"]},"answer_text":{"type":"string"}}},"AnswerResponse":{"type":"object","properties":{"answer_id":{"type":"string"},"answer_text":{"type":"string"},"current_answer_state":{"$ref":"#/definitions/StateResponse"},"history":{"type":"array","items":{"$ref":"#/definitions/StateResponse"}},"uri":{"type":"string"}}},"AnswerState":{"type":"object","properties":{"state_name":{"type":"string"}}},"ConversationResponse":{"type":"object","properties":{"online_hearing":{"$ref":"#/definitions/OnlineHearingResponse"}}},"CreateAnswerResponse":{"type":"object","properties":{"answer_id":{"type":"string"}}},"CreateDecisionReplyResponse":{"type":"object","properties":{"decision_reply_id":{"type":"string"}}},"CreateDecisionResponse":{"type":"object","properties":{"decision_id":{"type":"string"}}},"CreateOnlineHearingResponse":{"type":"object","properties":{"online_hearing_id":{"type":"string"}}},"CreateQuestionResponse":{"type":"object","properties":{"question_id":{"type":"string"}}},"DecisionReplyRequest":{"type":"object","required":["decision_reply","decision_reply_reason"],"properties":{"decision_reply":{"type":"string","enum":["decision_accepted","decision_rejected"]},"decision_reply_reason":{"type":"string"}}},"DecisionReplyResponse":{"type":"object","properties":{"author_reference":{"type":"string"},"decision_id":{"type":"string"},"decision_reply":{"type":"string"},"decision_reply_date":{"type":"string"},"decision_reply_id":{"type":"string"},"decision_reply_reason":{"type":"string"},"uri":{"type":"string"}}},"DecisionRequest":{"type":"object","required":["decision_award","decision_header","decision_reason","decision_text"],"properties":{"decision_award":{"type":"string"},"decision_header":{"type":"string"},"decision_reason":{"type":"string"},"decision_text":{"type":"string"}}},"DecisionResponse":{"type":"object","properties":{"deadline_expiry_date":{"type":"string"},"decision_award":{"type":"string"},"decision_header":{"type":"string"},"decision_id":{"type":"string"},"decision_reason":{"type":"string"},"decision_replies":{"type":"array","items":{"$ref":"#/definitions/DecisionReplyResponse"}},"decision_state":{"$ref":"#/definitions/StateResponse"},"decision_text":{"type":"string"},"history":{"type":"array","items":{"$ref":"#/definitions/StateResponse"}},"online_hearing_id":{"type":"string"},"uri":{"type":"string"}}},"EventRegistrationRequest":{"type":"object","required":["endpoint","event_type","jurisdiction"],"properties":{"endpoint":{"type":"string","description":"An absolute URL corresponding to the callback endpoint for the event"},"event_type":{"type":"string","description":"The event type","enum":["question_round_issued","question_deadline_elapsed","question_deadline_extended","question_deadline_extension_denied","question_deadline_extension_granted","answers_submitted","decision_rejected","decision_issued"]},"jurisdiction":{"type":"string","description":"The Jurisdiction interested in the event","enum":["SSCS"]},"maximum_retries":{"type":"integer","format":"int32","description":"The number of retry attempt to send a notification message. Default 3","minimum":0,"maximum":5}}},"OnlineHearingRequest":{"type":"object","required":["case_id","jurisdiction"],"properties":{"case_id":{"type":"string"},"jurisdiction":{"type":"string","enum":["SSCS"]},"start_date":{"type":"string","format":"date-time","description":"The start date of the online resolution"},"state":{"type":"string"}}},"OnlineHearingResponse":{"type":"object","properties":{"case_id":{"type":"string"},"current_state":{"$ref":"#/definitions/StateResponse"},"decision":{"$ref":"#/definitions/DecisionResponse"},"end_date":{"type":"string"},"history":{"type":"array","items":{"$ref":"#/definitions/StateResponse"}},"online_hearing_id":{"type":"string"},"questions":{"type":"array","items":{"$ref":"#/definitions/QuestionResponse"}},"relisting":{"$ref":"#/definitions/RelistingResponse"},"relisting_history":{"type":"array","items":{"$ref":"#/definitions/RelistingHistoryResponse"}},"start_date":{"type":"string"},"uri":{"type":"string"}}},"OnlineHearingsResponse":{"type":"object","properties":{"online_hearings":{"type":"array","items":{"$ref":"#/definitions/OnlineHearingResponse"}}}},"Question":{"type":"object","properties":{"answers":{"type":"array","items":{"$ref":"#/definitions/Answer"}},"authorReferenceId":{"type":"string"},"deadlineExpiryDate":{"type":"string","format":"date-time"},"deadlineExtCount":{"type":"integer","format":"int32"},"linkedQuestions":{"type":"array","items":{"type":"string"}},"ownerReferenceId":{"type":"string"},"questionHeaderText":{"type":"string"},"questionId":{"type":"string"},"questionOrdinal":{"type":"integer","format":"int32"},"questionRound":{"type":"integer","format":"int32"},"questionState":{"$ref":"#/definitions/QuestionState"},"questionStateHistories":{"type":"array","items":{"$ref":"#/definitions/QuestionStateHistory"}},"questionText":{"type":"string"}}},"QuestionRequest":{"type":"object","required":["owner_reference","question_body_text","question_header_text","question_ordinal","question_round"],"properties":{"linked_question_id":{"type":"array","items":{"type":"string"}},"owner_reference":{"type":"string"},"question_body_text":{"type":"string"},"question_header_text":{"type":"string"},"question_ordinal":{"type":"string","description":"Positive integer","enum":["0","1","2","..."]},"question_round":{"type":"string","description":"Positive integer","enum":["0","1","2","..."]}}},"QuestionResponse":{"type":"object","required":["owner_reference","question_body_text","question_header_text","question_ordinal","question_round"],"properties":{"answers":{"type":"array","items":{"$ref":"#/definitions/AnswerResponse"}},"current_question_state":{"$ref":"#/definitions/StateResponse"},"deadline_expiry_date":{"type":"string"},"deadline_extension_count":{"type":"integer","format":"int32"},"history":{"type":"array","items":{"$ref":"#/definitions/StateResponse"}},"linked_question_id":{"type":"array","items":{"type":"string"}},"owner_reference":{"type":"string"},"question_body_text":{"type":"string"},"question_header_text":{"type":"string"},"question_id":{"type":"string"},"question_ordinal":{"type":"string","description":"Positive integer","enum":["0","1","2","..."]},"question_round":{"type":"string","description":"Positive integer","enum":["0","1","2","..."]},"uri":{"type":"string"}}},"QuestionRoundRequest":{"type":"object","required":["state_name"],"properties":{"state_name":{"type":"string","enum":["question_issue_pending"]}}},"QuestionRoundResponse":{"type":"object","properties":{"deadline_extension_count":{"type":"integer","format":"int32"},"question_references":{"type":"array","items":{"$ref":"#/definitions/QuestionResponse"}},"question_round_number":{"type":"string"},"question_round_state":{"$ref":"#/definitions/QuestionRoundState"}}},"QuestionRoundState":{"type":"object","properties":{"state_name":{"type":"string"}}},"QuestionRoundsResponse":{"type":"object","properties":{"current_question_round":{"type":"integer","format":"int32"},"max_number_of_question_rounds":{"type":"integer","format":"int32"},"next_question_round":{"type":"integer","format":"int32"},"previous_question_round":{"type":"integer","format":"int32"},"question_rounds":{"type":"array","items":{"$ref":"#/definitions/QuestionRoundResponse"}}}},"QuestionState":{"type":"object","properties":{"state_name":{"type":"string"}}},"QuestionStateHistory":{"type":"object","properties":{"dateOccurred":{"type":"string","format":"date-time"},"questionstate":{"$ref":"#/definitions/QuestionState"}}},"RelistingHistoryResponse":{"type":"object","properties":{"date_occurred":{"type":"string","format":"date-time"},"reason":{"type":"string"},"state":{"type":"string","enum":["DRAFTED","ISSUE_PENDING","ISSUED"]}}},"RelistingRequest":{"type":"object","required":["state"],"properties":{"reason":{"type":"string"},"state":{"type":"string","enum":["drafted","issued"]}}},"RelistingResponse":{"type":"object","properties":{"created":{"type":"string","description":"ISO-8601 format: yyyy-MM-dd'T'HH:mm:ss'Z'"},"reason":{"type":"string"},"state":{"type":"string","enum":["DRAFTED","ISSUE_PENDING","ISSUED"]},"updated":{"type":"string","description":"ISO-8601 format: yyyy-MM-dd'T'HH:mm:ss'Z'"}}},"ResponseEntity":{"type":"object","properties":{"body":{"type":"object"},"statusCode":{"type":"string","enum":["100","101","102","103","200","201","202","203","204","205","206","207","208","226","300","301","302","303","304","305","307","308","400","401","402","403","404","405","406","407","408","409","410","411","412","413","414","415","416","417","418","419","420","421","422","423","424","426","428","429","431","451","500","501","502","503","504","505","506","507","508","509","510","511"]},"statusCodeValue":{"type":"integer","format":"int32"}}},"SessionEventRequest":{"type":"object","required":["event_type","jurisdiction"],"properties":{"event_type":{"type":"string","description":"The event type","enum":["question_round_issued","question_deadline_elapsed","question_deadline_extended","question_deadline_extension_denied","question_deadline_extension_granted","answers_submitted","decision_rejected","decision_issued"]},"jurisdiction":{"type":"string","description":"The Jurisdiction interested in the event","enum":["SSCS"]}}},"StateResponse":{"type":"object","properties":{"state_datetime":{"type":"string"},"state_desc":{"type":"string"},"state_name":{"type":"string"}}},"UpdateDecisionRequest":{"type":"object","required":["decision_award","decision_header","decision_reason","decision_state","decision_text"],"properties":{"decision_award":{"type":"string"},"decision_header":{"type":"string"},"decision_reason":{"type":"string"},"decision_state":{"type":"string","enum":["decision_drafted","decision_issue_pending"]},"decision_text":{"type":"string"}}},"UpdateQuestionRequest":{"type":"object","required":["owner_reference","question_body_text","question_header_text","question_ordinal","question_round","question_state"],"properties":{"linked_question_id":{"type":"array","items":{"type":"string"}},"owner_reference":{"type":"string"},"question_body_text":{"type":"string"},"question_header_text":{"type":"string"},"question_ordinal":{"type":"string","description":"Positive integer","enum":["0","1","2","..."]},"question_round":{"type":"string","description":"Positive integer","enum":["0","1","2","..."]},"question_state":{"type":"string","enum":["question_drafted"]}}}}}