Skip to main content
BluINFO

Web API

Web API
BluBØX provides an extensible RESTful API for integration into a variety of services. Our Professional Services team also provides assistance to those wishing to use the BluSKY API to extend their application. With the BluSKY API, the sky is the limit.

AccessLevel

API methods for lookup operations on Access Levels.

API Description
GET api/AccessLevel/GetAllAccessLevels

Returns a list of RoleViewModels that the API token has rights to view

GET api/AccessLevel/GetAllAccessLevelsBySystemId/{ACSystemId}

Returns a list of RoleViewModels that the API token has rights to view

GET api/AccessLevel/GetAllAccessLevelsByCompanyId/{CompanyId}

Returns a list of RoleViewModels that the API token has rights to view

GET api/AccessLevel/GetAccessLevelById/{AccessLevelId}

Returns a single AccessLevelViewModel that the API token has rights to view based on a parameterized PK.

AccessLevelGroup

API methods for lookup operations on Access Level Groups

API Description
GET api/AccessLevelGroup/GetAllAccessLevelGroups

Returns a list of RoleViewModels that the API token has rights to view

GET api/AccessLevelGroup/GetAllAccessLevelGroupsBySystemId/{ACSystemId}

Returns a list of RoleViewModels that the API token has rights to view

GET api/AccessLevelGroup/GetAllAccessLevelGroupsByOccupantId/{OccupantId}

Returns a list of RoleViewModels that the API token has rights to view

GET api/AccessLevelGroup/GetAccessLevelGroupById/{AccessLevelGroupId}

Returns a single AccessLevelGroupViewModel that the API token has rights to view based on a parameterized PK.

Account 

API Description
POST api/Account/Authenticate

Authenticates the API user and returns a Token that is required for all subsequent calls for the remainder of the session.

POST api/Account/Logout

Terminates the session by invalidating a previously obtained Token.

ACSystem

API methods for lookup operations on Access Control Systems.

API Description
GET api/ACSystem/GetAllSystems

Returns a list of FacilityViewModels that the API token has rights to view

GET api/ACSystem/GetSystemById/{ACSystemId}

Returns a single FacilityViewModel that the API token has rights to view based on a parameterized PK.

Badge

API methods for lookup operations on Badge Templates.

API Description
GET api/Badge/GetAllBadges

Returns a list of Badge Templates that the API token has rights to view

GET api/Badge/GetAllBadgesUsedByOccupancy/{OccupancyId}

Returns a list of Badge Templates used by a given Occupancy that the API token has rights to view

Card

API methods for lookup operations on Cards.

API Description
GET api/Card/GetAllCardTypes

Returns a static list of Card Types in BluSKY

ContactItem

API methods for lookup operations on Contact Items.

API Description
GET api/ContactItem/GetAllTypes

Returns a list of ConViewModels that the API token has rights to view

Facility

API methods for lookup operations on Facilities.

API Description
GET api/Facility/GetAllFacilities

Returns a list of FacilityViewModels that the API token has rights to view

GET api/Facility/GetFacilityById/{FacilityId}

Returns a single FacilityViewModel that the API token has rights to view based on a parameterized PK.

Floor

API methods for lookup operations on Floors.

API Description

GET api/Floor/GetFloorsByFacilityId/{FacilityId}
Returns a list of floors (FloorsViewModel) for a given Facility that the API token has rights to view.

FloorStop

API methods for lookup operations on Floor Stops.

API Description
GET api/FloorStop/GetFloorStopsByElevatorBankId/{ElevatorBankId}

Returns a list of floor stops for a given elevator bank that the API token has rights to view.

GET api/FloorStop/GetFloorStopsByFacilityId/{FacilityId}

Returns a list of floor stops for a given Facility that the API token has rights to view.

GET api/FloorStop/GetFloorStopsByFloorId/{FloorId}

Returns a list of floor stops for a given Floor that the API token has rights to view.

Occupancy

API methods for lookup operations on Occupancies.

API Description
GET api/Occupancy/GetAllOccupancies

Returns a list of Occupancies that the API token has rights to view.

GET api/Occupancy/GetOccupanciesByFacilityId/{FacilityId}

Returns a list of Occupancies for a given Facility that the API token has rights to view.

GET api/Occupancy/GetOccupancyById/{OccupancyId}

Returns a single OccupancyViewModel if the API token has rights to view it

POST api/Occupancy/AddOccupancy

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

POST api/Occupancy/UpdateOccupancy

Updates a single Occupancy that is already in the system. Returns Success/Error code.

POST api/Occupancy/RemoveOccupancy/{OccupancyId}

Deletes a single Occupancy that is already in the system. Returns Success/Error code

GET api/Occupancy/GetOccupancyFloors/{OccupancyId}

Gets a list of all Floors occupied by an Occupancy

POST api/Occupancy/AddOccupancyFloor

Adds a single Floor to the Occupancy. Returns Success/Error code plus primary key of Occupancy Floor added.

POST api/Occupancy/UpdateOccupancyFloor

Updates a single Floor occupancy to the system. Returns Success/Error code plus primary key of Occupancy Floor added.

POST api/Occupancy/RemoveOccupancyFloor/{OccupancyFloorId}

Removes a single Floor occupancy from the system. Returns Success/Error code.

Person

