{"openapi":"3.0.1","info":{"title":"OpenAPI definition","version":"v0"},"servers":[{"url":"http://localhost","description":"Generated server url"}],"paths":{"/bail/ccdAboutToSubmit":{"post":{"tags":["Asylum Service"],"summary":"Handles 'AboutToSubmitEvent' callbacks from CCD or delegated calls from IA Case API","operationId":"ccdAboutToSubmit","parameters":[{"name":"ServiceAuthorization","in":"header","description":"Keyword `Bearer` followed by a service-to-service token for a whitelisted micro-service","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CallbackBailCase"}}},"required":true},"responses":{"200":{"description":"Transformed Bail case data, with any identified error or warning messages","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PreSubmitCallbackResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PreSubmitCallbackResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PreSubmitCallbackResponse"}}}},"415":{"description":"Unsupported Media Type","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PreSubmitCallbackResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PreSubmitCallbackResponse"}}}}},"security":[{"Authorization":[]},{"ServiceAuthorization":[]}]}},"/bail/ccdAboutToStart":{"post":{"tags":["Asylum Service"],"summary":"Handles 'AboutToStartEvent' callbacks from CCD or delegated calls from IA Case API","operationId":"ccdAboutToStart","parameters":[{"name":"ServiceAuthorization","in":"header","description":"Keyword `Bearer` followed by a service-to-service token for a whitelisted micro-service","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CallbackBailCase"}}},"required":true},"responses":{"200":{"description":"Transformed Bail case data, with any identified error or warning messages","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PreSubmitCallbackResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PreSubmitCallbackResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PreSubmitCallbackResponse"}}}},"415":{"description":"Unsupported Media Type","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PreSubmitCallbackResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PreSubmitCallbackResponse"}}}}},"security":[{"Authorization":[]},{"ServiceAuthorization":[]}]}},"/asylum/ccdAboutToSubmit":{"post":{"tags":["Asylum Service"],"summary":"Handles 'AboutToSubmitEvent' callbacks from CCD or delegated calls from IA Case API","operationId":"ccdAboutToSubmit_1","parameters":[{"name":"ServiceAuthorization","in":"header","description":"Keyword `Bearer` followed by a service-to-service token for a whitelisted micro-service","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CallbackAsylumCase"}}},"required":true},"responses":{"200":{"description":"Transformed Asylum case data, with any identified error or warning messages","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PreSubmitCallbackResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PreSubmitCallbackResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PreSubmitCallbackResponse"}}}},"415":{"description":"Unsupported Media Type","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PreSubmitCallbackResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PreSubmitCallbackResponse"}}}}},"security":[{"Authorization":[]},{"ServiceAuthorization":[]}]}},"/asylum/ccdAboutToStart":{"post":{"tags":["Asylum Service"],"summary":"Handles 'AboutToStartEvent' callbacks from CCD or delegated calls from IA Case API","operationId":"ccdAboutToStart_1","parameters":[{"name":"ServiceAuthorization","in":"header","description":"Keyword `Bearer` followed by a service-to-service token for a whitelisted micro-service","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CallbackAsylumCase"}}},"required":true},"responses":{"200":{"description":"Transformed Asylum case data, with any identified error or warning messages","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PreSubmitCallbackResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PreSubmitCallbackResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PreSubmitCallbackResponse"}}}},"415":{"description":"Unsupported Media Type","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PreSubmitCallbackResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PreSubmitCallbackResponse"}}}}},"security":[{"Authorization":[]},{"ServiceAuthorization":[]}]}},"/":{"get":{"tags":["Asylum Service"],"summary":"Welcome message for the Immigration & Asylum case documents API","operationId":"welcome","parameters":[{"name":"ServiceAuthorization","in":"header","description":"Keyword `Bearer` followed by a service-to-service token for a whitelisted micro-service","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Welcome message","content":{"application/json":{"schema":{"type":"string"}}}}}}}},"components":{"schemas":{"CaseData":{"type":"object"},"PreSubmitCallbackResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/CaseData"},"errors":{"uniqueItems":true,"type":"array","items":{"type":"string"}}}},"CallbackBailCase":{"type":"object","properties":{"case_details":{"$ref":"#/components/schemas/CaseDetailsBailCase"},"case_details_before":{"$ref":"#/components/schemas/CaseDetailsBailCase"},"event_id":{"type":"string","enum":["startAppeal","editAppeal","submitAppeal","payAndSubmitAppeal","sendDirection","requestRespondentEvidence","uploadRespondentEvidence","buildCase","submitCase","requestCaseEdit","requestRespondentReview","addAppealResponse","requestHearingRequirements","draftHearingRequirements","changeDirectionDueDate","uploadAdditionalEvidence","listCase","createCaseSummary","revertStateToAwaitingRespondentEvidence","generateHearingBundle","asyncStitchingComplete","requestHearingRequirementsFeature","customiseHearingBundle","generateUpdatedHearingBundle","generateDecisionAndReasons","adaSuitabilityReview","sendDecisionAndReasons","editCaseListing","manageFeeUpdate","endAppeal","endAppealAutomatically","adjournHearingWithoutDate","submitCmaRequirements","listCma","editAppealAfterSubmit","generateUpperTribunalBundle","submitReasonsForAppeal","submitClarifyingQuestionAnswers","recordAdjournmentDetails","updateTribunalDecision","requestCaseBuilding","uploadHomeOfficeAppealResponse","recordOutOfTimeDecision","markAppealPaid","recordRemissionDecision","requestResponseReview","markAppealAsAda","applyForFTPARespondent","applyForFTPAAppellant","decideAnApplication","transferOutOfAda","residentJudgeFtpaDecision","maintainCaseLinks","uploadAddendumEvidenceAdminOfficer","changeHearingCentre","createCaseLink","requestResponseAmend","uploadAdditionalEvidenceHomeOffice","uploadAddendumEvidenceHomeOffice","uploadAddendumEvidence","reinstateAppeal","submitApplication","recordTheDecision","endApplication","makeNewApplication","editBailApplicationAfterSubmit","uploadSignedDecisionNotice","caseListing","updateHearingRequirements","updateHearingAdjustments","saveNotificationsToData","unknown"]}}},"CaseDetailsBailCase":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"jurisdiction":{"type":"string"},"state":{"type":"string","enum":["appealStarted","appealStartedByAdmin","appealSubmitted","appealSubmittedOutOfTime","awaitingRespondentEvidence","caseBuilding","caseUnderReview","respondentReview","submitHearingRequirements","listing","prepareForHearing","finalBundling","preHearing","hearingAndOutcome","decision","decided","ended","awaitingCmaRequirements","cmaAdjustmentsAgreed","ftpaDecided","pendingPayment","adjourned","ftpaSubmitted","decisionConditionalBail","unknown"]},"case_data":{"type":"object","properties":{"empty":{"type":"boolean"}},"additionalProperties":{"type":"object"}},"created_date":{"type":"string","format":"date-time"}}},"CallbackAsylumCase":{"type":"object","properties":{"case_details":{"$ref":"#/components/schemas/CaseDetailsAsylumCase"},"case_details_before":{"$ref":"#/components/schemas/CaseDetailsAsylumCase"},"event_id":{"type":"string","enum":["startAppeal","editAppeal","submitAppeal","payAndSubmitAppeal","sendDirection","requestRespondentEvidence","uploadRespondentEvidence","buildCase","submitCase","requestCaseEdit","requestRespondentReview","addAppealResponse","requestHearingRequirements","draftHearingRequirements","changeDirectionDueDate","uploadAdditionalEvidence","listCase","createCaseSummary","revertStateToAwaitingRespondentEvidence","generateHearingBundle","asyncStitchingComplete","requestHearingRequirementsFeature","customiseHearingBundle","generateUpdatedHearingBundle","generateDecisionAndReasons","adaSuitabilityReview","sendDecisionAndReasons","editCaseListing","manageFeeUpdate","endAppeal","endAppealAutomatically","adjournHearingWithoutDate","submitCmaRequirements","listCma","editAppealAfterSubmit","generateUpperTribunalBundle","submitReasonsForAppeal","submitClarifyingQuestionAnswers","recordAdjournmentDetails","updateTribunalDecision","requestCaseBuilding","uploadHomeOfficeAppealResponse","recordOutOfTimeDecision","markAppealPaid","recordRemissionDecision","requestResponseReview","markAppealAsAda","applyForFTPARespondent","applyForFTPAAppellant","decideAnApplication","transferOutOfAda","residentJudgeFtpaDecision","maintainCaseLinks","uploadAddendumEvidenceAdminOfficer","changeHearingCentre","createCaseLink","requestResponseAmend","uploadAdditionalEvidenceHomeOffice","uploadAddendumEvidenceHomeOffice","uploadAddendumEvidence","reinstateAppeal","submitApplication","recordTheDecision","endApplication","makeNewApplication","editBailApplicationAfterSubmit","uploadSignedDecisionNotice","caseListing","updateHearingRequirements","updateHearingAdjustments","saveNotificationsToData","unknown"]}}},"CaseDetailsAsylumCase":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"jurisdiction":{"type":"string"},"state":{"type":"string","enum":["appealStarted","appealStartedByAdmin","appealSubmitted","appealSubmittedOutOfTime","awaitingRespondentEvidence","caseBuilding","caseUnderReview","respondentReview","submitHearingRequirements","listing","prepareForHearing","finalBundling","preHearing","hearingAndOutcome","decision","decided","ended","awaitingCmaRequirements","cmaAdjustmentsAgreed","ftpaDecided","pendingPayment","adjourned","ftpaSubmitted","decisionConditionalBail","unknown"]},"case_data":{"type":"object","properties":{"empty":{"type":"boolean"}},"additionalProperties":{"type":"object"}},"created_date":{"type":"string","format":"date-time"}}}}}}