Billhighway Cloud API

<back to all web services

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 .jsv suffix or ?format=jsv

HTTP + JSV

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: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Keys: 
	[
		{
			Name: String,
			NumberRequested: 0
		}
	],
	DbName: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	KeyNameValuePairs: 
	{
		String: 0
	},
	IsSuccessful: False,
	ErrorCode: 0,
	Message: String,
	IsError: True
}