| POST | /cmd/users/register |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | body | string | No | |
| NewUserDTO | body | NewUserDTO | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ExternalUserId | form | string | No | |
| Credentials | form | LoginCredentials | No | |
| Person | form | Person | No | |
| Roles | form | RecordList<string> | No | |
| Avatar | form | AvatarImage | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Username | form | string | No | |
| Password | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Name | form | Name | No | |
| Address | form | Address | No | |
| DateOfBirth | form | DateTime? | No | |
| ContactInfo | form | ContactInfo | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| First | form | string | No | |
| Last | form | string | No | |
| Full | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Street | form | string | Yes | |
| City | form | string | Yes | |
| State | form | string | Yes | |
| PostalCode | form | string | Yes | |
| Country | form | Ref | Yes | |
| GPS | form | GPSCoordinates | Yes | |
| Data | form | RecordDictionary<string, string> | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | string | Yes | |
| Val | form | string | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Lat | form | double | No | |
| Lng | form | double | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Phone | form | string | No | |
| form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Base64 | form | string | No | |
| Tag | form | 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 /cmd/users/register HTTP/1.1
Host: api.sbbet.ath.cx
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
id: String,
newUserDTO:
{
externalUserId: String,
credentials:
{
username: String,
password: String
},
person:
{
name:
{
first: String,
last: String,
full: String String
},
address:
{
street: String,
city: String,
state: String,
postalCode: String,
country:
{
id: String,
val: String
},
gps:
{
lat: 0,
lng: 0
},
data:
{
String: String
}
},
dateOfBirth: 0001-01-01,
contactInfo:
{
phone: String,
email: String
}
},
roles:
[
String
],
avatar:
{
base64: String,
tag: String
}
}
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
errorCode: String,
message: String,
stackTrace: String,
errors:
[
{
errorCode: String,
fieldName: String,
message: String,
meta:
{
String: String
}
}
],
meta:
{
String: String
}
}