POST api/v1/Users

Adds a single User to the system. Returns Success/Error code plus primary key of user added.

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
FirstName	Required: The User's first/given name. Max Length = 60	string	Required Max length: 60
LastName	Required: The User's last name / surname. Max Length = 60	string	Required Max length: 60
MiddleInitial	Optional: The User's middle initial. Max Length = 2	string	Max length: 2
Nickname	Represents the User's nickname	string	None.
sGenderId	Optional: 1=Female, 2=Male, 3=Unspecified	integer	None.
DefaultFloorId	Optional: Usually the Floor that the person's desk/primary workplace is on.	globally unique identifier	None.
DefaultFloorStopId	Optional: Default Floor Stop in elevator that the person will go to when using Destination elevator systems.	integer	None.
FacilityId	Required: PK of the facility that the User is located in. Retrieve possible values by calling /Facility/GetAllFacilities	globally unique identifier	Required
CompanyInstanceType	Required: The type of company instance that the User belongs to - 1 = Occupancy, 2 = Vendor, 3 = System Owner, 4 = Integrator	integer	Required
CompanyInstanceId	Required: The PK of the company instance the User will be assigned to. Retrieve this by calling /Occupancy/GetAllOccupancies, /Vendor/GetAllVendors, /SystemOwner/GetAllOwners, or Integrator/GetAllIntegrators based on the CompanyInstanceType.	globally unique identifier	Required
ACSystemId	Required: The PK of the Access Control System the User will be assigned to. Retrieve this by calling /ACSystem/GetAllSystems	globally unique identifier	Required
StartDatetime	Optional: The DateTime when the record will start to be valid. If null, the record will be active immediately.	date	None.
EndDatetime	Optional: The DateTime when the record will stop being valid. If null, the record will be active indefinitely.	date	None.
AccessRightsSuspended	Required: Whether or not the User's Access Rights are suspended	boolean	None.
AccessRightsSuspendedStart	Optional: The DateTime when the User's Access Rights will become suspended. If null and AccessRightsSuspended is true, all access will be suspended immediately.	date	None.
AccessRightsSuspendedEnd	Optional: The DateTime when the User's Access Rights will stop being suspended. If null and AccessRightsSuspended is true, access will be suspended indefinitely.	date	None.
WebSiteRightsSuspended	Required: Whether or not the User's BluSKY login is suspended	boolean	None.
WebSiteRightsSuspendedStart	Optional: The DateTime when the User's BluSKY login will become suspended. If null and WebSiteRightsSuspended is true, all BluSKY access will be suspended immediately.	date	None.
WebSiteRightsSuspendedEnd	Optional: The DateTime when the User's BluSKY login will become suspended. If null and WebSiteRightsSuspended is true, all BluSKY access will be suspended immediately.	date	None.
BadgeTemplateId	Optional: The PK of the Badge Template assinged to the User. Retrieve this by calling /Badges/GetAllBadges	globally unique identifier	None.
EmployeeNumber	Optional: The employee number assigned to the User (typically by their HR department)	string	None.
HasLoginRights	Required: Whether or not the User should have a login and password	boolean	None.
Login	Conditional: Required if HasLoginRights is true	string	None.
Password	Conditional: Required if HasLoginRights is true	string	None.
GenerateWelcomeMessage	Optional: True to send a welcome email message	boolean	None.
Deleted	Optional: True to create/update User as deleted	boolean	None.
JobTitle	Optional: Job Title	string	None.
OccupancyName	Represents an Occupancy a User belongs to. If specified, ACSystemId and FacilityId can be omited as well as a CompanyInstanceId when CompanyInstanceType = 1	string	None.
UserUDFValueViewModels	Optional : User Defined Values while creating a new user in BluSky	Collection of UserUDFValueViewModel	None.
DepartmentName	Optional : The name of the department the person belgons to	string	None.
DepartmentCode	Optional : The Code of the department the person belgons to	string	None.
PronounId	Optional : The pronoun the person needs to be called as. Example : He/Him/His Or They/Them/Theirs She/Her/Hers Or They/Them/Theirs She/Her/Hers He/Him/His They/Them/Theirs To Fetch Pronouns : api/v1/Pronouns	globally unique identifier	None.
WorkEnvironmentTypeId	Optional : Determines the Employment Type of the person, Example : Full time Remote, Hybrid etc. To Fetch WorkEnvironmentType : api/v1/WorkEnvironmentTypes	globally unique identifier	None.
EmploymentTermId	Optional : Determines whether the employment is Permenent or temporary	EmploymentTerm	None.
WorkerTypeId	Optional : Determines the type of work the person is going to be doing, example : Consultant, Contractor etc..	WorkerType	None.
OfficeDeskLocation	Determines the location of the office desk	string	None.
EmergencyContactName	Determines the Name of the Person, whose contact is given as Emergency Contact.	string	None.
EmergencyContactRelationship	Determines the Relationship of the Person with user, whose contact is given as Emergency Contact.	string	None.
EmergencyContactHomePhone	Determines the Emergency Contact(Home) for a given user	string	None.
EmergencyContactWorkPhone	Determines the Emergency Contact(Work) for a given user	string	None.
EmergencyContactMobilePhone	Determines the Emergency Contact(Mobile) for a given user	string	None.

