Viviot.Api

CreateBusinessUser

**Requires Authentication**
Requires any of the roles:	Admin, TenantAdmin

The following routes are available for this service:
POST	/user	Creates a business user.

**CreateBusinessUser** Parameters:
Name	Parameter	Data Type	Required	Description
OrganizationId	body	string	Yes	The user's organization Id (GUID).
Image	body	ImageDto	No	Image object for setting image name, content and mime type.

**BaseEditBusinessUser** Parameters:
Name	Parameter	Data Type	Required	Description
FirstName	form	string	Yes	The user's first name.
LastName	form	string	Yes	The user's last name.
Email	form	string	Yes	The user's email address.
PhoneNumber	form	string	No	The user's phone number.
Roles	form	array	Yes	The user's roles.
ViviotId	form	string	No	Optional association to a Viviot user.

**BaseRequest** Parameters:
Name	Parameter	Data Type	Required	Description
Version	form	integer	No	Api version

**ImageDto** Parameters:
Name	Parameter	Data Type	Required
FileName	form	string	No
Content	form	string	No
MimeType	form	string	No

**BusinessUserProfileDataResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Data	form	BusinessUserProfileDataView	No

**BaseResponse** Parameters:
Name	Parameter	Data Type	Required	Description
ResponseStatus	form	ResponseStatus	No

**BusinessUserProfileDataView** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
ActivationStatus	form	ActivationStatus	No
UserName	form	string	No
FirstName	form	string	No
LastName	form	string	No
Email	form	string	No
TemporaryEmail	form	string	No
EmailConfirmed	form	bool	No
PhoneNumber	form	string	No
TemporaryPhoneNumber	form	string	No
PhoneNumberConfirmed	form	bool	No
Roles	form	List<string>	No
OrganizationId	form	Guid?	No
BusinessOrganizations	form	HashSet<OrganizationBasicView>	No
ViviotId	form	string	No
ImageContent	form	string	No
ImageUrl	form	string	No

**ActivationStatus** Enum:
Name	Value
Unconfirmed	0
Temporary	10
OwnershipConfirmed	20
IdentityConfirmed	30

**OrganizationBasicView** Parameters:
Name	Parameter	Data Type	Required
Id	form	Guid	No
Name	form	string	No
Type	form	OrganizationType	No
SubOrganizations	form	List<OrganizationBasicView>	No

**OrganizationType** Enum:
Name	Value
Unknown	0
Admin	10
Tenant	20
Location	30

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

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<CreateBusinessUser xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Viviot.Api.ServiceModel.Api.Business">
  <Version xmlns="http://schemas.datacontract.org/2004/07/Viviot.Api.ServiceModel.Api.Base">0</Version>
  <Email>String</Email>
  <FirstName>String</FirstName>
  <LastName>String</LastName>
  <PhoneNumber>String</PhoneNumber>
  <Roles xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Roles>
  <ViviotId>String</ViviotId>
  <Image xmlns:d2p1="http://schemas.datacontract.org/2004/07/Viviot.Infrastructure.Dto.Image">
    <d2p1:Content>String</d2p1:Content>
    <d2p1:FileName>String</d2p1:FileName>
    <d2p1:MimeType>String</d2p1:MimeType>
  </Image>
  <OrganizationId>00000000-0000-0000-0000-000000000000</OrganizationId>
</CreateBusinessUser>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<BusinessUserProfileDataResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Viviot.Api.ServiceModel.Api.Business">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types" xmlns="http://schemas.datacontract.org/2004/07/Viviot.Api.ServiceModel.Api.Base">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/Viviot.Api.ServiceModel.Views.Business.User">
    <d2p1:ActivationStatus>Unconfirmed</d2p1:ActivationStatus>
    <d2p1:BusinessOrganizations xmlns:d3p1="http://schemas.datacontract.org/2004/07/Viviot.Api.ServiceModel.Views.Business.Organization">
      <d3p1:OrganizationBasicView>
        <d3p1:Id>00000000-0000-0000-0000-000000000000</d3p1:Id>
        <d3p1:Name>String</d3p1:Name>
        <d3p1:SubOrganizations>
          <d3p1:OrganizationBasicView>
            <d3p1:Id>00000000-0000-0000-0000-000000000000</d3p1:Id>
            <d3p1:Name>String</d3p1:Name>
            <d3p1:SubOrganizations>
              <d3p1:OrganizationBasicView>
                <d3p1:Id>00000000-0000-0000-0000-000000000000</d3p1:Id>
                <d3p1:Name>String</d3p1:Name>
                <d3p1:SubOrganizations>
                  <d3p1:OrganizationBasicView i:nil="true" />
                </d3p1:SubOrganizations>
                <d3p1:Type>Unknown</d3p1:Type>
              </d3p1:OrganizationBasicView>
            </d3p1:SubOrganizations>
            <d3p1:Type>Unknown</d3p1:Type>
          </d3p1:OrganizationBasicView>
        </d3p1:SubOrganizations>
        <d3p1:Type>Unknown</d3p1:Type>
      </d3p1:OrganizationBasicView>
    </d2p1:BusinessOrganizations>
    <d2p1:Email>String</d2p1:Email>
    <d2p1:EmailConfirmed>false</d2p1:EmailConfirmed>
    <d2p1:FirstName>String</d2p1:FirstName>
    <d2p1:Id>0</d2p1:Id>
    <d2p1:ImageContent>String</d2p1:ImageContent>
    <d2p1:ImageUrl>String</d2p1:ImageUrl>
    <d2p1:LastName>String</d2p1:LastName>
    <d2p1:OrganizationId>00000000-0000-0000-0000-000000000000</d2p1:OrganizationId>
    <d2p1:PhoneNumber>String</d2p1:PhoneNumber>
    <d2p1:PhoneNumberConfirmed>false</d2p1:PhoneNumberConfirmed>
    <d2p1:Roles xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </d2p1:Roles>
    <d2p1:TemporaryEmail>String</d2p1:TemporaryEmail>
    <d2p1:TemporaryPhoneNumber>String</d2p1:TemporaryPhoneNumber>
    <d2p1:UserName>String</d2p1:UserName>
    <d2p1:ViviotId>String</d2p1:ViviotId>
  </Data>
</BusinessUserProfileDataResponse>