Navigation

Extract Data

The Extract endpoint can be used to obtain a collection of available extract reports for a customer. In addition, when provided with a specific extract file name it will decrypt and send that file to the client.

Extract data structures can be found in the Appendix – XSD section.

For the specifications of any Extract files, please contact your ARCOS Representative or Support.

Supported Operations

getExtracts - GET /extracts

This method can be used to obtain a collection of available extract report files for the customer. If no extracts are configured, a 404 error response is expected. The error provided will advise that no extracts are configured

Response Payload

A collection of extract files for the customer, if extracts are enabled.

downloadExtract - GET /extracts/{extract}

This method can be used to download a specific extract. The extract in the path param should be one of the file names returned from the “Get Extracts” operation. If the file is not found, this will return a 404.

Response Payload

The client will download whichever extract they requested.

getConfig - GET /extracts/config

This method returns the current cron configuration for the production of extracts. Extracts are not available for all customers. Speak with an ARCOS Representative if you are interested in extracts.

Response Payload

A representation of the extract configuration. XML example provided below.

<schedule minute="25" hour="4" dayOfMonth="4" month="*" dayOfWeek="*"

nextRun="06/04/2021 04:25"/>

</properties>

</extractConfiguration>

updateConfig - PUT /extracts/config

This method allows adjustment of the cron configuration for the production of extracts. This method accepts the extractConfiguration data structure. Extracts are not available for all customers. Speak with an ARCOS Representative if you are interested in extracts.

Callout Data

The Callout endpoint can be used to obtain detailed data on callout history and to submit uninitiated or initiated callouts for a customer. The WADL (Web Application Description Language) provides a number of examples of requests that can be run. Some requests have multiple parameters available to them to limit the search or directly find specific callout information. Below are some examples of those requests.

Callout data structures can be found in the Appendix – XSD section.

Attribute Key Descriptions

Key	Description of the Attribute
callout id	The CoMainId for the entire Callout event including all Sub Callouts, Attempts, Sequences, Call Results, and Contacts.
callout initiate	True/False. Sending True will initiate the callout without any user interaction.
calloutType name	The name for this Callout Type. Not Required for creating callouts.
calloutType id	The typeId for this Callout Type.
callout Description	Free-form field for entry of a human-readable description for the purpose of this Callout
location name	The name of the location this Callout was created within. Not Required for creating callouts.
location id	The locationId of the location this Callout was created within.
callout workStartDate	The Datetime the work assignment will begin for this Callout offer. Cannot be in the past.
callout workEndDate	The Datetime the work assignment will end for this Callout offer. Must occur after workStartDate.
creator id	The contactId of the ARCOS user that initially created this Callout. Alternatively, you may substitute this key with “vruId” and pass that ID.
creator name	The name of the ARCOS user that initially created this Callout. Not Required for creating callouts.
callout numberRequired	The number of positions that have been requested.
callout numberFilled	The number of positions that have been filled. Not Required for creating callouts.
callout numberOfCalls	The number of devices that have been called by this Callout. Not Required for creating callouts.
callout numberOfPeopleCalled	The number of employees who have been called by this Callout. Not Required for creating callouts.
callout percentFilled	The percentage of numberRequired / numberFilled. Not Required for creating callouts.
callout percentResonse	The percentage of employees who received calls and responded with either an Accept or a Decline. Not Required for creating callouts.
callout elapsedTime	The amount of time that has elapsed since this Callout was initiated. Not Required for creating callouts.
owner id	The contactId of the ARCOS user that currently has ownership of this Callout. Alternatively, you may substitute this key with “vruId” and pass that ID.
owner name	The name of the ARCOS user that currently has ownership of this Callout. Not Required for creating callouts.
attribute value	0 or 1. Defines if an attribute should be active or inactive for this Callout. The available attributes are dependent on system configuration. Not Required.
attribute name	Possible attributes are serialcall, blastcall, etc. The available attributes are dependent on system configuration. Not Required.
overrides value	The Event Name of an included Callout Override. The available overrides are dependent on system configuration. Not Required.
overrides key	The eventId of an included Callout Override. The available overrides are dependent on system configuration. Not Required.
subCallout id	The unique ARCOS key id for each Sub Callout. Not Required for creating callouts.
subCallout quantity	The number of Employees to be included in each Sub Callout.
subCallout status	The Status id of the Sub Callout. Possible values found in the Callout Status table. Not Required for creating callouts.
subCallout statusName	The Status name of the Sub Callout. Possible values found in the Callout Status table. Not Required for creating callouts.
callResult resultName	The Result Name of the call result. Possible values found in the Event Mappings Table. Not Required for creating callouts.
callResult contact id	contactId of the result contact. Not Required for creating callouts.
callResult contact vruId	vruId of the result contact. Not Required for creating callouts.
callResult contact webId	webId of the result contact. Not Required for creating callouts.
callResult contact name	Full name of the result contact. Not Required for creating callouts.

