Update an internal note

An internal note added to a freight can be modified at any time. The note cannot be longer than 500 characters and only one note can be added to the freight.

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

PUT
/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

PUT /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}

Request Parameters

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

Example Request Body

{ 
"contents": "Memory note" 
}

Response Fields

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

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

Length of content is too long

{
    "detail": "Failed Validation",
    "status": 422,
    "title": "Unprocessable Entity",
    "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html",
    "validation_messages": {
        "contents": {
            "stringLengthTooLong": "The input is more than 500 characters long"
        }
    }
}

Example error 2

Internal note does not exists

{
    "detail": "Internal note for this freight does not exist",
    "status": 422,
    "title": "Unprocessable Entity",
    "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}

Example error 3

Empty value

{
    "detail": "Failed Validation",
    "status": 422,
    "title": "Unprocessable Entity",
    "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html",
    "validation_messages": {
        "contents": {
            "isEmpty": "Value is required and can't be empty"
        }
    }
}