Jump to

• Request
• Response

Get employee - certificate associations.

get

/connectedWorker/clientapi/v2/employees/{employeeId}/certificates

This operation retrieves certificates associated with an employee.

Request

Path Parameters

• employeeId: string
  Employee identifier

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Employee - certificate associations were successfully retrieved.

Body ()

Root Schema : EmployeeCertificates

Type: object

Show Source

• items: array items
• links(optional): array links
  Read Only: true

{
    "required":[
        "items"
    ],
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/EmployeeCertificate"
            }
        },
        "links":{
            "type":"array",
            "readOnly":true,
            "items":{
                "$ref":"#/components/schemas/Link"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object EmployeeCertificate

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/EmployeeCertificate"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object Link

{
    "type":"array",
    "readOnly":true,
    "items":{
        "$ref":"#/components/schemas/Link"
    }
}

Nested Schema : EmployeeCertificate

Type: object

Show Source

• certificateId: string
  Id of the certificate to associate with the employee

  Example: 321
• employeeId: string
  Id of the employee to associate the certificate with

  Example: 123123-54564-546456
• expires: string(date-time)
  Date when the certificate will expire. Must be in the future and after the date when the certificate was issued. Note that if the certificate has expired, you have to update this field first

  Example: 2020-11-29T09:38:25.267Z
• issuedDate: string(date-time)
  Date when the employee has issued the certificate

  Example: 2019-11-29T09:38:25.267Z
• links(optional): array links
• sendReminder(optional): string(date-time)
  Read Only: true

  Date when the reminder will be sent to the employee

  Example: 2019-11-29T09:38:25.267Z

{
    "required":[
        "certificateId",
        "employeeId",
        "expires",
        "issuedDate"
    ],
    "type":"object",
    "properties":{
        "employeeId":{
            "type":"string",
            "description":"Id of the employee to associate the certificate with",
            "example":"123123-54564-546456"
        },
        "certificateId":{
            "type":"string",
            "description":"Id of the certificate to associate with the employee",
            "example":"321"
        },
        "issuedDate":{
            "type":"string",
            "description":"Date when the employee has issued the certificate",
            "format":"date-time",
            "example":"2019-11-29T09:38:25.267Z"
        },
        "expires":{
            "type":"string",
            "description":"Date when the certificate will expire. Must be in the future and after the date when the certificate was issued. Note that if the certificate has expired, you have to update this field first",
            "format":"date-time",
            "example":"2020-11-29T09:38:25.267Z"
        },
        "sendReminder":{
            "type":"string",
            "description":"Date when the reminder will be sent to the employee",
            "format":"date-time",
            "readOnly":true,
            "example":"2019-11-29T09:38:25.267Z"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Link"
            }
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Link"
    }
}

Nested Schema : Link

Type: object

Show Source

• href: string
  The target resource's URI
• rel: string
  Relation type

{
    "required":[
        "href",
        "rel"
    ],
    "type":"object",
    "properties":{
        "rel":{
            "type":"string",
            "description":"Relation type"
        },
        "href":{
            "type":"string",
            "description":"The target resource's URI"
        }
    }
}

Back to Top