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}
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using BH.Client.Configuration.Service;
using BH.Client.Configuration;

namespace BH.Client.Configuration
{
    public partial class ClientMap
    {
        public virtual long ClientMapID { get; set; }
        public virtual string TheirVal { get; set; }
        public virtual string OurVal { get; set; }
        public virtual int KeyTypeID { get; set; }
        public virtual string KeyTypeDesc { get; set; }
        public virtual int TypeID { get; set; }
        public virtual string TypeDesc { get; set; }
        public virtual int KeyValue { get; set; }
        public virtual string MapTarget { get; set; }
    }

}

namespace BH.Client.Configuration.Service
{
    public partial class ClientMappingsByTypeAndTargetRq
        : IApiRequest
    {
        public virtual string TypeDesc { get; set; }
        public virtual string Target { get; set; }
    }

    public partial class ClientMappingsRs
        : IApiResponse
    {
        public ClientMappingsRs()
        {
            ClientMappings = new List<ClientMap>{};
        }

        public virtual List<ClientMap> ClientMappings { get; set; }
    }

}

C# 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>