POST | /persons |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
UserAccountId | body | string | No | |
Timezone | body | string | No | |
PhoneNumber | body | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ResponseStatus | form | ResponseStatus | No | |
Person | form | Person | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Name | form | UserAccountName | No | |
DisplayName | form | string | No | |
form | string | No | ||
PhoneNumber | form | string | No | |
Timezone | form | string | No | |
DefaultOrganisationId | form | string | No | |
Id | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
FirstName | form | string | No | |
LastName | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ResponseStatus | form | ResponseStatus | No | |
Person | form | Person | 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 /persons HTTP/1.1
Host: staging-api.billiecart.com.au
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
userAccountId: String,
timezone: String,
phoneNumber: String
}
HTTP/1.1 200 OK Content-Type: text/jsv Content-Length: length { responseStatus: { errorCode: String, message: String, stackTrace: String, errors: [ { errorCode: String, fieldName: String, message: String, meta: { String: String } } ], meta: { String: String } }, person: { name: { firstName: String, lastName: String }, displayName: String, email: String, phoneNumber: String, timezone: String, defaultOrganisationId: String, id: String } }