Swagger URI : https://api.ssg.se/swagger/ui/index#/Access
För att snabbt kunna testa API:et så finns det en ”mockanvändare” som ger en respons men som är samma respons oavsett vad du skickar in.
ClientId = MockClient
ClientSecret = MockClient
Plant motsvarar den kravställande anläggningen, det vill säga den som ställer krav på att alla entreprenörer (Contractors) som vill ha tillträde (Access) till anläggningen måste ha genomfört de kurser (Competence) som anläggningen ställer krav (Requirements) på. Här ser du också om anläggningen ställer krav på att företaget ska kontrolleras och vara godkänt från tjänsten Supplier.
Zone motsvarar ett område. Ett område kan ha egna tillträdeskrav. Ett område kan antingen finnas inom anläggningen (då klassas området som "Zone 1/internt") och då ärver den anläggningen tillträdeskrav eller så är det utanför området (då klassas det som "Zone 2/externt") och har egna tillträdeskrav. Se bild här.
En entreprenör (contractor) kan identifieras via en eller flera identiteter (Identity) som är kopplat till denne, till exempel personnummer, accesskortnummer eller accesskortets MIFARE-id.
En Contractor motsvarar den fysiska personen som skall ha tillträde (Access) till den kravställande anläggningen (Plant). Innehåller till exempel namn på personen.
En entreprenör (contractor) kan representera en eller flera entreprenadföretag (company). Innehåller till exempel namn på företaget.
Ett Contract motsvarar ett projekt som en entreprenör (contractor) kan vara bemannad hos eller anställd av.
En competence motsvarar en genomförd kurs eller på annat sätt förvärvad kunskap (Qualification) och innehåller information till exempel giltighetstid.
En Requirement motsvarar en genomförd kurs eller på annat sätt förvärvad kunskap (Qualification) som anläggningen (Plant) ställer krav på för att entreprenören (Contractor) ska få tillträde (Access)
En qualification representerar något som en anläggning (plant) kan kräva (requirement) och som samtidigt en entreprenör (contractor) kan uppfylla genom sina kompetenser (competences) såsom en genomförd och giltig webbutbildning från SSG eller en färdighet/kunskap förvärvad på annat sätt. Det skulle också kunna vara ett intyg eller ett tillstånd.
Tillträde (Access) ges till de entreprenörer (contractors) som uppfyller de krav (requirements) som anläggningen (plant) ställer genom att kunna matcha dess bakomliggande sina kunskaper (qualifications) med sina motsvarande kunskaper (competences)
GET /api/access/v1/contractors/{identity}/{identityType}
identityType = ’SSG’, Identity = Kortnummer 7 siffror
Exempel:
GET /api/access/v1/contractors/1000004/SSG
Respons:
{
"Id": "a8501929-e88b-4315-855e-8ac2d1b5****",
"Name": "Lasse Json",
"AccessCardNo": "1000004",
"PhotoUrl": "https://ssgcardissueprod.blob.core.windows.net/cardphotos/89913637-b2a5-4b80-..."
}
GET /api/access/v1/contractors/{identity}/{identityType}
identityType = PERSONAL, Identity = Personummer
Exempel:
GET /api/access/v1/contractors/671023-XXXX/PERSONAL
Respons:
{
"Id": "a8501929-e88b-4315-855e-8ac2d1b5****",
"Name": "Lasse Json",
"AccessCardNo": "1000004",
"PhotoUrl": "https://ssgcardissueprod.blob.core.windows.net/cardphotos/89913637-b2a5-4b80-***"
}
/api/access/v1/contractors/{contractorId}/access
contractorId = Id på Contractor, uppslagen i exemplet ovan.
Exempel:
GET /api/access/v1/contractors/a8501929-e88b-4315-855e-8ac2d1b5****/access
Respons:
{
"HasAccess": true,
"ValidTo": "2019-01-28T19:33:17.533",
"PlantId": "ded49d7f-5109-476b-a4de-4fee9ea3****",
"ContractorId": "a8501929-e88b-4315-855e-8ac2d1b5****"
}
/api/access/v1/companies/{companyId}/approved
companyId = Id på företaget.
Exempel:
GET /api/access/v1/companies/a8501929-e88b-4315-855e-8ac2d1b5****/approved
Respons:
{
"IsApproved": true,
"PlantId": "ded49d7f-5109-476b-a4de-4fee9ea3****",
"CompanyId": "a8501929-e88b-4315-855e-8ac2d1b5****"
}