Viviot.Api

<back to all web services

CreateBusinessUser

Requires Authentication
Requires any of the roles:Admin, TenantAdmin
The following routes are available for this service:
POST/userCreates a business user.
CreateBusinessUser Parameters:
NameParameterData TypeRequiredDescription
OrganizationIdbodystringYesThe user's organization Id (GUID).
ImagebodyImageDtoNoImage object for setting image name, content and mime type.
BaseEditBusinessUser Parameters:
NameParameterData TypeRequiredDescription
FirstNameformstringYesThe user's first name.
LastNameformstringYesThe user's last name.
EmailformstringYesThe user's email address.
PhoneNumberformstringNoThe user's phone number.
RolesformarrayYesThe user's roles.
ViviotIdformstringNoOptional association to a Viviot user.
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
VersionformintegerNoApi version
ImageDto Parameters:
NameParameterData TypeRequiredDescription
FileNameformstringNo
ContentformstringNo
MimeTypeformstringNo
BusinessUserProfileDataResponse Parameters:
NameParameterData TypeRequiredDescription
DataformBusinessUserProfileDataViewNo
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.

POST /user HTTP/1.1 
Host: api.4spaces.io 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{Unable to show example output for type 'CreateBusinessUser' 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'.)
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{Unable to show example output for type 'BusinessUserProfileDataResponse' 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'.)