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}
namespace BH.Client.Configuration

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type ClientMap() = 
        member val ClientMapID:Int64 = new Int64() with get,set
        member val TheirVal:String = null with get,set
        member val OurVal:String = null with get,set
        member val KeyTypeID:Int32 = new Int32() with get,set
        member val KeyTypeDesc:String = null with get,set
        member val TypeID:Int32 = new Int32() with get,set
        member val TypeDesc:String = null with get,set
        member val KeyValue:Int32 = new Int32() with get,set
        member val MapTarget:String = null with get,set

    [<AllowNullLiteral>]
    type ClientMappingsRs() = 
        member val ClientMappings:ResizeArray<ClientMap> = new ResizeArray<ClientMap>() with get,set

    [<AllowNullLiteral>]
    type ClientMappingsByTypeAndTargetRq() = 
        member val TypeDesc:String = null with get,set
        member val Target:String = null with get,set

F# ClientMappingsByTypeAndTargetRq DTOs

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

HTTP + XML

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/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ClientMappingsRs xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BH.Client.Configuration.Service">
  <ClientMappings xmlns:d2p1="http://schemas.datacontract.org/2004/07/BH.Client.Configuration">
    <d2p1:ClientMap>
      <d2p1:_x003C_ClientMapID_x003E_k__BackingField>0</d2p1:_x003C_ClientMapID_x003E_k__BackingField>
      <d2p1:_x003C_KeyTypeDesc_x003E_k__BackingField>String</d2p1:_x003C_KeyTypeDesc_x003E_k__BackingField>
      <d2p1:_x003C_KeyTypeID_x003E_k__BackingField>0</d2p1:_x003C_KeyTypeID_x003E_k__BackingField>
      <d2p1:_x003C_KeyValue_x003E_k__BackingField>0</d2p1:_x003C_KeyValue_x003E_k__BackingField>
      <d2p1:_x003C_MapTarget_x003E_k__BackingField>String</d2p1:_x003C_MapTarget_x003E_k__BackingField>
      <d2p1:_x003C_OurVal_x003E_k__BackingField>String</d2p1:_x003C_OurVal_x003E_k__BackingField>
      <d2p1:_x003C_TheirVal_x003E_k__BackingField>String</d2p1:_x003C_TheirVal_x003E_k__BackingField>
      <d2p1:_x003C_TypeDesc_x003E_k__BackingField>String</d2p1:_x003C_TypeDesc_x003E_k__BackingField>
      <d2p1:_x003C_TypeID_x003E_k__BackingField>0</d2p1:_x003C_TypeID_x003E_k__BackingField>
    </d2p1:ClientMap>
  </ClientMappings>
</ClientMappingsRs>