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

Namespace Global

    Namespace BH.Client.Configuration

        Public Partial Class ClientMap
            Public Overridable Property ClientMapID As Long
            Public Overridable Property TheirVal As String
            Public Overridable Property OurVal As String
            Public Overridable Property KeyTypeID As Integer
            Public Overridable Property KeyTypeDesc As String
            Public Overridable Property TypeID As Integer
            Public Overridable Property TypeDesc As String
            Public Overridable Property KeyValue As Integer
            Public Overridable Property MapTarget As String
        End Class
    End Namespace

    Namespace BH.Client.Configuration.Service

        Public Partial Class ClientMappingsByTypeAndTargetRq
            Implements IApiRequest
            Public Overridable Property TypeDesc As String
            Public Overridable Property Target As String
        End Class

        Public Partial Class ClientMappingsRs
            Implements IApiResponse
            Public Sub New()
                ClientMappings = New List(Of ClientMap)
            End Sub

            Public Overridable Property ClientMappings As List(Of ClientMap)
        End Class
    End Namespace
End Namespace

VB.NET 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"}]}