Admin at 23:44, 1 September 2021

2021-09-01T23:44:24Z

← Older revision		Revision as of 23:44, 1 September 2021
Line 37:		Line 37:
	\|License Key\|\|id\|\|CustomerID		\|License Key\|\|id\|\|CustomerID
	\|-		\|-
	\|Units\|\|~~unit~~\|\|Units		\|Units\|\|units\|\|Units
	\|-		\|-
	\|Record ID\|\|rowspan="5"\|Record\|\| \|\|RecordID		\|Record ID\|\|rowspan="5"\|Record\|\| \|\|RecordID
Line 109:		Line 109:
	\|JSON\|\|<code>"Units":"'''''string'''''"</code>		\|JSON\|\|<code>"Units":"'''''string'''''"</code>
	\|-		\|-
	\|REST\|\|<code>&~~unit~~ = '''''string'''''</code>		\|REST\|\|<code>&units = '''''string'''''</code>
	\|}		\|}

Admin at 16:08, 25 March 2021

2021-03-25T16:08:17Z

← Older revision		Revision as of 16:08, 25 March 2021
Line 13:		Line 13:
	==URL==		==URL==
	{{URL-StreetRoute}}		{{URL-StreetRoute}}


			==Header==
			HTTP headers need to match the protocols and formats being used.

			Street Route requires the values of <code>Content-Type</code> and <code>Accept</code>.

			===Example JSON Request Header===
			<pre>{
			"Content-Type": "application/json; charset=utf-8",
			"Accept": "application/json"
			}</pre>

Admin at 17:02, 12 December 2018

2018-12-12T17:02:39Z

← Older revision		Revision as of 17:02, 12 December 2018
Line 9:		Line 9:

	Street Route supports the JSON and REST protocols to access the service.		Street Route supports the JSON and REST protocols to access the service.


			==URL==
			{{URL-StreetRoute}}

Admin at 21:45, 31 July 2018

2018-07-31T21:45:37Z

← Older revision		Revision as of 21:45, 31 July 2018
Line 179:		Line 179:


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

Admin: Created page with "{{StreetRouteNav |InputOutputCollapse= }} {{CustomTOC}} A request consists of a protocol to make a call to the service, detailing desired elements. Your License Key is requ..."

2018-07-21T00:40:59Z

Created page with "{{StreetRouteNav |InputOutputCollapse= }} {{CustomTOC}} A request consists of a protocol to make a call to the service, detailing desired elements. Your License Key is requ..."

New page

{{StreetRouteNav
|InputOutputCollapse=
}}

{{CustomTOC}}

A request consists of a protocol to make a call to the service, detailing desired elements. Your License Key is required.

Street Route supports the JSON and REST protocols to access the service.

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

{| class="alternate01 sortable"
!Field Name !! Level !! REST !! JSON
|-
|Transmission Reference||rowspan="3" valign="center"|Request||t||TransmissionReference
|-
|License Key||id||CustomerID
|-
|Units||unit||Units
|-
|Record ID||rowspan="5"|Record|| ||RecordID
|-
|Start Latitude||startLatitude||StartLatitude
|-
|Start Longitude||startLongitude||StartLongitude
|-
|End Latitude||endLatitude||EndLatitude
|-
|End Longitude||endLongitude||EndLongitude
|}

==Minimum Inputs==
The following are the possible minimum input requirements.

#Start Latitude, Start Longitude, End Latitude, and End Longitude.

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

<h3 class="productfield">Transmission Reference</h3>
:''Optional.''

:This is a string value that serves as a unique identifier for this set of records. It is returned as sent.

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

<h3 class="productfield">License Key</h3>
:''Required.''

:This is a string value containing the License Key issued to the customer by Melissa for Street Route.

:If this element is absent, the Web Service will return an error. To receive a License Key, please contact your Melissa sales representative at 1-800-MELISSA.

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"CustomerID":"'''''string'''''"</code>
|-
|REST||<code>&id = '''''string'''''</code>
|}

<h3 class="productfield">Units</h3>
:''Optional.''

:This specifies the returned distance unit scale.

:{| class="alternate01 sortable"
!Unit !! Syntax
|-
|Miles||mi
|-
|Kilometers||km
|}

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

==Request Record Elements==
REST will only contain the Records element.

{| class="alternate01"
!Protocol !! Definition
|-
|JSON||Each record will be contained within [{}] under the Records element.
|-
|REST||The REST interface only allows a single record per request.
|}

<h3 class="productfield">Record ID</h3>
:''Optional.''

:This is a string value containing a unique identifier for the current record. Use this to match the record submitted with the record returned. It will return what is inputted.

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

|}

<h3 class="productfield">Start Latitude</h3>
:''Required.''

:The street route starting latitude.

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"StartLatitude":"'''''string'''''"</code>
|-
|REST||<code>&startLatitude = '''''string'''''</code>
|}

<h3 class="productfield">Start Longitude</h3>
:''Required.''

:The street route starting longitude.

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"StartLongitude":"'''''string'''''"</code>
|-
|REST||<code>&startLongitude = '''''string'''''</code>
|}

<h3 class="productfield">End Latitude</h3>
:''Required.''

:The street route ending latitude.

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"EndLatitude":"'''''string'''''"</code>
|-
|REST||<code>&endLatitude = '''''string'''''</code>
|}

<h3 class="productfield">End Longitude</h3>
:''Required.''

:The street route ending longitude.

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"EndLongitude":"'''''string'''''"</code>
|-
|REST||<code>&endLongitude = '''''string'''''</code>
|}

[[Category:Street Route]]
[[Category:Reference]]

Street Route:Request - Revision history

Admin at 23:44, 1 September 2021

Admin at 16:08, 25 March 2021

Admin at 17:02, 12 December 2018

Admin at 21:45, 31 July 2018

Admin: Created page with "{{StreetRouteNav |InputOutputCollapse= }} {{CustomTOC}} A request consists of a protocol to make a call to the service, detailing desired elements. Your License Key is requ..."