GET api/access/v1/contractors/{contractorId}/access?zoneId={zoneId}

Request Information

Requires Authorization!

In order to make a request to work 2 headers are required, a ClientId and a ClientSecret

URI Parameters

NameDescriptionTypeAdditional information
contractorId

globally unique identifier

Required

zoneId

globally unique identifier

None.

Body Parameters

None.

Response Information

Resource Description

Access
NameDescriptionTypeAdditional information
HasAccess

boolean

None.

ValidTo

date

None.

PlantId

globally unique identifier

None.

ContractorId

globally unique identifier

None.

Response Formats

application/json, text/json

Sample:
{
  "HasAccess": true,
  "ValidTo": "2024-03-18T03:51:00.7783332+00:00",
  "PlantId": "e8e86a5c-1927-42bc-a39e-bdd275d40f37",
  "ContractorId": "8164bb4d-9227-4696-88d4-4124247207c5"
}

application/xml, text/xml

Sample:
<Access xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SSG.Services.AccessControl.Messages.Contracts.DataAPI">
  <ContractorId>8164bb4d-9227-4696-88d4-4124247207c5</ContractorId>
  <HasAccess>true</HasAccess>
  <PlantId>e8e86a5c-1927-42bc-a39e-bdd275d40f37</PlantId>
  <ValidTo>2024-03-18T03:51:00.7783332+00:00</ValidTo>
</Access>