Membership API

CustomerSearchResponse

object

A customer record.

customerNamestring

The customer’s name.

Example:Acu Logistics

customerIdstring

The Central Dispatch customer ID of the customer.

Example:d5c62b14-cbd1-11ee-9a0e-0242ac110002

emailstring

The email address of the customer.

Example:trans-port@notgmail.com

phoneNumbersarray[object]

Details of a customer’s phone number.

Show Child Parameters
addressesarray[object]

Details of a customer’s address.

Show Child Parameters
customerAuthorityNumbersarray[object]

Details of a customer’s authority number.

Show Child Parameters
Example

Error

object

Details of an error or issue.

codestring

The code used for the issue.

Example:resource.issue_type

descriptionstring

A detailed message.

Example:The issue happened because something is wrong.

propertystring

The property to which the issue is associated.

Example:person

propertiesobject

Additional properties related to the issue.

Example:{"firstName":"D0nn@","lastName":"Sm!th"}

Example

Errors

object

An error occurred, and the request could not be completed.

errorsarray[object]

Details of an error or issue.

Show Child Parameters
Example

PhoneResponse

object

Details of a customer’s phone number.

phoneNumberstring

The phone number of the contact.

Example:949-555-1323

typestring

The type of phone number (e.g., BILLING, LISTING, LOCAL).

Example:LOCAL

extensionstring

The phone number extension.

Example:303

notesstring

Additional notes about the phone number.

Example:Primary contact number

Example

UserCollection

object

A paginated collection of users.

hrefstring

The URL used to query the current collection of the resource.

Example:https://membership-api.centraldispatch.com/users/mine?limit(5,1)

itemsarray[object]

A user record.

Show Child Parameters
limitinteger(int32)

The maximum number of items to be returned in the response.

Example:1

nextstring

The URL to the next page of the collection, if available.

Example:https://membership-api.centraldispatch.com/users/mine?limit(6,1)

previousstring

The URL to the previous page of the collection, if available.

Example:https://membership-api.centraldispatch.com/users/mine?limit(4,1)

firststring

The URL to the first page of the collection.

Example:https://membership-api.centraldispatch.com/users/mine?limit(1,1)

countinteger(int32)

The total count of resources in the collection.

Example:23

Example