POST api/Account/update
Update an existing User Account profile. Not used for changing account password.
Request Information
URI Parameters
None.
Body Parameters
User Account information
UserAccount| Name | Description | Type | Additional information |
|---|---|---|---|
| UserAccountID |
Unique identifier for the user account |
integer |
None. |
| Subscription |
Obsolete. Do not use. |
UserSubscription |
None. |
| VerifyToken |
Unique generated token assigned to the account. Token is re-generated after each successful authentication. |
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
{
"UserAccountID": 54321,
"Subscription": null,
"VerifyToken": "a6e44579-8e75-431d-92af-d1287bbc1767",
"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
<UserAccount 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> <Subscription i:nil="true" /> <UserAccountID>54321</UserAccountID> <VerifyToken>a6e44579-8e75-431d-92af-d1287bbc1767</VerifyToken> </UserAccount>
Response Information
Resource Description
AccountResponse| Name | Description | Type | Additional 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
{
"Account": {
"UserAccountID": 54321,
"Subscription": null,
"VerifyToken": "a6e44579-8e75-431d-92af-d1287bbc1767",
"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
<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>a6e44579-8e75-431d-92af-d1287bbc1767</VerifyToken>
</Account>
</AccountResponse>