Error
objectDetails of an error or issue.
The code used for the issue.
Example:resource.issue_type
A detailed message.
Example:The issue happened because something is wrong.
The property to which the issue is associated.
Example:person
Additional properties related to the issue.
Example:{"firstName":"D0nn@","lastName":"Sm!th"}
Errors
objectAn error occurred, and the request could not be completed.
Details of an error or issue.
Show Child Parameters
PhoneResponse
objectDetails of a customer’s phone number.
The phone number of the contact.
Example:949-555-1323
The type of phone number (e.g., BILLING, LISTING, LOCAL).
Example:LOCAL
The phone number extension.
Example:303
Additional notes about the phone number.
Example:Primary contact number
UserCollection
objectA paginated collection of users.
The URL used to query the current collection of the resource.
Example:https://membership-api.centraldispatch.com/users/mine?limit(5,1)
A user record.
Show Child Parameters
The maximum number of items to be returned in the response.
Example:1
The URL to the next page of the collection, if available.
Example:https://membership-api.centraldispatch.com/users/mine?limit(6,1)
The URL to the previous page of the collection, if available.
Example:https://membership-api.centraldispatch.com/users/mine?limit(4,1)
The URL to the first page of the collection.
Example:https://membership-api.centraldispatch.com/users/mine?limit(1,1)
The total count of resources in the collection.
Example:23
UserResponse
objectA user record.
The fully qualified URL of the user record.
Example:https://membership-api.centraldispatch.com/users/id/d71b5750-e89b-12d3-a456-426614174000
The ID of the user.
Example:d71b5750-e89b-12d3-a456-426614174000
The first name of the user.
Example:Mickey
The last name of the user.
Example:Smith
The email address of the user.
Example:mickey@snoogle.com
The username of the user.
Example:msmith
Indicates if the user is active.
Example:true
The creation date of the user (UTC/ISO 8601).
Example:2024-10-31T00:00:00Z
The last updated date of the user (UTC/ISO 8601).
Example:2024-10-15T00:00:00Z
The phone number of the user.
Example:949-555-1323