{"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"v0"},"servers":[{"url":"http://localhost","description":"Generated server url"}],"paths":{"/partiesNotified/{id}":{"get":{"tags":["parties-notified-controller"],"operationId":"getPartiesNotified","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Hearing id is valid","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartiesNotifiedResponses"}}}},"400":{"description":"One or more of the following reasons:\n1) Invalid hearing Id\n2) 003 Already set","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartiesNotifiedResponses"}}}},"404":{"description":"001 No such id: %s","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartiesNotifiedResponses"}}}}}},"put":{"tags":["parties-notified-controller"],"operationId":"putPartiesNotified","parameters":[{"name":"ServiceAuthorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"version","in":"query","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"received","in":"query","required":true,"schema":{"type":"string","format":"date-time"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartiesNotified"}}},"required":true},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"404":{"description":"One or more of the following reasons:\n1) 001 No such id: %s\n2) 001 No such response"},"500":{"description":"Error occurred on the server"}}}},"/linkedHearingGroup":{"put":{"tags":["link-hearing-group-controller"],"operationId":"updateLinkedHearingGroup","parameters":[{"name":"ServiceAuthorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"id","in":"query","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HearingLinkGroupRequest"}}},"required":true},"responses":{"200":{"description":"Success"},"400":{"description":"One or more of the following reasons:\n1) Invalid linked group id\n2) 001 Insufficient requestIds\n3) 002 hearing request isLinked is False\n4) 003 hearing request already in a group\n5) 004 Invalid state for hearing request <hearingId>\n6) 007 group is in a <state> state\n7) 008 Invalid state for unlinking hearing request <hearingId>"}}},"post":{"tags":["link-hearing-group-controller"],"operationId":"validateLinkHearing","parameters":[{"name":"ServiceAuthorization","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HearingLinkGroupRequest"}}},"required":true},"responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HearingLinkGroupResponse"}}}},"400":{"description":"One or more of the following reasons:\n1) 001 Insufficient requestIds\n2) 002 hearing request isLinked is False\n3) 003 hearing request already in a group\n4) 004 Invalid state for hearing request <hearingId>\n5) 005 Hearing Order is not unique","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HearingLinkGroupResponse"}}}}}}},"/hearingActuals/{id}":{"get":{"tags":["hearing-actuals-controller"],"operationId":"getHearingActuals","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Hearing id is valid","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HearingActualResponse"}}}},"400":{"description":"Invalid hearing Id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HearingActualResponse"}}}},"404":{"description":"No hearing found for reference: %s","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HearingActualResponse"}}}},"204":{"description":"No Content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HearingActualResponse"}}}}}},"put":{"tags":["hearing-actuals-management-controller"],"operationId":"updateHearingActuals","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"ServiceAuthorization","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HearingActual"}}},"required":true},"responses":{"200":{"description":"Hearing actuals update processed"},"400":{"description":"One or more of the following reasons:\n1) No response found on the hearing %s\n2) Invalid hearing Id\n3) 001 No such id: %s\n4) 002 invalid status %s\n5) 003 invalid date\n6) 004 non-unique dates"},"500":{"description":"Error occurred on the server"}}}},"/hearing/{id}":{"get":{"tags":["hearing-management-controller"],"operationId":"getHearing","parameters":[{"name":"ServiceAuthorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"isValid","in":"query","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"204":{"description":"Hearing id is valid","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetHearingResponse"}}}},"404":{"description":"No hearing found for reference: %s","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetHearingResponse"}}}},"400":{"description":"Invalid hearing Id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetHearingResponse"}}}},"401":{"description":"Failed to invoke ‘getHearing’ from service: %s for hearing id: %s","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetHearingResponse"}}}}}},"put":{"tags":["hearing-management-controller"],"operationId":"updateHearing","parameters":[{"name":"hmctsDeploymentId","in":"header","required":false,"schema":{"type":"string"}},{"name":"ServiceAuthorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateHearingRequest"}}},"required":true},"responses":{"201":{"description":"Hearing successfully updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HearingResponse"}}}},"400":{"description":"Invalid details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HearingResponse"}}}},"404":{"description":"Case could not be found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HearingResponse"}}}},"500":{"description":"Error occurred on the server","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HearingResponse"}}}}}},"delete":{"tags":["hearing-management-controller"],"operationId":"deleteHearing","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"ServiceAuthorization","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteHearingRequest"}}},"required":true},"responses":{"200":{"description":"Hearing cancellation processed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HearingResponse"}}}},"400":{"description":"Invalid details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HearingResponse"}}}},"404":{"description":"No hearing found for reference: %s","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HearingResponse"}}}},"500":{"description":"Error occurred on the server","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HearingResponse"}}}}}}},"/manageExceptions":{"post":{"tags":["manage-exceptions-controller"],"operationId":"manageExceptions","parameters":[{"name":"ServiceAuthorization","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ManageExceptionRequest"}}},"required":true},"responses":{"200":{"description":"Hearing successfully transitioned","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ManageExceptionResponse"}}}},"400":{"description":"One or more of the following reasons:\n1) More than 100 hearings found in the request\n2) Each hearing can only be defined once\n3) Invalid case reference\n3) Hearing is in incorrect state","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ManageExceptionResponse"}}}},"401":{"description":"Invalid user role","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ManageExceptionResponse"}}}},"403":{"description":"Invalid manage hearing service invoked","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ManageExceptionResponse"}}}}}}},"/hearings":{"get":{"tags":["hearing-management-controller"],"summary":"Get hearings for list of cases","operationId":"getHearingsForListOfCases","parameters":[{"name":"ccdCaseRefs","in":"query","required":true,"schema":{"type":"array","items":{"type":"string"}}},{"name":"status","in":"query","required":false,"schema":{"type":"string"}},{"name":"caseTypeId","in":"query","required":true,"schema":{"type":"string","minLength":1}}],"responses":{"200":{"description":"Success (with content)","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/GetHearingsResponse"}}}}},"400":{"description":"One or more of the following reasons:\n1) Invalid details","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/GetHearingsResponse"}}}}}},"deprecated":true},"post":{"tags":["hearing-management-controller"],"summary":"Get hearings for list of cases.  Pagination details for list of cases must be supplied.","operationId":"getHearingsForListOfCasesPaginated","parameters":[{"name":"status","in":"query","required":false,"schema":{"type":"string"}},{"name":"caseTypeId","in":"query","required":true,"schema":{"type":"string","minLength":1}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HearingsForListOfCasesPaginatedRequest"}}},"required":true},"responses":{"200":{"description":"Success.  Content will be null under certain circumstances, such as if no cases are found.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/GetHearingsResponse"}}}}},"400":{"description":"One or more of the following reasons:\n1) Page size is mandatory\n2) Page size can not be less than one\n3) Offset is mandatory\n4) Offset can not be less than 0\n5) At least one case reference must be provided\n6) Case ref can not be empty\n7) Case ref has invalid length\n8) Invalid case reference (if case reference fails Luhn check)","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/GetHearingsResponse"}}}}}}}},"/hearing":{"post":{"tags":["hearing-management-controller"],"operationId":"saveHearing","parameters":[{"name":"hmctsDeploymentId","in":"header","required":false,"schema":{"type":"string"}},{"name":"ServiceAuthorization","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HearingRequest"}}},"required":true},"responses":{"201":{"description":"Hearing successfully created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HearingResponse"}}}},"400":{"description":"One or more of the following reasons:\n1) Invalid details\n2) Hearing window details are invalid\n3) Either Individual or Organisation details should be present","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HearingResponse"}}}}}}},"/hearingActualsCompletion/{id}":{"post":{"tags":["hearing-management-controller"],"operationId":"hearingCompletion","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"ServiceAuthorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success (with no content)","content":{"*/*":{"schema":{"type":"string"}}}},"404":{"description":"001 No such id: %s","content":{"*/*":{"schema":{"type":"string"}}}},"400":{"description":"One or more of the following reasons:\n1) Invalid details\n2) 002 invalid status %s\n3) 004 unexpected hearing day actuals\n4) 005 missing hearing outcome","content":{"*/*":{"schema":{"type":"string"}}}},"500":{"description":"Error occurred on the server","content":{"*/*":{"schema":{"type":"string"}}}}}}},"/unNotifiedHearings/{hmctsServiceCode}":{"get":{"tags":["un-notified-hearings-controller"],"operationId":"getUnNotifiedHearings","parameters":[{"name":"hmctsServiceCode","in":"path","required":true,"schema":{"type":"string","minLength":1}},{"name":"hearing_start_date_from","in":"query","required":true,"schema":{"type":"string","format":"date-time"}},{"name":"hearing_start_date_to","in":"query","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"hearingStatus","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnNotifiedHearingsResponse"}}}},"400":{"description":"Invalid hmcts service code","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnNotifiedHearingsResponse"}}}},"401":{"description":"Unauthorised","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnNotifiedHearingsResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnNotifiedHearingsResponse"}}}}}}},"/linkedHearingGroup/{id}":{"get":{"tags":["linked-hearing-group-controller"],"operationId":"getLinkedHearingGroup","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success (with content)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetLinkedHearingGroupResponse"}}}},"400":{"description":"Invalid linked group id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetLinkedHearingGroupResponse"}}}},"404":{"description":"Invalid linked group id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetLinkedHearingGroupResponse"}}}}}},"delete":{"tags":["link-hearing-group-controller"],"operationId":"deleteHearingGroup","parameters":[{"name":"ServiceAuthorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Hearing group deletion processed"},"400":{"description":"Invalid linked group id"},"404":{"description":"Invalid linked group id"},"500":{"description":"Error occurred on the server"}}}},"/hearings/{ccdCaseRef}":{"get":{"tags":["hearing-management-controller"],"summary":"Get hearings","operationId":"getHearings","parameters":[{"name":"ccdCaseRef","in":"path","required":true,"schema":{"type":"string","maxLength":16,"minLength":16}},{"name":"status","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success (with content)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetHearingsResponse"}}}},"400":{"description":"One or more of the following reasons:\n1) Invalid details\n2) Case ref can not be empty\n3) Case ref has invalid length\n4) Case ref details is invalid","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetHearingsResponse"}}}}}}},"/":{"get":{"tags":["root-controller"],"operationId":"welcome","responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"string"}}}}}}}},"components":{"schemas":{"JsonNode":{},"PartiesNotified":{"type":"object","properties":{"serviceData":{"$ref":"#/components/schemas/JsonNode"}}},"GroupDetails":{"type":"object","properties":{"groupName":{"type":"string","maxLength":255,"minLength":0},"groupReason":{"type":"string","maxLength":8,"minLength":0},"groupLinkType":{"type":"string"},"groupComments":{"type":"string","maxLength":4000,"minLength":0}},"required":["groupLinkType"]},"HearingLinkGroupRequest":{"type":"object","properties":{"groupDetails":{"$ref":"#/components/schemas/GroupDetails"},"hearingsInGroup":{"type":"array","items":{"$ref":"#/components/schemas/LinkHearingDetails"},"maxItems":2147483647,"minItems":2}},"required":["groupDetails","hearingsInGroup"]},"LinkHearingDetails":{"type":"object","properties":{"hearingId":{"type":"string","maxLength":30,"minLength":0},"hearingOrder":{"type":"integer","format":"int32"}},"required":["hearingId"]},"ActualHearingDay":{"type":"object","properties":{"hearingDate":{"type":"string","format":"date"},"hearingStartTime":{"type":"string","format":"date-time"},"hearingEndTime":{"type":"string","format":"date-time"},"pauseDateTimes":{"type":"array","items":{"$ref":"#/components/schemas/ActualHearingDayPauseDayTime"}},"actualDayParties":{"type":"array","items":{"$ref":"#/components/schemas/ActualHearingDayParties"}},"notRequired":{"type":"boolean"},"empty":{"type":"boolean"}},"required":["hearingDate"]},"ActualHearingDayParties":{"type":"object","properties":{"actualPartyId":{"type":"string","maxLength":40,"minLength":0},"partyRole":{"type":"string","maxLength":40,"minLength":0},"individualDetails":{"$ref":"#/components/schemas/ActualHearingDayPartyDetail"},"actualOrganisationName":{"type":"string","maxLength":200,"minLength":0},"partyChannelSubType":{"type":"string","maxLength":70,"minLength":0},"didNotAttendFlag":{"type":"boolean"},"representedParty":{"type":"string","maxLength":40,"minLength":0}},"required":["partyChannelSubType","partyRole"]},"ActualHearingDayPartyDetail":{"type":"object","properties":{"firstName":{"type":"string","maxLength":100,"minLength":0},"lastName":{"type":"string","maxLength":100,"minLength":0}},"required":["firstName","lastName"]},"ActualHearingDayPauseDayTime":{"type":"object","properties":{"pauseStartTime":{"type":"string","format":"date-time"},"pauseEndTime":{"type":"string","format":"date-time"}},"required":["pauseEndTime","pauseStartTime"]},"HearingActual":{"type":"object","properties":{"hearingOutcome":{"$ref":"#/components/schemas/HearingActualsOutcome"},"actualHearingDays":{"type":"array","items":{"$ref":"#/components/schemas/ActualHearingDay"}}}},"HearingActualsOutcome":{"type":"object","properties":{"hearingType":{"type":"string","maxLength":40,"minLength":0},"hearingFinalFlag":{"type":"boolean"},"hearingResult":{"type":"string"},"hearingResultReasonType":{"type":"string","maxLength":70,"minLength":0},"hearingResultDate":{"type":"string","format":"date"},"empty":{"type":"boolean"}},"required":["hearingType"]},"CaseCategory":{"type":"object","properties":{"categoryType":{"type":"string","enum":["caseType, caseSubType"],"minLength":1},"categoryValue":{"type":"string","maxLength":70,"minLength":0},"categoryParent":{"type":"string","maxLength":70,"minLength":0}},"required":["categoryType","categoryValue"]},"CaseDetails":{"type":"object","properties":{"hmctsServiceCode":{"type":"string","minLength":1,"pattern":"^\\w{4}$"},"caseRef":{"type":"string","minLength":1},"externalCaseReference":{"type":"string","maxLength":70,"minLength":0},"caseDeepLink":{"type":"string","maxLength":1024,"minLength":0},"hmctsInternalCaseName":{"type":"string","maxLength":1024,"minLength":0,"pattern":"^[\\p{Ll}\\p{Lm}\\p{Lt}\\p{Lu}\\p{N}\\p{P}\\p{Zs}\\p{Sc}\\p{Sk}\\p{Sm}\\p{Zs}]*$"},"publicCaseName":{"type":"string","maxLength":1024,"minLength":0,"pattern":"^[\\p{Ll}\\p{Lm}\\p{Lt}\\p{Lu}\\p{N}\\p{P}\\p{Zs}\\p{Sc}\\p{Sk}\\p{Sm}\\p{Zs}]*$"},"caseAdditionalSecurityFlag":{"type":"boolean"},"caseInterpreterRequiredFlag":{"type":"boolean"},"caseCategories":{"type":"array","items":{"$ref":"#/components/schemas/CaseCategory"},"minItems":1},"caseManagementLocationCode":{"type":"string","maxLength":40,"minLength":0},"caserestrictedFlag":{"type":"boolean"},"caseSLAStartDate":{"type":"string","format":"date"}},"required":["caseCategories","caseDeepLink","caseManagementLocationCode","caseRef","caseSLAStartDate","caserestrictedFlag","hmctsInternalCaseName","hmctsServiceCode","publicCaseName"]},"HearingDetails":{"type":"object","properties":{"listingAutoChangeReasonCode":{"type":"string","enum":["no-mapping-available, user-added-comments"],"maxLength":70,"minLength":0},"hearingType":{"type":"string","maxLength":40,"minLength":0},"hearingWindow":{"$ref":"#/components/schemas/HearingWindow"},"duration":{"type":"integer","format":"int32","minimum":0},"nonStandardHearingDurationReasons":{"type":"array","items":{"type":"string","maxLength":70,"minLength":0}},"hearingPriorityType":{"type":"string","maxLength":60,"minLength":0},"numberOfPhysicalAttendees":{"type":"integer","format":"int32","minimum":0},"hearingInWelshFlag":{"type":"boolean"},"hearingLocations":{"type":"array","items":{"$ref":"#/components/schemas/HearingLocation"},"minItems":1},"facilitiesRequired":{"type":"array","items":{"type":"string","maxLength":70,"minLength":0}},"listingComments":{"type":"string","maxLength":2000,"minLength":0},"hearingRequester":{"type":"string","maxLength":60,"minLength":0},"privateHearingRequiredFlag":{"type":"boolean"},"leadJudgeContractType":{"type":"string","maxLength":70,"minLength":0},"panelRequirements":{"$ref":"#/components/schemas/PanelRequirements"},"hearingIsLinkedFlag":{"type":"boolean"},"amendReasonCodes":{"type":"array","items":{"type":"string","maxLength":70,"minLength":1}},"hearingChannels":{"type":"array","items":{"type":"string","maxLength":70,"minLength":0}},"autolistFlag":{"type":"boolean"},"isAPanelFlag":{}},"required":["autolistFlag","duration","hearingChannels","hearingLocations","hearingPriorityType","hearingType","panelRequirements"]},"HearingLocation":{"type":"object","properties":{"locationType":{"type":"string","enum":["court, cluster, region"]},"locationId":{"type":"string","minLength":1}},"required":["locationId"]},"HearingWindow":{"type":"object","properties":{"dateRangeStart":{"type":"string","format":"date"},"dateRangeEnd":{"type":"string","format":"date"},"firstDateTimeMustBe":{"type":"string","format":"date-time"}}},"IndividualDetails":{"type":"object","properties":{"title":{"type":"string","maxLength":40,"minLength":0},"firstName":{"type":"string","maxLength":100,"minLength":0,"pattern":"^[\\p{Ll}\\p{Lm}\\p{Lt}\\p{Lu}\\p{N}\\p{P}\\p{Zs}\\p{Sc}\\p{Sk}\\p{Sm}\\p{Zs}]*$"},"lastName":{"type":"string","maxLength":730,"minLength":0,"pattern":"^[\\p{Ll}\\p{Lm}\\p{Lt}\\p{Lu}\\p{N}\\p{P}\\p{Zs}\\p{Sc}\\p{Sk}\\p{Sm}\\p{Zs}]*$"},"preferredHearingChannel":{"type":"string","maxLength":70,"minLength":0},"interpreterLanguage":{"type":"string","maxLength":10,"minLength":0},"reasonableAdjustments":{"type":"array","items":{"type":"string","maxLength":10,"minLength":0}},"vulnerableFlag":{"type":"boolean"},"vulnerabilityDetails":{"type":"string","maxLength":2000,"minLength":0},"hearingChannelEmail":{"type":"array","items":{"type":"string","format":"email","maxLength":120,"minLength":0}},"hearingChannelPhone":{"type":"array","items":{"type":"string","maxLength":30,"minLength":0,"pattern":"^\\+?(?:[0-9] ?){6,14}[0-9]$"}},"relatedParties":{"type":"array","items":{"$ref":"#/components/schemas/RelatedParty"}},"custodyStatus":{"type":"string","maxLength":80,"minLength":0},"otherReasonableAdjustmentDetails":{"type":"string","maxLength":3000,"minLength":0}},"required":["firstName","lastName"]},"OrganisationDetails":{"type":"object","properties":{"name":{"type":"string","maxLength":2000,"minLength":0,"pattern":"^[\\p{Ll}\\p{Lm}\\p{Lt}\\p{Lu}\\p{N}\\p{P}\\p{Zs}\\p{Sc}\\p{Sk}\\p{Sm}\\p{Zs}]*$"},"organisationType":{"type":"string","maxLength":60,"minLength":0},"cftOrganisationID":{"type":"string","maxLength":60,"minLength":0}},"required":["name","organisationType"]},"PanelPreference":{"type":"object","properties":{"memberID":{"type":"string","maxLength":70,"minLength":0},"memberType":{"type":"string","maxLength":70,"minLength":0},"requirementType":{"type":"string","enum":["MUSTINC, OPTINC, EXCLUDE"]}},"required":["memberID"]},"PanelRequirements":{"type":"object","properties":{"roleType":{"type":"array","items":{"type":"string","maxLength":70,"minLength":0}},"authorisationTypes":{"type":"array","items":{"type":"string","maxLength":70,"minLength":0}},"authorisationSubType":{"type":"array","items":{"type":"string","maxLength":70,"minLength":0}},"panelPreferences":{"type":"array","items":{"$ref":"#/components/schemas/PanelPreference"}},"panelSpecialisms":{"type":"array","items":{"type":"string","maxLength":70,"minLength":0}}}},"PartyDetails":{"type":"object","properties":{"partyID":{"type":"string","maxLength":40,"minLength":0},"partyType":{"type":"string","enum":["IND, ORG"],"minLength":1},"partyRole":{"type":"string","maxLength":40,"minLength":0},"individualDetails":{"$ref":"#/components/schemas/IndividualDetails"},"organisationDetails":{"$ref":"#/components/schemas/OrganisationDetails"},"unavailabilityRanges":{"type":"array","items":{"$ref":"#/components/schemas/UnavailabilityRanges"}},"partyChannelSubType":{"type":"string"},"unavailabilityDOW":{"type":"array","items":{"$ref":"#/components/schemas/UnavailabilityDow"}}},"required":["partyID","partyRole","partyType"]},"RelatedParty":{"type":"object","properties":{"relatedPartyID":{"type":"string","maxLength":15,"minLength":0},"relationshipType":{"type":"string","maxLength":10,"minLength":0}},"required":["relatedPartyID","relationshipType"]},"RequestDetails":{"type":"object","properties":{"versionNumber":{"type":"integer","format":"int32"}},"required":["versionNumber"]},"UnavailabilityDow":{"type":"object","properties":{"DOW":{"type":"string","enum":["Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday"]},"DOWUnavailabilityType":{"type":"string","enum":["AM, PM, All Day"]}}},"UnavailabilityRanges":{"type":"object","properties":{"unavailableFromDate":{"type":"string","format":"date"},"unavailableToDate":{"type":"string","format":"date"},"unavailabilityType":{"type":"string"}},"required":["unavailableFromDate","unavailableToDate"]},"UpdateHearingRequest":{"type":"object","properties":{"hearingDetails":{"$ref":"#/components/schemas/HearingDetails"},"caseDetails":{"$ref":"#/components/schemas/CaseDetails"},"partyDetails":{"type":"array","items":{"$ref":"#/components/schemas/PartyDetails"}},"requestDetails":{"$ref":"#/components/schemas/RequestDetails"}},"required":["caseDetails","hearingDetails","requestDetails"]},"HearingResponse":{"type":"object","properties":{"hearingRequestID":{"type":"integer","format":"int64","maximum":30,"minimum":0},"status":{"type":"string","maxLength":100,"minLength":0},"timeStamp":{"type":"string","format":"date-time"},"versionNumber":{"type":"integer","format":"int32"},"responseVersion":{"type":"integer","format":"int32"},"requestVersion":{"type":"integer","format":"int32"},"partiesNotified":{"type":"string","format":"date-time"},"serviceData":{"type":"object","additionalProperties":{}}},"required":["hearingRequestID","requestVersion","responseVersion","status","timeStamp","versionNumber"]},"ManageExceptionRequest":{"type":"object","properties":{"supportRequests":{"type":"array","items":{"$ref":"#/components/schemas/SupportRequest"}}},"required":["supportRequests"]},"SupportRequest":{"type":"object","properties":{"hearingId":{"type":"string","maxLength":30,"minLength":0},"caseRef":{"type":"string","minLength":1},"action":{"type":"string","enum":["rollback, final_state_transition"],"minLength":1},"state":{"type":"string","enum":["CANCELLED, COMPLETED, ADJOURNED"]},"notes":{"type":"string","maxLength":5000,"minLength":0}},"required":["action","caseRef","hearingId","notes"]},"ManageExceptionResponse":{"type":"object","properties":{"supportRequestResponse":{"type":"array","items":{"$ref":"#/components/schemas/SupportRequestResponse"}}},"required":["supportRequestResponse"]},"SupportRequestResponse":{"type":"object","properties":{"hearingId":{"type":"string","maxLength":30,"minLength":0},"status":{"type":"string","enum":["successful, failure"],"minLength":1},"message":{"type":"string","maxLength":2000,"minLength":0}},"required":["hearingId","status"]},"HearingLinkGroupResponse":{"type":"object","properties":{"hearingGroupRequestId":{"type":"string"}}},"HearingsForListOfCasesPaginatedRequest":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"offset":{"type":"integer","format":"int32","minimum":0},"caseReferences":{"type":"array","items":{"$ref":"#/components/schemas/HearingsForListOfCasesPaginatedRequestCaseReference"},"minItems":1}},"required":["caseReferences","offset","pageSize"]},"HearingsForListOfCasesPaginatedRequestCaseReference":{"type":"object","properties":{"caseReference":{"type":"string","maxLength":16,"minLength":16}},"required":["caseReference"]},"Attendee":{"type":"object","properties":{"hearingSubChannel":{"type":"string","maxLength":60,"minLength":0},"partyID":{"type":"string","maxLength":40,"minLength":0}},"required":["hearingSubChannel","partyID"]},"CaseHearing":{"type":"object","properties":{"hearingRequestDateTime":{"type":"string","format":"date-time"},"hearingType":{"type":"string","maxLength":60,"minLength":0},"hmcStatus":{"type":"string","maxLength":60,"minLength":0},"lastResponseReceivedDateTime":{"type":"string","format":"date-time"},"requestVersion":{"type":"integer","format":"int32","maximum":60,"minimum":0},"hearingListingStatus":{"type":"string","maxLength":60,"minLength":0},"listAssistCaseStatus":{"type":"string","maxLength":60,"minLength":0},"hearingDaySchedule":{"type":"array","items":{"$ref":"#/components/schemas/HearingDaySchedule"}},"hearingGroupRequestId":{"type":"string","maxLength":30,"minLength":0},"hearingIsLinkedFlag":{"type":"boolean"},"hearingChannels":{"type":"array","items":{"type":"string","maxLength":70,"minLength":0}},"hearingID":{"type":"integer","format":"int64","maximum":60,"minimum":0}},"required":["hearingChannels","hearingDaySchedule","hearingID","hearingListingStatus","hearingRequestDateTime","hearingType","hmcStatus","lastResponseReceivedDateTime","listAssistCaseStatus","requestVersion"]},"GetHearingsResponse":{"type":"object","properties":{"caseRef":{"type":"string"},"caseHearings":{"type":"array","items":{"$ref":"#/components/schemas/CaseHearing"}},"hmctsServiceCode":{"type":"string"}},"required":["caseHearings"]},"HearingDaySchedule":{"type":"object","properties":{"hearingStartDateTime":{"type":"string","format":"date-time"},"hearingEndDateTime":{"type":"string","format":"date-time"},"hearingVenueId":{"type":"string","maxLength":60,"minLength":0},"hearingRoomId":{"type":"string","maxLength":60,"minLength":0},"hearingJudgeId":{"type":"string","maxLength":60,"minLength":0},"panelMemberIds":{"type":"array","items":{"type":"string","maxLength":60,"minLength":0}},"attendees":{"type":"array","items":{"$ref":"#/components/schemas/Attendee"}},"listAssistSessionID":{"type":"string","maxLength":60,"minLength":0}},"required":["attendees","hearingEndDateTime","hearingRoomId","hearingStartDateTime","hearingVenueId","listAssistSessionID"]},"HearingRequest":{"type":"object","properties":{"hearingDetails":{"$ref":"#/components/schemas/HearingDetails"},"caseDetails":{"$ref":"#/components/schemas/CaseDetails"},"partyDetails":{"type":"array","items":{"$ref":"#/components/schemas/PartyDetails"}},"requestDetails":{"$ref":"#/components/schemas/RequestDetails"}},"required":["caseDetails","hearingDetails"]},"UnNotifiedHearingsResponse":{"type":"object","properties":{"hearingIds":{"type":"array","items":{"type":"string"}},"totalFound":{"type":"integer","format":"int64"}},"required":["totalFound"]},"PartiesNotifiedResponse":{"type":"object","properties":{"responseReceivedDateTime":{"type":"string","format":"date-time"},"requestVersion":{"type":"integer","format":"int32"},"partiesNotified":{"type":"string","format":"date-time"},"serviceData":{"$ref":"#/components/schemas/JsonNode"}}},"PartiesNotifiedResponses":{"type":"object","properties":{"hearingID":{"type":"string"},"responses":{"type":"array","items":{"$ref":"#/components/schemas/PartiesNotifiedResponse"}}}},"GetLinkedHearingGroupResponse":{"type":"object","properties":{"groupDetails":{"$ref":"#/components/schemas/GroupDetails"},"hearingsInGroup":{"type":"array","items":{"$ref":"#/components/schemas/LinkedHearingDetails"}}}},"LinkedHearingDetails":{"type":"object","properties":{"hearingId":{"type":"integer","format":"int64"},"hearingOrder":{"type":"integer","format":"int64"},"caseRef":{"type":"string"},"hmctsInternalCaseName":{"type":"string"}}},"HearingActualResponse":{"type":"object","properties":{"hmcStatus":{"type":"string"},"caseDetails":{"$ref":"#/components/schemas/CaseDetails"},"hearingPlanned":{"$ref":"#/components/schemas/HearingPlanned"},"hearingActuals":{"$ref":"#/components/schemas/HearingActual"}}},"HearingPlanned":{"type":"object","properties":{"plannedHearingType":{"type":"string"},"plannedHearingDays":{"type":"array","items":{"$ref":"#/components/schemas/PlannedHearingDays"}}}},"Party":{"type":"object","properties":{"partyID":{"type":"string"},"partyRole":{"type":"string"},"individualDetails":{"$ref":"#/components/schemas/IndividualDetails"},"organisationDetails":{"$ref":"#/components/schemas/OrganisationDetails"},"partyChannelSubType":{"type":"string"},"partyType":{"type":"string"}}},"PlannedHearingDays":{"type":"object","properties":{"plannedStartTime":{"type":"string","format":"date-time"},"plannedEndTime":{"type":"string","format":"date-time"},"parties":{"type":"array","items":{"$ref":"#/components/schemas/Party"}}}},"GetHearingResponse":{"type":"object","properties":{"requestDetails":{"$ref":"#/components/schemas/RequestDetails"},"hearingDetails":{"$ref":"#/components/schemas/HearingDetails"},"caseDetails":{"$ref":"#/components/schemas/CaseDetails"},"partyDetails":{"type":"array","items":{"$ref":"#/components/schemas/PartyDetails"}},"hearingResponse":{"$ref":"#/components/schemas/HearingResponse"}}},"DeleteHearingRequest":{"type":"object","properties":{"cancellationReasonCodes":{"type":"array","items":{"type":"string","maxLength":100,"minLength":1},"minItems":1}},"required":["cancellationReasonCodes"]}}}}