---
title: "Get Sample Summary"
method: GET
path: "/samples/samplesummary/{sampleSummaryId}"
tags: ["samples"]
---

# Get Sample Summary

`GET /samples/samplesummary/{sampleSummaryId}`

## Request

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

SampleSummary info for the given sampleSummaryId

## Path parameters

- `sampleSummaryId` string, uuid, required

## Response `201`

The sample summary was retrieved successfully.

- SampleUnit
  - `formType` string
  - `id` string, uuid
  - `sampleSummaryFK` integer
  - `sampleUnitPK` integer
  - `sampleUnitRef` string
  - `sampleUnitType` string
  - `status` 'INIT' | 'DELIVERED' | 'PERSISTED' | 'FAILED'

## Other responses

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

## Changes

- **2021-09-30** `fc3fec3be47e`: 1 breaking, 1 info
  - removed the success response with the status `200`
  - added the success response with the status `201`
- **2021-09-14** `4937f3b06222`: 1 warning
  - removed the optional property `sampleAttributes` from the response with the `200` status

[Operation history](https://skmtc.dev/office-of-national-statistics/apis/ras-rm-sample-service/changes/samples/samplesummary/:sampleSummaryId/get.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)