Booklinker.API

<back to all web services

GetVanityCodeAvailabilityRequest

The following routes are available for this service:
GET/v1/vanity-codes/availability
import 'package:servicestack/servicestack.dart';

// @DataContract
class GetVanityCodeAvailabilityResponse implements IConvertible
{
    // @DataMember(Name="isAvailable")
    bool? isAvailable;

    // @DataMember(Name="responseStatus")
    ResponseStatus? responseStatus;

    GetVanityCodeAvailabilityResponse({this.isAvailable,this.responseStatus});
    GetVanityCodeAvailabilityResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        isAvailable = json['isAvailable'];
        responseStatus = JsonConverters.fromJson(json['responseStatus'],'ResponseStatus',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'isAvailable': isAvailable,
        'responseStatus': JsonConverters.toJson(responseStatus,'ResponseStatus',context!)
    };

    getTypeName() => "GetVanityCodeAvailabilityResponse";
    TypeContext? context = _ctx;
}

// @DataContract
class GetVanityCodeAvailabilityRequest implements IConvertible
{
    // @DataMember(Name="code")
    String? code;

    // @DataMember(Name="domain")
    String? domain;

    GetVanityCodeAvailabilityRequest({this.code,this.domain});
    GetVanityCodeAvailabilityRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        code = json['code'];
        domain = json['domain'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'code': code,
        'domain': domain
    };

    getTypeName() => "GetVanityCodeAvailabilityRequest";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'api.booklinker.com', types: <String, TypeInfo> {
    'GetVanityCodeAvailabilityResponse': TypeInfo(TypeOf.Class, create:() => GetVanityCodeAvailabilityResponse()),
    'GetVanityCodeAvailabilityRequest': TypeInfo(TypeOf.Class, create:() => GetVanityCodeAvailabilityRequest()),
});

Dart GetVanityCodeAvailabilityRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

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: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetVanityCodeAvailabilityResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Booklinker.API.ServiceModel.V1.Requests">
  <isAvailable>false</isAvailable>
  <responseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </responseStatus>
</GetVanityCodeAvailabilityResponse>