Sign in

v1

latestOpenAPI 3.0.12026-07-243124341009.5 KB
Talent

Get a Talent Certificate

Returns a talent certificate.

get/v1/talent/certificate/{certificateId}

Path parameters

certificateIdstring required

The identifier for the talent certificate instance being requested.

Headers

RequestIdstring uuid

The unique request identifier used to correlate request data with log entries and events, formatted as a UUID.

Unique request identifier (UUID) used to correlate request data with log entries and events.

FrontOfficeTenantIdinteger

An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.

Tenantstring

Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.

Response

The talent certificate.

idinteger

The unique identifier for the talent certificate instance. Matches the certificateId provided in the request path.

certificateIdinteger

The identifier for the certificate definition associated with the talent certificate.

categoryIdinteger

The identifier for the certificate category.

applicantIdinteger

The identifier for the talent who holds the certificate.

issueDatestring date-time

The date the certficate was issued. The field follows the YYYY-MM-DDTHH:mm:ss format, for example, 2024-12-01T14:30:00 or 2024-12-01T00:00:00.

expirationDatestring date-time

The date the certificate is set to expire. The field follows the YYYY-MM-DDTHH:mm:ss format, for example, 2024-12-01T14:30:00 or 2024-12-01T00:00:00.

notesstring

Additional notes related to the talent certificate.

validatedboolean

An indication of whether the certificate has been validated or not.

validatedDatestring date-time

The date and time the certificate was validated. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats and also supports fractional seconds, such as YYYY-MM-DDTHH:mm:ss.sss. For example, 2024-12-01, 2024-12-01T14:30:00, and 2024-12-01T14:30:00.546.

validatedByinteger

The identifier for the user that has validated the certificate of the talent.

archivedboolean

An indication of whether the certificate is archived or not.

archiveDatestring date-time

The date the certificate was set to archived. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats and also supports fractional seconds, such as YYYY-MM-DDTHH:mm:ss.sss. For example, 2024-12-01, 2024-12-01T14:30:00, and 2024-12-01T14:30:00.546.

certificateNumberstring

The official number or reference assigned to the certificate.

certificateNamestring

The name of the certificate.

categoryNamestring

The name of the category the certificate belongs to.

talentFirstNamestring

The first name of the talent the certificate was issued to.

talentLastNamestring

The last name of the talent the certificate was issued to.

certificateAuthorityIdinteger

The identifier for the authority that issued the certificate.

certificateAuthorityNamestring

The name of the authority that issued the certificate.

Example response

{
  "id": 52910,
  "certificateId": 392,
  "categoryId": 58,
  "applicantId": 18499,
  "notes": "Waiting for validation.",
  "validated": true,
  "validatedBy": 13483,
  "certificateNumber": "A25623",
  "certificateName": "Tetanus vaccination",
  "categoryName": "Vaccinations",
  "talentFirstName": "John",
  "talentLastName": "Doe",
  "certificateAuthorityId": 350,
  "certificateAuthorityName": "America - MN"
}