RoscoLive API v1.0

Add event label

POST/event/{event_id}/label

Adds a label to the event_label value for an event. If viewing the event within RoscoLive, this value will be displayed instead of the event_display_type value. This is useful for event sub-categorization or flagging the end user finds valuable.

User Role Permissions

The following table shows which user roles are allowed to send requests using this API endpoint.

User Role	Allowed
Partner
Partner View
Custom Partner	Requires permissions to be enabled
Fleet Manager
Group Manager
User
Custom User	Requires permissions to be enabled

Request

Path Params

event_id

integer

required

ID of event to add label value

Example:

1234567

Body Params multipart/form-data

event_label

string

required

Label text to add to event. Pass an empty value to remove event label

<= 20 characters

Example:

lorem ipsum dolores

Request samples

Responses

Success(200)

Record Not Found(404)

HTTP Code: 200

Content Type : JSONapplication/json

meta

object

required

Request metadata object

code

integer

required

HTTP status code returned by response

>= 100<= 599

response

string

required

Contains response data

result

enum<string>

required

"OK" if successful, else "Fail" if error

Allowed values:

OKFailed

{
  "meta": {
    "code": 200
  },
  "response": "success",
  "result": "OK"
}

Last modified: 11 days ago