| Requires any of the roles: | Admin, TenantAdmin, Receptionist |
| GET | /viviotUser | Gets basic data for a VIVIOT user (for a business user). |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ViviotId | query | string | No | The VIVIOT ID of the user to find. |
| query | string | No | The email address of the user to find. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Version | form | integer | No | Api version |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Data | form | UserBasicView | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ResponseStatus | form | ResponseStatus | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | int | No | |
| FirstName | form | string | No | |
| LastName | form | string | No | |
| form | string | No | ||
| Phone | form | string | No | |
| ViviotId | 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.
GET /viviotUser HTTP/1.1 Host: api.4spaces.io Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
data:
{
id: 0,
firstName: String,
lastName: String,
email: String,
phone: String,
viviotId: String
},
responseStatus:
{
errorCode: String,
message: String,
stackTrace: String,
errors:
[
{
errorCode: String,
fieldName: String,
message: String,
meta:
{
String: String
}
}
],
meta:
{
String: String
}
}
}