{"openapi":"3.0.1","info":{"title":"OpenAPI definition","version":"v0"},"servers":[{"url":"http://localhost","description":"Generated server url"}],"tags":[{"name":"Asylum Service"}],"paths":{"/asylum/ccdSubmitted":{"post":{"tags":["Asylum Service"],"summary":"Handles 'SubmittedEvent' callbacks from CCD","operationId":"ccdSubmitted","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":"Optional confirmation text for CCD UI","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PostSubmitCallbackResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PostSubmitCallbackResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PostSubmitCallbackResponse"}}}},"415":{"description":"Unsupported Media Type","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PostSubmitCallbackResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PostSubmitCallbackResponse"}}}}},"security":[{"Authorization":[]},{"ServiceAuthorization":[]}]}},"/asylum/ccdMidEvent":{"post":{"tags":["Asylum Service"],"summary":"Handles 'midEvent' callbacks from CCD","operationId":"ccdMidEvent","parameters":[{"name":"pageId","in":"query","required":false,"schema":{"type":"string"}},{"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":"Optional confirmation text for CCD UI","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PostSubmitCallbackResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PostSubmitCallbackResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PostSubmitCallbackResponse"}}}},"415":{"description":"Unsupported Media Type","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PostSubmitCallbackResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PostSubmitCallbackResponse"}}}}},"security":[{"Authorization":[]},{"ServiceAuthorization":[]}]}},"/asylum/ccdAboutToSubmit":{"post":{"tags":["Asylum Service"],"summary":"Handles 'AboutToSubmitEvent' callbacks from CCD","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/CallbackAsylumCase"}}},"required":true},"responses":{"200":{"description":"Optional confirmation text for CCD UI","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PostSubmitCallbackResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PostSubmitCallbackResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PostSubmitCallbackResponse"}}}},"415":{"description":"Unsupported Media Type","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PostSubmitCallbackResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PostSubmitCallbackResponse"}}}}},"security":[{"Authorization":[]},{"ServiceAuthorization":[]}]}},"/asylum/ccdAboutToStart":{"post":{"tags":["Asylum Service"],"summary":"Handles 'AboutToStartEvent' callbacks from CCD","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/CallbackAsylumCase"}}},"required":true},"responses":{"200":{"description":"Optional confirmation text for CCD UI","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PostSubmitCallbackResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PostSubmitCallbackResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PostSubmitCallbackResponse"}}}},"415":{"description":"Unsupported Media Type","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PostSubmitCallbackResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PostSubmitCallbackResponse"}}}}},"security":[{"Authorization":[]},{"ServiceAuthorization":[]}]}},"/":{"get":{"tags":["Asylum Service"],"summary":"Welcome message for the Immigration & Asylum case 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":{"PostSubmitCallbackResponse":{"type":"object","properties":{"confirmation_header":{"type":"string"},"confirmation_body":{"type":"string"}}},"CallbackAsylumCase":{"type":"object","properties":{"case_details":{"$ref":"#/components/schemas/CaseDetailsAsylumCase"},"case_details_before":{"$ref":"#/components/schemas/CaseDetailsAsylumCase"},"page_id":{"type":"string"},"event_id":{"type":"string","enum":["startAppeal","editAppeal","submitAppeal","sendDirection","requestRespondentEvidence","uploadRespondentEvidence","uploadHomeOfficeBundle","buildCase","submitCase","requestCaseEdit","requestRespondentReview","addAppealResponse","uploadHomeOfficeAppealResponse","requestHearingRequirements","requestHearingRequirementsFeature","reviewHearingRequirements","draftHearingRequirements","updateHearingRequirements","updateHearingAdjustments","changeDirectionDueDate","uploadAdditionalEvidence","uploadAddendumEvidence","listCase","listCaseWithoutHearingRequirements","createCaseSummary","revertStateToAwaitingRespondentEvidence","generateHearingBundle","customiseHearingBundle","generateUpdatedHearingBundle","asyncStitchingComplete","decisionAndReasonsStarted","generateDecisionAndReasons","sendDecisionAndReasons","addCaseNote","editCaseListing","recordApplication","recordAttendeesAndDuration","uploadHearingRecording","endAppeal","requestCaseBuilding","forceRequestCaseBuilding","uploadAdditionalEvidenceHomeOffice","requestResponseReview","requestResponseAmend","uploadAddendumEvidenceLegalRep","uploadAddendumEvidenceHomeOffice","uploadAddendumEvidenceAdminOfficer","submitHearingRequirements","removeAppealFromOnline","shareACase","requestReasonsForAppeal","editReasonsForAppeal","submitReasonsForAppeal","requestClarifyingAnswers","submitClarifyingQuestionAnswers","completeClarifyQuestions","editDocuments","sendToPreHearing","changeHearingCentre","applyForFTPAAppellant","applyForFTPARespondent","leadershipJudgeFtpaDecision","residentJudgeFtpaDecision","decideFtpaApplication","recordAllocatedJudge","editTimeExtension","submitTimeExtension","reviewTimeExtension","sendDirectionWithQuestions","flagCase","createFlag","removeFlag","requestCmaRequirements","editCmaRequirements","submitCmaRequirements","reviewCmaRequirements","forceCaseToCaseUnderReview","updateDetailsAfterCma","forceCaseToSubmitHearingRequirements","updateLegalRepDetails","adjournHearingWithoutDate","restoreStateFromAdjourn","decisionWithoutHearing","listCma","editAppealAfterSubmit","linkAppeal","unlinkAppeal","paymentAppeal","moveToPaymentPending","rollbackPayment","rollbackPaymentTimeout","rollbackPaymentTimeoutToPaymentPending","uploadSensitiveDocuments","markAppealPaid","requestHomeOfficeData","makeAnApplication","reinstateAppeal","decideAnApplication","requestNewHearingRequirements","allocateTheCase","recordRemissionDecision","manageFeeUpdate","nocRequest","removeRepresentation","removeLegalRepresentative","revokeCaseAccess","requestFeeRemission","recordOutOfTimeDecision","generateUpperTribunalBundle","markEvidenceAsReviewed","updatePaymentStatus","reTriggerWaBulkTasks","reTriggerWaTasks","markAddendumEvidenceAsReviewed","markPaymentRequestSent","endAppealAutomatically","generateServiceRequest","transferOutOfAda","markAppealAsAda","createCaseLink","maintainCaseLinks","pipActivation","updateS94bStatus","adaSuitabilityReview","removeDetainedStatus","markAppealAsDetained","markAsReadyForUtTransfer","updateDetentionLocation","applyForCosts","turnOnNotifications","respondToCosts","addEvidenceForCosts","decideCostsApplication","considerMakingCostsOrder","updateTribunalDecision","recordRemissionReminder","markAppealAsRemitted","sendPaymentReminderNotification","ariaCreateCase","progressMigratedCase","refundConfirmation","updateInterpreterBookingStatus","updateInterpreterDetails","updateHearingRequest","handleHearingException","triggerCmrUpdated","recordAdjournmentDetails","listAssistIntegration","triggerCmrListed","decisionWithoutHearingListed","saveNotificationsToData","unknown"]}}},"CaseDetailsAsylumCase":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"jurisdiction":{"type":"string"},"state":{"type":"string","enum":["appealStarted","appealStartedByAdmin","appealSubmitted","appealSubmittedOutOfTime","pendingPayment","awaitingRespondentEvidence","caseBuilding","caseUnderReview","respondentReview","submitHearingRequirements","listing","prepareForHearing","finalBundling","preHearing","decision","decided","ended","appealTakenOffline","awaitingReasonsForAppeal","reasonsForAppealSubmitted","ftpaSubmitted","ftpaDecided","awaitingClarifyingQuestionsAnswers","clarifyingQuestionsAnswersSubmitted","awaitingCmaRequirements","cmaRequirementsSubmitted","cmaAdjustmentsAgreed","cmaListed","adjourned","remitted","migrated","unknown"]},"case_data":{"type":"object","properties":{"empty":{"type":"boolean"}},"additionalProperties":{"type":"object"}},"created_date":{"type":"string","format":"date-time"},"security_classification":{"type":"string"},"supplementary_data":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/JsonNode"}}}},"JsonNode":{"type":"object"}}}}