Skip to main content
BluINFO

GetUserById

  1. Last updated
    Dec 14, 2016
  2. Save as PDF

Overview 

Returns a list of UserViewModels from a given Occupancy that the API token has rights to view.

Request Information

Method

GET - api/Person/GetUserById/{UserId}

URI Parameters

Name Description Type Additional information
UserId

 

 globally unique identifier

Required

Body Parameters

None.

Response Information 

Resource Description

UserViewModel

Name Description Type Additional information
PersonId

Represents the PK of an existing User in BluSKY

 globally unique identifier

None.
FirstName

Represents the User's first/given name.

 string

None.
LastName

Represents the User's last name / surname.

 string

None.
MiddleInitial

Represents the User's middle initial

 string

None.
sGenderId

Represents the User's gender association for Life Safety purposes: 1=Female, 2=Male, 3=Unspecified

 integer

None.
DefaultFloorId

Represents the PK of the Floor that the person's desk/primary workplace is on.

 globally unique identifier

None.
DefaultFloorName

Represents the name of the Floor that the person's desk/primary workplace is on.

 string

None.
DefaultFloorStopId

Represents the PK of the default Floor Stop in the elevator that the person will go to when using Destination elevator systems.

 integer

None.
DefaultFloorStopName

Represents the name of the default Floor Stop in the elevator that the person will go to when using Destination elevator systems.

 string

None.
DefaultEmail

Represents the default email address of the User

 string

None.
DefaultPhone

Represents the default phone number of the User

 string

None.
FacilityId

Represents the PK of the facility that the User is located in

 globally unique identifier

None.
FacilityName

Represents the name of the facility that the User is located in

 string

None.
CompanyInstanceType

Represents the type of company instance that the User belongs to - 1 = Occupancy, 2 = Vendor, 3 = System Owner, 4 = Integrator

 integer

None.
CompanyName

Represents the name of the company instance that the User belongs - name of the occupancy, name of the vendor, etc.

 string

None.
ACSystemId

Represents the PK of the Access Control System that the User is located in

 globally unique identifier

None.
ACSystemName

Represents the name of the Access Control System that the User is located in

 string

None.
StartDatetime

Represents the DateTime when the record will start to be valid. If null, the record is currently active.

 date

None.
EndDatetime

Represents the DateTime when the record will start to be invalid. If null and StartDateTime is in the past, the record is currently active.

 date

None.
AccessRightsSuspended

Represents whether or not the User's Access Rights are suspended

 boolean

None.
AccessRightsSuspendedStart

Represents the DateTime when the User's Access Rights will become suspended. If null and AccessRightsSuspended is true, all access are currently suspended.

 date

None.
AccessRightsSuspendedEnd

Represents the DateTime when the User's Access Rights will become reactivated. If null and AccessRightsSuspended is true, access rights are suspended indefinitely.

 date

None.
WebSiteRightsSuspended

Represents whether or not the User's BluSKY login rights are suspended

 boolean

None.
WebSiteRightsSuspendedStart

Represents the DateTime when the User's BluSKY login rights will become suspended. If null and WebSiteRightsSuspended is true, all login rights are currently suspended.

 date

None.
WebSiteRightsSuspendedEnd

Represents the DateTime when the User's BluSKY login rights will become re-enabled. If null and WebSiteRightsSuspended is true, all login rights are suspended indefinitely.

 date

None.
BadgeTemplateId

Represents the PK of the Badge Template assinged to the User. Retrieve this by calling /Badge/GetAllBadges

 globally unique identifier

None.
EmployeeNumber

Represents the employee number assigned to the User (typically by their HR department)

 string

None.
HasPicture

Represents whether or not an image of the User exists in the System

 boolean

None.
PersonPhotoUri

Represents the path to the User's default badge image (if one exists)

 string

None.
ActiveLoginDatetime

Represents the time the User logged in to their current session in BluSKY

 date

None.
Cards

Represents a list of all Cards assigned to the User

 Collection of PersonCardViewModel

None.
ContactItems

Represents a list of all Contact Items associated with the User

 Collection of ContactInfoUserViewModel

None.
Roles

Represents a list of all Roles assigned to the User

 Collection of RoleViewModel

None.
ReaderAccess

Represents a list of all direct Reader Access assignments made to the User

 Collection of ReaderAccessViewModel

None.
FloorStopAccess