Supported Operations

getCallouts - GET /callout

This method can be used to obtain a collection of historical callouts.

Request Parameters

Parameter	Type	Required	Valid Values	Default	Description
coMainId	Int	yes	coMainId	None	You may supply multiple coMainId by passing this parameter multiple times.
basicData	Bool	No	True, False	False	When true, return only the primitive data about a callout. (Remove callResults)
acceptsOnly	Bool	No	True, False	False	When true, only return callResults that have a final outcome of Accepted.

Response Payload

A collection of historical callout data for the customer filtered by the above parameters.

Example

<description>Sample Callout for Testing</description>

<name>Rigdon, Preston</name>

</creator>

<name>Rigdon, Preston</name>

</owner>

</attributes>

</callout>

getCallout - GET /callout/{coMainId}

This method can be used to obtain historical callout data for the target Callout Main ID ({coMainId}).

Request Parameters

Parameter	Type	Required	Valid Values	Default	Description
coMainId	Int	yes	coMainId	None
basicData	Bool	No	True, False	False	When true, return only the primitive data about a callout. (Remove callResults)
acceptsOnly	Bool	No	True, False	False	When true, only return callResults that have a final outcome of Accepted.

Response Payload

A collection of historical callout data for the Callout Main ID, {coMainId}.

Example

<description>Sample Callout for Testing</description>

<name>Rigdon, Preston</name>

</creator>

<name>Rigdon, Preston</name>

</owner>

</attributes>

</callout>

createCallout - POST /callout

This method can be used to submit, modify, and initiate callouts in the customer system.

Request Payload

Example XML, ignore & remove comments preceded with “//” (pink text listed above the xml line to clarify the data being processed)

<callout id="0" initiate="true"> // Start the Callout immediately?

<calloutType name="Normal"/> // ARCOS Callout Type ID. Example: Emergency

<description>Sample Callout for Testing</description>

<location name="McLeod OpCenter"/> // ARCOS Location ID. Example: McLeod OpCenter

<troubleLoc/> // Optional, Trouble Location Vox ID

<creator id="3742"/> // User Contact ID (3742 is an Example)

<attribute name="serialcall" value="1"/> // Attribute Name (serialcall)

<attributes name="blastcall" value="1"/> // Value (0 = Off, 1 = On)

<overrides> // Providing any Override enables that Override.

<overide value="Vacation" key="1017"/> // Override Name (Vacation) Override Key ID (1017)

</overrides>

<subCallouts> // Add specification to a callout such as location, quantity or working class.

<subCallout quantity="1"> // Number of Responders requested for Callout

<location name="McLeod OpCenter"/> // ARCOS Location ID. Example: McLeod OpCenter

<classification name="Sample Test"/> // Roster Name/ID or Job Classification within the location that you wanting to call

</subCallout>

</subCallouts>

</callout>

Response Payload:

OpStatus response advising if the callout is saved successfully or if errors with the Request Payload are present. In the event the callout is saved successfully, the “id” returned is the CoMain ID. Upon successfully creating or modifying a callout the “code” returned will be “1”. Any code returned other than 1 indicates an error with the Request Payload.

Example

updateCallout – PUT /callout/{id}

This method has the same behavior as the createCallout method and is included to support REST Architecture standards.

getAllAttributes - GET /callout/allAttributes