API methods for CRUD operations for People/Users. Includes basic Access Rights assignments, Roles (permissions) assignments, and Card assignments.

API Description
GET api/Person/GetAllUsers

Returns a list of UserViewModels that the API token has rights to view

GET api/Person/GetAllUsersByFacility/{FacilityId}

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

GET api/Person/GetAllUsersByOccupancyId/{OccupancyId}

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

GET api/Person/GetAllUsersByVendorId/{VendorId}

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

GET api/Person/GetUserById/{UserId}

Returns a single UserViewModel if the API token has rights to view it

POST api/Person/AddUser

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

POST api/Person/UpdateUser

Updates a single User that is already in the system. Returns Success/Error code.

POST api/Person/RemoveUser

Deletes a single User that is already in the system. Returns Success/Error code

POST api/Person/AddUserRole

Adds an existing Role to an existing User. Returns Success/Error code plus primary key of UserRole entry made.

POST api/Person/RemoveUserRole

Removes an existing Role from an existing User. Returns Success/Error code.

POST api/Person/AddUserCard

Adds a Card to an existing User. Returns Success/Error code plus primary key of UserCard entry made.

POST api/Person/RemoveUserCard

Removes a Card from an existing User. Returns Success/Error code.

POST api/Person/AddUserContactItem

Adds a Contact Information to an existing User. Returns Success/Error code plus primary key of ContactInfo entry made.

POST api/Person/RemoveUserContactItem

Removes Contact Information from an existing User. Returns Success/Error code.

POST api/Person/AddReaderAccess

Adds Reader Access to an existing User. Returns Success/Error code plus primary key of UserReader entry made.

POST api/Person/RemoveReaderAccess

Removes Reader Access from an existing User. Returns Success/Error code.

POST api/Person/AddFloorStopAccess

Adds Floor Stop Access to an existing User. Returns Success/Error code plus primary key of UserFloorStop entry made.

POST api/Person/RemoveFloorStopAccess

Removes Floor Stop Access from an existing User. Returns Success/Error code.

POST api/Person/AddFloorAccess

Adds all Floor Stops pertaining to a given floor to an existing User. Returns Success/Error code.

POST api/Person/RemoveFloorAccess

Removes all Floor Stops pertaining to a given floor from an existing User. Returns Success/Error code.

POST api/Person/AddAccessLevel

Adds an existing Access Level to an existing User. Returns Success/Error code plus primary key of UserAccessLevel entry made.

POST api/Person/RemoveAccessLevel

Removes an existing Access Level from an existing User. Returns Success/Error code.

POST api/Person/AddAccessLevelGroup

Adds an existing Access Level Group to an existing User. Returns Success/Error code plus primary key of UserAccessLevelGroup entry made.

POST api/Person/RemoveAccessLevelGroup

Removes an existing Access Level Group from an existing User. Returns Success/Error code.

Reader

API methods for lookup operations on Readers

API Description
GET api/Reader/GetAllReaders

Returns a list of RoleViewModels that the API token has rights to view

GET api/Reader/GetAllReadersByBuildingId/{FacilityId}

Returns a list of RoleViewModels that the API token has rights to view

GET api/Reader/GetReaderById/{ReaderId}

Returns a single ReaderViewModel that the API token has rights to view based on a parameterized PK.

Vendor

API methods for lookup operations on Vendors.

API Description
GET api/Vendor/GetAllVendors

Returns a list of Vendors that the API token has rights to view.

GET api/Vendor/GetVendorsBySystemId/{ACSystemId}

Returns a list of Vendors for a given Facility that the API token has rights to view.

GET api/Vendor/GetVendorById/{VendorId}

Returns a single VendorViewModel if the API token has rights to view it

POST api/Vendor/AddVendor

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

POST api/Vendor/UpdateVendor

Updates a single Vendor that is already in the system. Returns Success/Error code.

POST api/Vendor/RemoveVendor/{VendorId}

Deletes a single Vendor that is already in the system. Returns Success/Error code

Visitor

API methods for CRUD operations for Visitor Requests.

API Description
GET api/Visitor/GetAllVisitorRequests

Returns a list of VisitorViewModels that the API token has rights to view

GET api/Visitor/GetAllVisitorRequestsByFacilityId/{FacilityId}

Returns a list of VisitorViewModels from a given Facility that the API token has rights to view

GET api/Visitor/GetAllVisitorRequestsByOccupancyId/{OccupancyId}

Returns a list of VisitorViewModels from a given Facility that the API token has rights to view

GET api/Visitor/GetAllVisitorRequestsByHostId/{HostId}

Returns a list of VisitorViewModels going to see a particular Host that the API token has rights to view

GET api/Visitor/GetVisitorRequestById/{VisitorRequestId}

Returns a single VisitorRequestViewModel if the API token has rights to view it

POST api/Visitor/AddVisitorRequest

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

POST api/Visitor/UpdateVisitorRequest

Updates a single VisitorRequest that is already in the system. Returns Success/Error code.

POST api/Visitor/RemoveVisitorRequest/{VisitorRequestId}

Deletes a single VisitorRequest that is already in the system. Returns Success/Error code

GET api/Visitor/GetAllVisitorTypes

Returns a list of VisitorViewModels that the API token has rights to view

  • Was this article helpful?