Represents a list of all direct Floor Stop Access assignments made to the User

 Collection of FloorStopAccessViewModel

None.
AccessLevels

Represents a list of all Access Level assignments made to the User

 Collection of AccessLevelViewModel

None.
AccessLevelGroups

Represents a list of all Access Level Group assignments made to the User

 Collection of AccessLevelGroupViewModel

None.

Response Formats 

JSON

view sourceprint?
001{
002  "PersonId": "b7924b30-cc9b-4d36-96e1-686172dfa659",
003  "FirstName": "sample string 2",
004  "LastName": "sample string 3",
005  "MiddleInitial": "sample string 4",
006  "sGenderId": 1,
007  "DefaultFloorId": "3f0295fd-3f07-4ab0-890a-e1c579be9720",
008  "DefaultFloorName": "sample string 5",
009  "DefaultFloorStopId": 1,
010  "DefaultFloorStopName": "sample string 6",
011  "DefaultEmail": "sample string 7",
012  "DefaultPhone": "sample string 8",
013  "FacilityId": "5d692bab-2897-405e-a531-78c14fe33005",
014  "FacilityName": "sample string 9",
015  "CompanyInstanceType": 10,
016  "CompanyName": "sample string 11",
017  "ACSystemId": "898c3ad1-62ca-4cce-9ae6-da82f4bcacd4",
018  "ACSystemName": "sample string 12",
019  "StartDatetime": "2016-12-13T23:19:57.6862555-05:00",
020  "EndDatetime": "2016-12-13T23:19:57.6862555-05:00",
021  "AccessRightsSuspended": true,
022  "AccessRightsSuspendedStart": "2016-12-13T23:19:57.6862555-05:00",
023  "AccessRightsSuspendedEnd": "2016-12-13T23:19:57.6862555-05:00",
024  "WebSiteRightsSuspended": true,
025  "WebSiteRightsSuspendedStart": "2016-12-13T23:19:57.6862555-05:00",
026  "WebSiteRightsSuspendedEnd": "2016-12-13T23:19:57.6862555-05:00",
027  "BadgeTemplateId": "7e7bcb3b-bca7-4122-abdd-f031bbdc214d",
028  "EmployeeNumber": "sample string 21",
029  "HasPicture": true,
030  "PersonPhotoUri": "sample string 23",
031  "ActiveLoginDatetime": "2016-12-13T23:19:57.6862555-05:00",
032  "Cards": [
033    {
034      "PersonCardId": "1f400f16-d2f0-4a23-bf97-6f6c7361b4c3",
035      "CardId": "2fa5caee-fe8d-49ec-8b54-9fc2b156bcec",
036      "CardType": 3,
037      "CardACSystemId": "3479702b-cbde-4ac4-8e63-2ab9b1d54424",
038      "CardACSystemName": "sample string 5",
039      "InternalCardNumber": 6,
040      "ExternalCardNumber": "sample string 7",
041      "CardSerialNumber": 1,
042      "FacilityCode": 8,
043      "IssueCode": 9,
044      "PIN": "sample string 10"
045    },
046    {
047      "PersonCardId": "1f400f16-d2f0-4a23-bf97-6f6c7361b4c3",
048      "CardId": "2fa5caee-fe8d-49ec-8b54-9fc2b156bcec",
049      "CardType": 3,
050      "CardACSystemId": "3479702b-cbde-4ac4-8e63-2ab9b1d54424",
051      "CardACSystemName": "sample string 5",
052      "InternalCardNumber": 6,
053      "ExternalCardNumber": "sample string 7",
054      "CardSerialNumber": 1,
055      "FacilityCode": 8,
056      "IssueCode": 9,
057      "PIN": "sample string 10"
058    }
059  ],
060  "ContactItems": [
061    {
062      "ContactInfoId": "b2bdacbd-b882-4950-af1b-813488f62afb",
063      "ContactType": "sample string 2",
064      "Label": "sample string 3",
065      "Value": "sample string 4",
066      "Deleted": true,
067      "IsDefault": true
068    },
069    {
070      "ContactInfoId": "b2bdacbd-b882-4950-af1b-813488f62afb",
071      "ContactType": "sample string 2",
072      "Label": "sample string 3",
073      "Value": "sample string 4",
074      "Deleted": true,
075      "IsDefault": true
076    }
077  ],
078  "Roles": [
079    {
080      "RoleId": "3dd3f1bc-dd5e-4a58-911e-85b679a8d2d2",
081      "Name": "sample string 2"
082    },
083    {
084      "RoleId": "3dd3f1bc-dd5e-4a58-911e-85b679a8d2d2",
085      "Name": "sample string 2"
086    }
087  ],
088  "ReaderAccess": [
089    {
090      "ReaderScheduleId": "a65ad7c0-3f9e-4f50-bbf3-afa47e911225",
091      "ReaderName": "sample string 2",
092      "ScheduleName": "sample string 3",
093      "AccessRightsGrantedStart": "2016-12-13T23:19:57.6862555-05:00",
094      "AccessRightsGrantedEnd": "2016-12-13T23:19:57.6862555-05:00"
095    },
096    {
097      "ReaderScheduleId": "a65ad7c0-3f9e-4f50-bbf3-afa47e911225",
098      "ReaderName": "sample string 2",
099      "ScheduleName": "sample string 3",
100      "AccessRightsGrantedStart": "2016-12-13T23:19:57.6862555-05:00",
101      "AccessRightsGrantedEnd": "2016-12-13T23:19:57.6862555-05:00"
102    }
103  ],
104  "FloorStopAccess": [
105    {
106      "FloorStopScheduleId": "c75c7257-1274-4bad-bc2b-7ea0b8ebd304",
107      "FloorStopName": "sample string 2",
108      "ScheduleName": "sample string 3",
109      "AccessRightsGrantedStart": "2016-12-13T23:19:57.6862555-05:00",
110      "AccessRightsGrantedEnd": "2016-12-13T23:19:57.6862555-05:00"
111    },
112    {
113      "FloorStopScheduleId": "c75c7257-1274-4bad-bc2b-7ea0b8ebd304",
114      "FloorStopName": "sample string 2",
115      "ScheduleName": "sample string 3",
116      "AccessRightsGrantedStart": "2016-12-13T23:19:57.6862555-05:00",
117      "AccessRightsGrantedEnd": "2016-12-13T23:19:57.6862555-05:00"
118    }
119  ],
120  "AccessLevels": [
121    {
122      "AccessLevelId": "3c231d0c-ab35-4201-af48-9b92e34d79a1",
123      "Name": "sample string 2"
124    },
125    {
126      "AccessLevelId": "3c231d0c-ab35-4201-af48-9b92e34d79a1",
127      "Name": "sample string 2"
128    }
129  ],
130  "AccessLevelGroups": [
131    {
132      "AccessLevelGroupId": "3027caa7-2349-402b-aaab-58a7f40225b0",
133      "Name": "sample string 2"
134    },
135    {
136      "AccessLevelGroupId": "3027caa7-2349-402b-aaab-58a7f40225b0",
137      "Name": "sample string 2"
138    }
139  ]
140}