This method can be used to retrieve a collection of all available Callout Attributes.

No parameters are available for this call.

Response Payload

A collection of all available callout attributes. Note, not all attributes displayed may be visible or configured in the customer instance.

<calloutAttribute id="1002" name="blastcall" attributeType="Callout" description="Blast Call"

fullDescription="During a callout, instead of calling an employee's devices one at a time, Blast Calling calls all of an employee's devices simultaneously. ARCOS still calls employees in the proper order according to business rules.Related Security Features: 121 - Callout - Blast Callout Option, 91 - SIREN - Blast Callout Option, 403 - Mobile - Callout Blast Callout Option, 407 - Mobile - Notification Blast Callout Option."

activeDescription="An Active Input of 1 makes the Blast Calling checkbox visible. Setting the Active Input to 2 enables the 'enhanced-killer' functionality. The enhanced killer functionality will terminate all active calls to other devices for this employee when a final result is recorded from a device, with a roughly 10 second delay from when the final result is received."

valueDescription="Setting this value to 1 will default the Blast Call attribute to checked."/>

getCalloutTypes - GET /callout/types

This method can be used to retrieve a collection of all available Callout Types. The callout type ID(s) will be needed when posting a callout that is generated through the API.

Response Payload

A collection of all available callout types for the customer. Note, not all types displayed may be visible in the customer instance.

Example

</attributes>

</override>

</overrides>

</calloutType>

getCalloutType - GET /callout/types/{id}

This method can be used to retrieve a collection of Callout Type data for the target Callout Type ID ({id}).

Response Payload

A collection of all attributes, templates, and recordings associated with the target Callout Type ID, {id}.

Sample Response -

calloutType id="1235" name="System Outage Staffing" displayOrder="115">

</attributes>

</override>

</overrides>

</calloutType>

getCalloutResultsMultiples - GET /callout/results

This method can be used to retrieve a collection of callout results for a specified Callout Main ID. The Callout Main ID is provided as a URI attribute, CoMainId.

Example URI

https://qa.rostermonster.com/arcos/rest/callout/results?coMainId=1466

Response Payload

A collection of historical response data for the target CoMainId.

</calloutResults>

getCalloutResults - GET /callout/results/{coMainId}

This method can be used to retrieve a collection of callout results for a specified Callout Main ID, {coMainId}.

Response Payload

A collection of historical response data for the target {coMainId}.

<description>Normal callout created for testing purposes only</description>

<name>George, Andrew</name>

</creator>

<name>Davis, Carson</name>

</owner>

</attributes>

</overrides>

</callout>

getCallDetails - GET /callout/callDetails/{callId}

This method can be used to retrieve details on a specific device notification event, such as a phone call. The target Call is provided as {callId}.

Example URI

https://qa.rostermonster.com/arcos/rest/callout/callDetails/1466

Response Payload

A callDetail element containing the details of the target Call, {callId}.

Example

<type>VRU-Inbound</type>

<host>qa-fsw-nvaaws-a02 : bandwidth1</host>

<recordingFound>false</recordingFound>

<failed>false</failed>

<recordingURL>https://[...]/arcos/rest/callout/callDetails?co_call_id=1466/download

</recordingURL>

</digitsList>

<cloudStorageInfo>s3|us-east-1|qas3env|/services/co_call/1466.ulaw|c193cb2c1c700344e4fd54b2821daa380907314960b78f2cf0475d4ae3676e1c</cloudStorageInfo>

</cloudStorage>

</callDetail>

downloadRecording - GET /callout/callDetails/{callId}/download

This method can be used to retrieve a WAV file recording of the target call, {callId}.

Example URI

https://qa.rostermonster.com/arcos/rest/callout/callDetails/callId/download?wav=1

If the client platform does not support the process of downloading .wav files, this URI can be processed through your browser while logged into ARCOS.

Response Payload

A WAV format recording of the phone call that took place under the target Call ID, {callId}.

getCalloutReasons - GET /callout/reasons

This method can be used to retrieve a collection of all available Callout Reasons.

Response Payload

A collection of all available callout reasons for the customer. Note, not all reasons displayed may be active configured in the customer instance.

