Viviot.Api

<back to all web services

GetViviotUserData

Requires Authentication
Requires any of the roles:Admin, TenantAdmin, Receptionist
The following routes are available for this service:
GET/viviotUserGets basic data for a VIVIOT user (for a business user).
GetViviotUserData Parameters:
NameParameterData TypeRequiredDescription
ViviotIdquerystringNoThe VIVIOT ID of the user to find.
EmailquerystringNoThe email address of the user to find.
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
VersionformintegerNoApi version
ViviotUserDataResponse Parameters:
NameParameterData TypeRequiredDescription
DataformUserBasicViewNo
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
UserBasicView Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
FirstNameformstringNo
LastNameformstringNo
EmailformstringNo
PhoneformstringNo
ViviotIdformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

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/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{Unable to show example output for type 'ViviotUserDataResponse' using the custom 'csv' filter}One or more errors occurred. (Unable to cast object of type 'ServiceStack.Host.BasicResponse' to type 'ServiceStack.Host.NetCore.NetCoreResponse'.)