{"swagger":"2.0","info":{"description":"Api Documentation","version":"1.0","title":"Api Documentation","termsOfService":"urn:tos","contact":{},"license":{"name":"Apache 2.0","url":"http://www.apache.org/licenses/LICENSE-2.0"}},"host":"localhost","basePath":"/","tags":[{"name":"post-submit-callback-controller","description":"Post Submit Callback Controller"},{"name":"pre-submit-callback-controller","description":"Pre Submit Callback Controller"},{"name":"welcome-controller","description":"Welcome Controller"}],"paths":{"/":{"get":{"tags":["welcome-controller"],"summary":"Welcome message for the Immigration & Asylum case notifications API","operationId":"welcomeUsingGET","produces":["application/json"],"responses":{"200":{"description":"Welcome message","schema":{"type":"string"}}},"deprecated":false}},"/asylum/ccdAboutToStart":{"post":{"tags":["pre-submit-callback-controller"],"summary":"Handles 'AboutToStartEvent' callbacks from CCD or delegated calls from IA Case API","operationId":"ccdAboutToStartUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"callback","description":"Asylum case data","required":true,"schema":{"$ref":"#/definitions/Callback«AsylumCase»"}}],"responses":{"200":{"description":"Transformed Asylum case data, with any identified error or warning messages","schema":{"$ref":"#/definitions/PreSubmitCallbackResponse"}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"415":{"description":"Unsupported Media Type"},"500":{"description":"Internal Server Error"}},"security":[{"Authorization":[]},{"ServiceAuthorization":[]}],"deprecated":false}},"/asylum/ccdAboutToSubmit":{"post":{"tags":["pre-submit-callback-controller"],"summary":"Handles 'AboutToSubmitEvent' callbacks from CCD or delegated calls from IA Case API","operationId":"ccdAboutToSubmitUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"callback","description":"Asylum case data","required":true,"schema":{"$ref":"#/definitions/Callback«AsylumCase»"}}],"responses":{"200":{"description":"Transformed Asylum case data, with any identified error or warning messages","schema":{"$ref":"#/definitions/PreSubmitCallbackResponse"}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"415":{"description":"Unsupported Media Type"},"500":{"description":"Internal Server Error"}},"security":[{"Authorization":[]},{"ServiceAuthorization":[]}],"deprecated":false}},"/asylum/ccdSubmitted":{"post":{"tags":["post-submit-callback-controller"],"summary":"Handles 'SubmittedEvent' callbacks from CCD","operationId":"ccdSubmittedUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"callback","description":"Asylum case data","required":true,"schema":{"$ref":"#/definitions/Callback«AsylumCase»"}}],"responses":{"200":{"description":"Optional confirmation text for CCD UI","schema":{"$ref":"#/definitions/PostSubmitCallbackResponse"}},"400":{"description":"Bad Request","schema":{"$ref":"#/definitions/PostSubmitCallbackResponse"}},"403":{"description":"Forbidden","schema":{"$ref":"#/definitions/PostSubmitCallbackResponse"}},"415":{"description":"Unsupported Media Type","schema":{"$ref":"#/definitions/PostSubmitCallbackResponse"}},"500":{"description":"Internal Server Error","schema":{"$ref":"#/definitions/PostSubmitCallbackResponse"}}},"security":[{"Authorization":[]},{"ServiceAuthorization":[]}],"deprecated":false}}},"securityDefinitions":{"Authorization":{"type":"apiKey","name":"Authorization","in":"header"},"ServiceAuthorization":{"type":"apiKey","name":"ServiceAuthorization","in":"header"}},"definitions":{"AsylumCase":{"type":"object","title":"AsylumCase","additionalProperties":{"type":"object"}},"Callback«AsylumCase»":{"type":"object","properties":{"case_details":{"$ref":"#/definitions/CaseDetails«AsylumCase»"},"case_details_before":{"$ref":"#/definitions/CaseDetails«AsylumCase»"},"event_id":{"type":"string","enum":["startAppeal","editAppeal","submitAppeal","payAndSubmitAppeal","payForAppeal","sendDirection","requestRespondentEvidence","uploadRespondentEvidence","uploadHomeOfficeBundle","buildCase","submitCase","requestCaseEdit","requestRespondentReview","addAppealResponse","requestHearingRequirements","reviewHearingRequirements","requestHearingRequirementsFeature","draftHearingRequirements","changeDirectionDueDate","uploadAdditionalEvidence","uploadAdditionalEvidenceHomeOffice","listCase","listCaseWithoutHearingRequirements","createCaseSummary","revertStateToAwaitingRespondentEvidence","generateHearingBundle","asyncStitchingComplete","customiseHearingBundle","editCaseListing","endAppeal","recordApplication","requestCaseBuilding","forceRequestCaseBuilding","uploadHomeOfficeAppealResponse","uploadAddendumEvidence","uploadAddendumEvidenceLegalRep","uploadAddendumEvidenceHomeOffice","uploadAddendumEvidenceAdminOfficer","requestResponseReview","sendDecisionAndReasons","requestReasonsForAppeal","submitReasonsForAppeal","updateHearingAdjustments","removeAppealFromOnline","changeHearingCentre","applyForFTPAAppellant","applyForFTPARespondent","submitTimeExtension","reviewTimeExtension","sendDirectionWithQuestions","submitClarifyingQuestionAnswers","forceCaseToCaseUnderReview","forceCaseToSubmitHearingRequirements","adjournHearingWithoutDate","restoreStateFromAdjourn","requestCmaRequirements","submitCmaRequirements","listCma","editAppealAfterSubmit","linkAppeal","unlinkAppeal","editDocuments","leadershipJudgeFtpaDecision","residentJudgeFtpaDecision","paymentAppeal","requestResponseAmend","markAppealPaid","reinstateAppeal","makeAnApplication","decideAnApplication","requestNewHearingRequirements","recordRemissionDecision","nocRequest","removeRepresentation","removeLegalRepresentative","requestFeeRemission","manageFeeUpdate","recordOutOfTimeDecision","editPaymentMethod","unknown"]}},"title":"Callback«AsylumCase»"},"CaseData":{"type":"object","title":"CaseData"},"CaseDetails«AsylumCase»":{"type":"object","properties":{"case_data":{"type":"object","additionalProperties":{"type":"object"}},"created_date":{"type":"string","format":"date-time"},"id":{"type":"integer","format":"int64"},"jurisdiction":{"type":"string"},"state":{"type":"string","enum":["appealStarted","appealSubmitted","appealSubmittedOutOfTime","pendingPayment","awaitingRespondentEvidence","caseBuilding","caseUnderReview","respondentReview","submitHearingRequirements","listing","prepareForHearing","finalBundling","preHearing","hearingAndOutcome","decided","awaitingReasonsForAppeal","reasonsForAppealSubmitted","ftpaSubmitted","ftpaDecided","awaitingClarifyingQuestionsAnswers","clarifyingQuestionsAnswersSubmitted","awaitingCmaRequirements","cmaRequirementsSubmitted","cmaAdjustmentsAgreed","cmaListed","adjourned","decision","ended","appealTakenOffline","unknown"]}},"title":"CaseDetails«AsylumCase»"},"PostSubmitCallbackResponse":{"type":"object","properties":{"confirmation_body":{"type":"string"},"confirmation_header":{"type":"string"}},"title":"PostSubmitCallbackResponse"},"PreSubmitCallbackResponse":{"type":"object","properties":{"data":{"$ref":"#/definitions/CaseData"},"errors":{"type":"array","items":{"type":"string"}}},"title":"PreSubmitCallbackResponse"},"PreSubmitCallbackResponse«AsylumCase»":{"type":"object","properties":{"data":{"type":"object","additionalProperties":{"type":"object"}},"errors":{"type":"array","items":{"type":"string"}}},"title":"PreSubmitCallbackResponse«AsylumCase»"}}}