POST Note by context, contextId, context1, context1Id
Overview
Request
POST /[context]/[contextId]/[context1]/[context1Id]/Note
Request Information
Request Parameters
Name
Type
Requirement
Description
context
String
Mandatory
Trip
context1
String
Mandatory
Customer
context1Id
Integer
Mandatory
ID of the customer
contextId
Integer
Mandatory
ID of the trip
noteType
String
Mandatory
Supported note types • Leader (Valid for: POST Note by context, contextId, context1, context1Id) • Booking (Valid for: POST Note by context, contextId) • Web (Valid for: POST Note by context, contextId)
text
String
Mandatory
Note text
Request Example
{
"noteType": "Leader",
"text": "test note"
}Response Information
Response Properties
Name
Type
Description
id
Integer
ID of the resource
href
String
URI of the resource
Response Codes
HTTP status code
Description
200 OK
The resource was updated successfully
201 Created
The resource was created
400 Bad Request
The resource was malformed
401 Unauthorized
Missing or invalid API key
500 Internal Server Error
An unexpected error occurred on the API server
202 Accepted
The request was accepted
404 Not Found
The specified resource was not found
403 Forbidden
One or more parameters has already been set on the resource record and cannot be updated
Response Example
{
"id": 887124,
"href": "context/contextid/context1/context1id/note/887124"
}