{ "paths": { "/achievements": { "get": { "tags": [ "QualificationAchievement" ], "responses": { "200": { "content": { "application/json": { "schema": { "format": "object", "properties": { "results": { "type": "array", "items": { "format": "object", "properties": { "remark": { "type": "string" }, "lastModifiedAt": { "type": "string", "format": "timestamp" }, "id": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "issueDate": { "type": "string", "format": "date" }, "overriddenExpirationDate": { "type": "string", "format": "date" }, "qualificationID": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "evidenceVariantID": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "externalId": { "type": "string" }, "documents": { "type": "array", "items": { "format": "object", "properties": { "contentType": { "type": "string" }, "filename": { "type": "string" } }, "required": [ "filename", "contentType" ], "type": "object" } }, "externalCode": { "type": "string" }, "scoreOrder": { "type": "integer", "format": "int32" }, "submittedByID": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "approvedByID": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "isAutoAchieved": { "type": "boolean" }, "createdAt": { "type": "string", "format": "timestamp" }, "employmentID": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "expirationDate": { "type": "string", "format": "date" } }, "required": [ "id", "createdAt", "lastModifiedAt", "employmentID", "evidenceVariantID", "qualificationID", "scoreOrder", "issueDate", "expirationDate", "isAutoAchieved", "submittedByID", "approvedByID" ], "type": "object" } }, "deltaToken": { "type": "string" }, "pageToken": { "type": "string" } }, "required": [ "results", "pageToken", "deltaToken" ], "type": "object" } } }, "description": "Successful request" } }, "deprecated": false, "parameters": [ { "allowEmptyValue": false, "deprecated": false, "schema": { "type": "string" }, "required": false, "in": "query", "description": "", "name": "pageToken" }, { "allowEmptyValue": false, "deprecated": false, "schema": { "type": "integer", "format": "int32" }, "required": false, "in": "query", "description": "", "name": "limit" }, { "allowEmptyValue": false, "deprecated": false, "schema": { "type": "string" }, "required": false, "in": "query", "description": "", "name": "sinceDeltaToken" }, { "allowEmptyValue": false, "deprecated": false, "schema": { "type": "array", "items": { "type": "string" } }, "required": false, "in": "query", "description": "", "name": "fields" } ], "summary": "List all achievements viewable for API user", "operationId": "achievementsFrom:limit:since:fields:" } }, "/achievements/{id}": { "get": { "operationId": "achievementAt:", "parameters": [ { "allowEmptyValue": false, "deprecated": false, "schema": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "required": true, "in": "path", "description": "", "name": "id" } ], "deprecated": false, "responses": { "200": { "content": { "application/json": { "schema": { "format": "object", "properties": { "remark": { "type": "string" }, "lastModifiedAt": { "type": "string", "format": "timestamp" }, "id": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "issueDate": { "type": "string", "format": "date" }, "overriddenExpirationDate": { "type": "string", "format": "date" }, "qualificationID": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "evidenceVariantID": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "externalId": { "type": "string" }, "documents": { "type": "array", "items": { "format": "object", "properties": { "contentType": { "type": "string" }, "filename": { "type": "string" } }, "required": [ "filename", "contentType" ], "type": "object" } }, "externalCode": { "type": "string" }, "scoreOrder": { "type": "integer", "format": "int32" }, "submittedByID": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "approvedByID": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "isAutoAchieved": { "type": "boolean" }, "createdAt": { "type": "string", "format": "timestamp" }, "employmentID": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "expirationDate": { "type": "string", "format": "date" } }, "required": [ "id", "createdAt", "lastModifiedAt", "employmentID", "evidenceVariantID", "qualificationID", "scoreOrder", "issueDate", "expirationDate", "isAutoAchieved", "submittedByID", "approvedByID" ], "type": "object" } } }, "description": "Successful request" } } } }, "/contractTypes": { "get": { "tags": [ "ContractType" ], "responses": { "200": { "content": { "application/json": { "schema": { "format": "object", "properties": { "results": { "type": "array", "items": { "format": "object", "properties": { "name": { "type": "string" }, "externalCode": { "type": "string" }, "lastModifiedAt": { "type": "string", "format": "timestamp" }, "createdAt": { "type": "string", "format": "timestamp" }, "externalId": { "type": "string" }, "id": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "code": { "type": "string" } }, "required": [ "id", "createdAt", "lastModifiedAt", "code", "name" ], "type": "object" } }, "deltaToken": { "type": "string" }, "pageToken": { "type": "string" } }, "required": [ "results", "pageToken", "deltaToken" ], "type": "object" } } }, "description": "Successful request" } }, "deprecated": false, "parameters": [ { "allowEmptyValue": false, "deprecated": false, "schema": { "type": "string" }, "required": false, "in": "query", "description": "", "name": "pageToken" }, { "allowEmptyValue": false, "deprecated": false, "schema": { "type": "integer", "format": "int32" }, "required": false, "in": "query", "description": "", "name": "limit" }, { "allowEmptyValue": false, "deprecated": false, "schema": { "type": "string" }, "required": false, "in": "query", "description": "", "name": "sinceDeltaToken" }, { "allowEmptyValue": false, "deprecated": false, "schema": { "type": "array", "items": { "type": "string" } }, "required": false, "in": "query", "description": "", "name": "fields" } ], "summary": "List all contractTypes viewable for API user", "operationId": "contractTypesFrom:limit:since:fields:" } }, "/contractTypes/{id}": { "get": { "operationId": "contractTypeAt:", "parameters": [ { "allowEmptyValue": false, "deprecated": false, "schema": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "required": true, "in": "path", "description": "", "name": "id" } ], "deprecated": false, "responses": { "200": { "content": { "application/json": { "schema": { "format": "object", "properties": { "name": { "type": "string" }, "externalCode": { "type": "string" }, "lastModifiedAt": { "type": "string", "format": "timestamp" }, "createdAt": { "type": "string", "format": "timestamp" }, "externalId": { "type": "string" }, "id": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "code": { "type": "string" } }, "required": [ "id", "createdAt", "lastModifiedAt", "code", "name" ], "type": "object" } } }, "description": "Successful request" } } } }, "/contractTypes/{id}/employmentContracts": { "get": { "operationId": "contractTypes_employmentContractsFor:from:limit:fields:", "parameters": [ { "allowEmptyValue": false, "deprecated": false, "schema": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "required": true, "in": "path", "description": "", "name": "id" }, { "allowEmptyValue": false, "deprecated": false, "schema": { "type": "string" }, "required": false, "in": "query", "description": "", "name": "pageToken" }, { "allowEmptyValue": false, "deprecated": false, "schema": { "type": "integer", "format": "int32" }, "required": false, "in": "query", "description": "", "name": "limit" }, { "allowEmptyValue": false, "deprecated": false, "schema": { "type": "array", "items": { "type": "string" } }, "required": false, "in": "query", "description": "", "name": "fields" } ], "deprecated": false, "responses": { "200": { "content": { "application/json": { "schema": { "format": "object", "properties": { "results": { "type": "array", "items": { "format": "object", "properties": { "id": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "interval": { "format": "object", "properties": { }, "required": [ ], "type": "object" }, "externalCode": { "type": "string" }, "createdAt": { "type": "string", "format": "timestamp" }, "contractTypeID": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "lastModifiedAt": { "type": "string", "format": "timestamp" }, "externalId": { "type": "string" }, "employmentID": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" } }, "required": [ "id", "createdAt", "lastModifiedAt", "employmentID", "interval", "contractTypeID" ], "type": "object" } }, "deltaToken": { "type": "string" }, "pageToken": { "type": "string" } }, "required": [ "results", "pageToken", "deltaToken" ], "type": "object" } } }, "description": "Successful request" } } } }, "/employmentContracts": { "get": { "tags": [ "EmploymentContract" ], "responses": { "200": { "content": { "application/json": { "schema": { "format": "object", "properties": { "results": { "type": "array", "items": { "format": "object", "properties": { "id": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "interval": { "format": "object", "properties": { }, "required": [ ], "type": "object" }, "externalCode": { "type": "string" }, "createdAt": { "type": "string", "format": "timestamp" }, "contractTypeID": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "lastModifiedAt": { "type": "string", "format": "timestamp" }, "externalId": { "type": "string" }, "employmentID": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" } }, "required": [ "id", "createdAt", "lastModifiedAt", "employmentID", "interval", "contractTypeID" ], "type": "object" } }, "deltaToken": { "type": "string" }, "pageToken": { "type": "string" } }, "required": [ "results", "pageToken", "deltaToken" ], "type": "object" } } }, "description": "Successful request" } }, "deprecated": false, "parameters": [ { "allowEmptyValue": false, "deprecated": false, "schema": { "type": "string" }, "required": false, "in": "query", "description": "", "name": "pageToken" }, { "allowEmptyValue": false, "deprecated": false, "schema": { "type": "integer", "format": "int32" }, "required": false, "in": "query", "description": "", "name": "limit" }, { "allowEmptyValue": false, "deprecated": false, "schema": { "type": "string" }, "required": false, "in": "query", "description": "", "name": "sinceDeltaToken" }, { "allowEmptyValue": false, "deprecated": false, "schema": { "type": "array", "items": { "type": "string" } }, "required": false, "in": "query", "description": "", "name": "fields" } ], "summary": "List all employmentContracts viewable for API user", "operationId": "employmentContractsFrom:limit:since:fields:" } }, "/employmentContracts/{id}": { "get": { "operationId": "employmentContractAt:", "parameters": [ { "allowEmptyValue": false, "deprecated": false, "schema": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "required": true, "in": "path", "description": "", "name": "id" } ], "deprecated": false, "responses": { "200": { "content": { "application/json": { "schema": { "format": "object", "properties": { "id": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "interval": { "format": "object", "properties": { }, "required": [ ], "type": "object" }, "externalCode": { "type": "string" }, "createdAt": { "type": "string", "format": "timestamp" }, "contractTypeID": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "lastModifiedAt": { "type": "string", "format": "timestamp" }, "externalId": { "type": "string" }, "employmentID": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" } }, "required": [ "id", "createdAt", "lastModifiedAt", "employmentID", "interval", "contractTypeID" ], "type": "object" } } }, "description": "Successful request" } } } }, "/employmentRelations": { "get": { "tags": [ "EmploymentRelation" ], "responses": { "200": { "content": { "application/json": { "schema": { "format": "object", "properties": { "results": { "type": "array", "items": { "format": "object", "properties": { "fromEmploymentID": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "lastModifiedAt": { "type": "string", "format": "timestamp" }, "createdAt": { "type": "string", "format": "timestamp" }, "interval": { "format": "object", "properties": { }, "required": [ ], "type": "object" }, "id": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "toEmploymentID": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" } }, "required": [ "id", "createdAt", "lastModifiedAt", "fromEmploymentID", "interval", "toEmploymentID" ], "type": "object" } }, "deltaToken": { "type": "string" }, "pageToken": { "type": "string" } }, "required": [ "results", "pageToken", "deltaToken" ], "type": "object" } } }, "description": "Successful request" } }, "deprecated": false, "parameters": [ { "allowEmptyValue": false, "deprecated": false, "schema": { "type": "string" }, "required": false, "in": "query", "description": "", "name": "pageToken" }, { "allowEmptyValue": false, "deprecated": false, "schema": { "type": "integer", "format": "int32" }, "required": false, "in": "query", "description": "", "name": "limit" }, { "allowEmptyValue": false, "deprecated": false, "schema": { "type": "string" }, "required": false, "in": "query", "description": "", "name": "sinceDeltaToken" }, { "allowEmptyValue": false, "deprecated": false, "schema": { "type": "array", "items": { "type": "string" } }, "required": false, "in": "query", "description": "", "name": "fields" } ], "summary": "List all employmentRelations viewable for API user", "operationId": "employmentRelationsFrom:limit:since:fields:" } }, "/employmentRelations/{id}": { "get": { "operationId": "employmentRelationAt:", "parameters": [ { "allowEmptyValue": false, "deprecated": false, "schema": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "required": true, "in": "path", "description": "", "name": "id" } ], "deprecated": false, "responses": { "200": { "content": { "application/json": { "schema": { "format": "object", "properties": { "fromEmploymentID": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "lastModifiedAt": { "type": "string", "format": "timestamp" }, "createdAt": { "type": "string", "format": "timestamp" }, "interval": { "format": "object", "properties": { }, "required": [ ], "type": "object" }, "id": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "toEmploymentID": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" } }, "required": [ "id", "createdAt", "lastModifiedAt", "fromEmploymentID", "interval", "toEmploymentID" ], "type": "object" } } }, "description": "Successful request" } } } }, "/employments": { "get": { "tags": [ "Employment" ], "responses": { "200": { "content": { "application/json": { "schema": { "format": "object", "properties": { "results": { "type": "array", "items": { "format": "object", "properties": { "externalCode": { "type": "string" }, "remark": { "type": "string" }, "id": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "employeeNumber": { "type": "string" }, "externalId": { "type": "string" }, "firstName": { "type": "string" }, "customValues": { "type": "object" }, "employmentContracts": { "type": "array", "items": { "format": "object", "properties": { "id": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "interval": { "format": "object", "properties": { }, "required": [ ], "type": "object" }, "externalCode": { "type": "string" }, "createdAt": { "type": "string", "format": "timestamp" }, "contractTypeID": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "lastModifiedAt": { "type": "string", "format": "timestamp" }, "externalId": { "type": "string" }, "employmentID": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" } }, "required": [ "id", "createdAt", "lastModifiedAt", "employmentID", "interval", "contractTypeID" ], "type": "object" } }, "email": { "type": "string" }, "createdAt": { "type": "string", "format": "timestamp" }, "surname": { "type": "string" }, "initials": { "type": "string" }, "relations": { "type": "array", "items": { "format": "object", "properties": { "fromEmploymentID": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "lastModifiedAt": { "type": "string", "format": "timestamp" }, "createdAt": { "type": "string", "format": "timestamp" }, "interval": { "format": "object", "properties": { }, "required": [ ], "type": "object" }, "id": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "toEmploymentID": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" } }, "required": [ "id", "createdAt", "lastModifiedAt", "fromEmploymentID", "interval", "toEmploymentID" ], "type": "object" } }, "birthDate": { "type": "string", "format": "date" }, "referringRelations": { "type": "array", "items": { "format": "object", "properties": { "fromEmploymentID": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "lastModifiedAt": { "type": "string", "format": "timestamp" }, "createdAt": { "type": "string", "format": "timestamp" }, "interval": { "format": "object", "properties": { }, "required": [ ], "type": "object" }, "id": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "toEmploymentID": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" } }, "required": [ "id", "createdAt", "lastModifiedAt", "fromEmploymentID", "interval", "toEmploymentID" ], "type": "object" } }, "employmentUnavailabilities": { "type": "array", "items": { "format": "object", "properties": { "reason": { "type": "string" }, "lastModifiedAt": { "type": "string", "format": "timestamp" }, "createdAt": { "type": "string", "format": "timestamp" }, "interval": { "format": "object", "properties": { }, "required": [ ], "type": "object" }, "id": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "employmentID": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" } }, "required": [ "id", "createdAt", "lastModifiedAt", "employmentID", "interval" ], "type": "object" } }, "positions": { "type": "array", "items": { "format": "object", "properties": { "id": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "interval": { "format": "object", "properties": { }, "required": [ ], "type": "object" }, "externalCode": { "type": "string" }, "createdAt": { "type": "string", "format": "timestamp" }, "externalId": { "type": "string" }, "lastModifiedAt": { "type": "string", "format": "timestamp" }, "employmentID": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "tagIDs": { "type": "array", "items": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" } } }, "required": [ "id", "createdAt", "lastModifiedAt", "employmentID", "interval", "tagIDs" ], "type": "object" } }, "lastModifiedAt": { "type": "string", "format": "timestamp" } }, "required": [ "id", "createdAt", "lastModifiedAt", "email", "surname", "customValues", "positions", "relations", "referringRelations", "employmentContracts", "employmentUnavailabilities" ], "type": "object" } }, "deltaToken": { "type": "string" }, "pageToken": { "type": "string" } }, "required": [ "results", "pageToken", "deltaToken" ], "type": "object" } } }, "description": "Successful request" } }, "deprecated": false, "parameters": [ { "allowEmptyValue": false, "deprecated": false, "schema": { "type": "string" }, "required": false, "in": "query", "description": "", "name": "pageToken" }, { "allowEmptyValue": false, "deprecated": false, "schema": { "type": "integer", "format": "int32" }, "required": false, "in": "query", "description": "", "name": "limit" }, { "allowEmptyValue": false, "deprecated": false, "schema": { "type": "string" }, "required": false, "in": "query", "description": "", "name": "sinceDeltaToken" }, { "allowEmptyValue": false, "deprecated": false, "schema": { "type": "array", "items": { "type": "string" } }, "required": false, "in": "query", "description": "", "name": "fields" } ], "summary": "List all employments viewable for API user", "operationId": "employmentsFrom:limit:since:fields:" } }, "/employments/{id}": { "get": { "operationId": "employmentAt:", "parameters": [ { "allowEmptyValue": false, "deprecated": false, "schema": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "required": true, "in": "path", "description": "", "name": "id" } ], "deprecated": false, "responses": { "200": { "content": { "application/json": { "schema": { "format": "object", "properties": { "externalCode": { "type": "string" }, "remark": { "type": "string" }, "id": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "employeeNumber": { "type": "string" }, "externalId": { "type": "string" }, "firstName": { "type": "string" }, "customValues": { "type": "object" }, "employmentContracts": { "type": "array", "items": { "format": "object", "properties": { "id": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "interval": { "format": "object", "properties": { }, "required": [ ], "type": "object" }, "externalCode": { "type": "string" }, "createdAt": { "type": "string", "format": "timestamp" }, "contractTypeID": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "lastModifiedAt": { "type": "string", "format": "timestamp" }, "externalId": { "type": "string" }, "employmentID": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" } }, "required": [ "id", "createdAt", "lastModifiedAt", "employmentID", "interval", "contractTypeID" ], "type": "object" } }, "email": { "type": "string" }, "createdAt": { "type": "string", "format": "timestamp" }, "surname": { "type": "string" }, "initials": { "type": "string" }, "relations": { "type": "array", "items": { "format": "object", "properties": { "fromEmploymentID": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "lastModifiedAt": { "type": "string", "format": "timestamp" }, "createdAt": { "type": "string", "format": "timestamp" }, "interval": { "format": "object", "properties": { }, "required": [ ], "type": "object" }, "id": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "toEmploymentID": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" } }, "required": [ "id", "createdAt", "lastModifiedAt", "fromEmploymentID", "interval", "toEmploymentID" ], "type": "object" } }, "birthDate": { "type": "string", "format": "date" }, "referringRelations": { "type": "array", "items": { "format": "object", "properties": { "fromEmploymentID": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "lastModifiedAt": { "type": "string", "format": "timestamp" }, "createdAt": { "type": "string", "format": "timestamp" }, "interval": { "format": "object", "properties": { }, "required": [ ], "type": "object" }, "id": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "toEmploymentID": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" } }, "required": [ "id", "createdAt", "lastModifiedAt", "fromEmploymentID", "interval", "toEmploymentID" ], "type": "object" } }, "employmentUnavailabilities": { "type": "array", "items": { "format": "object", "properties": { "reason": { "type": "string" }, "lastModifiedAt": { "type": "string", "format": "timestamp" }, "createdAt": { "type": "string", "format": "timestamp" }, "interval": { "format": "object", "properties": { }, "required": [ ], "type": "object" }, "id": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "employmentID": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" } }, "required": [ "id", "createdAt", "lastModifiedAt", "employmentID", "interval" ], "type": "object" } }, "positions": { "type": "array", "items": { "format": "object", "properties": { "id": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "interval": { "format": "object", "properties": { }, "required": [ ], "type": "object" }, "externalCode": { "type": "string" }, "createdAt": { "type": "string", "format": "timestamp" }, "externalId": { "type": "string" }, "lastModifiedAt": { "type": "string", "format": "timestamp" }, "employmentID": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "tagIDs": { "type": "array", "items": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" } } }, "required": [ "id", "createdAt", "lastModifiedAt", "employmentID", "interval", "tagIDs" ], "type": "object" } }, "lastModifiedAt": { "type": "string", "format": "timestamp" } }, "required": [ "id", "createdAt", "lastModifiedAt", "email", "surname", "customValues", "positions", "relations", "referringRelations", "employmentContracts", "employmentUnavailabilities" ], "type": "object" } } }, "description": "Successful request" } } } }, "/employments/{id}/achievements": { "get": { "operationId": "employments_achievementsFor:from:limit:fields:", "parameters": [ { "allowEmptyValue": false, "deprecated": false, "schema": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "required": true, "in": "path", "description": "", "name": "id" }, { "allowEmptyValue": false, "deprecated": false, "schema": { "type": "string" }, "required": false, "in": "query", "description": "", "name": "pageToken" }, { "allowEmptyValue": false, "deprecated": false, "schema": { "type": "integer", "format": "int32" }, "required": false, "in": "query", "description": "", "name": "limit" }, { "allowEmptyValue": false, "deprecated": false, "schema": { "type": "array", "items": { "type": "string" } }, "required": false, "in": "query", "description": "", "name": "fields" } ], "deprecated": false, "responses": { "200": { "content": { "application/json": { "schema": { "format": "object", "properties": { "results": { "type": "array", "items": { "format": "object", "properties": { "remark": { "type": "string" }, "lastModifiedAt": { "type": "string", "format": "timestamp" }, "id": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "issueDate": { "type": "string", "format": "date" }, "overriddenExpirationDate": { "type": "string", "format": "date" }, "qualificationID": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "evidenceVariantID": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "externalId": { "type": "string" }, "documents": { "type": "array", "items": { "format": "object", "properties": { "contentType": { "type": "string" }, "filename": { "type": "string" } }, "required": [ "filename", "contentType" ], "type": "object" } }, "externalCode": { "type": "string" }, "scoreOrder": { "type": "integer", "format": "int32" }, "submittedByID": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "approvedByID": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "isAutoAchieved": { "type": "boolean" }, "createdAt": { "type": "string", "format": "timestamp" }, "employmentID": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "expirationDate": { "type": "string", "format": "date" } }, "required": [ "id", "createdAt", "lastModifiedAt", "employmentID", "evidenceVariantID", "qualificationID", "scoreOrder", "issueDate", "expirationDate", "isAutoAchieved", "submittedByID", "approvedByID" ], "type": "object" } }, "deltaToken": { "type": "string" }, "pageToken": { "type": "string" } }, "required": [ "results", "pageToken", "deltaToken" ], "type": "object" } } }, "description": "Successful request" } } } }, "/employments/{id}/approvedAchievements": { "get": { "operationId": "employments_approvedAchievementsFor:from:limit:fields:", "parameters": [ { "allowEmptyValue": false, "deprecated": false, "schema": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "required": true, "in": "path", "description": "", "name": "id" }, { "allowEmptyValue": false, "deprecated": false, "schema": { "type": "string" }, "required": false, "in": "query", "description": "", "name": "pageToken" }, { "allowEmptyValue": false, "deprecated": false, "schema": { "type": "integer", "format": "int32" }, "required": false, "in": "query", "description": "", "name": "limit" }, { "allowEmptyValue": false, "deprecated": false, "schema": { "type": "array", "items": { "type": "string" } }, "required": false, "in": "query", "description": "", "name": "fields" } ], "deprecated": false, "responses": { "200": { "content": { "application/json": { "schema": { "format": "object", "properties": { "results": { "type": "array", "items": { "format": "object", "properties": { "remark": { "type": "string" }, "lastModifiedAt": { "type": "string", "format": "timestamp" }, "id": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "issueDate": { "type": "string", "format": "date" }, "overriddenExpirationDate": { "type": "string", "format": "date" }, "qualificationID": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "evidenceVariantID": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "externalId": { "type": "string" }, "documents": { "type": "array", "items": { "format": "object", "properties": { "contentType": { "type": "string" }, "filename": { "type": "string" } }, "required": [ "filename", "contentType" ], "type": "object" } }, "externalCode": { "type": "string" }, "scoreOrder": { "type": "integer", "format": "int32" }, "submittedByID": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "approvedByID": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "isAutoAchieved": { "type": "boolean" }, "createdAt": { "type": "string", "format": "timestamp" }, "employmentID": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "expirationDate": { "type": "string", "format": "date" } }, "required": [ "id", "createdAt", "lastModifiedAt", "employmentID", "evidenceVariantID", "qualificationID", "scoreOrder", "issueDate", "expirationDate", "isAutoAchieved", "submittedByID", "approvedByID" ], "type": "object" } }, "deltaToken": { "type": "string" }, "pageToken": { "type": "string" } }, "required": [ "results", "pageToken", "deltaToken" ], "type": "object" } } }, "description": "Successful request" } } } }, "/employments/{id}/inProgressEntries": { "get": { "operationId": "employments_inProgressEntriesFor:from:limit:fields:", "parameters": [ { "allowEmptyValue": false, "deprecated": false, "schema": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "required": true, "in": "path", "description": "", "name": "id" }, { "allowEmptyValue": false, "deprecated": false, "schema": { "type": "string" }, "required": false, "in": "query", "description": "", "name": "pageToken" }, { "allowEmptyValue": false, "deprecated": false, "schema": { "type": "integer", "format": "int32" }, "required": false, "in": "query", "description": "", "name": "limit" }, { "allowEmptyValue": false, "deprecated": false, "schema": { "type": "array", "items": { "type": "string" } }, "required": false, "in": "query", "description": "", "name": "fields" } ], "deprecated": false, "responses": { "200": { "content": { "application/json": { "schema": { "format": "object", "properties": { "results": { "type": "array", "items": { "format": "object", "properties": { "remark": { "type": "string" }, "toDate": { "type": "string", "format": "date" }, "lastModifiedAt": { "type": "string", "format": "timestamp" }, "id": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "plannedScoreOrder": { "type": "integer", "format": "int32" }, "closeDate": { "type": "string", "format": "date" }, "qualificationID": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "evidenceVariantID": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "externalId": { "type": "string" }, "externalCode": { "type": "string" }, "fromDate": { "type": "string", "format": "date" }, "createdAt": { "type": "string", "format": "timestamp" }, "employmentID": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "deadlineDate": { "type": "string", "format": "date" } }, "required": [ "id", "createdAt", "lastModifiedAt", "employmentID", "evidenceVariantID", "qualificationID", "plannedScoreOrder", "fromDate", "toDate" ], "type": "object" } }, "deltaToken": { "type": "string" }, "pageToken": { "type": "string" } }, "required": [ "results", "pageToken", "deltaToken" ], "type": "object" } } }, "description": "Successful request" } } } }, "/employments/{id}/positions": { "get": { "operationId": "employments_positionsFor:from:limit:fields:", "parameters": [ { "allowEmptyValue": false, "deprecated": false, "schema": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "required": true, "in": "path", "description": "", "name": "id" }, { "allowEmptyValue": false, "deprecated": false, "schema": { "type": "string" }, "required": false, "in": "query", "description": "", "name": "pageToken" }, { "allowEmptyValue": false, "deprecated": false, "schema": { "type": "integer", "format": "int32" }, "required": false, "in": "query", "description": "", "name": "limit" }, { "allowEmptyValue": false, "deprecated": false, "schema": { "type": "array", "items": { "type": "string" } }, "required": false, "in": "query", "description": "", "name": "fields" } ], "deprecated": false, "responses": { "200": { "content": { "application/json": { "schema": { "format": "object", "properties": { "results": { "type": "array", "items": { "format": "object", "properties": { "id": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "interval": { "format": "object", "properties": { }, "required": [ ], "type": "object" }, "externalCode": { "type": "string" }, "createdAt": { "type": "string", "format": "timestamp" }, "externalId": { "type": "string" }, "lastModifiedAt": { "type": "string", "format": "timestamp" }, "employmentID": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "tagIDs": { "type": "array", "items": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" } } }, "required": [ "id", "createdAt", "lastModifiedAt", "employmentID", "interval", "tagIDs" ], "type": "object" } }, "deltaToken": { "type": "string" }, "pageToken": { "type": "string" } }, "required": [ "results", "pageToken", "deltaToken" ], "type": "object" } } }, "description": "Successful request" } } } }, "/employments/{id}/referringRelations": { "get": { "operationId": "employments_referringRelationsFor:from:limit:fields:", "parameters": [ { "allowEmptyValue": false, "deprecated": false, "schema": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "required": true, "in": "path", "description": "", "name": "id" }, { "allowEmptyValue": false, "deprecated": false, "schema": { "type": "string" }, "required": false, "in": "query", "description": "", "name": "pageToken" }, { "allowEmptyValue": false, "deprecated": false, "schema": { "type": "integer", "format": "int32" }, "required": false, "in": "query", "description": "", "name": "limit" }, { "allowEmptyValue": false, "deprecated": false, "schema": { "type": "array", "items": { "type": "string" } }, "required": false, "in": "query", "description": "", "name": "fields" } ], "deprecated": false, "responses": { "200": { "content": { "application/json": { "schema": { "format": "object", "properties": { "results": { "type": "array", "items": { "format": "object", "properties": { "fromEmploymentID": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "lastModifiedAt": { "type": "string", "format": "timestamp" }, "createdAt": { "type": "string", "format": "timestamp" }, "interval": { "format": "object", "properties": { }, "required": [ ], "type": "object" }, "id": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "toEmploymentID": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" } }, "required": [ "id", "createdAt", "lastModifiedAt", "fromEmploymentID", "interval", "toEmploymentID" ], "type": "object" } }, "deltaToken": { "type": "string" }, "pageToken": { "type": "string" } }, "required": [ "results", "pageToken", "deltaToken" ], "type": "object" } } }, "description": "Successful request" } } } }, "/employments/{id}/submittedAchievements": { "get": { "operationId": "employments_submittedAchievementsFor:from:limit:fields:", "parameters": [ { "allowEmptyValue": false, "deprecated": false, "schema": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "required": true, "in": "path", "description": "", "name": "id" }, { "allowEmptyValue": false, "deprecated": false, "schema": { "type": "string" }, "required": false, "in": "query", "description": "", "name": "pageToken" }, { "allowEmptyValue": false, "deprecated": false, "schema": { "type": "integer", "format": "int32" }, "required": false, "in": "query", "description": "", "name": "limit" }, { "allowEmptyValue": false, "deprecated": false, "schema": { "type": "array", "items": { "type": "string" } }, "required": false, "in": "query", "description": "", "name": "fields" } ], "deprecated": false, "responses": { "200": { "content": { "application/json": { "schema": { "format": "object", "properties": { "results": { "type": "array", "items": { "format": "object", "properties": { "remark": { "type": "string" }, "lastModifiedAt": { "type": "string", "format": "timestamp" }, "id": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "issueDate": { "type": "string", "format": "date" }, "overriddenExpirationDate": { "type": "string", "format": "date" }, "qualificationID": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "evidenceVariantID": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "externalId": { "type": "string" }, "documents": { "type": "array", "items": { "format": "object", "properties": { "contentType": { "type": "string" }, "filename": { "type": "string" } }, "required": [ "filename", "contentType" ], "type": "object" } }, "externalCode": { "type": "string" }, "scoreOrder": { "type": "integer", "format": "int32" }, "submittedByID": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "approvedByID": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "isAutoAchieved": { "type": "boolean" }, "createdAt": { "type": "string", "format": "timestamp" }, "employmentID": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "expirationDate": { "type": "string", "format": "date" } }, "required": [ "id", "createdAt", "lastModifiedAt", "employmentID", "evidenceVariantID", "qualificationID", "scoreOrder", "issueDate", "expirationDate", "isAutoAchieved", "submittedByID", "approvedByID" ], "type": "object" } }, "deltaToken": { "type": "string" }, "pageToken": { "type": "string" } }, "required": [ "results", "pageToken", "deltaToken" ], "type": "object" } } }, "description": "Successful request" } } } }, "/employmentUnavailabilities": { "get": { "tags": [ "EmploymentUnavailability" ], "responses": { "200": { "content": { "application/json": { "schema": { "format": "object", "properties": { "results": { "type": "array", "items": { "format": "object", "properties": { "reason": { "type": "string" }, "lastModifiedAt": { "type": "string", "format": "timestamp" }, "createdAt": { "type": "string", "format": "timestamp" }, "interval": { "format": "object", "properties": { }, "required": [ ], "type": "object" }, "id": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "employmentID": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" } }, "required": [ "id", "createdAt", "lastModifiedAt", "employmentID", "interval" ], "type": "object" } }, "deltaToken": { "type": "string" }, "pageToken": { "type": "string" } }, "required": [ "results", "pageToken", "deltaToken" ], "type": "object" } } }, "description": "Successful request" } }, "deprecated": false, "parameters": [ { "allowEmptyValue": false, "deprecated": false, "schema": { "type": "string" }, "required": false, "in": "query", "description": "", "name": "pageToken" }, { "allowEmptyValue": false, "deprecated": false, "schema": { "type": "integer", "format": "int32" }, "required": false, "in": "query", "description": "", "name": "limit" }, { "allowEmptyValue": false, "deprecated": false, "schema": { "type": "string" }, "required": false, "in": "query", "description": "", "name": "sinceDeltaToken" }, { "allowEmptyValue": false, "deprecated": false, "schema": { "type": "array", "items": { "type": "string" } }, "required": false, "in": "query", "description": "", "name": "fields" } ], "summary": "List all employmentUnavailabilities viewable for API user", "operationId": "employmentUnavailabilitiesFrom:limit:since:fields:" } }, "/employmentUnavailabilities/{id}": { "get": { "operationId": "employmentUnavailabilityAt:", "parameters": [ { "allowEmptyValue": false, "deprecated": false, "schema": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "required": true, "in": "path", "description": "", "name": "id" } ], "deprecated": false, "responses": { "200": { "content": { "application/json": { "schema": { "format": "object", "properties": { "reason": { "type": "string" }, "lastModifiedAt": { "type": "string", "format": "timestamp" }, "createdAt": { "type": "string", "format": "timestamp" }, "interval": { "format": "object", "properties": { }, "required": [ ], "type": "object" }, "id": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "employmentID": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" } }, "required": [ "id", "createdAt", "lastModifiedAt", "employmentID", "interval" ], "type": "object" } } }, "description": "Successful request" } } } }, "/evidenceVariants": { "get": { "tags": [ "EvidenceVariant" ], "responses": { "200": { "content": { "application/json": { "schema": { "format": "object", "properties": { "results": { "type": "array", "items": { "format": "object", "properties": { "qualificationID": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "lastModifiedAt": { "type": "string", "format": "timestamp" }, "externalCode": { "type": "string" }, "createdAt": { "type": "string", "format": "timestamp" }, "externalId": { "type": "string" }, "id": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "code": { "type": "string" }, "name": { "type": "string" }, "interval": { "format": "object", "properties": { }, "required": [ ], "type": "object" } }, "required": [ "id", "createdAt", "lastModifiedAt", "interval", "name", "qualificationID" ], "type": "object" } }, "deltaToken": { "type": "string" }, "pageToken": { "type": "string" } }, "required": [ "results", "pageToken", "deltaToken" ], "type": "object" } } }, "description": "Successful request" } }, "deprecated": false, "parameters": [ { "allowEmptyValue": false, "deprecated": false, "schema": { "type": "string" }, "required": false, "in": "query", "description": "", "name": "pageToken" }, { "allowEmptyValue": false, "deprecated": false, "schema": { "type": "integer", "format": "int32" }, "required": false, "in": "query", "description": "", "name": "limit" }, { "allowEmptyValue": false, "deprecated": false, "schema": { "type": "string" }, "required": false, "in": "query", "description": "", "name": "sinceDeltaToken" }, { "allowEmptyValue": false, "deprecated": false, "schema": { "type": "array", "items": { "type": "string" } }, "required": false, "in": "query", "description": "", "name": "fields" } ], "summary": "List all evidenceVariants viewable for API user", "operationId": "evidenceVariantsFrom:limit:since:fields:" } }, "/evidenceVariants/{id}": { "get": { "operationId": "evidenceVariantAt:", "parameters": [ { "allowEmptyValue": false, "deprecated": false, "schema": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "required": true, "in": "path", "description": "", "name": "id" } ], "deprecated": false, "responses": { "200": { "content": { "application/json": { "schema": { "format": "object", "properties": { "qualificationID": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "lastModifiedAt": { "type": "string", "format": "timestamp" }, "externalCode": { "type": "string" }, "createdAt": { "type": "string", "format": "timestamp" }, "externalId": { "type": "string" }, "id": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "code": { "type": "string" }, "name": { "type": "string" }, "interval": { "format": "object", "properties": { }, "required": [ ], "type": "object" } }, "required": [ "id", "createdAt", "lastModifiedAt", "interval", "name", "qualificationID" ], "type": "object" } } }, "description": "Successful request" } } } }, "/evidenceVariants/{id}/achievements": { "get": { "operationId": "evidenceVariants_achievementsFor:from:limit:fields:", "parameters": [ { "allowEmptyValue": false, "deprecated": false, "schema": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "required": true, "in": "path", "description": "", "name": "id" }, { "allowEmptyValue": false, "deprecated": false, "schema": { "type": "string" }, "required": false, "in": "query", "description": "", "name": "pageToken" }, { "allowEmptyValue": false, "deprecated": false, "schema": { "type": "integer", "format": "int32" }, "required": false, "in": "query", "description": "", "name": "limit" }, { "allowEmptyValue": false, "deprecated": false, "schema": { "type": "array", "items": { "type": "string" } }, "required": false, "in": "query", "description": "", "name": "fields" } ], "deprecated": false, "responses": { "200": { "content": { "application/json": { "schema": { "format": "object", "properties": { "results": { "type": "array", "items": { "format": "object", "properties": { "remark": { "type": "string" }, "lastModifiedAt": { "type": "string", "format": "timestamp" }, "id": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "issueDate": { "type": "string", "format": "date" }, "overriddenExpirationDate": { "type": "string", "format": "date" }, "qualificationID": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "evidenceVariantID": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "externalId": { "type": "string" }, "documents": { "type": "array", "items": { "format": "object", "properties": { "contentType": { "type": "string" }, "filename": { "type": "string" } }, "required": [ "filename", "contentType" ], "type": "object" } }, "externalCode": { "type": "string" }, "scoreOrder": { "type": "integer", "format": "int32" }, "submittedByID": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "approvedByID": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "isAutoAchieved": { "type": "boolean" }, "createdAt": { "type": "string", "format": "timestamp" }, "employmentID": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "expirationDate": { "type": "string", "format": "date" } }, "required": [ "id", "createdAt", "lastModifiedAt", "employmentID", "evidenceVariantID", "qualificationID", "scoreOrder", "issueDate", "expirationDate", "isAutoAchieved", "submittedByID", "approvedByID" ], "type": "object" } }, "deltaToken": { "type": "string" }, "pageToken": { "type": "string" } }, "required": [ "results", "pageToken", "deltaToken" ], "type": "object" } } }, "description": "Successful request" } } } }, "/evidenceVariants/{id}/inProgressEntries": { "get": { "operationId": "evidenceVariants_inProgressEntriesFor:from:limit:fields:", "parameters": [ { "allowEmptyValue": false, "deprecated": false, "schema": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "required": true, "in": "path", "description": "", "name": "id" }, { "allowEmptyValue": false, "deprecated": false, "schema": { "type": "string" }, "required": false, "in": "query", "description": "", "name": "pageToken" }, { "allowEmptyValue": false, "deprecated": false, "schema": { "type": "integer", "format": "int32" }, "required": false, "in": "query", "description": "", "name": "limit" }, { "allowEmptyValue": false, "deprecated": false, "schema": { "type": "array", "items": { "type": "string" } }, "required": false, "in": "query", "description": "", "name": "fields" } ], "deprecated": false, "responses": { "200": { "content": { "application/json": { "schema": { "format": "object", "properties": { "results": { "type": "array", "items": { "format": "object", "properties": { "remark": { "type": "string" }, "toDate": { "type": "string", "format": "date" }, "lastModifiedAt": { "type": "string", "format": "timestamp" }, "id": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "plannedScoreOrder": { "type": "integer", "format": "int32" }, "closeDate": { "type": "string", "format": "date" }, "qualificationID": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "evidenceVariantID": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "externalId": { "type": "string" }, "externalCode": { "type": "string" }, "fromDate": { "type": "string", "format": "date" }, "createdAt": { "type": "string", "format": "timestamp" }, "employmentID": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "deadlineDate": { "type": "string", "format": "date" } }, "required": [ "id", "createdAt", "lastModifiedAt", "employmentID", "evidenceVariantID", "qualificationID", "plannedScoreOrder", "fromDate", "toDate" ], "type": "object" } }, "deltaToken": { "type": "string" }, "pageToken": { "type": "string" } }, "required": [ "results", "pageToken", "deltaToken" ], "type": "object" } } }, "description": "Successful request" } } } }, "/groupings": { "get": { "tags": [ "Grouping" ], "responses": { "200": { "content": { "application/json": { "schema": { "format": "object", "properties": { "results": { "type": "array", "items": { "format": "object", "properties": { "code": { "type": "string" }, "lastModifiedAt": { "type": "string", "format": "timestamp" }, "typeID": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "externalCode": { "type": "string" }, "createdAt": { "type": "string", "format": "timestamp" }, "description": { "type": "string" }, "externalId": { "type": "string" }, "id": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "name": { "type": "string" }, "definedInGroupingID": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "interval": { "format": "object", "properties": { }, "required": [ ], "type": "object" } }, "required": [ "id", "createdAt", "lastModifiedAt", "definedInGroupingID", "interval", "code", "name", "typeID" ], "type": "object" } }, "deltaToken": { "type": "string" }, "pageToken": { "type": "string" } }, "required": [ "results", "pageToken", "deltaToken" ], "type": "object" } } }, "description": "Successful request" } }, "deprecated": false, "parameters": [ { "allowEmptyValue": false, "deprecated": false, "schema": { "type": "string" }, "required": false, "in": "query", "description": "", "name": "pageToken" }, { "allowEmptyValue": false, "deprecated": false, "schema": { "type": "integer", "format": "int32" }, "required": false, "in": "query", "description": "", "name": "limit" }, { "allowEmptyValue": false, "deprecated": false, "schema": { "type": "string" }, "required": false, "in": "query", "description": "", "name": "sinceDeltaToken" }, { "allowEmptyValue": false, "deprecated": false, "schema": { "type": "array", "items": { "type": "string" } }, "required": false, "in": "query", "description": "", "name": "fields" } ], "summary": "List all groupings viewable for API user", "operationId": "groupingsFrom:limit:since:fields:" } }, "/groupings/{id}": { "get": { "operationId": "groupingAt:", "parameters": [ { "allowEmptyValue": false, "deprecated": false, "schema": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "required": true, "in": "path", "description": "", "name": "id" } ], "deprecated": false, "responses": { "200": { "content": { "application/json": { "schema": { "format": "object", "properties": { "code": { "type": "string" }, "lastModifiedAt": { "type": "string", "format": "timestamp" }, "typeID": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "externalCode": { "type": "string" }, "createdAt": { "type": "string", "format": "timestamp" }, "description": { "type": "string" }, "externalId": { "type": "string" }, "id": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "name": { "type": "string" }, "definedInGroupingID": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "interval": { "format": "object", "properties": { }, "required": [ ], "type": "object" } }, "required": [ "id", "createdAt", "lastModifiedAt", "definedInGroupingID", "interval", "code", "name", "typeID" ], "type": "object" } } }, "description": "Successful request" } } } }, "/groupings/{id}/definedGroupings": { "get": { "operationId": "groupings_definedGroupingsFor:from:limit:fields:", "parameters": [ { "allowEmptyValue": false, "deprecated": false, "schema": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "required": true, "in": "path", "description": "", "name": "id" }, { "allowEmptyValue": false, "deprecated": false, "schema": { "type": "string" }, "required": false, "in": "query", "description": "", "name": "pageToken" }, { "allowEmptyValue": false, "deprecated": false, "schema": { "type": "integer", "format": "int32" }, "required": false, "in": "query", "description": "", "name": "limit" }, { "allowEmptyValue": false, "deprecated": false, "schema": { "type": "array", "items": { "type": "string" } }, "required": false, "in": "query", "description": "", "name": "fields" } ], "deprecated": false, "responses": { "200": { "content": { "application/json": { "schema": { "format": "object", "properties": { "results": { "type": "array", "items": { "format": "object", "properties": { "code": { "type": "string" }, "lastModifiedAt": { "type": "string", "format": "timestamp" }, "typeID": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "externalCode": { "type": "string" }, "createdAt": { "type": "string", "format": "timestamp" }, "description": { "type": "string" }, "externalId": { "type": "string" }, "id": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "name": { "type": "string" }, "definedInGroupingID": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "interval": { "format": "object", "properties": { }, "required": [ ], "type": "object" } }, "required": [ "id", "createdAt", "lastModifiedAt", "definedInGroupingID", "interval", "code", "name", "typeID" ], "type": "object" } }, "deltaToken": { "type": "string" }, "pageToken": { "type": "string" } }, "required": [ "results", "pageToken", "deltaToken" ], "type": "object" } } }, "description": "Successful request" } } } }, "/groupingTypes": { "get": { "tags": [ "GroupingType" ], "responses": { "200": { "content": { "application/json": { "schema": { "format": "object", "properties": { "results": { "type": "array", "items": { "format": "object", "properties": { "name": { "type": "string" }, "externalCode": { "type": "string" }, "lastModifiedAt": { "type": "string", "format": "timestamp" }, "createdAt": { "type": "string", "format": "timestamp" }, "externalId": { "type": "string" }, "id": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "code": { "type": "string" } }, "required": [ "id", "createdAt", "lastModifiedAt", "code", "name" ], "type": "object" } }, "deltaToken": { "type": "string" }, "pageToken": { "type": "string" } }, "required": [ "results", "pageToken", "deltaToken" ], "type": "object" } } }, "description": "Successful request" } }, "deprecated": false, "parameters": [ { "allowEmptyValue": false, "deprecated": false, "schema": { "type": "string" }, "required": false, "in": "query", "description": "", "name": "pageToken" }, { "allowEmptyValue": false, "deprecated": false, "schema": { "type": "integer", "format": "int32" }, "required": false, "in": "query", "description": "", "name": "limit" }, { "allowEmptyValue": false, "deprecated": false, "schema": { "type": "string" }, "required": false, "in": "query", "description": "", "name": "sinceDeltaToken" }, { "allowEmptyValue": false, "deprecated": false, "schema": { "type": "array", "items": { "type": "string" } }, "required": false, "in": "query", "description": "", "name": "fields" } ], "summary": "List all groupingTypes viewable for API user", "operationId": "groupingTypesFrom:limit:since:fields:" } }, "/groupingTypes/{id}": { "get": { "operationId": "groupingTypeAt:", "parameters": [ { "allowEmptyValue": false, "deprecated": false, "schema": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "required": true, "in": "path", "description": "", "name": "id" } ], "deprecated": false, "responses": { "200": { "content": { "application/json": { "schema": { "format": "object", "properties": { "name": { "type": "string" }, "externalCode": { "type": "string" }, "lastModifiedAt": { "type": "string", "format": "timestamp" }, "createdAt": { "type": "string", "format": "timestamp" }, "externalId": { "type": "string" }, "id": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "code": { "type": "string" } }, "required": [ "id", "createdAt", "lastModifiedAt", "code", "name" ], "type": "object" } } }, "description": "Successful request" } } } }, "/groupingTypes/{id}/instances": { "get": { "operationId": "groupingTypes_instancesFor:from:limit:fields:", "parameters": [ { "allowEmptyValue": false, "deprecated": false, "schema": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "required": true, "in": "path", "description": "", "name": "id" }, { "allowEmptyValue": false, "deprecated": false, "schema": { "type": "string" }, "required": false, "in": "query", "description": "", "name": "pageToken" }, { "allowEmptyValue": false, "deprecated": false, "schema": { "type": "integer", "format": "int32" }, "required": false, "in": "query", "description": "", "name": "limit" }, { "allowEmptyValue": false, "deprecated": false, "schema": { "type": "array", "items": { "type": "string" } }, "required": false, "in": "query", "description": "", "name": "fields" } ], "deprecated": false, "responses": { "200": { "content": { "application/json": { "schema": { "format": "object", "properties": { "results": { "type": "array", "items": { "format": "object", "properties": { "code": { "type": "string" }, "lastModifiedAt": { "type": "string", "format": "timestamp" }, "typeID": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "externalCode": { "type": "string" }, "createdAt": { "type": "string", "format": "timestamp" }, "description": { "type": "string" }, "externalId": { "type": "string" }, "id": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "name": { "type": "string" }, "definedInGroupingID": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "interval": { "format": "object", "properties": { }, "required": [ ], "type": "object" } }, "required": [ "id", "createdAt", "lastModifiedAt", "definedInGroupingID", "interval", "code", "name", "typeID" ], "type": "object" } }, "deltaToken": { "type": "string" }, "pageToken": { "type": "string" } }, "required": [ "results", "pageToken", "deltaToken" ], "type": "object" } } }, "description": "Successful request" } } } }, "/inProgressEntries": { "get": { "tags": [ "InProgressEntry" ], "responses": { "200": { "content": { "application/json": { "schema": { "format": "object", "properties": { "results": { "type": "array", "items": { "format": "object", "properties": { "remark": { "type": "string" }, "toDate": { "type": "string", "format": "date" }, "lastModifiedAt": { "type": "string", "format": "timestamp" }, "id": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "plannedScoreOrder": { "type": "integer", "format": "int32" }, "closeDate": { "type": "string", "format": "date" }, "qualificationID": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "evidenceVariantID": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "externalId": { "type": "string" }, "externalCode": { "type": "string" }, "fromDate": { "type": "string", "format": "date" }, "createdAt": { "type": "string", "format": "timestamp" }, "employmentID": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "deadlineDate": { "type": "string", "format": "date" } }, "required": [ "id", "createdAt", "lastModifiedAt", "employmentID", "evidenceVariantID", "qualificationID", "plannedScoreOrder", "fromDate", "toDate" ], "type": "object" } }, "deltaToken": { "type": "string" }, "pageToken": { "type": "string" } }, "required": [ "results", "pageToken", "deltaToken" ], "type": "object" } } }, "description": "Successful request" } }, "deprecated": false, "parameters": [ { "allowEmptyValue": false, "deprecated": false, "schema": { "type": "string" }, "required": false, "in": "query", "description": "", "name": "pageToken" }, { "allowEmptyValue": false, "deprecated": false, "schema": { "type": "integer", "format": "int32" }, "required": false, "in": "query", "description": "", "name": "limit" }, { "allowEmptyValue": false, "deprecated": false, "schema": { "type": "string" }, "required": false, "in": "query", "description": "", "name": "sinceDeltaToken" }, { "allowEmptyValue": false, "deprecated": false, "schema": { "type": "array", "items": { "type": "string" } }, "required": false, "in": "query", "description": "", "name": "fields" } ], "summary": "List all inProgressEntries viewable for API user", "operationId": "inProgressEntriesFrom:limit:since:fields:" } }, "/inProgressEntries/{id}": { "get": { "operationId": "inProgressEntryAt:", "parameters": [ { "allowEmptyValue": false, "deprecated": false, "schema": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "required": true, "in": "path", "description": "", "name": "id" } ], "deprecated": false, "responses": { "200": { "content": { "application/json": { "schema": { "format": "object", "properties": { "remark": { "type": "string" }, "toDate": { "type": "string", "format": "date" }, "lastModifiedAt": { "type": "string", "format": "timestamp" }, "id": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "plannedScoreOrder": { "type": "integer", "format": "int32" }, "closeDate": { "type": "string", "format": "date" }, "qualificationID": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "evidenceVariantID": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "externalId": { "type": "string" }, "externalCode": { "type": "string" }, "fromDate": { "type": "string", "format": "date" }, "createdAt": { "type": "string", "format": "timestamp" }, "employmentID": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "deadlineDate": { "type": "string", "format": "date" } }, "required": [ "id", "createdAt", "lastModifiedAt", "employmentID", "evidenceVariantID", "qualificationID", "plannedScoreOrder", "fromDate", "toDate" ], "type": "object" } } }, "description": "Successful request" } } } }, "/measurementSystems": { "get": { "tags": [ "MeasurementSystem" ], "responses": { "200": { "content": { "application/json": { "schema": { "format": "object", "properties": { "results": { "type": "array", "items": { "format": "object", "properties": { "measurementValues": { "type": "array", "items": { "format": "object", "properties": { "id": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "order": { "type": "integer", "format": "int32" }, "externalCode": { "type": "string" }, "createdAt": { "type": "string", "format": "timestamp" }, "externalId": { "type": "string" }, "lastModifiedAt": { "type": "string", "format": "timestamp" }, "code": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "createdAt", "lastModifiedAt", "code", "name", "order" ], "type": "object" } }, "id": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "externalCode": { "type": "string" }, "createdAt": { "type": "string", "format": "timestamp" }, "externalId": { "type": "string" }, "lastModifiedAt": { "type": "string", "format": "timestamp" }, "scale": { "type": "integer", "format": "int32" }, "name": { "type": "string" } }, "required": [ "id", "createdAt", "lastModifiedAt", "name", "scale", "measurementValues" ], "type": "object" } }, "deltaToken": { "type": "string" }, "pageToken": { "type": "string" } }, "required": [ "results", "pageToken", "deltaToken" ], "type": "object" } } }, "description": "Successful request" } }, "deprecated": false, "parameters": [ { "allowEmptyValue": false, "deprecated": false, "schema": { "type": "string" }, "required": false, "in": "query", "description": "", "name": "pageToken" }, { "allowEmptyValue": false, "deprecated": false, "schema": { "type": "integer", "format": "int32" }, "required": false, "in": "query", "description": "", "name": "limit" }, { "allowEmptyValue": false, "deprecated": false, "schema": { "type": "string" }, "required": false, "in": "query", "description": "", "name": "sinceDeltaToken" }, { "allowEmptyValue": false, "deprecated": false, "schema": { "type": "array", "items": { "type": "string" } }, "required": false, "in": "query", "description": "", "name": "fields" } ], "summary": "List all measurementSystems viewable for API user", "operationId": "measurementSystemsFrom:limit:since:fields:" } }, "/measurementSystems/{id}": { "get": { "operationId": "measurementSystemAt:", "parameters": [ { "allowEmptyValue": false, "deprecated": false, "schema": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "required": true, "in": "path", "description": "", "name": "id" } ], "deprecated": false, "responses": { "200": { "content": { "application/json": { "schema": { "format": "object", "properties": { "measurementValues": { "type": "array", "items": { "format": "object", "properties": { "id": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "order": { "type": "integer", "format": "int32" }, "externalCode": { "type": "string" }, "createdAt": { "type": "string", "format": "timestamp" }, "externalId": { "type": "string" }, "lastModifiedAt": { "type": "string", "format": "timestamp" }, "code": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "createdAt", "lastModifiedAt", "code", "name", "order" ], "type": "object" } }, "id": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "externalCode": { "type": "string" }, "createdAt": { "type": "string", "format": "timestamp" }, "externalId": { "type": "string" }, "lastModifiedAt": { "type": "string", "format": "timestamp" }, "scale": { "type": "integer", "format": "int32" }, "name": { "type": "string" } }, "required": [ "id", "createdAt", "lastModifiedAt", "name", "scale", "measurementValues" ], "type": "object" } } }, "description": "Successful request" } } } }, "/measurementSystems/{id}/qualifications": { "get": { "operationId": "measurementSystems_qualificationsFor:from:limit:fields:", "parameters": [ { "allowEmptyValue": false, "deprecated": false, "schema": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "required": true, "in": "path", "description": "", "name": "id" }, { "allowEmptyValue": false, "deprecated": false, "schema": { "type": "string" }, "required": false, "in": "query", "description": "", "name": "pageToken" }, { "allowEmptyValue": false, "deprecated": false, "schema": { "type": "integer", "format": "int32" }, "required": false, "in": "query", "description": "", "name": "limit" }, { "allowEmptyValue": false, "deprecated": false, "schema": { "type": "array", "items": { "type": "string" } }, "required": false, "in": "query", "description": "", "name": "fields" } ], "deprecated": false, "responses": { "200": { "content": { "application/json": { "schema": { "format": "object", "properties": { "results": { "type": "array", "items": { "format": "object", "properties": { "interval": { "format": "object", "properties": { }, "required": [ ], "type": "object" }, "description": { "type": "string" }, "createdAt": { "type": "string", "format": "timestamp" }, "id": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "externalCode": { "type": "string" }, "evidenceVariants": { "type": "array", "items": { "format": "object", "properties": { "qualificationID": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "lastModifiedAt": { "type": "string", "format": "timestamp" }, "externalCode": { "type": "string" }, "createdAt": { "type": "string", "format": "timestamp" }, "externalId": { "type": "string" }, "id": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "code": { "type": "string" }, "name": { "type": "string" }, "interval": { "format": "object", "properties": { }, "required": [ ], "type": "object" } }, "required": [ "id", "createdAt", "lastModifiedAt", "interval", "name", "qualificationID" ], "type": "object" } }, "lastModifiedAt": { "type": "string", "format": "timestamp" }, "qualificationTypeID": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "measurementSystemID": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "name": { "type": "string" }, "externalId": { "type": "string" }, "code": { "type": "string" } }, "required": [ "id", "createdAt", "lastModifiedAt", "interval", "name", "qualificationTypeID", "measurementSystemID", "evidenceVariants" ], "type": "object" } }, "deltaToken": { "type": "string" }, "pageToken": { "type": "string" } }, "required": [ "results", "pageToken", "deltaToken" ], "type": "object" } } }, "description": "Successful request" } } } }, "/measurementValues": { "get": { "tags": [ "MeasurementValue" ], "responses": { "200": { "content": { "application/json": { "schema": { "format": "object", "properties": { "results": { "type": "array", "items": { "format": "object", "properties": { "id": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "order": { "type": "integer", "format": "int32" }, "externalCode": { "type": "string" }, "createdAt": { "type": "string", "format": "timestamp" }, "externalId": { "type": "string" }, "lastModifiedAt": { "type": "string", "format": "timestamp" }, "code": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "createdAt", "lastModifiedAt", "code", "name", "order" ], "type": "object" } }, "deltaToken": { "type": "string" }, "pageToken": { "type": "string" } }, "required": [ "results", "pageToken", "deltaToken" ], "type": "object" } } }, "description": "Successful request" } }, "deprecated": false, "parameters": [ { "allowEmptyValue": false, "deprecated": false, "schema": { "type": "string" }, "required": false, "in": "query", "description": "", "name": "pageToken" }, { "allowEmptyValue": false, "deprecated": false, "schema": { "type": "integer", "format": "int32" }, "required": false, "in": "query", "description": "", "name": "limit" }, { "allowEmptyValue": false, "deprecated": false, "schema": { "type": "string" }, "required": false, "in": "query", "description": "", "name": "sinceDeltaToken" }, { "allowEmptyValue": false, "deprecated": false, "schema": { "type": "array", "items": { "type": "string" } }, "required": false, "in": "query", "description": "", "name": "fields" } ], "summary": "List all measurementValues viewable for API user", "operationId": "measurementValuesFrom:limit:since:fields:" } }, "/measurementValues/{id}": { "get": { "operationId": "measurementValueAt:", "parameters": [ { "allowEmptyValue": false, "deprecated": false, "schema": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "required": true, "in": "path", "description": "", "name": "id" } ], "deprecated": false, "responses": { "200": { "content": { "application/json": { "schema": { "format": "object", "properties": { "id": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "order": { "type": "integer", "format": "int32" }, "externalCode": { "type": "string" }, "createdAt": { "type": "string", "format": "timestamp" }, "externalId": { "type": "string" }, "lastModifiedAt": { "type": "string", "format": "timestamp" }, "code": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "createdAt", "lastModifiedAt", "code", "name", "order" ], "type": "object" } } }, "description": "Successful request" } } } }, "/positions": { "get": { "tags": [ "Position" ], "responses": { "200": { "content": { "application/json": { "schema": { "format": "object", "properties": { "results": { "type": "array", "items": { "format": "object", "properties": { "id": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "interval": { "format": "object", "properties": { }, "required": [ ], "type": "object" }, "externalCode": { "type": "string" }, "createdAt": { "type": "string", "format": "timestamp" }, "externalId": { "type": "string" }, "lastModifiedAt": { "type": "string", "format": "timestamp" }, "employmentID": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "tagIDs": { "type": "array", "items": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" } } }, "required": [ "id", "createdAt", "lastModifiedAt", "employmentID", "interval", "tagIDs" ], "type": "object" } }, "deltaToken": { "type": "string" }, "pageToken": { "type": "string" } }, "required": [ "results", "pageToken", "deltaToken" ], "type": "object" } } }, "description": "Successful request" } }, "deprecated": false, "parameters": [ { "allowEmptyValue": false, "deprecated": false, "schema": { "type": "string" }, "required": false, "in": "query", "description": "", "name": "pageToken" }, { "allowEmptyValue": false, "deprecated": false, "schema": { "type": "integer", "format": "int32" }, "required": false, "in": "query", "description": "", "name": "limit" }, { "allowEmptyValue": false, "deprecated": false, "schema": { "type": "string" }, "required": false, "in": "query", "description": "", "name": "sinceDeltaToken" }, { "allowEmptyValue": false, "deprecated": false, "schema": { "type": "array", "items": { "type": "string" } }, "required": false, "in": "query", "description": "", "name": "fields" } ], "summary": "List all positions viewable for API user", "operationId": "positionsFrom:limit:since:fields:" } }, "/positions/{id}": { "get": { "operationId": "positionAt:", "parameters": [ { "allowEmptyValue": false, "deprecated": false, "schema": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "required": true, "in": "path", "description": "", "name": "id" } ], "deprecated": false, "responses": { "200": { "content": { "application/json": { "schema": { "format": "object", "properties": { "id": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "interval": { "format": "object", "properties": { }, "required": [ ], "type": "object" }, "externalCode": { "type": "string" }, "createdAt": { "type": "string", "format": "timestamp" }, "externalId": { "type": "string" }, "lastModifiedAt": { "type": "string", "format": "timestamp" }, "employmentID": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "tagIDs": { "type": "array", "items": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" } } }, "required": [ "id", "createdAt", "lastModifiedAt", "employmentID", "interval", "tagIDs" ], "type": "object" } } }, "description": "Successful request" } } } }, "/qualifications": { "get": { "tags": [ "Qualification" ], "responses": { "200": { "content": { "application/json": { "schema": { "format": "object", "properties": { "results": { "type": "array", "items": { "format": "object", "properties": { "interval": { "format": "object", "properties": { }, "required": [ ], "type": "object" }, "description": { "type": "string" }, "createdAt": { "type": "string", "format": "timestamp" }, "id": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "externalCode": { "type": "string" }, "evidenceVariants": { "type": "array", "items": { "format": "object", "properties": { "qualificationID": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "lastModifiedAt": { "type": "string", "format": "timestamp" }, "externalCode": { "type": "string" }, "createdAt": { "type": "string", "format": "timestamp" }, "externalId": { "type": "string" }, "id": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "code": { "type": "string" }, "name": { "type": "string" }, "interval": { "format": "object", "properties": { }, "required": [ ], "type": "object" } }, "required": [ "id", "createdAt", "lastModifiedAt", "interval", "name", "qualificationID" ], "type": "object" } }, "lastModifiedAt": { "type": "string", "format": "timestamp" }, "qualificationTypeID": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "measurementSystemID": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "name": { "type": "string" }, "externalId": { "type": "string" }, "code": { "type": "string" } }, "required": [ "id", "createdAt", "lastModifiedAt", "interval", "name", "qualificationTypeID", "measurementSystemID", "evidenceVariants" ], "type": "object" } }, "deltaToken": { "type": "string" }, "pageToken": { "type": "string" } }, "required": [ "results", "pageToken", "deltaToken" ], "type": "object" } } }, "description": "Successful request" } }, "deprecated": false, "parameters": [ { "allowEmptyValue": false, "deprecated": false, "schema": { "type": "string" }, "required": false, "in": "query", "description": "", "name": "pageToken" }, { "allowEmptyValue": false, "deprecated": false, "schema": { "type": "integer", "format": "int32" }, "required": false, "in": "query", "description": "", "name": "limit" }, { "allowEmptyValue": false, "deprecated": false, "schema": { "type": "string" }, "required": false, "in": "query", "description": "", "name": "sinceDeltaToken" }, { "allowEmptyValue": false, "deprecated": false, "schema": { "type": "array", "items": { "type": "string" } }, "required": false, "in": "query", "description": "", "name": "fields" } ], "summary": "List all qualifications viewable for API user", "operationId": "qualificationsFrom:limit:since:fields:" } }, "/qualifications/{id}": { "get": { "operationId": "qualificationAt:", "parameters": [ { "allowEmptyValue": false, "deprecated": false, "schema": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "required": true, "in": "path", "description": "", "name": "id" } ], "deprecated": false, "responses": { "200": { "content": { "application/json": { "schema": { "format": "object", "properties": { "interval": { "format": "object", "properties": { }, "required": [ ], "type": "object" }, "description": { "type": "string" }, "createdAt": { "type": "string", "format": "timestamp" }, "id": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "externalCode": { "type": "string" }, "evidenceVariants": { "type": "array", "items": { "format": "object", "properties": { "qualificationID": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "lastModifiedAt": { "type": "string", "format": "timestamp" }, "externalCode": { "type": "string" }, "createdAt": { "type": "string", "format": "timestamp" }, "externalId": { "type": "string" }, "id": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "code": { "type": "string" }, "name": { "type": "string" }, "interval": { "format": "object", "properties": { }, "required": [ ], "type": "object" } }, "required": [ "id", "createdAt", "lastModifiedAt", "interval", "name", "qualificationID" ], "type": "object" } }, "lastModifiedAt": { "type": "string", "format": "timestamp" }, "qualificationTypeID": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "measurementSystemID": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "name": { "type": "string" }, "externalId": { "type": "string" }, "code": { "type": "string" } }, "required": [ "id", "createdAt", "lastModifiedAt", "interval", "name", "qualificationTypeID", "measurementSystemID", "evidenceVariants" ], "type": "object" } } }, "description": "Successful request" } } } }, "/qualifications/{id}/achievements": { "get": { "operationId": "qualifications_achievementsFor:from:limit:fields:", "parameters": [ { "allowEmptyValue": false, "deprecated": false, "schema": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "required": true, "in": "path", "description": "", "name": "id" }, { "allowEmptyValue": false, "deprecated": false, "schema": { "type": "string" }, "required": false, "in": "query", "description": "", "name": "pageToken" }, { "allowEmptyValue": false, "deprecated": false, "schema": { "type": "integer", "format": "int32" }, "required": false, "in": "query", "description": "", "name": "limit" }, { "allowEmptyValue": false, "deprecated": false, "schema": { "type": "array", "items": { "type": "string" } }, "required": false, "in": "query", "description": "", "name": "fields" } ], "deprecated": false, "responses": { "200": { "content": { "application/json": { "schema": { "format": "object", "properties": { "results": { "type": "array", "items": { "format": "object", "properties": { "remark": { "type": "string" }, "lastModifiedAt": { "type": "string", "format": "timestamp" }, "id": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "issueDate": { "type": "string", "format": "date" }, "overriddenExpirationDate": { "type": "string", "format": "date" }, "qualificationID": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "evidenceVariantID": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "externalId": { "type": "string" }, "documents": { "type": "array", "items": { "format": "object", "properties": { "contentType": { "type": "string" }, "filename": { "type": "string" } }, "required": [ "filename", "contentType" ], "type": "object" } }, "externalCode": { "type": "string" }, "scoreOrder": { "type": "integer", "format": "int32" }, "submittedByID": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "approvedByID": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "isAutoAchieved": { "type": "boolean" }, "createdAt": { "type": "string", "format": "timestamp" }, "employmentID": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "expirationDate": { "type": "string", "format": "date" } }, "required": [ "id", "createdAt", "lastModifiedAt", "employmentID", "evidenceVariantID", "qualificationID", "scoreOrder", "issueDate", "expirationDate", "isAutoAchieved", "submittedByID", "approvedByID" ], "type": "object" } }, "deltaToken": { "type": "string" }, "pageToken": { "type": "string" } }, "required": [ "results", "pageToken", "deltaToken" ], "type": "object" } } }, "description": "Successful request" } } } }, "/qualifications/{id}/evidenceVariants": { "get": { "operationId": "qualifications_evidenceVariantsFor:from:limit:fields:", "parameters": [ { "allowEmptyValue": false, "deprecated": false, "schema": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "required": true, "in": "path", "description": "", "name": "id" }, { "allowEmptyValue": false, "deprecated": false, "schema": { "type": "string" }, "required": false, "in": "query", "description": "", "name": "pageToken" }, { "allowEmptyValue": false, "deprecated": false, "schema": { "type": "integer", "format": "int32" }, "required": false, "in": "query", "description": "", "name": "limit" }, { "allowEmptyValue": false, "deprecated": false, "schema": { "type": "array", "items": { "type": "string" } }, "required": false, "in": "query", "description": "", "name": "fields" } ], "deprecated": false, "responses": { "200": { "content": { "application/json": { "schema": { "format": "object", "properties": { "results": { "type": "array", "items": { "format": "object", "properties": { "qualificationID": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "lastModifiedAt": { "type": "string", "format": "timestamp" }, "externalCode": { "type": "string" }, "createdAt": { "type": "string", "format": "timestamp" }, "externalId": { "type": "string" }, "id": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "code": { "type": "string" }, "name": { "type": "string" }, "interval": { "format": "object", "properties": { }, "required": [ ], "type": "object" } }, "required": [ "id", "createdAt", "lastModifiedAt", "interval", "name", "qualificationID" ], "type": "object" } }, "deltaToken": { "type": "string" }, "pageToken": { "type": "string" } }, "required": [ "results", "pageToken", "deltaToken" ], "type": "object" } } }, "description": "Successful request" } } } }, "/qualifications/{id}/inProgressEntries": { "get": { "operationId": "qualifications_inProgressEntriesFor:from:limit:fields:", "parameters": [ { "allowEmptyValue": false, "deprecated": false, "schema": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "required": true, "in": "path", "description": "", "name": "id" }, { "allowEmptyValue": false, "deprecated": false, "schema": { "type": "string" }, "required": false, "in": "query", "description": "", "name": "pageToken" }, { "allowEmptyValue": false, "deprecated": false, "schema": { "type": "integer", "format": "int32" }, "required": false, "in": "query", "description": "", "name": "limit" }, { "allowEmptyValue": false, "deprecated": false, "schema": { "type": "array", "items": { "type": "string" } }, "required": false, "in": "query", "description": "", "name": "fields" } ], "deprecated": false, "responses": { "200": { "content": { "application/json": { "schema": { "format": "object", "properties": { "results": { "type": "array", "items": { "format": "object", "properties": { "remark": { "type": "string" }, "toDate": { "type": "string", "format": "date" }, "lastModifiedAt": { "type": "string", "format": "timestamp" }, "id": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "plannedScoreOrder": { "type": "integer", "format": "int32" }, "closeDate": { "type": "string", "format": "date" }, "qualificationID": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "evidenceVariantID": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "externalId": { "type": "string" }, "externalCode": { "type": "string" }, "fromDate": { "type": "string", "format": "date" }, "createdAt": { "type": "string", "format": "timestamp" }, "employmentID": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "deadlineDate": { "type": "string", "format": "date" } }, "required": [ "id", "createdAt", "lastModifiedAt", "employmentID", "evidenceVariantID", "qualificationID", "plannedScoreOrder", "fromDate", "toDate" ], "type": "object" } }, "deltaToken": { "type": "string" }, "pageToken": { "type": "string" } }, "required": [ "results", "pageToken", "deltaToken" ], "type": "object" } } }, "description": "Successful request" } } } }, "/qualificationTypes": { "get": { "tags": [ "QualificationType" ], "responses": { "200": { "content": { "application/json": { "schema": { "format": "object", "properties": { "results": { "type": "array", "items": { "format": "object", "properties": { "name": { "type": "string" }, "externalCode": { "type": "string" }, "lastModifiedAt": { "type": "string", "format": "timestamp" }, "createdAt": { "type": "string", "format": "timestamp" }, "externalId": { "type": "string" }, "id": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" } }, "required": [ "id", "createdAt", "lastModifiedAt", "name" ], "type": "object" } }, "deltaToken": { "type": "string" }, "pageToken": { "type": "string" } }, "required": [ "results", "pageToken", "deltaToken" ], "type": "object" } } }, "description": "Successful request" } }, "deprecated": false, "parameters": [ { "allowEmptyValue": false, "deprecated": false, "schema": { "type": "string" }, "required": false, "in": "query", "description": "", "name": "pageToken" }, { "allowEmptyValue": false, "deprecated": false, "schema": { "type": "integer", "format": "int32" }, "required": false, "in": "query", "description": "", "name": "limit" }, { "allowEmptyValue": false, "deprecated": false, "schema": { "type": "string" }, "required": false, "in": "query", "description": "", "name": "sinceDeltaToken" }, { "allowEmptyValue": false, "deprecated": false, "schema": { "type": "array", "items": { "type": "string" } }, "required": false, "in": "query", "description": "", "name": "fields" } ], "summary": "List all qualificationTypes viewable for API user", "operationId": "qualificationTypesFrom:limit:since:fields:" } }, "/qualificationTypes/{id}": { "get": { "operationId": "qualificationTypeAt:", "parameters": [ { "allowEmptyValue": false, "deprecated": false, "schema": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "required": true, "in": "path", "description": "", "name": "id" } ], "deprecated": false, "responses": { "200": { "content": { "application/json": { "schema": { "format": "object", "properties": { "name": { "type": "string" }, "externalCode": { "type": "string" }, "lastModifiedAt": { "type": "string", "format": "timestamp" }, "createdAt": { "type": "string", "format": "timestamp" }, "externalId": { "type": "string" }, "id": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" } }, "required": [ "id", "createdAt", "lastModifiedAt", "name" ], "type": "object" } } }, "description": "Successful request" } } } }, "/qualificationTypes/{id}/qualifications": { "get": { "operationId": "qualificationTypes_qualificationsFor:from:limit:fields:", "parameters": [ { "allowEmptyValue": false, "deprecated": false, "schema": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "required": true, "in": "path", "description": "", "name": "id" }, { "allowEmptyValue": false, "deprecated": false, "schema": { "type": "string" }, "required": false, "in": "query", "description": "", "name": "pageToken" }, { "allowEmptyValue": false, "deprecated": false, "schema": { "type": "integer", "format": "int32" }, "required": false, "in": "query", "description": "", "name": "limit" }, { "allowEmptyValue": false, "deprecated": false, "schema": { "type": "array", "items": { "type": "string" } }, "required": false, "in": "query", "description": "", "name": "fields" } ], "deprecated": false, "responses": { "200": { "content": { "application/json": { "schema": { "format": "object", "properties": { "results": { "type": "array", "items": { "format": "object", "properties": { "interval": { "format": "object", "properties": { }, "required": [ ], "type": "object" }, "description": { "type": "string" }, "createdAt": { "type": "string", "format": "timestamp" }, "id": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "externalCode": { "type": "string" }, "evidenceVariants": { "type": "array", "items": { "format": "object", "properties": { "qualificationID": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "lastModifiedAt": { "type": "string", "format": "timestamp" }, "externalCode": { "type": "string" }, "createdAt": { "type": "string", "format": "timestamp" }, "externalId": { "type": "string" }, "id": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "code": { "type": "string" }, "name": { "type": "string" }, "interval": { "format": "object", "properties": { }, "required": [ ], "type": "object" } }, "required": [ "id", "createdAt", "lastModifiedAt", "interval", "name", "qualificationID" ], "type": "object" } }, "lastModifiedAt": { "type": "string", "format": "timestamp" }, "qualificationTypeID": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "measurementSystemID": { "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$", "example": "550e8400-e29b-41d4-a716-446655440000", "format": "hexadecimal-integer", "type": "string" }, "name": { "type": "string" }, "externalId": { "type": "string" }, "code": { "type": "string" } }, "required": [ "id", "createdAt", "lastModifiedAt", "interval", "name", "qualificationTypeID", "measurementSystemID", "evidenceVariants" ], "type": "object" } }, "deltaToken": { "type": "string" }, "pageToken": { "type": "string" } }, "required": [ "results", "pageToken", "deltaToken" ], "type": "object" } } }, "description": "Successful request" } } } }, "/serviceIsAvailable": { "get": { "operationId": "isAvailable", "parameters": [ ], "deprecated": false, "responses": { "200": { "content": { "application/json": { "schema": { "type": "boolean" } } }, "description": "Successful request" } } } }, "/serviceVersion": { "get": { "operationId": "getServiceVersion", "parameters": [ ], "deprecated": false, "responses": { "200": { "content": { "application/json": { "schema": { "format": "object", "properties": { "serviceName": { "type": "string" }, "version": { "type": "string" } }, "required": [ "serviceName", "version" ], "type": "object" } } }, "description": "Successful request" } } } } }, "components": { "responses": { }, "schemas": { }, "examples": { }, "headers": { }, "securitySchemes": { "bearer-token": { "scheme": "bearer", "description": "This API uses Bearer token authentication.\n\nRequests to this API should contain an Authorization header like this:\n\n```\nAuthorization: Bearer [Token]\n```\n", "type": "http" } }, "requestBodies": { }, "callbacks": { }, "parameters": { }, "links": { } }, "security": [ { "bearer-token": [ ] } ], "tags": [ ], "info": { "termsOfService": "https://www.ag5.com", "title": "AG5 API v3", "description": "\nThis is the AG5 OpenAPI.\n## Authentication\n\nThis API uses Bearer token authentication.\n\nRequests to this API should contain an Authorization header like this:\n\n```\nAuthorization: Bearer [Token]\n```\n", "contact": { "url": "https://www.ag5.com/", "email": "support@ag5.com", "name": "AG5 API Support" }, "version": "1.0" }, "openapi": "3.0.0" }