Retrieve an Account by id.

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

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

int64

MUST be provided in the object, in request body, for PUT requests. MUST NOT be provided in the object in request body for POST requests. Will result in an HTTP - 400 Bad Request response if provided in POST requests.

name

string

required

Name of the account. Max Length = 64 characters

status

string

required

Defaults to 'Enabled'

Enabled Disabled Suspended Deleted Pending_Delete

parent

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

activatedOn

date-time

yyyy-MM-dd'T'HH:mm:ss.SSSZ. When this account was activated.

addresses

array of objects

List of addresses for the Account.

addresses

object

country

string

Name of the country. Max length = 64 characters

block

string

subdistrict

string

subblock

string

houseNumber

string

street2

string

The street2 address. Max length = 128 characters

city

string

required

Required along with StateProvinceCd if a Zip is not provided. Max length = 64 characters

stateProvince

string

Name of the state/province. Max length = 64 characters

countryCd

string

The international country code. If not specified, default 'US' is used. Max length = 3 characters

zip

string

required

Either this field or the City+State fields should be provided for a valid address. Max length = 10 characters

street

string

The street address, including house number. Max length = 128 characters

district

string

stateProvinceCd

string

Required along with City if a Zip is not provided. Max Length = 8 characters.

addressType

string

required

BILLING MAILING SHIPPING

ancestors

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

applications

array of objects

List of application links associated to this account

applications

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

autoAssetAssociationEnabled

boolean

Controls whether automatic asset-device association, on receipt of a vehicle discovery message from the device, is allowed for devices belonging to this account. Defaults to true.

true

autoAssetCreationEnabled

boolean

Controls whether automatic asset creation, on receipt of a vehicle discovery message from the device, is allowed for devices belonging to this account. If this is set to true, it supercedes the value set for 'isAutoAssetAssociationEnabled'. Defaults to true.

true

canViewAirtimeStore

boolean

Defaults to false. Deprecated, not used anymore.

true

canViewHardwareStore

boolean

Defaults to false. Deprecated, not used anymore.

true

canViewSubAccounts

boolean

Defaults to true.

true

checkPulsDeviceOwnership

boolean

Flag for puls ownership check for icn enabled devices. If not specified then parent account's flag value will be taken.

true

createAssetOnFirstMessage

boolean

Defaults to false.

true

createdOn

date-time

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

creditTerms

string

Defaults to 'COD'

COD CreditCard OpenLine

customerProfile

object

Represents a customer profile

partnerLogoUrl

string

Partner brand logo URL of the customer profile

partnerUrl

string

Partner URL of the customer profile

partnerBrand

string

Defaults to Calamp

relativeSize

string

Small(6-50) Medium(51-200) Large(201-2000) National(2001-10000) Global(10001-*) MomAndPop(1-5)

deletedOn

date-time

yyyy-MM-dd'T'HH:mm:ss.SSSZ. When this account was deleted

description

string

Description of the account. Max Length = 255 characters

enterprise

boolean

required

Indicates if this is an enterprise level account. Defaults to false.

true

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.

externalRefID

string

External reference id of this account. Most generally used for correlating the CTC identifier to an external system's identifier for this account. Max length = 64 characters.

geoMapper

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

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

hardwareDiscount

float

Defaults to 0.0

labels

array of strings

A Set of strings denoting the labels to be associated with the account.

labels

language

string

The language to be configured for an account. Max Length = 8 characters. Language MUST be provided in country locale code format

lastModifiedOn

date-time

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

phoneNumbers

array of objects

List of phoneNumbers for the Account.

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

pointOfContacts

array of objects

List of contacts for this account.

pointOfContacts

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

solomonId

string

splitTagMessages

boolean

Controls whether 'TagReport' messages from devices under this account, should be split while sending to DataPump. Defaults to false.

true

ssoConfig

string

SsoConfig of the Account.

ssoMode

string

SsoMode of the Account.

STRICT LAX

subAccounts

array of objects

Links to the direct child accounts of this account. Updated when a sub account is moved out of this account's hierarchy.

subAccounts

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

subscription

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

timeZone

string

The time zone of the account. Defaults to 'UTC'. Max Length = 64 characters.Timezones MUST be provided in canonical form - '/'. See https://nodatime.org/TimeZones

unitOfMeasure

string

System of Units used by this account. Default value is configured per CTC environment.

SI US Metric Mixed Device Default Imperial

useCustomVisionSettings

boolean

True indicates a customized fleet being created for the customer, Defaults to false.

true

vehicleTestProfileValidation

boolean

Will be set to true if the customer 'Opts-in' for allowing CalAmp devices to read Vehicle PID for 'test' profiles and send telematics/CAN data to CTC for Vehicle Profile validation, Defaults to false. Calamp may issue remote commands or gather accumulator information in special messages from devices in vehicles set in the 'test' profile mode on this account when True. This is not expected to impact operation or script functionality with the devices and serves to help validate changes made.

true

version

int64

Defaults to 0

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

403

Not authorized for this operation.

404

Account not found.

417

Association expansion error

500

Server error

Language

Credentials


xxxxxxxxxx
1
curl --request GET \
2
     --url https://qa.connect.calamp.com/connect/services/accounts/id \
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