GET api/access/v1/plants/{plantId}/whitelist?typeOfId={typeOfId}&validFrom={validFrom}&zoneId={zoneId}

Get the whitelist of contractors for the plant

Request Information

Requires Authorization!

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

URI Parameters

Name	Description	Type	Additional information
plantId	The unique identifier of the plant.	globally unique identifier	Required
typeOfId	Comma-separated list of id types. Defaults to "SSG"	string	None.
validFrom	Date from when the contractors are valid. Defaults to 24 hours prior	date	None.
zoneId	Unique identifier of a zone within the plant. Defaults to null	globally unique identifier	None.

Body Parameters

None.

Response Information

Resource Description

Collection of ContractorExtract

Name	Type	Additional information
ContractorId	globally unique identifier	None.
ValidFromDate	date	None.
ValidToDate	date	None.
Identity	string	None.
IdentityType	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "ContractorId": "0bfae9ca-187d-461b-8922-18e9efa602c7",
    "ValidFromDate": "2023-03-09T18:23:12.1030694+00:00",
    "ValidToDate": "2023-03-09T18:23:12.1030694+00:00",
    "Identity": "sample string 4",
    "IdentityType": "sample string 5"
  },
  {
    "ContractorId": "0bfae9ca-187d-461b-8922-18e9efa602c7",
    "ValidFromDate": "2023-03-09T18:23:12.1030694+00:00",
    "ValidToDate": "2023-03-09T18:23:12.1030694+00:00",
    "Identity": "sample string 4",
    "IdentityType": "sample string 5"
  }
]

application/xml, text/xml

Sample:

<ArrayOfContractorExtract xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SSG.Services.AccessControl.Messages.Contracts.ApiModels">
  <ContractorExtract>
    <ContractorId>0bfae9ca-187d-461b-8922-18e9efa602c7</ContractorId>
    <Identity>sample string 4</Identity>
    <IdentityType>sample string 5</IdentityType>
    <ValidFromDate>2023-03-09T18:23:12.1030694+00:00</ValidFromDate>
    <ValidToDate>2023-03-09T18:23:12.1030694+00:00</ValidToDate>
  </ContractorExtract>
  <ContractorExtract>
    <ContractorId>0bfae9ca-187d-461b-8922-18e9efa602c7</ContractorId>
    <Identity>sample string 4</Identity>
    <IdentityType>sample string 5</IdentityType>
    <ValidFromDate>2023-03-09T18:23:12.1030694+00:00</ValidFromDate>
    <ValidToDate>2023-03-09T18:23:12.1030694+00:00</ValidToDate>
  </ContractorExtract>
</ArrayOfContractorExtract>