Example

[...]

</reasons>

searchCallouts - GET /callout/search

This method provides several URI attributes to search for a specific callout and return data on any callouts found in the search.

Request Parameters

Parameter	Type	Required	Valid Values	Default	Description
start	Datetime	yes	Datetime	none	Records returned will have started or ended at or after this date.
end	Datetime	yes	Datetime	none	Records returned will have started or ended up to and including this time.
locations		no
classes		no
calloutTypes	List	no	numbers	none	Limit the data returned but the calloutType id.
searchMode	int	no
includeOpen	int	no

Response Payload

A collection of Callouts and all associated callout data for any callouts found matching the URI search parameters.

Example

</subCallouts>

</calloutSearchResult>

</calloutSearchResults>

getDetailCalloutResults - GET /callout/search/detailResults

This method provides several URI attributes to search for a specific callout and return extended data on any callouts found in the search. This method supports pagination through the use of the ‘page’ parameter, ‘X-Arcos-Page’ header, and ‘X-Arcos-Total-Pages’ header.

If the response payload could contain over 5000 callout records, the use of pagination is required or the request may fail with an error that the response contains over 5000 records and pagination is required.

Request Parameters

Parameter	Type	Required	Valid Values	Default	Description
start	Datetime	yes	Datetime	none	Records returned will have started or ended at or after this date.
end	Datetime	yes	Datetime	none	Records returned will have started or ended up to and including this time. The endTime
locations	int	no	0, 1	0	Show Crew and Member Assignments.
classes	int	no	Number of whole hours	36	Number of hours before and after PIT to search for Member Schedule Records.
calloutTypes	int	no	numbers	none	Limit the data returned but the calloutType id.
searchMode	int	no
includeOpen	int	no
onlyOpen	int	no
basicData	query	no
acceptsOnly	query	no
page	int	No, unless number of records exceeds 5000	Number of page	none	Enables and controls pagination. Value is the number of page requested

Response Payload

A collection of Callouts and all associated and extended callout data for any callouts found matching the URI search parameters. An example of the data returned by this method is too large to provide in this document. For the data specification, please see the Appendix – XML Schema Definitions (XSD) section of this manual.

getActivations - GET /callout/activations

This method can be used to retrieve a collection of all available pre-configured Callout Activations. Callout Activations can be initiated with the initiate method.

Request Parameters

Parameter	Type	Required	Valid Values	Default	Description
likeAct	Int	No	acivationId	None	If Activation ID is provided here, return any other Activations that occurred in the same location for the same callout type.
locations	List	No	List of locationId	None	Return only activations that exist in these locations.
level	List	No	1 - 5	None	Return only activations that match these levels.
type	String	No	calloutType name	None	Return only activations that contain a callout of this type.

Response Payload

A collection of Callout Activations that have been created in the customer instance.

Example

</calloutActivation>

</calloutActivations>

getConfiguredClasses - GET /callout/configuredClasses

This method can be used to retrieve a collection of “Classes” for callout purposes. This includes configured roster Primary Class Groups and Workgroup Rosters.

Request Parameters

Parameter	Type	Required	Valid Values	Default	Description
locationId	Int	Yes	locationId	None	If provided, then only supply Classifications present in this location.
getDisabled	Bool	No	0, 1	0	If 1 then also supply Disabled Classifications.
primaryOnly	Bool	No	0, 1	0	If 1 then only supply Primary Classifications.

Response Payload

A collection of available callout classes for the customer.

Example

</coLookup>

</coLookup>

</coLookup>

</coLookups>

getAttributes - GET /callout/attributes

This method can be used to retrieve a collection of all available Callout Attributes for the customer.

Request Parameters

Parameter	Type	Required	Valid Values	Default	Description
attributeType	int	No	0,1,2,3,4	0	Display only Attributes of the provided type.

Response Payload

A collection of all available callout attributes for the customer. Note, not all attributes displayed may be active configured in the customer instance.

Example

</calloutAttributes>

initiateCallout - POST /callout/{coMainId}/initiate

This method can be used to initiate an already existing callout matching {coMainId} that is ready for initiation.

Response Payload

