HMhm-courts-and-tribunals-service

Gets the appellants' details of an application for immigration or asylum from the Home Office.

Changed on

This resource represents the people involved in an application for immigration or asylum from the Home Office. The application number is identified by the id passed in, which is a UAN (16 digits in four blocks of four separated by dashes) or a GWF (beginning wth the letters GWF followed by nine digits).

get/applications/v1/{id}

Request

  • Base URL
    http://localhost:8098/ichallenge
  • URL
    http://localhost:8098/ichallenge/applications/v1/{id}
  • Auth
    none declared. Required headers: Home-Office-Correlation-ID, Home-Office-Consumer, Home-Office-Event-DateTime

Path parameters

idstring required

Application ID

Headers

Home-Office-Correlation-IDstring uuid required
Home-Office-Consumer'HMCTS' required
Example:HMCTS
Home-Office-Event-DateTimestring date-time required

Response

OK (response returned)

uanstring
hoClaimDatestring required
hoDecisionDatestring required
hoDecisionLetterDatestring required

Example response

{
  "hoClaimDate": "2017-07-18",
  "uan": "1342-5786-9120-3564",
  "hoDecisionLetterDate": "2017-07-20",
  "appellants": [
    {
      "pp": "01",
      "familyName": "Bachchan",
      "givenNames": "Abhishek Amitabh",
      "dateOfBirth": "1976-02-05",
      "nationality": "IND",
      "roa": true,
      "asylumSupport": false,
      "hoFeeWaiver": true,
      "language": "GUJ",
      "interpreterNeeded": false
    },
    {
      "pp": "02",
      "familyName": "Rai",
      "givenNames": "Aishwarya",
      "dateOfBirth": "1973-11-01",
      "nationality": "IND",
      "roa": false,
      "asylumSupport": true,
      "hoFeeWaiver": false,
      "language": "HINDI",
      "interpreterNeeded": true
    },
    {
      "pp": "03",
      "familyName": "Gonzalez",
      "givenNames": "Jose",
      "dateOfBirth": "1989-02-10",
      "nationality": "SPN"
    }
  ],
  "hoDecisionDate": "2017-07-19"
}

Changes

  • cbc37ea89d76Revision changes
    • info

      the // response's property pattern was changed from ^[a-z]{3}$ to ^[A-Z_]{3,50}$ for the status

  • 227b8cd41bd6Revision changes
    • warning

      changed the pattern of the path request parameter id from ^(?!1234)(\d{4}-\d{4}-\d{4}-\d{4}|GWF\d{9})$ to ^(\d{4}-\d{4}-\d{4}-\d{4}|GWF\d{9})$