Viviot.Api

<back to all web services

GetCurrentGuests

Requires Authentication
Requires any of the roles:Admin, TenantAdmin, AccessAdmin, Receptionist
The following routes are available for this service:
GET/organization/currentguestsGets all users currently being a guest at an organization.
GetCurrentGuests Parameters:
NameParameterData TypeRequiredDescription
OrganizationIdquerystringYesOrganization ID
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
VersionformintegerNoApi version
BusinessUserProfilesDataResponse Parameters:
NameParameterData TypeRequiredDescription
DataformIEnumerable<BusinessUserProfileDataView>No
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
BusinessUserProfileDataView Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
ActivationStatusformActivationStatusNo
UserNameformstringNo
FirstNameformstringNo
LastNameformstringNo
EmailformstringNo
TemporaryEmailformstringNo
EmailConfirmedformboolNo
PhoneNumberformstringNo
TemporaryPhoneNumberformstringNo
PhoneNumberConfirmedformboolNo
RolesformList<string>No
OrganizationIdformGuid?No
BusinessOrganizationsformHashSet<OrganizationBasicView>No
ViviotIdformstringNo
ImageContentformstringNo
ImageUrlformstringNo
ActivationStatus Enum:
NameValue
Unconfirmed0
Temporary10
OwnershipConfirmed20
IdentityConfirmed30
OrganizationBasicView Parameters:
NameParameterData TypeRequiredDescription
IdformGuidNo
NameformstringNo
TypeformOrganizationTypeNo
SubOrganizationsformList<OrganizationBasicView>No
OrganizationType Enum:
NameValue
Unknown0
Admin10
Tenant20
Location30

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 /organization/currentguests HTTP/1.1 
Host: api.4spaces.io 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}