Get a single CPD requirement

Prev Next
Get
/cpdRequirementSummaries/{audienceRequirementId}

Retrieves a specific CPD requirement by its ID

Security
HTTP
Type basic

To pass the authentication step you will need to provide the following:

Username is the Tenant ID (i.e. eu-west-2_AbcdEfghI) Password is the secret you would have received

Path parameters
audienceRequirementId
stringRequired

Unique identifier of the CPD requirement

Pattern^[0-9a-fA-F]{24}$
Example5f9d88d6e1b2a34c56d78902
Responses
200

Successful response

{
  "audienceRequirementId": "507f1f77bcf86cd799439011",
  "audienceId": "507f1f77bcf86cd799439012",
  "requiredMinutes": 660,
  "createdAt": "2020-05-27T10:44:05.687Z",
  "updatedAt": "2020-08-05T09:37:47.824Z"
}
object
audienceRequirementId
string

Unique ID for this requirement record

Pattern^[0-9a-fA-F]{24}$
Example64b6f4a8c2e4a1b9d3f2c4a2
audienceId
string

ID of the audience this requirement applies to

Pattern^[0-9a-fA-F]{24}$
Example5f9d88d6e1b2a34c56d78901
requiredMinutes
integer

Number of minutes required for CPD completion

Minimum0.0
Example660
createdAt
string (date-time)

Timestamp when the requirement was created

Example2020-05-27T10:44:05.687Z
updatedAt
string (date-time) | null

Timestamp when the requirement was last updated

Example2020-08-05T09:37:47.824Z
404

CPD requirement not found