All Verbs | /service/auth/Register/{Role} | ||
---|---|---|---|
All Verbs | /service/RegisterUser/{Role} | ||
All Verbs | /service/RegisterUser |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ConfirmEmail | query | string | No | |
ConfirmPassword | query | string | No | |
Context | query | string | No | |
ForceResetPassword | query | bool | No | |
ContactId | query | string | No | |
RetailerId | query | string | No | |
BillingZip | query | string | No | |
SalesRepId | query | string | No | |
NewSalesRepId | query | string | No | |
SalesRep | query | SalesRep | No | |
Role | path | Roles | No | |
PrimaryEmail | query | string | No | |
Address | query | string | No | |
Address2 | query | string | No | |
City | query | string | No | |
State | query | string | No | |
Zip | query | string | No | |
Country | query | string | No | |
ParentRepId | query | string | No | |
RegistrationStatus | query | string | No | |
Roles | query | List<string> | No | |
Permissions | query | List<string> | No | |
PersonName | query | PersonNameInfo | No | |
FullName | query | string | No | |
Name | query | string | No | |
FirstName | query | string | No | |
LastName | query | string | No | |
Shard | query | string | No | |
Meta | query | Dictionary<string, string> | No | |
Tags | query | Dictionary<string, HashSet<String>> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
UserName | form | string | No | |
DisplayName | form | string | No | |
form | string | No | ||
Password | form | string | No | |
AutoLogin | form | bool? | No | |
Continue | form | string | No | |
FirstName | form | string | No | |
LastName | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | string | No | |
Name | form | string | No | |
form | string | No | ||
Bio | form | string | No | |
RegionId | form | string | No | |
RepGroupId | form | string | No | |
CommissionGroup | form | string | No | |
Phone | form | string | No | |
Manager | form | string | No | |
Address | form | string | No | |
City | form | string | No | |
State | form | string | No | |
Zip | form | string | No | |
Country | form | string | No | |
IsActive | form | bool | No | |
CustomerServiceEmailAddress | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Salutation | form | string | No | |
First | form | string | No | |
Middle | form | string | No | |
Last | form | string | No | |
Suffix | form | string | No | |
Full | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
UserId | form | string | No | |
SessionId | form | string | No | |
UserName | form | string | No | |
ReferrerUrl | form | string | No | |
ResponseStatus | form | ResponseStatus | No | |
Meta | form | Dictionary<string, string> | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /service/auth/Register/{Role} HTTP/1.1
Host: www.bernhardthospitality.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
confirmEmail: String,
confirmPassword: String,
context: String,
forceResetPassword: False,
contactId: String,
retailerId: String,
billingZip: String,
salesRepId: String,
newSalesRepId: String,
salesRep:
{
id: String,
name: String,
email: String,
bio: String,
regionId: String,
repGroupId: String,
commissionGroup: String,
phone: String,
manager: String,
address: String,
city: String,
state: String,
zip: String,
country: String,
isActive: False,
customerServiceEmailAddress: String
},
role: Administrator,
primaryEmail: String,
address: String,
address2: String,
city: String,
state: String,
zip: String,
country: String,
parentRepId: String,
registrationStatus: String,
roles:
[
Administrator
],
permissions:
[
String
],
personName:
{
salutation: "",
first: String,
middle: "",
last: String,
suffix: "",
full: String String
},
fullName: String String,
name: String String,
firstName: String,
lastName: String,
shard: String,
meta:
{
String: String,
Tags: "{
String:
[
String
]
}"
},
tags:
{
String:
[
String
]
},
userName: String,
displayName: String,
email: String,
password: String,
autoLogin: False,
continue: String
}
HTTP/1.1 200 OK Content-Type: text/jsv Content-Length: length { userId: String, sessionId: String, userName: String, referrerUrl: String, responseStatus: { errorCode: String, message: String, stackTrace: String, errors: [ { errorCode: String, fieldName: String, message: String, meta: { String: String } } ], meta: { String: String } }, meta: { String: String } }