{"swagger":"2.0","info":{"description":"Provides data validation and other services","version":"1.0","title":"Solicitor CCD service","license":{"name":"MIT License"}},"host":"localhost:8080","basePath":"/","tags":[{"name":"business-validation-controller","description":"Business Validation Controller"},{"name":"next-steps-controller","description":"Next Steps Controller"},{"name":"print-service-template-controller","description":"Print Service Template Controller"}],"paths":{"/case/stopConfirmation":{"post":{"tags":["business-validation-controller"],"summary":"stopWithConfirmation","operationId":"stopWithConfirmationUsingPOST","consumes":["application/json;charset=UTF-8"],"produces":["application/json"],"parameters":[{"name":"ServiceAuthorization","in":"header","description":"User authorization header","required":true,"type":"string"},{"in":"body","name":"callbackRequest","description":"callbackRequest","required":true,"schema":{"$ref":"#/definitions/CallbackRequest"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/AfterSubmitCallbackResponse"}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/case/validate":{"post":{"tags":["business-validation-controller"],"summary":"validate","operationId":"validateUsingPOST","consumes":["application/json;charset=UTF-8"],"produces":["*/*"],"parameters":[{"name":"ServiceAuthorization","in":"header","description":"User authorization header","required":true,"type":"string"},{"in":"body","name":"callbackRequest","description":"callbackRequest","required":true,"schema":{"$ref":"#/definitions/CallbackRequest"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/CallbackResponse"}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/nextsteps/confirmation":{"post":{"tags":["next-steps-controller"],"summary":"getNextSteps","operationId":"getNextStepsUsingPOST","consumes":["application/json;charset=UTF-8"],"produces":["application/json;charset=UTF-8"],"parameters":[{"name":"ServiceAuthorization","in":"header","description":"User authorization header","required":true,"type":"string"},{"in":"body","name":"callbackRequest","description":"callbackRequest","required":true,"schema":{"$ref":"#/definitions/CallbackRequest"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/AfterSubmitCallbackResponse"}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/nextsteps/validate":{"post":{"tags":["next-steps-controller"],"summary":"validate","operationId":"validateUsingPOST_1","consumes":["application/json;charset=UTF-8"],"produces":["application/json;charset=UTF-8"],"parameters":[{"name":"ServiceAuthorization","in":"header","description":"User authorization header","required":true,"type":"string"},{"in":"body","name":"callbackRequest","description":"callbackRequest","required":true,"schema":{"$ref":"#/definitions/CallbackRequest"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/CallbackResponse"}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/template/case-details/pa":{"get":{"tags":["print-service-template-controller"],"summary":"getPACaseDetailsTemplate","operationId":"getPACaseDetailsTemplateUsingGET","consumes":["application/json;charset=UTF-8"],"produces":["text/html"],"parameters":[{"name":"ServiceAuthorization","in":"header","description":"User authorization header","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"string"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/template/case-details/sol":{"get":{"tags":["print-service-template-controller"],"summary":"getSolicitorCaseDetailsTemplate","operationId":"getSolicitorCaseDetailsTemplateUsingGET","consumes":["application/json;charset=UTF-8"],"produces":["text/html"],"parameters":[{"name":"ServiceAuthorization","in":"header","description":"User authorization header","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"string"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/template/documents":{"post":{"tags":["print-service-template-controller"],"summary":"getAllDocuments","operationId":"getAllDocumentsUsingPOST","consumes":["application/json;charset=UTF-8"],"produces":["*/*"],"parameters":[{"name":"ServiceAuthorization","in":"header","description":"User authorization header","required":true,"type":"string"},{"in":"body","name":"caseDetails","description":"caseDetails","required":true,"schema":{"$ref":"#/definitions/CaseDetails"}}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"type":"object"}}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}}},"definitions":{"CallbackRequest":{"type":"object","required":["case_details"],"properties":{"case_details":{"$ref":"#/definitions/CaseDetails"}}},"AfterSubmitCallbackResponse":{"type":"object","properties":{"confirmation_body":{"type":"string"},"confirmation_header":{"type":"string"}}},"CaseData":{"type":"object","required":["applicationFee","applicationType","deceasedAddress","deceasedAnyOtherNames","deceasedDateOfBirth","deceasedDateOfDeath","deceasedDomicileInEngWales","deceasedForenames","deceasedSurname","executorsApplying","executorsNotApplying","extraCopiesOfGrant","feeForNonUkCopies","feeForUkCopies","ihtGrossValue","ihtNetValue","otherExecutorExists","outsideUKGrantCopies","primaryApplicantAddress","primaryApplicantForenames","primaryApplicantHasAlias","primaryApplicantIsApplying","primaryApplicantSurname","registryLocation","solsAdditionalExecutorList","solsAdditionalInfo","solsDeceasedAliasNamesList","solsExecutorAliasNames","solsFeeAccountNumber","solsIHTFormId","solsLegalStatementDocument","solsPaymentMethods","solsPrimaryExecutorNotApplyingReason","solsSOTJobTitle","solsSOTName","solsSOTNeedToUpdate","solsSolicitorAppReference","solsSolicitorEmail","solsSolicitorFirmName","solsSolicitorFirmPostcode","solsSolicitorPhoneNumber","totalFee","willAccessOriginal","willExists","willHasCodicils","willNumberOfCodicils"],"properties":{"solsSolicitorFirmName":{"type":"string"},"solsSolicitorFirmPostcode":{"type":"string"},"solsSolicitorAppReference":{"type":"string"},"solsSolicitorEmail":{"type":"string"},"solsSolicitorPhoneNumber":{"type":"string"},"deceasedForenames":{"type":"string"},"deceasedSurname":{"type":"string"},"deceasedDateOfDeath":{"type":"string","format":"date"},"deceasedDateOfBirth":{"type":"string","format":"date"},"willExists":{"type":"string"},"willAccessOriginal":{"type":"string"},"willHasCodicils":{"type":"string"},"willNumberOfCodicils":{"type":"string"},"deceasedDomicileInEngWales":{"type":"string"},"deceasedAddress":{"$ref":"#/definitions/SolsAddress"},"deceasedAnyOtherNames":{"type":"string"},"solsDeceasedAliasNamesList":{"type":"array","items":{"$ref":"#/definitions/AliasNames"}},"solsIHTFormId":{"type":"string"},"ihtNetValue":{"type":"number","format":"float"},"ihtGrossValue":{"type":"number","format":"float"},"primaryApplicantForenames":{"type":"string"},"primaryApplicantSurname":{"type":"string"},"primaryApplicantHasAlias":{"type":"string"},"solsExecutorAliasNames":{"type":"string"},"primaryApplicantIsApplying":{"type":"string"},"solsPrimaryExecutorNotApplyingReason":{"type":"string"},"primaryApplicantAddress":{"$ref":"#/definitions/SolsAddress"},"otherExecutorExists":{"type":"string"},"solsAdditionalExecutorList":{"type":"array","items":{"$ref":"#/definitions/AdditionalExecutors"}},"solsAdditionalInfo":{"type":"string"},"solsLegalStatementDocument":{"$ref":"#/definitions/CCDDocument"},"solsSOTNeedToUpdate":{"type":"string"},"solsSOTName":{"type":"string"},"solsSOTJobTitle":{"type":"string"},"extraCopiesOfGrant":{"type":"integer","format":"int64"},"outsideUKGrantCopies":{"type":"integer","format":"int64"},"solsPaymentMethods":{"type":"string"},"solsFeeAccountNumber":{"type":"string"},"applicationFee":{"type":"number"},"feeForUkCopies":{"type":"number"},"feeForNonUkCopies":{"type":"number"},"totalFee":{"type":"number"},"executorsApplying":{"type":"array","items":{"$ref":"#/definitions/AdditionalExecutors"}},"executorsNotApplying":{"type":"array","items":{"$ref":"#/definitions/AdditionalExecutors"}},"applicationType":{"type":"string"},"registryLocation":{"type":"string"}}},"AdditionalExecutor":{"type":"object","required":["additionalApplying","additionalExecAddress","additionalExecAliasNameOnWill","additionalExecForenames","additionalExecLastname","additionalExecNameOnWill","additionalExecReasonNotApplying"],"properties":{"additionalExecForenames":{"type":"string"},"additionalExecLastname":{"type":"string"},"additionalExecNameOnWill":{"type":"string"},"additionalExecAliasNameOnWill":{"type":"string"},"additionalApplying":{"type":"string"},"additionalExecAddress":{"$ref":"#/definitions/SolsAddress"},"additionalExecReasonNotApplying":{"type":"string"}}},"ResponseCaseData":{"type":"object","properties":{"applicationFee":{"type":"string"},"applicationType":{"type":"string"},"deceasedAddress":{"$ref":"#/definitions/SolsAddress"},"deceasedAnyOtherNames":{"type":"string"},"deceasedDateOfBirth":{"type":"string"},"deceasedDateOfDeath":{"type":"string"},"deceasedDomicileInEngWales":{"type":"string"},"deceasedForenames":{"type":"string"},"deceasedSurname":{"type":"string"},"extraCopiesOfGrant":{"type":"string"},"feeForNonUkCopies":{"type":"string"},"feeForUkCopies":{"type":"string"},"ihtGrossValue":{"type":"string"},"ihtNetValue":{"type":"string"},"otherExecutorExists":{"type":"string"},"outsideUKGrantCopies":{"type":"string"},"primaryApplicantAddress":{"$ref":"#/definitions/SolsAddress"},"primaryApplicantForenames":{"type":"string"},"primaryApplicantHasAlias":{"type":"string"},"primaryApplicantIsApplying":{"type":"string"},"primaryApplicantSurname":{"type":"string"},"registryLocation":{"type":"string"},"solsAdditionalExecutorList":{"type":"array","items":{"$ref":"#/definitions/AdditionalExecutors"}},"solsAdditionalInfo":{"type":"string"},"solsDeceasedAliasNamesList":{"type":"array","items":{"$ref":"#/definitions/AliasNames"}},"solsExecutorAliasNames":{"type":"string"},"solsFeeAccountNumber":{"type":"string"},"solsIHTFormId":{"type":"string"},"solsLegalStatementDocument":{"$ref":"#/definitions/CCDDocument"},"solsNextStepsDocument":{"$ref":"#/definitions/CCDDocument"},"solsPaymentMethods":{"type":"string"},"solsPaymentReferenceNumber":{"type":"string"},"solsPrimaryExecutorNotApplyingReason":{"type":"string"},"solsSOTJobTitle":{"type":"string"},"solsSOTName":{"type":"string"},"solsSOTNeedToUpdate":{"type":"string"},"solsSolicitorAppReference":{"type":"string"},"solsSolicitorEmail":{"type":"string"},"solsSolicitorFirmName":{"type":"string"},"solsSolicitorFirmPostcode":{"type":"string"},"solsSolicitorPhoneNumber":{"type":"string"},"state":{"type":"string"},"totalFee":{"type":"string"},"willAccessOriginal":{"type":"string"},"willExists":{"type":"string"},"willHasCodicils":{"type":"string"},"willNumberOfCodicils":{"type":"string"}}},"SolsAddress":{"type":"object","required":["AddressLine1","AddressLine2","AddressLine3","Country","County","PostCode","PostTown"],"properties":{"AddressLine1":{"type":"string"},"AddressLine2":{"type":"string"},"AddressLine3":{"type":"string"},"County":{"type":"string"},"PostTown":{"type":"string"},"PostCode":{"type":"string"},"Country":{"type":"string"}}},"CallbackResponse":{"type":"object","properties":{"data":{"$ref":"#/definitions/ResponseCaseData"},"errors":{"type":"array","items":{"type":"string"}},"warnings":{"type":"array","items":{"type":"string"}}}},"CaseDetails":{"type":"object","required":["case_data","id","last_modified"],"properties":{"case_data":{"$ref":"#/definitions/CaseData"},"last_modified":{"type":"array","items":{"type":"string"}},"id":{"type":"integer","format":"int64"}}},"CCDDocument":{"type":"object","required":["document_binary_url","document_filename","document_url"],"properties":{"document_url":{"type":"string"},"document_binary_url":{"type":"string"},"document_filename":{"type":"string"}}},"AliasName":{"type":"object","required":["SolsAliasname"],"properties":{"SolsAliasname":{"type":"string"}}},"AliasNames":{"type":"object","required":["id","value"],"properties":{"value":{"$ref":"#/definitions/AliasName"},"id":{"type":"string"}}},"AdditionalExecutors":{"type":"object","required":["id","value"],"properties":{"value":{"$ref":"#/definitions/AdditionalExecutor"},"id":{"type":"string"}}}}}