GetAllBadgesUsedByOccupancy
Overview
Returns a list of Badge Templates used by a given Occupancy that the API token has rights to view
Request Information
Method
GET - api/Badge/GetAllBadgesUsedByOccupancy/{OccupancyId}
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| OccupancyId | globally unique identifier | Required |
Body Parameters
None.
Response Information
Resource Description
Collection of BadgeBasicViewModel
| Name | Description | Type | Additional information |
|---|---|---|---|
| BadgeTemplateId | Represents the PK of the Badge template | globally unique identifier | None. |
| ACSystemId | Represents the PK of the Access Control System for the badge template | globally unique identifier | None. |
| ACSystemName | Represents the name of the Access Control System for the badge template | string | None. |
| CompanyId | Represents the nullalbe PK of the company (if applicable) that owns the badge template. Null means this is a system-wide template. | globally unique identifier | None. |
| CompanyName | Represents the name of the company (if applicable) that owns the badge template. | string | None. |
| Name | Represents the name of the Badge template | string | None. |
| BadgeTemplateTypeId | Represents type of badge template - visitor, employee, visiting employee, vendor | globally unique identifier | None. |
| Deleted | Represents the deleted status of the badge template | boolean | None. |
Response Formats
JSON
\\\\[ { "BadgeTemplateId": "5e35cf92-a407-42d9-b3e4-a64e23817528", "ACSystemId": "99a29196-2cde-4c45-8037-724973d76b95", "ACSystemName": "sample string 3", "CompanyId": "71807db0-b399-4763-8d5d-72cbb51d9046", "CompanyName": "sample string 4", "Name": "sample string 5", "BadgeTemplateTypeId": "b90889b3-083b-4fff-a13c-5222811da2a5", "Deleted": true }, { "BadgeTemplateId": "5e35cf92-a407-42d9-b3e4-a64e23817528", "ACSystemId": "99a29196-2cde-4c45-8037-724973d76b95", "ACSystemName": "sample string 3", "CompanyId": "71807db0-b399-4763-8d5d-72cbb51d9046", "CompanyName": "sample string 4", "Name": "sample string 5", "BadgeTemplateTypeId": "b90889b3-083b-4fff-a13c-5222811da2a5", "Deleted": true } ]
XML
<ArrayOfBadgeBasicViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BluSKYWebAPI.Controllers">
<BadgeBasicViewModel>
<ACSystemId>99a29196-2cde-4c45-8037-724973d76b95</ACSystemId>
<ACSystemName>sample string 3</ACSystemName>
<BadgeTemplateId>5e35cf92-a407-42d9-b3e4-a64e23817528</BadgeTemplateId>
<BadgeTemplateTypeId>b90889b3-083b-4fff-a13c-5222811da2a5</BadgeTemplateTypeId>
<CompanyId>71807db0-b399-4763-8d5d-72cbb51d9046</CompanyId>
<CompanyName>sample string 4</CompanyName>
<Deleted>true</Deleted>
`<Name>`sample string 5</Name>
</BadgeBasicViewModel>
<BadgeBasicViewModel>
<ACSystemId>99a29196-2cde-4c45-8037-724973d76b95</ACSystemId>
<ACSystemName>sample string 3</ACSystemName>
<BadgeTemplateId>5e35cf92-a407-42d9-b3e4-a64e23817528</BadgeTemplateId>
<BadgeTemplateTypeId>b90889b3-083b-4fff-a13c-5222811da2a5</BadgeTemplateTypeId>
<CompanyId>71807db0-b399-4763-8d5d-72cbb51d9046</CompanyId>
<CompanyName>sample string 4</CompanyName>
<Deleted>true</Deleted>
`<Name>`sample string 5</Name>
</BadgeBasicViewModel>
</ArrayOfBadgeBasicViewModel>