---
title: "Create sample summary"
method: POST
path: "/samples/samplesummary"
tags: ["samples"]
---

# Create sample summary

`POST /samples/samplesummary`

## Request

- Base URL: `http://localhost:8125`
- URL: `http://localhost:8125/samples/samplesummary`
- Auth: HTTP basic

Create sample summary

## Request body

- SampleSummary
  - `effectiveEndDateTime` string, date-time
  - `effectiveStartDateTime` string, date-time
  - `errorCode` 'None' | 'NotCsv' | 'DataError' | 'NotSpecified'
  - `expectedCollectionInstruments` integer
  - `id` string, uuid
  - `ingestDateTime` string, date-time
  - `notes` string
  - `state` 'ACTIVE' | 'INIT' | 'FAILED'
  - `surveyRef` string
  - `totalSampleUnits` integer

## Response `200`

The sample summary was created successfully.

- SampleSummary
  - `effectiveEndDateTime` string, date-time
  - `effectiveStartDateTime` string, date-time
  - `errorCode` 'None' | 'NotCsv' | 'DataError' | 'NotSpecified'
  - `expectedCollectionInstruments` integer
  - `id` string, uuid
  - `ingestDateTime` string, date-time
  - `notes` string
  - `state` 'ACTIVE' | 'INIT' | 'FAILED'
  - `surveyRef` string
  - `totalSampleUnits` integer

## Other responses

- `401`: Authentication information is missing or invalid.
- `404`: Resource has not been found

## Changes

- **2021-09-30** `fc3fec3be47e`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/office-of-national-statistics/apis/ras-rm-sample-service/changes/samples/samplesummary/post.md)

---

[API](https://skmtc.dev/office-of-national-statistics/apis/ras-rm-sample-service.md) - [All operations](https://skmtc.dev/office-of-national-statistics/apis/ras-rm-sample-service/llms.txt) - [OpenAPI document](https://skmtc.dev/office-of-national-statistics/apis/ras-rm-sample-service/revisions/6236ad7256ad?raw)