Booklinker.API

<back to all web services

SignUpRequest

The following routes are available for this service:
POST/v1/signup

// @DataContract
export class SignUpResponse
{
    // @DataMember(Name="success")
    public success: boolean;

    // @DataMember(Name="hasAccount")
    public hasAccount: boolean;

    // @DataMember(Name="accountConfirmed")
    public accountConfirmed: boolean;

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

    public constructor(init?: Partial<SignUpResponse>) { (Object as any).assign(this, init); }
}

// @DataContract
export class SignUpRequest
{
    // @DataMember(Name="email")
    // @ApiMember(IsRequired=true, Name="email")
    public email: string;

    // @DataMember(Name="url")
    // @ApiMember(IsRequired=true, Name="url")
    public url: string;

    // @DataMember(Name="domain")
    public domain: string;

    // @DataMember(Name="code")
    public code: string;

    // @DataMember(Name="affiliateProgramGuid")
    public affiliateProgramGuid: string;

    // @DataMember(Name="affiliateParameters")
    public affiliateParameters: { [index:string]: string; };

    public constructor(init?: Partial<SignUpRequest>) { (Object as any).assign(this, init); }
}

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