Get an internal note - Trans.eu Api

An internal note added to a freight can be downloaded at any time.

The freight-id identification number in method call can be taken from response after creating the freight or by downloading the freight list.

GET
/ext/freights-api/v1/freights/{freight-id}/internal-note

Request Authorization

Every request MUST include a valid access token obtained during the user authorization process, provided using the Bearer token scheme in the Authorization header.

Request Header

GET /ext/freights-api/v1/freights/{freight-id}/internal-note HTTP/1.1 
Host: api.platform.trans.eu 
Content-Type: application/json
Accept: application/json
Authorization: Bearer {access_token) 
Api-key: {unique_app_api-key}

Response Fields

Attribute	Type	Example	Description
contents	String	“Memory note”	Content of the internal note

Example Response Body

{ 
"contents": "Memory note" 
}

Client errors (code 400)

HTTP 4xx status codes indicate client errors, meaning that the request could not be processed due to an issue on the client side. Below is a list of request-specific errors.

Example error 1

Internal note does not exists

{
    "detail": "Freight (id: 3772908) does not have any internal note",
    "status": 404,
    "title": "Not Found",
    "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}

Example error 2

Incorrect freight id

{
    "detail": "Freight 1234 not found or not accessible",
    "status": 404,
    "title": "Not Found",
    "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}