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 'package:servicestack/servicestack.dart';

class ClientMap implements IConvertible
{
    int? ClientMapID;
    String? TheirVal;
    String? OurVal;
    int? KeyTypeID;
    String? KeyTypeDesc;
    int? TypeID;
    String? TypeDesc;
    int? KeyValue;
    String? MapTarget;

    ClientMap({this.ClientMapID,this.TheirVal,this.OurVal,this.KeyTypeID,this.KeyTypeDesc,this.TypeID,this.TypeDesc,this.KeyValue,this.MapTarget});
    ClientMap.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        ClientMapID = json['ClientMapID'];
        TheirVal = json['TheirVal'];
        OurVal = json['OurVal'];
        KeyTypeID = json['KeyTypeID'];
        KeyTypeDesc = json['KeyTypeDesc'];
        TypeID = json['TypeID'];
        TypeDesc = json['TypeDesc'];
        KeyValue = json['KeyValue'];
        MapTarget = json['MapTarget'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'ClientMapID': ClientMapID,
        'TheirVal': TheirVal,
        'OurVal': OurVal,
        'KeyTypeID': KeyTypeID,
        'KeyTypeDesc': KeyTypeDesc,
        'TypeID': TypeID,
        'TypeDesc': TypeDesc,
        'KeyValue': KeyValue,
        'MapTarget': MapTarget
    };

    getTypeName() => "ClientMap";
    TypeContext? context = _ctx;
}

class ClientMappingsRs implements IApiResponse, IConvertible
{
    List<ClientMap>? ClientMappings;

    ClientMappingsRs({this.ClientMappings});
    ClientMappingsRs.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        ClientMappings = JsonConverters.fromJson(json['ClientMappings'],'List<ClientMap>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'ClientMappings': JsonConverters.toJson(ClientMappings,'List<ClientMap>',context!)
    };

    getTypeName() => "ClientMappingsRs";
    TypeContext? context = _ctx;
}

class ClientMappingsByTypeAndTargetRq implements IApiRequest, IConvertible
{
    String? TypeDesc;
    String? Target;

    ClientMappingsByTypeAndTargetRq({this.TypeDesc,this.Target});
    ClientMappingsByTypeAndTargetRq.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        TypeDesc = json['TypeDesc'];
        Target = json['Target'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'TypeDesc': TypeDesc,
        'Target': Target
    };

    getTypeName() => "ClientMappingsByTypeAndTargetRq";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'devapi.billhighway.com', types: <String, TypeInfo> {
    'ClientMap': TypeInfo(TypeOf.Class, create:() => ClientMap()),
    'ClientMappingsRs': TypeInfo(TypeOf.Class, create:() => ClientMappingsRs()),
    'List<ClientMap>': TypeInfo(TypeOf.Class, create:() => <ClientMap>[]),
    'ClientMappingsByTypeAndTargetRq': TypeInfo(TypeOf.Class, create:() => ClientMappingsByTypeAndTargetRq()),
});

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