Retrieve all Operators for account.

get https://qa.connect.calamp.com/connect/services/accounts/{id}/operators

Responses

Response body

object

_self

object

Represents a resource in the system

href

string

required

The URI of the resource this Link represents.

rel

string

required

Relation to the resource represented by the Link, within the context of the containing resource. While a Link represents a specific resource in the system, the 'rel' property defines the type of the association between the containing resource and the linked resource.Except for the 'self', 'first', 'last', 'next', 'prev' relations, generally it is the type of the resource at the other end of the association. E.g. 'asset', 'device', 'pegBehavior, 'role', 'primary-operator', etc.

status

string

Status of the resource represented by this Link.

Enabled Disabled Suspended Deleted Pending_Delete

title

string

Some descriptive text about the Link. Generally name of the resource represented by this Link.

associationStatus

string

Association Status of the resource this link represent with the main(top-level) resource

PENDING DISSOCIATING

source

object

Represents a resource in the system

groups

array of objects

Links to Groups to which the resource belongs.

groups

object

href

string

required

The URI of the resource this Link represents.

rel

string

required

status

string

Status of the resource represented by this Link.

Enabled Disabled Suspended Deleted Pending_Delete

title

string

Some descriptive text about the Link. Generally name of the resource represented by this Link.

associationStatus

string

Association Status of the resource this link represent with the main(top-level) resource

PENDING DISSOCIATING

source

object

Represents a resource in the system

extendedAttribute

object

Represents an Extended Attribute in the system

value

string

required

Supplemental data. The application can store any string here as meta-data for a given resource. Max size = 1MB

createdOn

date-time

yyyy-MM-dd'T'HH:mm:ss.SSSZ. When was this extendedAttribute created.

application

object

Represents a resource in the system

lastModifiedOn

date-time

yyyy-MM-dd'T'HH:mm:ss.SSSZ. When was this extendedAttribute last modified.

schedules

array of objects

Schedules to which the Operator is associated with. Read-only

schedules

object

href

string

required

The URI of the resource this Link represents.

rel

string

required

status

string

Status of the resource represented by this Link.

Enabled Disabled Suspended Deleted Pending_Delete

title

string

Some descriptive text about the Link. Generally name of the resource represented by this Link.

associationStatus

string

Association Status of the resource this link represent with the main(top-level) resource

PENDING DISSOCIATING

source

object

Represents a resource in the system

int64

Required for PUT requests with resource object in the request body. Forbidden for POST requests with resource object in the request body. Will result in an HTTP 400 - Bad Request response.

type

string

Type of the Operator. Maxlength:100 characters

operatorCategory

string

Category of the Operator. Maxlength:32 characters

description

string

Description of the operator. Max Length = 255 characters

asset

object

Represents a resource in the system

href

string

required

The URI of the resource this Link represents.

rel

string

required

status

string

Status of the resource represented by this Link.

Enabled Disabled Suspended Deleted Pending_Delete

title

string

Some descriptive text about the Link. Generally name of the resource represented by this Link.

associationStatus

string

Association Status of the resource this link represent with the main(top-level) resource

PENDING DISSOCIATING

source

object

Represents a resource in the system

createdOn

date

yyyy-MM-dd'T'HH:mm:ss.SSSZ. Generated and managed by the service. Read-only.

deletionDate

date

yyyy-MM-dd'T'HH:mm:ss.SSSZ. Last time this Device was deleted. Maintained by system based on status change. Read-only

phoneNumbers

array of objects

List of phoneNumbers for the Contact.

phoneNumbers

object

extension

string

The an extension to be dialed after main number. Max length = 6 characters

phoneNumber

string

required

Max length = 32 characters

phoneType

string

required

WORK CELL FAX TOLL_FREE

externalId

string

The ExternalId of the Operator. Useful as correlation identifier between CTC and an external system. Max Length = 64 characters.

lastName

string

required

The Operator's last name. Maxlength:32 characters

firstName

string

required

The Operator's first name. Maxlength:32 characters

association

string

Describes the way in which the association of the operator to the asset was made. Maxlength:100 characters

badgeNumber

string

Name to indicate operator employee ID, key fob button ID or other identifier. Maxlength:16 characters

activationDate

date

yyyy-MM-dd'T'HH:mm:ss.SSSZ. Last time this Device was activated. Maintained by system based on status change. Read-only

account

object

required

Represents a resource in the system

href

string

required

The URI of the resource this Link represents.

rel

string

required

status

string

Status of the resource represented by this Link.

Enabled Disabled Suspended Deleted Pending_Delete

title

string

Some descriptive text about the Link. Generally name of the resource represented by this Link.

associationStatus

string

Association Status of the resource this link represent with the main(top-level) resource

PENDING DISSOCIATING

source

object

Represents a resource in the system

lastModifiedOn

date

yyyy-MM-dd'T'HH:mm:ss.SSSZ. Generated and managed by the server. Read-only.

version

int64

Defaults to 0

Read-only. Managed by the service. Required for PUT, ignored for POST.

status

string

Status of the Operator. Default value is 'Enabled'. Maxlength:32 characters

Enabled Disabled Suspended Deleted Pending_Delete

400

Invalid request.

403

Not authorized for this operation.

404

Operator not found.

500

Server error

Language

Credentials


xxxxxxxxxx
1
curl --request GET \
2
     --url https://qa.connect.calamp.com/connect/services/accounts/id/operators \
3
     --header 'accept: application/json;charset=UTF-8'

Click Try It! to start a request and see the response here! Or choose an example:

application/json;charset=UTF-8

200successful operation