Booklinker.API

<back to all web services

GetVanityCodeAvailabilityRequest

The following routes are available for this service:
GET/v1/vanity-codes/availability
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Booklinker.API.ServiceModel.V1.Requests;

namespace Booklinker.API.ServiceModel.V1.Requests
{
    [DataContract]
    public partial class GetVanityCodeAvailabilityRequest
    {
        [DataMember(Name="code")]
        public virtual string Code { get; set; }

        [DataMember(Name="domain")]
        public virtual string Domain { get; set; }
    }

    [DataContract]
    public partial class GetVanityCodeAvailabilityResponse
    {
        [DataMember(Name="isAvailable")]
        public virtual bool IsAvailable { get; set; }

        [DataMember(Name="responseStatus")]
        public virtual ResponseStatus ResponseStatus { get; set; }
    }

}

C# GetVanityCodeAvailabilityRequest 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.

GET /v1/vanity-codes/availability HTTP/1.1 
Host: api.booklinker.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	isAvailable: False,
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}