Billhighway Cloud API

<back to all web services

ExternalId

The following routes are available for this service:
GET/members/externalid/groups
namespace BH.CloudAPI.Common4.DTO

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type ExternalId() = 
        member val ClientId:Int32 = new Int32() with get,set
        member val UserId:String = null with get,set

F# ExternalId 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 /members/externalid/groups HTTP/1.1 
Host: devapi.billhighway.com 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ArrayOfExternalIdChapters xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://www.billhighway.com/api">
  <ExternalIdChapters>
    <BhUserId>0</BhUserId>
    <ErrorCode>0</ErrorCode>
    <ErrorMessage>String</ErrorMessage>
    <GroupId>String</GroupId>
    <GroupName>String</GroupName>
    <GroupNickName>String</GroupNickName>
  </ExternalIdChapters>
</ArrayOfExternalIdChapters>