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 java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    public static class ClientMappingsByTypeAndTargetRq implements IApiRequest
    {
        public String TypeDesc = null;
        public String Target = null;
        
        public String getTypeDesc() { return TypeDesc; }
        public ClientMappingsByTypeAndTargetRq setTypeDesc(String value) { this.TypeDesc = value; return this; }
        public String getTarget() { return Target; }
        public ClientMappingsByTypeAndTargetRq setTarget(String value) { this.Target = value; return this; }
    }

    public static class ClientMappingsRs implements IApiResponse
    {
        public ArrayList<ClientMap> ClientMappings = null;
        
        public ArrayList<ClientMap> getClientMappings() { return ClientMappings; }
        public ClientMappingsRs setClientMappings(ArrayList<ClientMap> value) { this.ClientMappings = value; return this; }
    }

    public static class ClientMap
    {
        public Long ClientMapID = null;
        public String TheirVal = null;
        public String OurVal = null;
        public Integer KeyTypeID = null;
        public String KeyTypeDesc = null;
        public Integer TypeID = null;
        public String TypeDesc = null;
        public Integer KeyValue = null;
        public String MapTarget = null;
        
        public Long getClientMapID() { return ClientMapID; }
        public ClientMap setClientMapID(Long value) { this.ClientMapID = value; return this; }
        public String getTheirVal() { return TheirVal; }
        public ClientMap setTheirVal(String value) { this.TheirVal = value; return this; }
        public String getOurVal() { return OurVal; }
        public ClientMap setOurVal(String value) { this.OurVal = value; return this; }
        public Integer getKeyTypeID() { return KeyTypeID; }
        public ClientMap setKeyTypeID(Integer value) { this.KeyTypeID = value; return this; }
        public String getKeyTypeDesc() { return KeyTypeDesc; }
        public ClientMap setKeyTypeDesc(String value) { this.KeyTypeDesc = value; return this; }
        public Integer getTypeID() { return TypeID; }
        public ClientMap setTypeID(Integer value) { this.TypeID = value; return this; }
        public String getTypeDesc() { return TypeDesc; }
        public ClientMap setTypeDesc(String value) { this.TypeDesc = value; return this; }
        public Integer getKeyValue() { return KeyValue; }
        public ClientMap setKeyValue(Integer value) { this.KeyValue = value; return this; }
        public String getMapTarget() { return MapTarget; }
        public ClientMap setMapTarget(String value) { this.MapTarget = value; return this; }
    }

}

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