Finds applications by search parameters (initially one). This API is now deprecated. Please use /applications for appeal validation and /applicationInstruct/setInstruct for appeal submission instead.
post/applicationStatus/getBySearchParameters
Request body
Example request
{
"messageHeader": {
"eventDateTime": "2017-07-21T17:32:28Z",
"correlationId": "ABC2344BCED2234EA",
"consumer": {
"code": "HMCTS",
"description": "HM Courts and Tribunal Service"
}
},
"searchParams": [
{
"spValue": "UAN (nnnn-nnnn-nnnn-nnnn) or CID (case ID, e.g. 001234567)",
"spType": "DOCUMENT_REFERENCE"
},
{
"spValue": "UAN (nnnn-nnnn-nnnn-nnnn) or CID (case ID, e.g. 001234567)",
"spType": "DOCUMENT_REFERENCE"
}
]
}Response
OK
Example response
{
"messageHeader": {
"eventDateTime": "2017-07-21T17:32:28Z",
"correlationId": "ABC2344BCED2234EA",
"consumer": {
"code": "HMCTS",
"description": "HM Courts and Tribunal Service"
}
},
"messageType": "RESPONSE_RIGHT_OF_APPEAL_DETAILS",
"status": [
{
"person": {
"givenName": "Capability",
"familyName": "Smith",
"fullName": "Capability Smith",
"gender": {
"code": "M",
"description": "Male"
},
"dayOfBirth": 21,
"monthOfBirth": 4,
"yearOfBirth": 1970,
"nationality": {
"code": "CAN",
"description": "Canada"
}
},
"applicationStatus": {
"documentReference": "9876-5432-1111-2222/01",
"roleType": {
"code": "APPLICANT",
"description": "Applicant"
},
"applicationType": {
"code": "ASYLUM",
"description": "Asylum and Protection"
},
"decisionType": {
"code": "REJECTION",
"description": "Rejected"
},
"decisionDate": "2017-07-21T17:32:28Z",
"decisionCommunication": {
"type": "EMAIL",
"description": "E-mail",
"sentDate": "2017-07-21T17:32:28Z"
},
"rejectionReasons": [
{
"reason": "Application not completed properly"
},
{
"reason": "You caught me on a bad day"
}
],
"metadata": [
{
"code": "APPEALABLE",
"valueBoolean": true
},
{
"code": "DISPATCH_DATE",
"valueDateTime": "2017-07-21T17:32:28Z"
},
{
"code": "SUSPENSIVE",
"valueString": "Some extra decision data",
"valueDateTime": "2027-07-27T07:17:27Z",
"valueBoolean": false
}
]
}
},
{
"person": {
"givenName": "Aishwarya",
"familyName": "Rai",
"fullName": "Aishwarya Rai",
"gender": {
"code": "F",
"description": "Female"
},
"dayOfBirth": 1,
"monthOfBirth": 11,
"yearOfBirth": 1973,
"nationality": {
"code": "IND",
"description": "India"
}
},
"applicationStatus": {
"documentReference": "9876-5432-1111-2222/02",
"roleType": {
"code": "DEPENDANT",
"description": "Dependant"
},
"roleSubType": {
"code": "SPOUSE",
"description": "Spouse"
},
"applicationType": {
"code": "ASYLUM",
"description": "Asylum and Protection"
},
"claimReasonType": {
"code": "HUMANRIGHTS",
"description": "Human Rights"
},
"decisionType": {
"code": "REJECTION",
"description": "Rejected"
},
"decisionDate": "2018-01-10T09:15:00Z",
"decisionCommunication": {
"type": "POST",
"description": "Postal",
"sentDate": "2018-01-10T09:15:00Z",
"dispatchDate": "2018-01-11T10:00:00Z"
},
"rejectionReasons": [
{
"reason": "Application submitted late"
}
],
"metadata": [
{
"code": "DISPATCH_DATE",
"valueDateTime": "2018-01-11T10:00:00Z"
},
{
"code": "SUSPENSIVE",
"valueBoolean": false
},
{
"code": "NOTE",
"valueString": "Manual review required"
}
]
}
}
]
}