Billhighway Cloud API

<back to all web services

KeyRequest

The following routes are available for this service:
POST/api/keys/generate
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using BH.CloudAPI.Common4.DTO;
using BH.CloudAPI.Common.DTO;

namespace BH.CloudAPI.Common.DTO
{
    public partial class KeyResult
        : IHaveErrorField
    {
        public KeyResult()
        {
            KeyNameValuePairs = new Dictionary<string, long>{};
        }

        public virtual Dictionary<string, long> KeyNameValuePairs { get; set; }
        public virtual bool IsSuccessful { get; set; }
        public virtual int ErrorCode { get; set; }
        public virtual string Message { get; set; }
        public virtual bool IsError { get; set; }
    }

}

namespace BH.CloudAPI.Common4.DTO
{
    public partial class KeyRequest
        : KeyRequest
    {
    }

}

C# 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
}