MatchUp Web Service:GetMatchcodeList

← MatchUp

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.

Header

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

MatchUp requires the values of Content-Type and Accept.

Example JSON Request Header

{
    "Content-Type": "application/json; charset=utf-8",
    "Accept": "application/json"
}

Field Names

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

Request

Field Name	REST	JSON
Localization	loc	Localization
Transmission Reference	t	TransmissionReference
Format	format	Format

Response

Field Name	Level
TransmissionReference	Response (Base)
Version
Matchcodes
Name	Matchcodes
Description
InputFields

GetMatchcodeListRequest

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

Localization

Optional.

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

Protocol	Syntax
JSON	"Localization":"string"
REST	?loc = string

Transmission Reference

Optional.

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

Protocol	Syntax
JSON	"TransmissionReference":"string"
REST	&t = string

Format

Optional.

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

Protocol	Syntax
JSON	"Format":"string"
REST	&format = string

GetMatchcodeListResponse

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

TransmissionReference

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

Protocol	Syntax
JSON	"TransmissionReference":"string"

Version

This is a string value containing the current version number.

Protocol	Syntax
JSON	"Version":"string"

Matchcodes

This is an array containing a list of the available matchcodes.

Protocol	Syntax
JSON	"Matchcodes":{array}

Name

This is a string value containing the matchcode name.

Protocol	Syntax
JSON	"Name":"string"

Description

This is a string value containing a description of this matchcode.

Protocol	Syntax
JSON	"Description":"string"

InputFields

This is an array containing a list of input fields that should be specified when using this matchcode.

Protocol	Syntax
JSON	"InputFields":{array}