Booklinker.API

<back to all web services

GetVanityCodeAvailabilityRequest

The following routes are available for this service:
GET/v1/vanity-codes/availability
import Foundation
import ServiceStack

// @DataContract
public class GetVanityCodeAvailabilityRequest : Codable
{
    // @DataMember(Name="code")
    public var code:String

    // @DataMember(Name="domain")
    public var domain:String

    required public init(){}
}

// @DataContract
public class GetVanityCodeAvailabilityResponse : Codable
{
    // @DataMember(Name="isAvailable")
    public var isAvailable:Bool

    // @DataMember(Name="responseStatus")
    public var responseStatus:ResponseStatus

    required public init(){}
}


Swift GetVanityCodeAvailabilityRequest 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.

GET /v1/vanity-codes/availability HTTP/1.1 
Host: api.booklinker.com 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
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"}}}