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 ClientSecretURI Parameters
Name | Description | Type | Additional 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 CompetenceName | Description | Type | Additional 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": "5be2ee17-837b-427d-9225-d45787a946ef", "QualificationId": "sample string 1", "Name": "sample string 2", "Type": "sample string 3", "IsValid": true, "MarkedAsValidDate": "2023-02-21T06:26:49.2308484+00:00", "ExpectedExpirationDate": "2023-02-21T06:26:49.2308484+00:00", "MarkedAsExpiredDate": "2023-02-21T06:26:49.2308484+00:00" }, { "ZoneId": "5be2ee17-837b-427d-9225-d45787a946ef", "QualificationId": "sample string 1", "Name": "sample string 2", "Type": "sample string 3", "IsValid": true, "MarkedAsValidDate": "2023-02-21T06:26:49.2308484+00:00", "ExpectedExpirationDate": "2023-02-21T06:26:49.2308484+00:00", "MarkedAsExpiredDate": "2023-02-21T06:26:49.2308484+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">2023-02-21T06:26:49.2308484+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">2023-02-21T06:26:49.2308484+00:00</MarkedAsExpiredDate> <MarkedAsValidDate xmlns="http://schemas.datacontract.org/2004/07/SSG.Services.AccessControl.Messages.Contracts.DataApi">2023-02-21T06:26:49.2308484+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>5be2ee17-837b-427d-9225-d45787a946ef</ZoneId> </Competence> <Competence> <ExpectedExpirationDate xmlns="http://schemas.datacontract.org/2004/07/SSG.Services.AccessControl.Messages.Contracts.DataApi">2023-02-21T06:26:49.2308484+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">2023-02-21T06:26:49.2308484+00:00</MarkedAsExpiredDate> <MarkedAsValidDate xmlns="http://schemas.datacontract.org/2004/07/SSG.Services.AccessControl.Messages.Contracts.DataApi">2023-02-21T06:26:49.2308484+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>5be2ee17-837b-427d-9225-d45787a946ef</ZoneId> </Competence> </ArrayOfCompetence>