Booklinker.API

<back to all web services

SignUpRequest

The following routes are available for this service:
POST/v1/signup
import 'package:servicestack/servicestack.dart';

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

    // @DataMember(Name="hasAccount")
    bool? hasAccount;

    // @DataMember(Name="accountConfirmed")
    bool? accountConfirmed;

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

    SignUpResponse({this.success,this.hasAccount,this.accountConfirmed,this.responseStatus});
    SignUpResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

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

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

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

// @DataContract
class SignUpRequest implements IConvertible
{
    // @DataMember(Name="email")
    // @ApiMember(IsRequired=true, Name="email")
    String? email;

    // @DataMember(Name="url")
    // @ApiMember(IsRequired=true, Name="url")
    String? url;

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

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

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

    // @DataMember(Name="affiliateParameters")
    Map<String,String?>? affiliateParameters;

    SignUpRequest({this.email,this.url,this.domain,this.code,this.affiliateProgramGuid,this.affiliateParameters});
    SignUpRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        email = json['email'];
        url = json['url'];
        domain = json['domain'];
        code = json['code'];
        affiliateProgramGuid = json['affiliateProgramGuid'];
        affiliateParameters = JsonConverters.toStringMap(json['affiliateParameters']);
        return this;
    }

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

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

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

Dart SignUpRequest 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.

POST /v1/signup HTTP/1.1 
Host: api.booklinker.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<SignUpRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Booklinker.API.ServiceModel.V1.Requests">
  <affiliateParameters xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </affiliateParameters>
  <affiliateProgramGuid>00000000-0000-0000-0000-000000000000</affiliateProgramGuid>
  <code>String</code>
  <domain>String</domain>
  <email>String</email>
  <url>String</url>
</SignUpRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<SignUpResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Booklinker.API.ServiceModel.V1.Responses">
  <accountConfirmed>false</accountConfirmed>
  <hasAccount>false</hasAccount>
  <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>
  <success>false</success>
</SignUpResponse>