Skip to content
Sanmopia Modernization

Get caregiver monthly work capacity comparison

Switch to Zen Mode
GET
/caregiver-monthly-work-capacity-comparisons/{caregiverProfileId}/{year}/{month}
curl --request GET \
  --url 'https://example.com/caregiver-monthly-work-capacity-comparisons/example/1/1?branchProfileId=example' \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
caregiverProfileId
required
string
>= 1 characters
year
required
integer
>= 2000 <= 2100
month
required
integer
>= 1 <= 12

Query Parameters

Section titled “Query Parameters”
branchProfileId
required
string
>= 1 characters

Responses

Section titled “Responses”

200

Section titled “200”

Caregiver monthly work capacity comparison projection

Media typeapplication/json
object
comparisonSnapshotId
required
string
>= 1 characters
caregiverProfileId
required
string
>= 1 characters
branchProfileId
required
string
>= 1 characters
year
required
integer
>= 2000 <= 2100
month
required
integer
>= 1 <= 12
yearMonthKey
required
string
/^[0-9]{4}-[0-9]{2}$/
monthDayCount
required
integer
>= 28 <= 31
capacityRevisionNumber
required
integer
>= 1
capacityDayCount
required
integer
<= 31
attendanceEvidenceRevisionKey
required
string
>= 1 characters
attendanceDayCount
required
integer
attendanceCapacityVarianceDayCount
required
integer
comparisonState
required
string
Allowed values: attendance_matches_capacity attendance_under_capacity attendance_over_capacity
downstreamInvalidationKeys
required
Array<string>
projectedAt
required
string format: date-time
key
additional properties

400

Section titled “400”

Comparison query is invalid

401

Section titled “401”

Supabase bearer token is required

403

Section titled “403”

Actor cannot view caregiver work capacity comparison

404

Section titled “404”

Caregiver work capacity comparison was not found

503

Section titled “503”

Caregiver work capacity runtime is unavailable