Billhighway Cloud API

ClientMappingsByTypeAndTargetRq

The following routes are available for this service:
GET	/api/client/mappings/type/{typeDesc}/target/{target}

import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ClientMap:
    client_map_i_d: Optional[int] = None
    their_val: Optional[str] = None
    our_val: Optional[str] = None
    key_type_i_d: Optional[int] = None
    key_type_desc: Optional[str] = None
    type_i_d: Optional[int] = None
    type_desc: Optional[str] = None
    key_value: Optional[int] = None
    map_target: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ClientMappingsRs(IApiResponse):
    client_mappings: Optional[List[ClientMap]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ClientMappingsByTypeAndTargetRq(IApiRequest):
    type_desc: Optional[str] = None
    target: Optional[str] = None

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