MatchUp Web Service:GetMatchcodeList - Revision history

Admin at 17:07, 26 March 2021

2021-03-26T17:07:40Z

← Older revision		Revision as of 17:07, 26 March 2021
Line 10:		Line 10:
	MatchUp Web Service supports the JSON and REST protocols to access the service.		MatchUp Web Service supports the JSON and REST protocols to access the service.

	~~==Header==~~		{{HTTPHeader-MatchUp}}
	~~HTTP headers need to match the protocols and formats being used.~~

	~~MatchUp 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>~~

	==Field Names==		==Field Names==

Admin at 17:04, 26 March 2021

2021-03-26T17:04:16Z

← Older revision		Revision as of 17:04, 26 March 2021
Line 9:		Line 9:

	MatchUp Web Service supports the JSON and REST protocols to access the service.		MatchUp Web Service supports the JSON and REST protocols to access the service.

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

			MatchUp 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>

	==Field Names==		==Field Names==

Admin at 21:09, 24 March 2017

2017-03-24T21:09:24Z

← Older revision		Revision as of 21:09, 24 March 2017
Line 121:		Line 121:


	<h3 style="~~background~~-~~color~~:~~rgb(240,240,240)~~;">Name</h3>		:<h4 style="border-bottom:1px solid black;">Name</h4>
	:This is a string value containing the matchcode name.		::This is a string value containing the matchcode name.

	:{\| class="alternate01"		::{\| class="alternate01"
	!Protocol !! Syntax		!Protocol !! Syntax
	\|-		\|-
Line 131:		Line 131:


	<h3 style="~~background~~-~~color~~:~~rgb(240,240,240)~~;">Description</h3>		:<h4 style="border-bottom:1px solid black;">Description</h4>
	:This is a string value containing a description of this matchcode.		::This is a string value containing a description of this matchcode.

	:{\| class="alternate01"		::{\| class="alternate01"
	!Protocol !! Syntax		!Protocol !! Syntax
	\|-		\|-
Line 141:		Line 141:


	<h3 style="~~background~~-~~color~~:~~rgb(240,240,240)~~;">InputFields</h3>		:<h4 style="border-bottom:1px solid black;">InputFields</h4>
	:This is an array containing a list of input fields that should be specified when using this matchcode.		::This is an array containing a list of input fields that should be specified when using this matchcode.

	:{\| class="alternate01"		::{\| class="alternate01"
	!Protocol !! Syntax		!Protocol !! Syntax
	\|-		\|-

Admin at 21:07, 24 March 2017

2017-03-24T21:07:03Z

← Older revision		Revision as of 21:07, 24 March 2017
Line 91:		Line 91:
	This will return a list of available matchcodes and their descriptions.		This will return a list of available matchcodes and their descriptions.

	<h3 style="background-color:rgb(240,240,240);">~~Matchcodes~~</h3>		<h3 style="background-color:rgb(240,240,240);">TransmissionReference</h3>
	:This is ~~an array containing~~ a ~~list~~ of ~~the available matchcodes~~.		:This is a string value that serves as a unique identifier for this set of records. It is returned as sent.

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


	<h3 style="background-color:rgb(240,240,240);">~~Name~~</h3>		<h3 style="background-color:rgb(240,240,240);">Version</h3>
	:This is a string value containing the ~~matchcode name~~.		:This is a string value containing the current version number.

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


	<h3 style="background-color:rgb(240,240,240);">~~Description~~</h3>		<h3 style="background-color:rgb(240,240,240);">Matchcodes</h3>
	:This is ~~a string value~~ containing a ~~description~~ of ~~this matchcode~~.		:This is an array containing a list of the available matchcodes.

	:{\| class="alternate01"		:{\| class="alternate01"
	!Protocol !! Syntax		!Protocol !! Syntax
	\|-		\|-
	\|JSON\|\|<code>"~~Description~~":"'''''~~string~~'''''"</code>		\|JSON\|\|<code>"Matchcodes":{'''''array'''''}</code>
	\|}		\|}


	<h3 style="background-color:rgb(240,240,240);">~~InputFields~~</h3>		<h3 style="background-color:rgb(240,240,240);">Name</h3>
	:This is ~~an array~~ containing ~~a list of input fields that should be specified when using this~~ matchcode.		:This is a string value containing the matchcode name.

	:{\| class="alternate01"		:{\| class="alternate01"
	!Protocol !! Syntax		!Protocol !! Syntax
	\|-		\|-
	\|JSON\|\|<code>"~~InputFields~~":{'''''~~array~~'''''}</code>		\|JSON\|\|<code>"Name":"'''''string'''''"</code>
	\|}		\|}


	<h3 style="background-color:rgb(240,240,240);">~~TransmissionReference~~</h3>		<h3 style="background-color:rgb(240,240,240);">Description</h3>
	:This is a string value ~~that serves as~~ a ~~unique identifier for~~ this ~~set of records. It is returned as sent~~.		:This is a string value containing a description of this matchcode.

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


	<h3 style="background-color:rgb(240,240,240);">~~Version~~</h3>		<h3 style="background-color:rgb(240,240,240);">InputFields</h3>
	:This is a ~~string value containing the current version number~~.		:This is an array containing a list of input fields that should be specified when using this matchcode.

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

Admin at 20:56, 24 March 2017

2017-03-24T20:56:07Z

← Older revision		Revision as of 20:56, 24 March 2017
Line 27:		Line 27:
	<h3 style="background-color:rgb(240,240,240);">Response</h3>		<h3 style="background-color:rgb(240,240,240);">Response</h3>
	{\| class="alternate01 sortable"		{\| class="alternate01 sortable"
	!Field Name		!Field Name !! Level
			\|-
			\|TransmissionReference \|\|rowspan="3" valign="center"\| Response (Base)
			\|-
			\|Version
	\|-		\|-
	\|Matchcodes		\|Matchcodes
	\|-		\|-
	\|Name		\|Name \|\|rowspan="3" valign="center"\| Matchcodes
	\|-		\|-
	\|Description		\|Description
	\|-		\|-
	\|InputFields		\|InputFields
	\|-
	~~\|TransmissionReference~~
	\|-
	~~\|Version~~
	\|}		\|}

Admin at 22:59, 23 March 2017

2017-03-23T22:59:08Z

← Older revision		Revision as of 22:59, 23 March 2017
Line 88:		Line 88:


	=GetMatchcodeListResponse=		==GetMatchcodeListResponse==
	This will return a list of available matchcodes and their descriptions.		This will return a list of available matchcodes and their descriptions.

Admin: Created page with "{{MatchUpWebServiceNav |InputOutputCollapse= }} {{CustomTOC}} A request consists of a protocol to make a call to the service, detailing desired elements. MatchUp Web Servi..."

2017-03-23T21:06:17Z

Created page with "{{MatchUpWebServiceNav |InputOutputCollapse= }} {{CustomTOC}} A request consists of a protocol to make a call to the service, detailing desired elements. MatchUp Web Servi..."

New page

{{MatchUpWebServiceNav
|InputOutputCollapse=
}}

{{CustomTOC}}

A request consists of a protocol to make a call to the service, detailing desired elements.

MatchUp Web Service supports the JSON and REST protocols to access the service.

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

<h3 style="background-color:rgb(240,240,240);">Request</h3>
{| class="alternate01 sortable"
!Field Name !! REST !! JSON
|-
|Localization||loc||Localization
|-
|Transmission Reference||t||TransmissionReference
|-
|Format||format||Format
|}

<h3 style="background-color:rgb(240,240,240);">Response</h3>
{| class="alternate01 sortable"
!Field Name
|-
|Matchcodes
|-
|Name
|-
|Description
|-
|InputFields
|-
|TransmissionReference
|-
|Version
|}

==GetMatchcodeListRequest==
This will request a list of available matchcodes and their descriptions.

<h3 style="background-color:rgb(240,240,240);">Localization</h3>
:''Optional.''

:Language (culture code) to use for output fields Name and Description. Currently ignored.

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

<h3 style="background-color:rgb(240,240,240);">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 style="background-color:rgb(240,240,240);">Format</h3>
:''Optional.''

:Specify the desired output format (XML or JSON). '''Default is '''.

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

=GetMatchcodeListResponse=
This will return a list of available matchcodes and their descriptions.

<h3 style="background-color:rgb(240,240,240);">Matchcodes</h3>
:This is an array containing a list of the available matchcodes.

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

<h3 style="background-color:rgb(240,240,240);">Name</h3>
:This is a string value containing the matchcode name.

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

<h3 style="background-color:rgb(240,240,240);">Description</h3>
:This is a string value containing a description of this matchcode.

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

<h3 style="background-color:rgb(240,240,240);">InputFields</h3>
:This is an array containing a list of input fields that should be specified when using this matchcode.

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

<h3 style="background-color:rgb(240,240,240);">TransmissionReference</h3>
: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>
|}

<h3 style="background-color:rgb(240,240,240);">Version</h3>
:This is a string value containing the current version number.

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

[[Category:MatchUp Web Service]]
[[Category:Reference]]