Booklinker.API

<back to all web services

SignUpRequest

The following routes are available for this service:
POST/v1/signup
"use strict";
export class SignUpResponse {
    /** @param {{success?:boolean,hasAccount?:boolean,accountConfirmed?:boolean,responseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {boolean} */
    success;
    /** @type {boolean} */
    hasAccount;
    /** @type {boolean} */
    accountConfirmed;
    /** @type {ResponseStatus} */
    responseStatus;
}
export class SignUpRequest {
    /** @param {{email?:string,url?:string,domain?:string,code?:string,affiliateProgramGuid?:string,affiliateParameters?:{ [index:string]: string; }}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    email;
    /** @type {string} */
    url;
    /** @type {string} */
    domain;
    /** @type {string} */
    code;
    /** @type {string} */
    affiliateProgramGuid;
    /** @type {{ [index:string]: string; }} */
    affiliateParameters;
}

JavaScript 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>