Skip to main content

GetSystemById

Overview

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

Request Information


Method

GET - api/ACSystem/GetSystemById/{ACSystemId}

URI Parameters

NameDescriptionTypeAdditional information
ACSystemIdglobally unique identifierRequired

Body Parameters

None.

Response Information


Resource Description

SystemViewModel

NameDescriptionTypeAdditional information
ACSystemIdRepresents the PK of an existing Access Control System in BluSKYglobally unique identifierNone.
NameRepresents the name of an existing Facility in BluSKYstringNone.
DeletedRepresents whether the Facility is deleted or not.booleanNone.
CustomerIdRepresents the PK of an existing Customer/SystemOwner in BluSKYglobally unique identifierNone.
CustomerNameRepresents the name of an existing Customer (System Owner) that owns the Access Control System in BluSKYstringNone.
IntegratorIdRepresents the PK of an existing Integrator in BluSKY that maintains the systemglobally unique identifierNone.
IntegratorNameRepresents the name of an existing Integrator in BluSKY that maintains the systemstringNone.

Response Formats

JSON

{
"ACSystemId": "52696829-d868-4972-ac4e-874cf9493b1a",
"Name": "sample string 2",
"Deleted": true,
"CustomerId": "e6b2c7f9-a1d5-4b69-83b6-ef35dde9a6ce",
"CustomerName": "sample string 5",
"IntegratorId": "c358019e-efc6-43df-ae37-0429a96a6bd8",
"IntegratorName": "sample string 7"
}

XML

<SystemViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BluSKYWebAPI.Controllers">
<ACSystemId>52696829-d868-4972-ac4e-874cf9493b1a</ACSystemId>
<CustomerId>e6b2c7f9-a1d5-4b69-83b6-ef35dde9a6ce</CustomerId>
<CustomerName>sample string 5</CustomerName>
<Deleted>true</Deleted>
<IntegratorId>c358019e-efc6-43df-ae37-0429a96a6bd8</IntegratorId>
<IntegratorName>sample string 7</IntegratorName>
`<Name>`sample string 2</Name>
</SystemViewModel>