Billhighway Cloud API

KeyRequest

The following routes are available for this service:
POST	/api/keys/generate

import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    public static class KeyRequest extends KeyRequest
    {
        
    }

    public static class KeyResult implements IHaveErrorField
    {
        public HashMap<String,Long> KeyNameValuePairs = null;
        public Boolean IsSuccessful = null;
        public Integer ErrorCode = null;
        public String Message = null;
        public Boolean IsError = null;
        
        public HashMap<String,Long> getKeyNameValuePairs() { return KeyNameValuePairs; }
        public KeyResult setKeyNameValuePairs(HashMap<String,Long> value) { this.KeyNameValuePairs = value; return this; }
        public Boolean getIsSuccessful() { return IsSuccessful; }
        public KeyResult setIsSuccessful(Boolean value) { this.IsSuccessful = value; return this; }
        public Integer getErrorCode() { return ErrorCode; }
        public KeyResult setErrorCode(Integer value) { this.ErrorCode = value; return this; }
        public String getMessage() { return Message; }
        public KeyResult setMessage(String value) { this.Message = value; return this; }
        public Boolean getIsError() { return IsError; }
        public KeyResult setIsError(Boolean value) { this.IsError = value; return this; }
    }

}

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

POST /api/keys/generate HTTP/1.1 
Host: devapi.billhighway.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<KeyRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://www.billhighway.com/api">
  <DbName xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">String</DbName>
  <Keys xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">
    <Keys>
      <Name>String</Name>
      <NumberRequested>0</NumberRequested>
    </Keys>
  </Keys>
</KeyRequest>

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

<KeyResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">
  <ErrorCode>0</ErrorCode>
  <IsSuccessful>false</IsSuccessful>
  <KeyNameValuePairs xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringlong>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>0</d2p1:Value>
    </d2p1:KeyValueOfstringlong>
  </KeyNameValuePairs>
  <Message>String</Message>
</KeyResult>