---
title: "Calculate the agency candidate compliance summary health"
method: POST
path: "/agency/{agency_id}/candidate-compliance-summary-health/{candidate_id}"
tags: ["Agency Candidate Compliance Summary Health"]
---

# Calculate the agency candidate compliance summary health

`POST /agency/{agency_id}/candidate-compliance-summary-health/{candidate_id}`

## Request

- Base URL: `http://localhost:3010/v1`
- URL: `http://localhost:3010/v1/agency/{agency_id}/candidate-compliance-summary-health/{candidate_id}`
- Auth: HTTP basic and HTTP basic

## Headers

- `Authorization` string, string, required
- `Context` string, string, required
- `Accept` 'application/json', required
- `X-Accept-Timezone` string

## Request body

- object
  - `job_title_ids` string[], required
  - `type` 'possible-shifts' | 'past-shifts', required
  - `section` 'summary' | 'all', required
  - `location` object, required
    - `coordinates` number[], required
    - `max_distance` number, required

## Response `200`

The agency candidate compliance summary health

- object
  - `number_compliant_shifts` integer, required
  - `number_incompliant_shifts` integer, required
  - `compliant_percentage` number, required
  - `incompliant_percentage` number, required
  - `outstanding_rules` object[]
    - `rule_id` string, required
    - `rule_percentage` number, required
    - `web_description` string
    - `name` string, required
    - `description` string

## Other responses

- `400`: Validation error response
- `401`: Failed to authenticate the user making the request
- `403`: Permission denied error
- `404`: Resource not found
- `412`: Failed some precondition on business logic
- `default`: Server error occurred

---

[API](https://skmtc.dev/staffshift/apis/staffshift-api-gateway.md) - [All operations](https://skmtc.dev/staffshift/apis/staffshift-api-gateway/llms.txt) - [OpenAPI document](https://skmtc.dev/staffshift/apis/staffshift-api-gateway/revisions/1f079f6b65f5?raw)