# Get annotation

This API is responsible for retrieving the annotation with the given **id**.

<p class="callout info">**\[GET\]/api/v1/annotations/{id}**</p>

**Response:** Annotation.

### Header

Header used on this API are those taken from <span style="color: #3366ff;">[header standards of TS Digital.](https://digital-docs.ts-paas.com/books/utilizzo-api-tsdigital/page/linee-guida-generali-api-ts-digital)</span>

`Content-type` is accepted in `application/json`

### Query Parameters

Parameters used to make a successful request.

- **id**: Unique identifier associated with the requested annotation. (<span style="background-color: #ffffff; color: #ff0000;">***required***</span>)

### Body

No body is needed to make this request.

### Response

##### On successful response

If successful, the **API** responds with HTTP code **200(OK)** with the following body:

```JSON
{
  "id": "string",
  "type": "string",
  "text": "string",
  "classification": "string",
  "referencingDate": "string",
  "referencePeriod": "string",
  "referenceType": "string",
  "referenceIds": [
    "string"
  ],
  "deleted": true,
  "ownership": {
    "type": "WS",
    "identifier": "string"
  },
  "itemClassifier": "string",
  "insertedBy": "string",
  "insertedAt": "2022-10-28T13:01:00.754Z",
  "modifiedAt": "2022-10-28T13:01:00.754Z"
}
```

- **id**: unique identifier of the annotation
- **type**: specifies the annotation type.
- **text**: contains information about the annotation. Depending on the type, the information contained can be: 
    - **note text**: the text value, in case the annotation is of type **NOTE**
    - **folder name**: the name of the folder, in case the annotation is of type **FOLDER**
- **classification**: the classification of the annotation
- **referencing\_date**: the referencing date
- **reference\_period:** the year of reference
- **reference\_type**: the reference type, at the moment the only possible value is **DOCSTORE**
- **reference\_ids**: the ids of the related documents
- **deleted**: specifies if the annotation is deleted or not
- **ownership**: specifies the ownership of the annotation. It contains the following 2 fields: 
    - **type**: it can be **WS** or **ITEM**
    - **identifier**: the item identifier
- **item\_classifier**: it can be **ACCOUNTANT** or **COMPANY**
- **inserted\_by**: the name of the creator of the annotation
- **inserted\_at**: the timestamp of the annotation creation
- **modified\_at**: the timestamp of the last edit of the annotation

##### On error response

In the event of an error, the **API** responds with a body **JSON** with the following format:

```JSON
{
  "code": "string",
  "timestamp": "2022-10-28T13:01:00.754Z",
  "message": "string",
  "subErrors": [
    {}
  ]
}
```

- **code**: A string representation of the HTTP error code, linked with the returned http error
- **timestamp**: Date and time of the answer, expressed as a string.
- **message**: Message expressing error.

Possible errors are:

- **400**: The request is malformed (parameters with incorrect format, invalid or inconsistent parameters).
- **401**: An authorization token has not been provided or the authorization token provided is invalid (eg: it has expired).
- **403**: The provided token is valid, but the user is not authorized to perform the operation.
- **404**: No annotation found with the given id
- **500**: An unexpected error occurred.