Request Formats

application/json, text/json

Sample:

{
  "FirstName": "sample string 1",
  "LastName": "sample string 2",
  "MiddleInitial": "sample string 3",
  "Nickname": "sample string 4",
  "sGenderId": 1,
  "DefaultFloorId": "52e4e4b8-6ce4-4c24-9b45-cfcd2a247df2",
  "DefaultFloorStopId": 1,
  "FacilityId": "cafb30fa-9af0-4963-9f14-e97c2884aefe",
  "CompanyInstanceType": 5,
  "CompanyInstanceId": "00376b78-bf48-4d43-ab3e-ad0d56f6bc8b",
  "ACSystemId": "30fd7312-383f-4a3c-a2d7-f40442e14cd7",
  "StartDatetime": "2025-03-14T13:01:06.5605725+00:00",
  "EndDatetime": "2025-03-14T13:01:06.5605725+00:00",
  "AccessRightsSuspended": true,
  "AccessRightsSuspendedStart": "2025-03-14T13:01:06.5605725+00:00",
  "AccessRightsSuspendedEnd": "2025-03-14T13:01:06.5605725+00:00",
  "WebSiteRightsSuspended": true,
  "WebSiteRightsSuspendedStart": "2025-03-14T13:01:06.5605725+00:00",
  "WebSiteRightsSuspendedEnd": "2025-03-14T13:01:06.5605725+00:00",
  "BadgeTemplateId": "67ae3658-d293-4159-8e05-d89d739a6541",
  "EmployeeNumber": "sample string 9",
  "HasLoginRights": true,
  "Login": "sample string 11",
  "Password": "sample string 12",
  "GenerateWelcomeMessage": true,
  "Deleted": true,
  "JobTitle": "sample string 15",
  "OccupancyName": "sample string 16",
  "UserUDFValueViewModels": [
    {
      "UDFId": "ea05bae0-d8d9-4a07-808b-7fa819df1025",
      "UDFValue": "sample string 2"
    },
    {
      "UDFId": "ea05bae0-d8d9-4a07-808b-7fa819df1025",
      "UDFValue": "sample string 2"
    }
  ],
  "DepartmentName": "sample string 17",
  "DepartmentCode": "sample string 18",
  "PronounId": "303ea03e-2816-4ed9-8569-1b2dfcf437c2",
  "WorkEnvironmentTypeId": "86534a3e-ff4f-47e8-adaa-9da8a672fd59",
  "EmploymentTermId": 0,
  "WorkerTypeId": 0,
  "OfficeDeskLocation": "sample string 19",
  "EmergencyContactName": "sample string 20",
  "EmergencyContactRelationship": "sample string 21",
  "EmergencyContactHomePhone": "sample string 22",
  "EmergencyContactWorkPhone": "sample string 23",
  "EmergencyContactMobilePhone": "sample string 24"
}

application/xml, text/xml

Sample:

<AddUserViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/APIWebRole.Controllers">
  <ACSystemId>30fd7312-383f-4a3c-a2d7-f40442e14cd7</ACSystemId>
  <AccessRightsSuspended>true</AccessRightsSuspended>
  <AccessRightsSuspendedEnd>2025-03-14T13:01:06.5605725+00:00</AccessRightsSuspendedEnd>
  <AccessRightsSuspendedStart>2025-03-14T13:01:06.5605725+00:00</AccessRightsSuspendedStart>
  <BadgeTemplateId>67ae3658-d293-4159-8e05-d89d739a6541</BadgeTemplateId>
  <CompanyInstanceId>00376b78-bf48-4d43-ab3e-ad0d56f6bc8b</CompanyInstanceId>
  <CompanyInstanceType>5</CompanyInstanceType>
  <DefaultFloorId>52e4e4b8-6ce4-4c24-9b45-cfcd2a247df2</DefaultFloorId>
  <DefaultFloorStopId>1</DefaultFloorStopId>
  <Deleted>true</Deleted>
  <DepartmentCode>sample string 18</DepartmentCode>
  <DepartmentName>sample string 17</DepartmentName>
  <EmergencyContactHomePhone>sample string 22</EmergencyContactHomePhone>
  <EmergencyContactMobilePhone>sample string 24</EmergencyContactMobilePhone>
  <EmergencyContactName>sample string 20</EmergencyContactName>
  <EmergencyContactRelationship>sample string 21</EmergencyContactRelationship>
  <EmergencyContactWorkPhone>sample string 23</EmergencyContactWorkPhone>
  <EmployeeNumber>sample string 9</EmployeeNumber>
  <EmploymentTermId>Permanent</EmploymentTermId>
  <EndDatetime>2025-03-14T13:01:06.5605725+00:00</EndDatetime>
  <FacilityId>cafb30fa-9af0-4963-9f14-e97c2884aefe</FacilityId>
  <FirstName>sample string 1</FirstName>
  <GenerateWelcomeMessage>true</GenerateWelcomeMessage>
  <HasLoginRights>true</HasLoginRights>
  <JobTitle>sample string 15</JobTitle>
  <LastName>sample string 2</LastName>
  <Login>sample string 11</Login>
  <MiddleInitial>sample string 3</MiddleInitial>
  <Nickname>sample string 4</Nickname>
  <OccupancyName>sample string 16</OccupancyName>
  <OfficeDeskLocation>sample string 19</OfficeDeskLocation>
  <Password>sample string 12</Password>
  <PronounId>303ea03e-2816-4ed9-8569-1b2dfcf437c2</PronounId>
  <StartDatetime>2025-03-14T13:01:06.5605725+00:00</StartDatetime>
  <UserUDFValueViewModels>
    <UserUDFValueViewModel>
      <UDFId>ea05bae0-d8d9-4a07-808b-7fa819df1025</UDFId>
      <UDFValue>sample string 2</UDFValue>
    </UserUDFValueViewModel>
    <UserUDFValueViewModel>
      <UDFId>ea05bae0-d8d9-4a07-808b-7fa819df1025</UDFId>
      <UDFValue>sample string 2</UDFValue>
    </UserUDFValueViewModel>
  </UserUDFValueViewModels>
  <WebSiteRightsSuspended>true</WebSiteRightsSuspended>
  <WebSiteRightsSuspendedEnd>2025-03-14T13:01:06.5605725+00:00</WebSiteRightsSuspendedEnd>
  <WebSiteRightsSuspendedStart>2025-03-14T13:01:06.5605725+00:00</WebSiteRightsSuspendedStart>
  <WorkEnvironmentTypeId>86534a3e-ff4f-47e8-adaa-9da8a672fd59</WorkEnvironmentTypeId>
  <WorkerTypeId>Employee</WorkerTypeId>
  <sGenderId>1</sGenderId>
</AddUserViewModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ResultWithGuid

Name	Description	Type	Additional information
Value	Represents the PK value that was created as a result of an add	globally unique identifier	None.
ResultCode	Represents the result code	integer	None.
Description	Represents a description of the result code	string	None.

Response Formats

application/json, text/json

Sample:

{
  "Value": "f4a6e289-e766-4d1a-a47a-a860086f3420",
  "ResultCode": 2,
  "Description": "sample string 3"
}

application/xml, text/xml

Sample:

<ResultWithGuid xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/APIWebRole.Controllers">
  <Description>sample string 3</Description>
  <HttpStatusCode>Continue</HttpStatusCode>
  <ResultCode>2</ResultCode>
  <Value>f4a6e289-e766-4d1a-a47a-a860086f3420</Value>
</ResultWithGuid>