XML

view sourceprint?
001<UserViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BluSKYWebAPI.Controllers">
002  <ACSystemId>898c3ad1-62ca-4cce-9ae6-da82f4bcacd4</ACSystemId>
003  <ACSystemName>sample string 12</ACSystemName>
004  <AccessLevelGroups>
005    <AccessLevelGroupViewModel>
006      <AccessLevelGroupId>3027caa7-2349-402b-aaab-58a7f40225b0</AccessLevelGroupId>
007      <Name>sample string 2</Name>
008    </AccessLevelGroupViewModel>
009    <AccessLevelGroupViewModel>
010      <AccessLevelGroupId>3027caa7-2349-402b-aaab-58a7f40225b0</AccessLevelGroupId>
011      <Name>sample string 2</Name>
012    </AccessLevelGroupViewModel>
013  </AccessLevelGroups>
014  <AccessLevels>
015    <AccessLevelViewModel>
016      <AccessLevelId>3c231d0c-ab35-4201-af48-9b92e34d79a1</AccessLevelId>
017      <Name>sample string 2</Name>
018    </AccessLevelViewModel>
019    <AccessLevelViewModel>
020      <AccessLevelId>3c231d0c-ab35-4201-af48-9b92e34d79a1</AccessLevelId>
021      <Name>sample string 2</Name>
022    </AccessLevelViewModel>
023  </AccessLevels>
024  <AccessRightsSuspended>true</AccessRightsSuspended>
025  <AccessRightsSuspendedEnd>2016-12-13T23:19:57.6862555-05:00</AccessRightsSuspendedEnd>
026  <AccessRightsSuspendedStart>2016-12-13T23:19:57.6862555-05:00</AccessRightsSuspendedStart>
027  <ActiveLoginDatetime>2016-12-13T23:19:57.6862555-05:00</ActiveLoginDatetime>
028  <BadgeTemplateId>7e7bcb3b-bca7-4122-abdd-f031bbdc214d</BadgeTemplateId>
029  <Cards>
030    <PersonCardViewModel>
031      <CardACSystemId>3479702b-cbde-4ac4-8e63-2ab9b1d54424</CardACSystemId>
032      <CardACSystemName>sample string 5</CardACSystemName>
033      <CardId>2fa5caee-fe8d-49ec-8b54-9fc2b156bcec</CardId>
034      <CardSerialNumber>1</CardSerialNumber>
035      <CardType>3</CardType>
036      <ExternalCardNumber>sample string 7</ExternalCardNumber>
037      <FacilityCode>8</FacilityCode>
038      <InternalCardNumber>6</InternalCardNumber>
039      <IssueCode>9</IssueCode>
040      <PIN>sample string 10</PIN>
041      <PersonCardId>1f400f16-d2f0-4a23-bf97-6f6c7361b4c3</PersonCardId>
042    </PersonCardViewModel>
043    <PersonCardViewModel>
044      <CardACSystemId>3479702b-cbde-4ac4-8e63-2ab9b1d54424</CardACSystemId>
045      <CardACSystemName>sample string 5</CardACSystemName>
046      <CardId>2fa5caee-fe8d-49ec-8b54-9fc2b156bcec</CardId>
047      <CardSerialNumber>1</CardSerialNumber>
048      <CardType>3</CardType>
049      <ExternalCardNumber>sample string 7</ExternalCardNumber>
050      <FacilityCode>8</FacilityCode>
051      <InternalCardNumber>6</InternalCardNumber>
052      <IssueCode>9</IssueCode>
053      <PIN>sample string 10</PIN>
054      <PersonCardId>1f400f16-d2f0-4a23-bf97-6f6c7361b4c3</PersonCardId>
055    </PersonCardViewModel>
056  </Cards>
057  <CompanyInstanceType>10</CompanyInstanceType>
058  <CompanyName>sample string 11</CompanyName>
059  <ContactItems>
060    <ContactInfoUserViewModel>
061      <ContactInfoId>b2bdacbd-b882-4950-af1b-813488f62afb</ContactInfoId>
062      <ContactType>sample string 2</ContactType>
063      <Deleted>true</Deleted>
064      <IsDefault>true</IsDefault>
065      <Label>sample string 3</Label>
066      <Value>sample string 4</Value>
067    </ContactInfoUserViewModel>
068    <ContactInfoUserViewModel>
069      <ContactInfoId>b2bdacbd-b882-4950-af1b-813488f62afb</ContactInfoId>
070      <ContactType>sample string 2</ContactType>
071      <Deleted>true</Deleted>
072      <IsDefault>true</IsDefault>
073      <Label>sample string 3</Label>
074      <Value>sample string 4</Value>
075    </ContactInfoUserViewModel>
076  </ContactItems>
077  <DefaultEmail>sample string 7</DefaultEmail>
078  <DefaultFloorId>3f0295fd-3f07-4ab0-890a-e1c579be9720</DefaultFloorId>
079  <DefaultFloorName>sample string 5</DefaultFloorName>
080  <DefaultFloorStopId>1</DefaultFloorStopId>
081  <DefaultFloorStopName>sample string 6</DefaultFloorStopName>
082  <DefaultPhone>sample string 8</DefaultPhone>
083  <EmployeeNumber>sample string 21</EmployeeNumber>
084  <EndDatetime>2016-12-13T23:19:57.6862555-05:00</EndDatetime>
085  <FacilityId>5d692bab-2897-405e-a531-78c14fe33005</FacilityId>
086  <FacilityName>sample string 9</FacilityName>
087  <FirstName>sample string 2</FirstName>
088  <FloorStopAccess>
089    <FloorStopAccessViewModel>
090      <AccessRightsGrantedEnd>2016-12-13T23:19:57.6862555-05:00</AccessRightsGrantedEnd>
091      <AccessRightsGrantedStart>2016-12-13T23:19:57.6862555-05:00</AccessRightsGrantedStart>
092      <FloorStopName>sample string 2</FloorStopName>
093      <FloorStopScheduleId>c75c7257-1274-4bad-bc2b-7ea0b8ebd304</FloorStopScheduleId>
094      <ScheduleName>sample string 3</ScheduleName>
095    </FloorStopAccessViewModel>
096    <FloorStopAccessViewModel>
097      <AccessRightsGrantedEnd>2016-12-13T23:19:57.6862555-05:00</AccessRightsGrantedEnd>
098      <AccessRightsGrantedStart>2016-12-13T23:19:57.6862555-05:00</AccessRightsGrantedStart>
099      <FloorStopName>sample string 2</FloorStopName>
100      <FloorStopScheduleId>c75c7257-1274-4bad-bc2b-7ea0b8ebd304</FloorStopScheduleId>
101      <ScheduleName>sample string 3</ScheduleName>
102    </FloorStopAccessViewModel>
103  </FloorStopAccess>
104  <HasPicture>true</HasPicture>
105  <LastName>sample string 3</LastName>
106  <MiddleInitial>sample string 4</MiddleInitial>
107  <PersonId>b7924b30-cc9b-4d36-96e1-686172dfa659</PersonId>
108  <PersonPhotoUri>sample string 23</PersonPhotoUri>
109  <ReaderAccess>
110    <ReaderAccessViewModel>
111      <AccessRightsGrantedEnd>2016-12-13T23:19:57.6862555-05:00</AccessRightsGrantedEnd>
112      <AccessRightsGrantedStart>2016-12-13T23:19:57.6862555-05:00</AccessRightsGrantedStart>
113      <ReaderName>sample string 2</ReaderName>
114      <ReaderScheduleId>a65ad7c0-3f9e-4f50-bbf3-afa47e911225</ReaderScheduleId>
115      <ScheduleName>sample string 3</ScheduleName>
116    </ReaderAccessViewModel>
117    <ReaderAccessViewModel>
118      <AccessRightsGrantedEnd>2016-12-13T23:19:57.6862555-05:00</AccessRightsGrantedEnd>
119      <AccessRightsGrantedStart>2016-12-13T23:19:57.6862555-05:00</AccessRightsGrantedStart>
120      <ReaderName>sample string 2</ReaderName>
121      <ReaderScheduleId>a65ad7c0-3f9e-4f50-bbf3-afa47e911225</ReaderScheduleId>
122      <ScheduleName>sample string 3</ScheduleName>
123    </ReaderAccessViewModel>
124  </ReaderAccess>
125  <Roles>
126    <RoleViewModel>
127      <Name>sample string 2</Name>
128      <RoleId>3dd3f1bc-dd5e-4a58-911e-85b679a8d2d2</RoleId>
129    </RoleViewModel>
130    <RoleViewModel>
131      <Name>sample string 2</Name>
132      <RoleId>3dd3f1bc-dd5e-4a58-911e-85b679a8d2d2</RoleId>
133    </RoleViewModel>
134  </Roles>
135  <StartDatetime>2016-12-13T23:19:57.6862555-05:00</StartDatetime>
136  <WebSiteRightsSuspended>true</WebSiteRightsSuspended>
137  <WebSiteRightsSuspendedEnd>2016-12-13T23:19:57.6862555-05:00</WebSiteRightsSuspendedEnd>
138  <WebSiteRightsSuspendedStart>2016-12-13T23:19:57.6862555-05:00</WebSiteRightsSuspendedStart>
139  <sGenderId>1</sGenderId>
140</UserViewModel>
  1. Back to top
  • Was this article helpful?

Recommended articles

  1. GetAllUsersReturns a list of UserViewModels that the API token has rights to view
  2. GetAllUsersByFacilityReturns a list of UserViewModels from a given Facility that the API token has rights to view
  3. GetAllUsersByOccupancyId​​​​​​​Returns a list of UserViewModels from a given Occupancy that the API token has rights to viewReturns a list of UserViewModels from a given Occu...
  4. GetAllUsersByVendorIdReturns a list of UserViewModels from a given Occupancy that the API token has rights to view.
  1. Article type
    Topic
    Flag
    Software
    Stage
    Review
  2. Tags
    1. API