Admin at 22:15, 22 September 2020

2020-09-22T22:15:04Z

← Older revision		Revision as of 22:15, 22 September 2020
Line 21:		Line 21:
	\|Units\|\|Units		\|Units\|\|Units
	\|-		\|-
	\|~~Tranmission~~ Reference\|\|~~TranmissionReference~~		\|Transmission Reference\|\|TransmissionReference
	\|-		\|-
	\|Transmission Result\|\|TransmissionResult		\|Transmission Result\|\|TransmissionResult

Admin: Created page with "{{StreetRouteNav |InputOutputCollapse= }} {{CustomTOC}} A response is the result of a request. This consists of returned results codes and Business details. Street Route s..."

2018-08-06T18:18:50Z

Created page with "{{StreetRouteNav |InputOutputCollapse= }} {{CustomTOC}} A response is the result of a request. This consists of returned results codes and Business details. Street Route s..."

New page

{{StreetRouteNav
|InputOutputCollapse=
}}

{{CustomTOC}}

A response is the result of a request. This consists of returned results codes and Business details.

Street Route supports the JSON response protocol.

==Field Names==
This is a list of the response field names and their protocol naming conventions.

{| class="alternate01 sortable"
!Field Name !! Level !! JSON
|-
|Version||rowspan="5" valign="center"|Response||Version
|-
|Units||Units
|-
|Tranmission Reference||TranmissionReference
|-
|Transmission Result||TransmissionResult
|-
|Total Records||TotalRecords
|-
|Record ID||rowspan="4" valign="center"|Record||RecordID
|-
|Results||Results
|-
|Travel Time||TravelTime
|-
|Total Driving Distance||TotalDrivingDistance
|}

==Response Elements==
The following elements are the basic options for each request. These apply to the entire response, not the individual records.

<h3 class="productfield">Version</h3>
:This is a string value that is the current revision number of Street Route Cloud API.

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"Version":"'''''string'''''"</code>
|}

<h3 class="productfield">Units</h3>
:This is a string value that is the set unit of measurment for the '''[[#Total Driving Distance|TotalDrivingDistance]]''' field.

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"Units":"'''''string'''''"</code>
|}

<h3 class="productfield">Transmission Reference</h3>
:This is a string value that serves as a unique identifier for this set of records. It is returned as sent by the Request Array, allowing you to match the Response to the Request.

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"TransmissionReference":"'''''string'''''"</code>
|}

<h3 class="productfield">Transmission Result</h3>
:This is a string value that lists error codes from any errors caused by the most recent request as a whole.

:For a complete list of error codes, see [[Result Code Details#Street Route Cloud API|Street Route Cloud API Result Codes]].

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"TransmissionResult":"'''''string'''''"</code>
|}

<h3 class="productfield">Total Records</h3>
:Displays the total number of records returned.

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"TotalRecords":"'''''string'''''"</code>
|}

==Response Record Elements==
JSON will only contain the Records element.

:{| class="alternate01"
!Protocol !! Definition
|-
|JSON||Each record will be contained within [{}] under the Records element.
|}

Each of the following elements are returned for each record in the Response Array.

<h3 class="productfield">Record ID</h3>
:This is a string value that is a unique identifier for the current record if one was sent in the request. Use this element to match a request record and the corresponding response record.

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"RecordID":"'''''string'''''"</code>
|}

<h3 class="productfield">Results</h3>
:This is a string value with comma delimited status, error codes, and change codes for the record.

:For a complete list of codes, see [[Result Code Details#Street Route Cloud API|Street Route Cloud API Result Codes]].

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"Results":"'''''string'''''"</code>
|}

<h3 class="productfield">Travel Time</h3>
:This is a string value of the travel time for the record in the format HH:MM:SS.

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"TravelTime":"'''''string'''''"</code>
|}

<h3 class="productfield">Total Driving Distance</h3>
:This is a string value with the total driving distance. Refer to the '''[[#Units|Units]]''' field to know what unit of measurement it is.

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"TotalDrivingDistance":"'''''string'''''"</code>
|}

[[Category:Street Route Cloud API]]
[[Category:Reference]]

Street Route:Response - Revision history

Admin at 22:15, 22 September 2020

Admin: Created page with "{{StreetRouteNav |InputOutputCollapse= }} {{CustomTOC}} A response is the result of a request. This consists of returned results codes and Business details. Street Route s..."