OFoffice-of-national-statistics
samples

Create sample summary

Changed on

Create sample summary

post/samples/samplesummary

Request

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

Request body

effectiveEndDateTimestring date-time
effectiveStartDateTimestring date-time
errorCode'None' | 'NotCsv' | 'DataError' | 'NotSpecified'
expectedCollectionInstrumentsinteger
idstring uuid
ingestDateTimestring date-time
notesstring
state'ACTIVE' | 'INIT' | 'FAILED'
surveyRefstring
totalSampleUnitsinteger

Example request

{
  "effectiveEndDateTime": "2020-06-08T09:50:25.338Z",
  "effectiveStartDateTime": "2020-06-08T09:50:25.338Z",
  "errorCode": "NotCsv",
  "id": "fd6a1aa3-ba17-43a8-beae-a39e67c6444d",
  "ingestDateTime": "2020-06-08T09:50:25.338Z",
  "notes": "example",
  "state": "ACTIVE",
  "surveyRef": "342",
  "totalSampleUnits": 1
}

Response

The sample summary was created successfully.

effectiveEndDateTimestring date-time
effectiveStartDateTimestring date-time
errorCode'None' | 'NotCsv' | 'DataError' | 'NotSpecified'
expectedCollectionInstrumentsinteger
idstring uuid
ingestDateTimestring date-time
notesstring
state'ACTIVE' | 'INIT' | 'FAILED'
surveyRefstring
totalSampleUnitsinteger

Example response

{
  "effectiveEndDateTime": "2020-06-08T09:50:25.338Z",
  "effectiveStartDateTime": "2020-06-08T09:50:25.338Z",
  "errorCode": "NotCsv",
  "id": "fd6a1aa3-ba17-43a8-beae-a39e67c6444d",
  "ingestDateTime": "2020-06-08T09:50:25.338Z",
  "notes": "example",
  "state": "ACTIVE",
  "surveyRef": "342",
  "totalSampleUnits": 1
}

Changes