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

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

{"email":"String","url":"String","domain":"String","code":"String","affiliateParameters":{"String":"String"}}

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"success":false,"hasAccount":false,"accountConfirmed":false,"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}