GET api/v1/Badges
Returns a list of Badge Templates that the API token has rights to view
Request Information
URI Parameters
None.
Body Parameters
None.
Response Information
Resource Description
Collection of BadgeBasicViewModelName | 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": "75a70d03-8f33-4584-88cd-ed15582a2b21", "ACSystemId": "2b131d5f-ea09-4d7b-8374-4703b3f3f367", "ACSystemName": "sample string 2", "CompanyId": "8e4a1f0e-ac2f-48c8-8746-49cee6455883", "CompanyName": "sample string 3", "Name": "sample string 4", "BadgeTemplateTypeId": "52023e1f-643f-409c-8da9-9ca696ed7fb7", "Deleted": true }, { "BadgeTemplateId": "75a70d03-8f33-4584-88cd-ed15582a2b21", "ACSystemId": "2b131d5f-ea09-4d7b-8374-4703b3f3f367", "ACSystemName": "sample string 2", "CompanyId": "8e4a1f0e-ac2f-48c8-8746-49cee6455883", "CompanyName": "sample string 3", "Name": "sample string 4", "BadgeTemplateTypeId": "52023e1f-643f-409c-8da9-9ca696ed7fb7", "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>2b131d5f-ea09-4d7b-8374-4703b3f3f367</ACSystemId> <ACSystemName>sample string 2</ACSystemName> <BadgeTemplateId>75a70d03-8f33-4584-88cd-ed15582a2b21</BadgeTemplateId> <BadgeTemplateTypeId>52023e1f-643f-409c-8da9-9ca696ed7fb7</BadgeTemplateTypeId> <CompanyId>8e4a1f0e-ac2f-48c8-8746-49cee6455883</CompanyId> <CompanyName>sample string 3</CompanyName> <Deleted>true</Deleted> <Name>sample string 4</Name> </BadgeBasicViewModel> <BadgeBasicViewModel> <ACSystemId>2b131d5f-ea09-4d7b-8374-4703b3f3f367</ACSystemId> <ACSystemName>sample string 2</ACSystemName> <BadgeTemplateId>75a70d03-8f33-4584-88cd-ed15582a2b21</BadgeTemplateId> <BadgeTemplateTypeId>52023e1f-643f-409c-8da9-9ca696ed7fb7</BadgeTemplateTypeId> <CompanyId>8e4a1f0e-ac2f-48c8-8746-49cee6455883</CompanyId> <CompanyName>sample string 3</CompanyName> <Deleted>true</Deleted> <Name>sample string 4</Name> </BadgeBasicViewModel> </ArrayOfBadgeBasicViewModel>