{"swagger":"2.0","info":{"description":"SSCS Tribunals Case API","version":"1.0.0","title":"tribunals-case-api","contact":{"name":"SSCS","url":"http://sscs.net/","email":"sscs@hmcts.net"}},"host":"localhost:8080","basePath":"/","tags":[{"name":"evidence-management-controller","description":"Evidence Management Controller"},{"name":"reminder-controller","description":"Reminder Controller"},{"name":"subscriptions-controller","description":"Subscriptions Controller"},{"name":"sya-controller","description":"Sya Controller"},{"name":"tribunals-controller","description":"Tribunals Controller"},{"name":"tya-controller","description":"Tya Controller"}],"paths":{"/":{"get":{"tags":["tribunals-controller"],"summary":"getRootContext","description":"Returns root context of tribunals case api","operationId":"getRootContextUsingGET","consumes":["*/*"],"produces":["*/*"],"responses":{"200":{"description":"Appeal api","schema":{"type":"string"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/appeals":{"post":{"tags":["sya-controller"],"summary":"submitAppeal","description":"Creates a case from the SYA details","operationId":"createAppealsUsingPOST","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"syaCaseWrapper","description":"syaCaseWrapper","required":true,"schema":{"$ref":"#/definitions/SyaCaseWrapper"}}],"responses":{"200":{"description":"OK","schema":{"type":"string"}},"201":{"description":"Submitted appeal successfully","schema":{"type":"string"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/appeals/{appealNumber}":{"get":{"tags":["tya-controller"],"summary":"getAppeal","description":"Returns an appeal given the appeal number","operationId":"getAppealUsingGET","produces":["application/json;charset=UTF-8"],"parameters":[{"name":"appealNumber","in":"path","description":"appealNumber","required":true,"type":"string"}],"responses":{"200":{"description":"Appeal","schema":{"type":"string"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/appeals/{appealNumber}/subscriptions/{subscriptionId}":{"post":{"tags":["subscriptions-controller"],"summary":"UpdateSubscription","operationId":"updateSubscriptionUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"subscriptionRequest","description":"subscriptionRequest","required":true,"schema":{"$ref":"#/definitions/SubscriptionRequest"}},{"name":"appealNumber","in":"path","description":"appealNumber","required":true,"type":"string"},{"name":"subscriptionId","in":"path","description":"subscriptionId","required":true,"type":"string"}],"responses":{"200":{"description":"Updated subscription","schema":{"type":"string"}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/appeals/{appealNumber}/surname/{surname}":{"get":{"tags":["tya-controller"],"summary":"validateSurname","description":"Checks valid appeal number and surname","operationId":"validateSurnameUsingGET","produces":["application/json;charset=UTF-8"],"parameters":[{"name":"appealNumber","in":"path","description":"appealNumber","required":true,"type":"string"},{"name":"surname","in":"path","description":"surname","required":true,"type":"string"}],"responses":{"200":{"description":"Appeal","schema":{"type":"string"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/appeals/{id}/subscriptions/{subscriptionId}":{"delete":{"tags":["subscriptions-controller"],"summary":"Unsubscribe email notification","operationId":"unsubscribeUsingDELETE","produces":["application/json"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"type":"string"},{"name":"subscriptionId","in":"path","description":"subscriptionId","required":true,"type":"string"}],"responses":{"200":{"description":"Removed email notification subscription","schema":{"type":"string"}},"204":{"description":"No Content"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}}}},"/evidence/upload":{"post":{"tags":["evidence-management-controller"],"summary":"upload","operationId":"uploadUsingPOST","consumes":["multipart/form-data"],"produces":["application/json;charset=UTF-8"],"parameters":[{"name":"file","in":"formData","description":"file","required":true,"type":"array","items":{"type":"file"},"collectionFormat":"multi"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Embedded"}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/reminder":{"post":{"tags":["reminder-controller"],"summary":"reminder","operationId":"reminderUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"reminderResponse","description":"reminderResponse","required":true,"schema":{"$ref":"#/definitions/ReminderResponse"}}],"responses":{"200":{"description":"OK"},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/tokens/{token}":{"get":{"tags":["subscriptions-controller"],"summary":"validateMacToken","description":"Validates given mac token and returns Mac token details like subscription id, appeal id, decrypted token value, benefit type in the response json","operationId":"validateMacTokenUsingGET","produces":["application/json"],"parameters":[{"name":"token","in":"path","description":"token","required":true,"type":"string"}],"responses":{"200":{"description":"Validated mac token","schema":{"type":"string"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}}},"definitions":{"Document":{"type":"object","properties":{"_links":{"$ref":"#/definitions/Links"},"classification":{"type":"string"},"createdBy":{"type":"string"},"createdOn":{"type":"string","format":"date-time"},"mimeType":{"type":"string"},"modifiedOn":{"type":"string","format":"date-time"},"originalDocumentName":{"type":"string"},"size":{"type":"integer","format":"int64"}},"title":"Document"},"Embedded":{"type":"object","properties":{"documents":{"type":"array","items":{"$ref":"#/definitions/Document"}}},"title":"Embedded"},"Link":{"type":"object","properties":{"href":{"type":"string"}},"title":"Link"},"Links":{"type":"object","properties":{"binary":{"$ref":"#/definitions/Link"},"self":{"$ref":"#/definitions/Link"}},"title":"Links"},"Reason":{"type":"object","properties":{"reasonForAppealing":{"type":"string"},"whatYouDisagreeWith":{"type":"string"}},"title":"Reason"},"ReminderResponse":{"type":"object","properties":{"caseId":{"type":"string"},"eventId":{"type":"string"}},"title":"ReminderResponse"},"SubscriptionRequest":{"type":"object","properties":{"email":{"type":"string"}},"title":"SubscriptionRequest"},"SyaAppellant":{"type":"object","properties":{"contactDetails":{"$ref":"#/definitions/SyaContactDetails"},"dob":{"type":"string","example":"dd-MM-yyyy"},"firstName":{"type":"string"},"lastName":{"type":"string"},"nino":{"type":"string"},"title":{"type":"string"}},"title":"SyaAppellant"},"SyaArrangements":{"type":"object","properties":{"accessibleHearingRoom":{"type":"boolean"},"hearingLoop":{"type":"boolean"},"languageInterpreter":{"type":"boolean"},"other":{"type":"boolean"},"signLanguageInterpreter":{"type":"boolean"}},"title":"SyaArrangements"},"SyaBenefitType":{"type":"object","properties":{"code":{"type":"string"},"description":{"type":"string"}},"title":"SyaBenefitType"},"SyaCaseWrapper":{"type":"object","properties":{"appellant":{"$ref":"#/definitions/SyaAppellant"},"benefitType":{"$ref":"#/definitions/SyaBenefitType"},"hasRepresentative":{"type":"boolean"},"hearing":{"$ref":"#/definitions/SyaHearingOptions"},"isAppointee":{"type":"boolean"},"mrn":{"$ref":"#/definitions/SyaMrn"},"reasonsForAppealing":{"$ref":"#/definitions/SyaReasonsForAppealing"},"representative":{"$ref":"#/definitions/SyaRepresentative"},"signAndSubmit":{"$ref":"#/definitions/SyaSignAndSubmit"},"smsNotify":{"$ref":"#/definitions/SyaSmsNotify"}},"title":"SyaCaseWrapper"},"SyaContactDetails":{"type":"object","properties":{"addressLine1":{"type":"string"},"addressLine2":{"type":"string"},"county":{"type":"string"},"emailAddress":{"type":"string"},"phoneNumber":{"type":"string"},"postCode":{"type":"string"},"townCity":{"type":"string"}},"title":"SyaContactDetails"},"SyaEvidence":{"type":"object","properties":{"url":{"type":"string"},"fileName":{"type":"string"},"uploadedDate":{"type":"string","example":"yyyy-MM-dd"}},"title":"SyaEvidence"},"SyaHearingOptions":{"type":"object","properties":{"anythingElse":{"type":"string"},"arrangements":{"$ref":"#/definitions/SyaArrangements"},"datesCantAttend":{"type":"array","items":{"type":"string"}},"interpreterLanguageType":{"type":"string"},"scheduleHearing":{"type":"boolean"},"signLanguageType":{"type":"string"},"wantsSupport":{"type":"boolean"},"wantsToAttend":{"type":"boolean"}},"title":"SyaHearingOptions"},"SyaMrn":{"type":"object","properties":{"date":{"type":"string","example":"dd-MM-yyyy"},"dateAppealSubmitted":{"type":"string","example":"dd-MM-yyyy"},"dwpIssuingOffice":{"type":"string"},"reasonForBeingLate":{"type":"string"},"reasonForNoMRN":{"type":"string"}},"title":"SyaMrn"},"SyaReasonsForAppealing":{"type":"object","properties":{"evidences":{"type":"array","items":{"$ref":"#/definitions/SyaEvidence"}},"otherReasons":{"type":"string"},"reasons":{"type":"array","items":{"$ref":"#/definitions/Reason"}}},"title":"SyaReasonsForAppealing"},"SyaRepresentative":{"type":"object","properties":{"contactDetails":{"$ref":"#/definitions/SyaContactDetails"},"firstName":{"type":"string"},"fullName":{"type":"string"},"lastName":{"type":"string"},"organisation":{"type":"string"}},"title":"SyaRepresentative"},"SyaSignAndSubmit":{"type":"object","properties":{"signer":{"type":"string"}},"title":"SyaSignAndSubmit"},"SyaSmsNotify":{"type":"object","properties":{"smsNumber":{"type":"string"},"useSameNumber":{"type":"boolean"},"wantsSMSNotifications":{"type":"boolean"}},"title":"SyaSmsNotify"}}}