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

NameDescriptionTypeAdditional information
OccupancyId

globally unique identifier

Required

Body Parameters

None.

Response Information

Resource Description

Collection of BadgeBasicViewModel
NameDescriptionTypeAdditional 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": "0fb15fb9-356e-45ae-ab26-bc76a8d5133c",
    "ACSystemId": "cfaad222-9995-4a72-85a6-cd763e7c0781",
    "ACSystemName": "sample string 2",
    "CompanyId": "8d9c7ded-aec0-4b34-acc1-778aaeaaf7eb",
    "CompanyName": "sample string 3",
    "Name": "sample string 4",
    "BadgeTemplateTypeId": "9b994266-99eb-4f63-9dc1-17dae9a0c158",
    "Deleted": true
  },
  {
    "BadgeTemplateId": "0fb15fb9-356e-45ae-ab26-bc76a8d5133c",
    "ACSystemId": "cfaad222-9995-4a72-85a6-cd763e7c0781",
    "ACSystemName": "sample string 2",
    "CompanyId": "8d9c7ded-aec0-4b34-acc1-778aaeaaf7eb",
    "CompanyName": "sample string 3",
    "Name": "sample string 4",
    "BadgeTemplateTypeId": "9b994266-99eb-4f63-9dc1-17dae9a0c158",
    "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>cfaad222-9995-4a72-85a6-cd763e7c0781</ACSystemId>
    <ACSystemName>sample string 2</ACSystemName>
    <BadgeTemplateId>0fb15fb9-356e-45ae-ab26-bc76a8d5133c</BadgeTemplateId>
    <BadgeTemplateTypeId>9b994266-99eb-4f63-9dc1-17dae9a0c158</BadgeTemplateTypeId>
    <CompanyId>8d9c7ded-aec0-4b34-acc1-778aaeaaf7eb</CompanyId>
    <CompanyName>sample string 3</CompanyName>
    <Deleted>true</Deleted>
    <Name>sample string 4</Name>
  </BadgeBasicViewModel>
  <BadgeBasicViewModel>
    <ACSystemId>cfaad222-9995-4a72-85a6-cd763e7c0781</ACSystemId>
    <ACSystemName>sample string 2</ACSystemName>
    <BadgeTemplateId>0fb15fb9-356e-45ae-ab26-bc76a8d5133c</BadgeTemplateId>
    <BadgeTemplateTypeId>9b994266-99eb-4f63-9dc1-17dae9a0c158</BadgeTemplateTypeId>
    <CompanyId>8d9c7ded-aec0-4b34-acc1-778aaeaaf7eb</CompanyId>
    <CompanyName>sample string 3</CompanyName>
    <Deleted>true</Deleted>
    <Name>sample string 4</Name>
  </BadgeBasicViewModel>
</ArrayOfBadgeBasicViewModel>