{"openapi":"3.0.1","info":{"title":"OpenAPI definition","version":"v0"},"servers":[{"url":"http://localhost","description":"Generated server url"}],"paths":{"/supplementary-details":{"post":{"tags":["supplementary-details-controller"],"summary":"Handles 'supplementary-details' calls from Pay Hub","operationId":"post","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/SupplementaryDetailsRequest"}}},"required":true},"responses":{"404":{"description":"Supplementary details not found for all the case numbers given.","content":{"*/*":{"schema":{"$ref":"#/components/schemas/SupplementaryDetailsResponse"}}}},"200":{"description":"Supplementary details completely retrieved.","content":{"*/*":{"schema":{"type":"string"}}}},"401":{"description":"Unauthorized - missing or invalid S2S token.","content":{"*/*":{"schema":{"$ref":"#/components/schemas/SupplementaryDetailsResponse"}}}},"403":{"description":"Forbidden - system user does not have access to the resources.","content":{"*/*":{"schema":{"$ref":"#/components/schemas/SupplementaryDetailsResponse"}}}},"500":{"description":"Unexpected or Run time exception.","content":{"*/*":{"schema":{"$ref":"#/components/schemas/SupplementaryDetailsResponse"}}}},"206":{"description":"Supplementary details partially retrieved.","content":{"*/*":{"schema":{"type":"string"}}}}},"security":[{"Authorization":[]},{"ServiceAuthorization":[]}]}},"/":{"get":{"tags":["root-controller"],"summary":"Welcome message for the Immigration & Asylum Case Access 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":{"*/*":{"schema":{"type":"string"}}}}}}}},"components":{"schemas":{"SupplementaryDetailsRequest":{"type":"object","properties":{"ccd_case_numbers":{"type":"array","items":{"type":"string"}}}},"MissingSupplementaryInfo":{"type":"object","properties":{"ccd_case_numbers":{"type":"array","items":{"type":"string"}}}},"SupplementaryDetails":{"type":"object","properties":{"surname":{"type":"string"},"case_reference_number":{"type":"string"}}},"SupplementaryDetailsResponse":{"type":"object","properties":{"supplementary_info":{"type":"array","items":{"$ref":"#/components/schemas/SupplementaryInfo"}},"missing_supplementary_info":{"$ref":"#/components/schemas/MissingSupplementaryInfo"}}},"SupplementaryInfo":{"type":"object","properties":{"ccd_case_number":{"type":"string"},"supplementary_details":{"$ref":"#/components/schemas/SupplementaryDetails"}}}}}}