API Reference

Create Note

Use to create a note for a waypoint.

❗️

File Size Limit of 1 MB

When creating notes, especially when they are images, please note that there is a 1 MB file size limit.
Make sure to compress your images accordingly.
Remember, these are for the driver to see on their phone, so they shouldn't be of a large size.

OUTPUT PARAMS

success

boolean

Indicates whether the service completed successfully.

  • false - the service failed.
  • true - the service succeeded.

rc

Int32

If an error occurred, the return code.

message

string

If an error occurred, a message indicating the error.

created_at

datetime

The date and time this note was created. This is in UTC and is in the format is " %Y-%m-%dT%H:%M:%S%z".

customer_id

Int32

The Id of the customer with which this note is associated.

lat

double

The geoposition latitude of the user (driver) when the task note was added.

lng

double

The geoposition longitutde of the user (driver) when the task note was added.

pending_upload

boolean

Indicates whether the note is pending upload (or was already uploaded). A note may be pending upload due to the size of the note or system latency.

  • false or 0 - the note is not pending upload
  • true or 1 - the note is pending upload

task_id

Int32

Bringg order Id.

type

string

The type of task note. The values include:

  • TaskNote (text) This is the default. You don't need to explicitly specify it.
  • Form
  • HtmlTaskNote
  • Signature
  • TaskPhoto

happened_at

datetime

The date and time when this note was added to the order (by API or in the Bringg Driver App. You can enter this in epoch time (number of milliseconds since 1.1.1970) or in datetime format (UTC in the format " %Y-%m-%dT%H:%M:%S%z".

updated_at

datetime

The date and time of the last update for this note. This is in UTC and is in the format is " %Y-%m-%dT%H:%M:%S%z".

url

text

URL added to this note.
FOR IMAGE UPLOADS: Put the base64 code here (see example above)

user_id

Int32

The Id of the user (driver).

way_point_id

Int32

The Id of the way point with which this note is associated.

Language