applyAction – POST /callout/applyAction

This method can be used to apply various actions to an existing Callout. This includes Sub Callout list “Rollover” actions and stopping an “Active” or “Waiting” callout events.

Request Actions Parameters

Parameter	Type	Required	Valid Values	Default	Description
coMainId	int	Yes		null	The key identifier for the entire Callout event including all Sub Callouts, Attempts, Sequences, Call Results, and Contacts.
note	String
coId	int
status	String				Update the status of current callout listed by the coMainId
Quantity	int
rollLoc	String
rollLocId	int
rollClass	String
rollClassId	int

Request Payload Example

https://qa.rostermonster.com/arcos/rest/callout/applyAction?status=Stop&coMainId=303775

Response Payload

getCalloutTypeLocations – GET /callout/types/{id}/locations

This method returns a collection of <attribute> elements representing the locations this callout type is available to be used within the customer schema.

Two attributes are provided:

Attribute	Datatype	Description
name	String	The long form name of the location as visible throughout the ARCOS platform.
value	Int	The internal ARCOS ID (locationId) for the provided location.

Response Payload

Collection of attributes.

Example

</attributes>

getCalloutStats – GET /callout/stats

This method provides Key Performance Indicator statistics for the provided coMainId(s) and/or ticketId(s).

Request Parameters

Parameter	Type	Required	Valid Values	Default	Description
coMainId	Int	Yes (If no ticketId)	coMainId	None	You may provide multiple coMainId’s by passing this parameter multiple times.
ticketId	Int	Yes (If no coMainId)	ticketId	None	You may provide multiple ticketId’s by passing this parameter multiple times.

Response Payload

Collection of calloutStats.

Example

</calloutStat>

</calloutStats>

updateCalloutStats – POST /callout/stats

This method is published in our Web Application Description language (WADL) but not yet described here. If you require additional information on this method, please speak with an ARCOS Representative.

sMART Data

The smart endpoint can be used to obtain real-time automatic vehicle localization (AVL) data from ARCOS sMART applications associated with the target instance.

getCurrentAVL – GET /smart/getCurrentAVL

This method provides automatic vehicle localization (AVL) data from ARCOS sMART applications associated with the target instance. This method does not support any additional request parameters.

Response Payload Example

Collection of currentAvl.

<currentAvl

xmlns="http://samsix.com/cust/smart/Smart.ext">

<entry>

<signal_sequence>2</signal_sequence>

<status>stopped</status>

<userid>Android04-16@gmail.com</userid>

<platform>Android</platform>

<fullname>Android 4-16</fullname>

<destination>The Ohio Statehouse</destination>

<fuel>Gasoline & Diesel</fuel>

<eta/>

<end_dist>2</end_dist>

<application>rsales</application>

</entry>

</currentAvl>

currentAvl Entry Definition

{

vehicleid : int

signaltime : xsd:dateTime speed : int

heading : int signal_sequence : int status : string

userid : string

storm : string platform : string

platformversion : string lastlogin : xsd:dateTime company : string

fullname : string

cell : string destination : string workers : int numvehicles : int

fuel : string

drivetime : int

eta : string

end_dist : int application : string crewtype : string longitude : float latitude : float

}

currentAvl Entry Attribute Table

Note that Type, Min Length, and Max Length may change for any attribute during future releases of ARCOS; Such changes will be identified in our C.L.I.

Min Length and Max Length provided are the ARCOS software limitations. See Description for additional detail on typical anticipated value ranges.

