Billhighway Cloud API

<back to all web services

KeyRequest

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

export class KeyResult implements IHaveErrorField
{
    public KeyNameValuePairs?: { [index: string]: number; };
    public IsSuccessful?: boolean;
    public ErrorCode?: number;
    public Message?: string;
    public IsError?: boolean;

    public constructor(init?: Partial<KeyResult>) { (Object as any).assign(this, init); }
}

export class KeyRequest extends KeyRequest
{

    public constructor(init?: Partial<KeyRequest>) { super(init); (Object as any).assign(this, init); }
}

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

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

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

{"KeyNameValuePairs":{"String":0},"IsSuccessful":false,"ErrorCode":0,"Message":"String","IsError":true}