Retrieve a Route.

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

Returns the Routes or null if no Routes for the given Id was found.

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.

name

string

required

The Route Name. Maxlength:64 characters

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 Route. Max Length = 32 characters

category

string

Category of the Route. Max Length = 32 characters

description

string

The Route Description. Maxlength:255 characters

status

string

required

Defaults to 'Enabled'

Enabled Disabled Suspended Deleted Pending_Delete

createdOn

date

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

inheritable

boolean

Defaults to false.

true

deletionDate

date

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

polyline

string

Polyline of the Route. Max Length = 32 characters

lineBuffer

int32

LineBuffer is the distance to either side of PolyLine that vehicle is allowed to deviate and still be considered on route. Units: Meters, Range: 0 - 32,000

activationDate

date

yyyy-MM-dd'T'HH:mm:ss.SSSZ. Last time this route 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.

400

Invalid request.

403

Not authorized for this operation.

404

Not found.

417

Link expansion could not be completed.

500

Server error

Language

Credentials


xxxxxxxxxx
1
curl --request GET \
2
     --url https://qa.connect.calamp.com/connect/services/routes/id \
3
     --header 'accept: */*'

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

*/*

200successful operation