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

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
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.

Body Parameters

None.

Response Information

Resource Description

Collection of ContractorExtract
NameDescriptionTypeAdditional 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": "43d8e071-b8b8-47e0-9c5d-f90ed85a6a84",
    "ValidFromDate": "2019-08-12T07:35:19.637005+00:00",
    "ValidToDate": "2019-08-12T07:35:19.637005+00:00",
    "Identity": "sample string 4",
    "IdentityType": "sample string 5"
  },
  {
    "ContractorId": "43d8e071-b8b8-47e0-9c5d-f90ed85a6a84",
    "ValidFromDate": "2019-08-12T07:35:19.637005+00:00",
    "ValidToDate": "2019-08-12T07:35:19.637005+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>43d8e071-b8b8-47e0-9c5d-f90ed85a6a84</ContractorId>
    <Identity>sample string 4</Identity>
    <IdentityType>sample string 5</IdentityType>
    <ValidFromDate>2019-08-12T07:35:19.637005+00:00</ValidFromDate>
    <ValidToDate>2019-08-12T07:35:19.637005+00:00</ValidToDate>
  </ContractorExtract>
  <ContractorExtract>
    <ContractorId>43d8e071-b8b8-47e0-9c5d-f90ed85a6a84</ContractorId>
    <Identity>sample string 4</Identity>
    <IdentityType>sample string 5</IdentityType>
    <ValidFromDate>2019-08-12T07:35:19.637005+00:00</ValidFromDate>
    <ValidToDate>2019-08-12T07:35:19.637005+00:00</ValidToDate>
  </ContractorExtract>
</ArrayOfContractorExtract>