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 .csv suffix or ?format=csv

HTTP + CSV

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

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

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