Attribute	Type	Min Length	Max Length	Description
vehicleid	Int	1	2,147,483,647	The unique numeric ARCOS assigned ID for this Entry ‘Vehicle’. The length of this value depends heavily on customer utilization of a particular instance. The value could reasonably be expected to remain between 1000 – 10000000.
signaltime	Datetime	N/A	N/A	The Datetime the last signal was received from this Entry. YYYY-MM-DDThh:mm:ss+hh:mm where ‘+’ could also be ‘-‘. See ISO-8601.
speed	Int	1	N/A	The speed of the entry as calculated by sMART. Defaults to ‘0’. ARCOS does not constrain the maximum value provided and it’s typically expected to be between 0 – 220.
heading	Int	NULL	N/A	If the heading is not available, no value will be provided. The heading of the vehicle as provided by the sMART Mobile application. ARCOS does not constrain the maximum value provided and it’s typically expected to be between 0 – 360.
signal_sequence	Int	N/A	N/A	The numeric sequence position used by ARCOS to define the bread crumb trail, mapping to the location values in the order of signal_sequence value received. ARCOS does not constrain the maximum value length provided and it’s typically expected to be between 1 – 25000.
status	String	N/A	N/A	The movement status of this vehicle. Possible values are ‘stopped’ or ‘moving’. ARCOS does not constrain the maximum value length provided and it’s typically expected to be between 6 - 7 alpha characters.
userid	String	N/A	N/A	The email address of the user logged into the sMART Mobile Application. ARCOS does not constrain the maximum value length provided and it’s typically expected to be between 12 - 50 alphanumeric characters including ‘@’ and ‘.’.
storm	String	N/A	N/A	The name of the storm this vehicle is associated with. (Description of sMART Code) ARCOS does not constrain the maximum value length provided and it may be unexpectedly long depending on user input during storm creation. Recommended customers typically anticipate between 1 – 255 alphanumeric characters.
platform	String	N/A	N/A	The type of device being used by the vehicle. Possible values are ‘iOS’ or ‘Android’. ARCOS does not constrain the maximum value length provided and it’s typically expected to be between 3 - 7 alpha characters.
platformversion	String	N/A	N/A	The Operating System version number of the device being used by the vehicle. ARCOS does not constrain the maximum value length provided and it’s typically expected to be between 1 - 8 alphanumeric characters. Such as: ’13.3’, ’14.4’, ‘9’, ’13.3.1’, etc.
lastlogin	Datetime	N/A	N/A	The Datetime the last login from this Entry occurred. YYYY-MM-DDThh:mm:ss+hh:mm where ‘+’ could also be ‘-‘. See ISO-8601.
company	String	N/A	N/A	The name of the company this vehicle is associated with. ARCOS does not constrain the maximum value length provided and it may be unexpectedly long depending on user input during storm creation. Recommended customers typically anticipate between 1 – 255 alphanumeric characters.
fullname	String	N/A	N/A	The Full Name of the individual logged in as this vehicle. ARCOS does not constrain the maximum value length provided and it may be unexpectedly long depending on user input during mobile device event registration creation. Recommended customers typically anticipate between 1 – 255 alphanumeric characters.
cell	String	12	12	The Cell Phone Number of the individual logged in as this vehicle. Must be provided by a mobile user during event registration and will always be 12 characters in length, including two ‘-‘. I.e. XXX-XXX-XXXX
destination	String	N/A	N/A	The name of the destination this vehicle is associated with. (‘Name’ of ‘Location’) ARCOS does not constrain the maximum value length provided and it may be unexpectedly long depending on user input during destination creation. Recommended customers typically anticipate between 1 – 255 alphanumeric characters.
workers	Int	N/A	N/A	The numeric number of workers reported as part of the entry during mobile user event registration. ARCOS does not constrain the maximum value length provided and it may be unexpectedly long depending on user input during event registration. Typical values are between 1 – 1000.
numvehicles	Int	1	N/A	The numeric number of vehicles reported as part of the entry during mobile user event registration. ARCOS does not constrain the maximum value length provided and it may be unexpectedly long depending on user input during event registration. Typical values are between 1 – 1000.
fuel	String	N/A	N/A	The type of fuel required by the vehicles in this entry. "Gasoline", "Gasoline & Diesel", and "Diesel" are the only currently supported values. Note the API will conduct HTML Code Formatting on values and as such ‘&’ will be seen as ‘&’. See the HTML Charset.
drivetime	Int	N/A	N/A	The numeric number of hours reported as available for driving per each day as part of the entry during mobile user event registration. ARCOS does not constrain the maximum value length provided and it may be unexpectedly long depending on user input during event registration. Typical values are between 1 – 16.
eta	String	1	N/A	The number of hours estimated for vehicle arrival at destination. May be ‘_’ when unknown or a numeric value typically between 0 – 168. ARCOS does not constrain the maximum value length provided.
end_dist	Int	N/A	N/A	The number of miles between the last known location ping of this vehicle entry and the target destination address. ARCOS does not constrain the maximum value length provided. Typically values will be between 0 – 1000.
application	String	N/A	N/A	The schema name, or company name, of the target system the application is authenticated against. ARCOS does not constrain the maximum value length provided, but these values are configured by ARCOS during initial system creation. Typically, values are alphanumeric and between 3 – 7 in length.
crewtype	String	NULL	N/A	This value is optional and may not be included in every Entry. ARCOS does not constrain the maximum value length provided and it’s typically expected to be between 0 – 360 characters.
longitude	Float	17	19	Current longitude location of the vehicle as calculated by the sMART Mobile Application. The Longitude displayed contains 14 decimal places of precision. May also be cast as DECIMAL(16,14), for example. Consider casting the longitude and latitude into a Point, where supported.
latitude	Float	17	19	Current latitude location of the vehicle as calculated by the sMART Mobile Application. The latitude displayed contains 15 decimal places of precision. May also be cast as DECIMAL(17,15), for example. Consider casting the longitude and latitude into a Point, where supported.

