Search
K
Event API

EmptyResponse

object

No response.

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

EventTypeCollection

object

Details of the event types.

hrefstringrequired

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

Example:https://event-api.centraldispatch.com/event-types

countinteger(int32)required

The total count of resources in the collection.

Example:1

itemsarray[object]required

Details of an event type.

Show Child Parameters
Example

EventTypeResponse

object

Details of an event type.

eventTypestring

The type of the event.

Example:DispatchCreated

descriptionstring

The description of the event type.

Example:A dispatch has been created

Example