Policy
Candidate Policy

Candidate policy listing for a particular agency group

  • All assigned policy types for a candidate for a particular agency group
    • /candidate/{candidate_id}/agency-group/{group_id}/policy
  • Has a candidate acknowledged a particular policy?
    • /candidate/{candidate_id}/agency-group/{group_id}/policy?action=acknowledged&policy_type_id=2468
  • Has a candidate acknowledged a particular version of the policy?
    • /candidate/{candidate_id}/agency-group/{group_id}/policy?action=acknowledged&policy_type_id=2468&latest_only=true
    • /candidate/{candidate_id}/agency-group/{group_id}/policy?action=acknowledged&policy_type_id=2468&version=2
  • Has a candidate acknowledged a document that has an effective date greater than x?
    • /candidate/{candidate_id}/agency-group/{group_id}/policy?action=acknowledged&policy_type_id=2468&policy_effective_at_from=x
get/candidate/{candidate_id}/agency-group/{group_id}/policy

Request

  • Base URL
    http://localhost:3010/v1
  • URL
    http://localhost:3010/v1/candidate/{candidate_id}/agency-group/{group_id}/policy
  • Auth
    HTTP basic

Query parameters

action'acknowledged' | 'not_acknowledged'

The action that has / has not been applied

version_frominteger

The starting value of version, inclusive

versioninteger

The exact value of the version

version_tointeger

The end value of version, exclusive

latest_onlyboolean

When only the latest version of something should be considered

policy_type_idstring

A single or comma separated list of policy type ids

policy_effective_at_fromstring date-time

The starting value of the date something became effective at, inclusive

policy_effective_atstring date-time

The date something became effective at

policy_effective_at_tostring date-time

The ending value of the date something became effective at, exclusive

sortBystring[]

A comma seperated list of fields indicating sort order _id, a negative sign reverses direction -_id

policy_type_classification'viewable' | 'acknowledgeable'

The policy classification for filter

pageinteger

The page of documents to be displayed

items_per_pageinteger

The number of documents per page

Response

Listing of all policies assigned to the candidate for the agency group

_idstring required
updated_atstring date-time required
created_atstring date-time required
__vinteger required
resource_typestring required
resource_idstring required
policy_type_idstring required
policy_type_titlestring required
policy_type_descriptionstring required
policy_type_classification'viewable' | 'acknowledgeable'

Changes

No recorded changes to this operation across all 3 revisions of this API.