Health

A Health object represents the health of Sync resources. It contains relevant information about the current connection of Sync to the resource webpages based on the last 100 processed vehicles per resource.

The data is organized by state and resource type. Each resource type of a state has a different health status based on the resources that belong to that state and resource type.

Methods

The API supports the following methods for Health objects:

HTTP request	Description
GET resource health	Returns a collection with the current resources health per state.

Object representation

Health

{
    "state": State ,
    "resourceTypeHealth": ResourceTypeHealth[]
}

The following table defines the properties that appear in this object:

Properties	Type	Description
state	State	Indicates the state.
resourceTypeHealth	ResourceTypeHealth	A collection representing the health of the different available resource types in Sync.

ResourceTypeHealth

{
    "resourceType": ResourceType,
    "avrgTimeSpan"?: number,
    "successPercentage"?: number,
    "dateTime"?: DateTime,
    "resourceInfo"?: ResourceInfo[]
}

The following table defines the properties that appear in this object:

Properties	Type	Description
resourceType	ResourceType	Indicates the resource type.
avrgTimeSpan	number	The current average time span for processing vehicles in the resource type.
successPercentage	number	The current success percentage of processing vehicles in the resource type.
dateTime	DateTime	The date and time of the last vehicle processed in the resource type.
ResourceInfo	ResourceInfo	A collection representing the health of the different available resources in Sync.

ResourceInfo

{
    "resource": Resource,
    "avrgTimeSpan": number,
    "successPercentage": number,
    "dateTime"?: Date,
    "portal": string
}

The following table defines the properties that appear in this object:

Properties	Type	Description
resource	Resource	Indicates the resource.
avrgTimeSpan	number	The current average time span for processing vehicles in the resource.
successPercentage	number	The current success percentage of processing vehicles in the resource.
dateTime	Date	The date and time of the last vehicle processed in the resource.
portal	string	The resource portal where vehicles are processed.