POST api/Account/create

Create a new user account. If account was successfully created, a 201 HTTP Status will be returned.

Request Information

URI Parameters

None.

Body Parameters

User Account information

NewAccount
NameDescriptionTypeAdditional information
Password

Plain text password. Minimum length of 6 characters. Maximum length of 24 characters

string

None.

EmailAddress

Email Address for the user account

string

None.

LastName

Last Name

string

None.

FirstName

First Name

string

None.

Alias

User Alias (displayed in chat area of PBR Live)

string

None.

Passport

Obsolete. Do not use.

Passport

None.

Gender

Gender Code for the user account. Valid values = 'F' or 'M'.

string

None.

BirthDate

Birth Date for the user account. Format = {yyyy-MM-dd}

string

None.

Address1

First line of the street address

string

None.

Address2

Second line of the street address

string

None.

City

City Name.

string

None.

State

State or Province Code. For USA and Canada, use 2-character postal code.

string

None.

Country

2-character Country Code (ISO 3166 Alpha-2). Reference http://www.iso.org/iso/home/standards/country_codes.htm

string

None.

PostalCode

Zip or Postal Code

string

None.

Phone_Home

Home telephone number

string

None.

Phone_Office

Office/Work telephone number

string

None.

Phone_Mobile

Mobile telephone number

string

None.

SMS_OptIn

SMS Opt-In

boolean

None.

MailingList_OptIn

Mailing List Opt-In

boolean

None.

Request Formats

application/json, text/json

Sample:
{
  "Password": "aNewPassword$",
  "EmailAddress": "john.doe@email.com",
  "LastName": "Doe",
  "FirstName": "John",
  "Alias": "Johnny",
  "Passport": null,
  "Gender": "M",
  "BirthDate": "1970-06-28",
  "Address1": "123 Main St.",
  "Address2": "Apt. 2-D",
  "City": "AnyTown",
  "State": "NY",
  "Country": "US",
  "PostalCode": "10001",
  "Phone_Home": null,
  "Phone_Office": null,
  "Phone_Mobile": "2125551212",
  "SMS_OptIn": null,
  "MailingList_OptIn": true
}

application/xml, text/xml

Sample:
<NewAccount xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PBR.FanClub.WebAPI.Models">
  <Address1>123 Main St.</Address1>
  <Address2>Apt. 2-D</Address2>
  <Alias>Johnny</Alias>
  <BirthDate>1970-06-28</BirthDate>
  <City>AnyTown</City>
  <Country>US</Country>
  <EmailAddress>john.doe@email.com</EmailAddress>
  <FirstName>John</FirstName>
  <Gender>M</Gender>
  <LastName>Doe</LastName>
  <MailingList_OptIn>true</MailingList_OptIn>
  <Passport i:nil="true" />
  <Phone_Home i:nil="true" />
  <Phone_Mobile>2125551212</Phone_Mobile>
  <Phone_Office i:nil="true" />
  <PostalCode>10001</PostalCode>
  <SMS_OptIn i:nil="true" />
  <State>NY</State>
  <Password>aNewPassword$</Password>
</NewAccount>

Response Information

Resource Description

AccountResponse
NameDescriptionTypeAdditional information
Account

User Account profile

UserAccount

None.

Success

Boolean value indicating if request was fulfilled

boolean

None.

ErrorMessage

List of any errors or problems that prevented request from being fulfilled.

Collection of string

None.

Response Formats

application/json, text/json

Sample:
{
  "Account": {
    "UserAccountID": 54321,
    "Subscription": null,
    "VerifyToken": "e9c45477-6f3d-40b3-b278-b186691150a6",
    "EmailAddress": "john.doe@email.com",
    "LastName": "Doe",
    "FirstName": "John",
    "Alias": "Johnny",
    "Passport": null,
    "Gender": "M",
    "BirthDate": "1970-06-28",
    "Address1": "123 Main St.",
    "Address2": "Apt. 2-D",
    "City": "AnyTown",
    "State": "NY",
    "Country": "US",
    "PostalCode": "10001",
    "Phone_Home": null,
    "Phone_Office": null,
    "Phone_Mobile": "2125551212",
    "SMS_OptIn": null,
    "MailingList_OptIn": true
  },
  "Success": true,
  "ErrorMessage": []
}

application/xml, text/xml

Sample:
<AccountResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PBR.FanClub.WebAPI.Models">
  <ErrorMessage xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" />
  <Success>true</Success>
  <Account>
    <Address1>123 Main St.</Address1>
    <Address2>Apt. 2-D</Address2>
    <Alias>Johnny</Alias>
    <BirthDate>1970-06-28</BirthDate>
    <City>AnyTown</City>
    <Country>US</Country>
    <EmailAddress>john.doe@email.com</EmailAddress>
    <FirstName>John</FirstName>
    <Gender>M</Gender>
    <LastName>Doe</LastName>
    <MailingList_OptIn>true</MailingList_OptIn>
    <Passport i:nil="true" />
    <Phone_Home i:nil="true" />
    <Phone_Mobile>2125551212</Phone_Mobile>
    <Phone_Office i:nil="true" />
    <PostalCode>10001</PostalCode>
    <SMS_OptIn i:nil="true" />
    <State>NY</State>
    <Subscription i:nil="true" />
    <UserAccountID>54321</UserAccountID>
    <VerifyToken>e9c45477-6f3d-40b3-b278-b186691150a6</VerifyToken>
  </Account>
</AccountResponse>