Articles in this section

ARCOS API Documentation - Extracts, Callout, sMART

Navigation

Contents:

Extract Data

Supported Operations

getExtracts - GET /extracts

downloadExtract - GET /extracts/{extract}

getConfig - GET /extracts/config

updateConfig - PUT /extracts/config

Callout Data

Supported Operations

getCallouts - GET /callout

getCallout - GET /callout/{coMainId}

createCallout - POST /callout

updateCallout – PUT /callout/{id}

getAllAttributes - GET /callout/allAttributes

getCalloutTypes - GET /callout/types

getCalloutType - GET /callout/types/{id}

getCalloutResultsMultiples - GET /callout/results

getCalloutResults - GET /callout/results/{coMainId}

getCallDetails - GET /callout/callDetails/{callId}

downloadRecording - GET /callout/callDetails/{callId}/download

getCalloutReasons - GET /callout/reasons

searchCallouts - GET /callout/search

getDetailCalloutResults - GET /callout/search/detailResults

getActivations - GET /callout/activations

getConfiguredClasses - GET /callout/configuredClasses

getAttributes - GET /callout/attributes

initiateCallout - POST /callout/{coMainId}/initiate

applyAction – POST /callout/applyAction

getCalloutTypeLocations – GET /callout/types/{id}/locations

getCalloutStats – GET /callout/stats

updateCalloutStats – POST /callout/stats

sMART Data

getCurrentAVL – GET /smart/getCurrentAVL

Comments

Articles in this section

Navigation

Contents:

Extract Data

Supported Operations

getExtracts - GET /extracts

downloadExtract - GET /extracts/{extract}

getConfig - GET /extracts/config

updateConfig - PUT /extracts/config

Callout Data

Supported Operations

getCallouts - GET /callout

getCallout - GET /callout/{coMainId}

createCallout - POST /callout

updateCallout – PUT /callout/{id}

getAllAttributes - GET /callout/allAttributes

getCalloutTypes - GET /callout/types

getCalloutType - GET /callout/types/{id}

getCalloutResultsMultiples - GET /callout/results

getCalloutResults - GET /callout/results/{coMainId}

getCallDetails - GET /callout/callDetails/{callId}

downloadRecording - GET /callout/callDetails/{callId}/download

getCalloutReasons - GET /callout/reasons

searchCallouts - GET /callout/search

getDetailCalloutResults - GET /callout/search/detailResults

getActivations - GET /callout/activations

getConfiguredClasses - GET /callout/configuredClasses

getAttributes - GET /callout/attributes

initiateCallout - POST /callout/{coMainId}/initiate

applyAction – POST /callout/applyAction

getCalloutTypeLocations – GET /callout/types/{id}/locations

getCalloutStats – GET /callout/stats

updateCalloutStats – POST /callout/stats

sMART Data

getCurrentAVL – GET /smart/getCurrentAVL

Related articles