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}
import Foundation
import ServiceStack

public class ClientMappingsByTypeAndTargetRq : IApiRequest, Codable
{
    public var typeDesc:String?
    public var target:String?

    required public init(){}
}

public class ClientMappingsRs : IApiResponse, Codable
{
    public var clientMappings:[ClientMap] = []

    required public init(){}
}

public class ClientMap : Codable
{
    public var clientMapID:Int?
    public var theirVal:String?
    public var ourVal:String?
    public var keyTypeID:Int?
    public var keyTypeDesc:String?
    public var typeID:Int?
    public var typeDesc:String?
    public var keyValue:Int?
    public var mapTarget:String?

    required public init(){}
}


Swift ClientMappingsByTypeAndTargetRq DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

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