OFoffice-of-national-statistics
samples

Get Sample Unit

Changed on

SampleUnit info for the given ID

get/samples/{id}

Request

  • Base URL
    http://localhost:8125
  • Auth
    HTTP basic

Path parameters

idstring uuid required
Example:34597808-ec88-4e93-af2f-228e33ff7946

Response

The sample unit was retrieved successfully.

formTypestring
idstring uuid
sampleSummaryFKinteger
sampleUnitPKinteger
sampleUnitRefstring
sampleUnitTypestring
status'INIT' | 'DELIVERED' | 'PERSISTED' | 'FAILED'

Example response

{
  "formType": "0001",
  "id": "34597808-ec88-4e93-af2f-228e33ff7946",
  "sampleSummaryFK": 321,
  "sampleUnitPK": 123,
  "sampleUnitRef": "01234567890",
  "sampleUnitType": "01234567890",
  "status": "INIT"
}

Changes