Billhighway Cloud API

<back to all web services

ClientMappingsByTypeAndTargetRq

The following routes are available for this service:
GET/api/client/mappings/type/{typeDesc}/target/{target}
ClientMappingsByTypeAndTargetRq Parameters:
NameParameterData TypeRequiredDescription
TypeDescpathstringNo
TargetpathstringNo
ClientMappingsRs Parameters:
NameParameterData TypeRequiredDescription
ClientMappingsformList<ClientMap>No
ClientMap Parameters:
NameParameterData TypeRequiredDescription
ClientMapIDformlongNo
TheirValformstringNo
OurValformstringNo
KeyTypeIDformintNo
KeyTypeDescformstringNo
TypeIDformintNo
TypeDescformstringNo
KeyValueformintNo
MapTargetformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /api/client/mappings/type/{typeDesc}/target/{target} HTTP/1.1 
Host: devapi.billhighway.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ClientMappings: 
	[
		{
			ClientMapID: 0,
			TheirVal: String,
			OurVal: String,
			KeyTypeID: 0,
			KeyTypeDesc: String,
			TypeID: 0,
			TypeDesc: String,
			KeyValue: 0,
			MapTarget: String
		}
	]
}