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

Get required compenteces for plant, both internal and external requirements

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

Id of contractor

globally unique identifier

Required

zoneId

Id of specific zone

globally unique identifier

None.

includeAllZones

Wether to include zonerequirement

boolean

Default value is False

Body Parameters

None.

Response Information

Resource Description

Collection of Competence
NameDescriptionTypeAdditional information
ZoneId

globally unique identifier

None.

QualificationId

string

None.

Name

string

None.

Type

string

None.

IsValid

boolean

None.

MarkedAsValidDate

date

None.

ExpectedExpirationDate

date

None.

MarkedAsExpiredDate

date

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "ZoneId": "20a594ae-70b0-4652-8282-0a04bd4b9815",
    "QualificationId": "sample string 1",
    "Name": "sample string 2",
    "Type": "sample string 3",
    "IsValid": true,
    "MarkedAsValidDate": "2022-12-03T22:42:20.9788982+00:00",
    "ExpectedExpirationDate": "2022-12-03T22:42:20.9788982+00:00",
    "MarkedAsExpiredDate": "2022-12-03T22:42:20.9788982+00:00"
  },
  {
    "ZoneId": "20a594ae-70b0-4652-8282-0a04bd4b9815",
    "QualificationId": "sample string 1",
    "Name": "sample string 2",
    "Type": "sample string 3",
    "IsValid": true,
    "MarkedAsValidDate": "2022-12-03T22:42:20.9788982+00:00",
    "ExpectedExpirationDate": "2022-12-03T22:42:20.9788982+00:00",
    "MarkedAsExpiredDate": "2022-12-03T22:42:20.9788982+00:00"
  }
]

application/xml, text/xml

Sample:
<ArrayOfCompetence xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SSG.Systems.DataAPI.Logic.Models.Access">
  <Competence>
    <ExpectedExpirationDate xmlns="http://schemas.datacontract.org/2004/07/SSG.Services.AccessControl.Messages.Contracts.DataApi">2022-12-03T22:42:20.9788982+00:00</ExpectedExpirationDate>
    <IsValid xmlns="http://schemas.datacontract.org/2004/07/SSG.Services.AccessControl.Messages.Contracts.DataApi">true</IsValid>
    <MarkedAsExpiredDate xmlns="http://schemas.datacontract.org/2004/07/SSG.Services.AccessControl.Messages.Contracts.DataApi">2022-12-03T22:42:20.9788982+00:00</MarkedAsExpiredDate>
    <MarkedAsValidDate xmlns="http://schemas.datacontract.org/2004/07/SSG.Services.AccessControl.Messages.Contracts.DataApi">2022-12-03T22:42:20.9788982+00:00</MarkedAsValidDate>
    <Name xmlns="http://schemas.datacontract.org/2004/07/SSG.Services.AccessControl.Messages.Contracts.DataApi">sample string 2</Name>
    <QualificationId xmlns="http://schemas.datacontract.org/2004/07/SSG.Services.AccessControl.Messages.Contracts.DataApi">sample string 1</QualificationId>
    <Type xmlns="http://schemas.datacontract.org/2004/07/SSG.Services.AccessControl.Messages.Contracts.DataApi">sample string 3</Type>
    <ZoneId>20a594ae-70b0-4652-8282-0a04bd4b9815</ZoneId>
  </Competence>
  <Competence>
    <ExpectedExpirationDate xmlns="http://schemas.datacontract.org/2004/07/SSG.Services.AccessControl.Messages.Contracts.DataApi">2022-12-03T22:42:20.9788982+00:00</ExpectedExpirationDate>
    <IsValid xmlns="http://schemas.datacontract.org/2004/07/SSG.Services.AccessControl.Messages.Contracts.DataApi">true</IsValid>
    <MarkedAsExpiredDate xmlns="http://schemas.datacontract.org/2004/07/SSG.Services.AccessControl.Messages.Contracts.DataApi">2022-12-03T22:42:20.9788982+00:00</MarkedAsExpiredDate>
    <MarkedAsValidDate xmlns="http://schemas.datacontract.org/2004/07/SSG.Services.AccessControl.Messages.Contracts.DataApi">2022-12-03T22:42:20.9788982+00:00</MarkedAsValidDate>
    <Name xmlns="http://schemas.datacontract.org/2004/07/SSG.Services.AccessControl.Messages.Contracts.DataApi">sample string 2</Name>
    <QualificationId xmlns="http://schemas.datacontract.org/2004/07/SSG.Services.AccessControl.Messages.Contracts.DataApi">sample string 1</QualificationId>
    <Type xmlns="http://schemas.datacontract.org/2004/07/SSG.Services.AccessControl.Messages.Contracts.DataApi">sample string 3</Type>
    <ZoneId>20a594ae-70b0-4652-8282-0a04bd4b9815</ZoneId>
  </Competence>
</ArrayOfCompetence>