GET api/v1/Badges?OccupancyId={OccupancyId}

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

Request Information

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

application/json, text/json

Sample:

[
  {
    "BadgeTemplateId": "5d29614a-7111-4a50-935b-191b94b32706",
    "ACSystemId": "ce72a0da-7558-43a1-9cab-ddc78f010e6f",
    "ACSystemName": "sample string 2",
    "CompanyId": "76ca4df7-08f7-4be8-b525-3a4b5cc3e592",
    "CompanyName": "sample string 3",
    "Name": "sample string 4",
    "BadgeTemplateTypeId": "b6a473b0-e8fc-493a-8b18-bc20a35102cd",
    "Deleted": true
  },
  {
    "BadgeTemplateId": "5d29614a-7111-4a50-935b-191b94b32706",
    "ACSystemId": "ce72a0da-7558-43a1-9cab-ddc78f010e6f",
    "ACSystemName": "sample string 2",
    "CompanyId": "76ca4df7-08f7-4be8-b525-3a4b5cc3e592",
    "CompanyName": "sample string 3",
    "Name": "sample string 4",
    "BadgeTemplateTypeId": "b6a473b0-e8fc-493a-8b18-bc20a35102cd",
    "Deleted": true
  }
]

application/xml, text/xml

Sample:

<ArrayOfBadgeBasicViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/APIWebRole.Controllers">
  <BadgeBasicViewModel>
    <ACSystemId>ce72a0da-7558-43a1-9cab-ddc78f010e6f</ACSystemId>
    <ACSystemName>sample string 2</ACSystemName>
    <BadgeTemplateId>5d29614a-7111-4a50-935b-191b94b32706</BadgeTemplateId>
    <BadgeTemplateTypeId>b6a473b0-e8fc-493a-8b18-bc20a35102cd</BadgeTemplateTypeId>
    <CompanyId>76ca4df7-08f7-4be8-b525-3a4b5cc3e592</CompanyId>
    <CompanyName>sample string 3</CompanyName>
    <Deleted>true</Deleted>
    <Name>sample string 4</Name>
  </BadgeBasicViewModel>
  <BadgeBasicViewModel>
    <ACSystemId>ce72a0da-7558-43a1-9cab-ddc78f010e6f</ACSystemId>
    <ACSystemName>sample string 2</ACSystemName>
    <BadgeTemplateId>5d29614a-7111-4a50-935b-191b94b32706</BadgeTemplateId>
    <BadgeTemplateTypeId>b6a473b0-e8fc-493a-8b18-bc20a35102cd</BadgeTemplateTypeId>
    <CompanyId>76ca4df7-08f7-4be8-b525-3a4b5cc3e592</CompanyId>
    <CompanyName>sample string 3</CompanyName>
    <Deleted>true</Deleted>
    <Name>sample string 4</Name>
  </BadgeBasicViewModel>
</ArrayOfBadgeBasicViewModel>