API reference › Assignments › Provider portal

Mark assignment as complete

POST /v1/settings/portal/provider/assignment/assignment-complete/{id}

Scope
assignments:write
Roles
service-provider

Allows the service provider assigned to an assignment or shift to mark their part of it as completed. A provider with no assigned row on this work item gets 403.

Parameters

Path parameters

NameTypeDescription
id requiredstring

Unique identifier of the assignment to mark as complete.

Example ASG-23RT45.

Every call also sends Authorization and X-Tenant-ID; see Getting started.

Example request

Shell
curl -X POST "https://api.fetchfido.ai/v1/settings/portal/provider/assignment/assignment-complete/{id}" \
  -H "Authorization: Bearer $FIDO_API_KEY" \
  -H "X-Tenant-ID: $FIDO_TENANT_ID"

Try it

Responses

200 Assignment marked as complete successfully

Assignment marked as complete successfully

JSON
{
  "success": true,
  "message": "Assignment Morning interpreting (ASG-23RT45) was marked as complete.",
  "data": null
}
Response fields (3)
FieldTypeDescription
successboolean

Example true.

messagestring

':entity :name (:id) was marked as complete.' — entity is Assignment or Shift, name is the title (the id when it has none)

Example Assignment Morning interpreting (ASG-23RT45) was marked as complete..

dataobject or null
400 Bad request

Assignment cannot be marked as complete. Two cases, each with its own message/errors pair: already completed ('This assignment has already been completed.' / 'Action not allowed'); before the scheduled end time ('Action not allowed' / 'You can complete the assignment only after the scheduled end time.').

JSON
{
  "success": false,
  "message": "Action not allowed",
  "errors": "You can complete the assignment only after the scheduled end time.",
  "code": ""
}
Response fields (4)
FieldTypeDescription
successboolean

Example false.

messagestring

Example Action not allowed.

errorsstring

Example You can complete the assignment only after the scheduled end time..

codestring

Example .

401 Not signed in

Unauthorized - Authentication required

JSON
{
  "success": false,
  "message": "Invalid API key. Org and user tier keys must send an X-Tenant-ID header naming the organization the key was issued for.",
  "errors": null,
  "code": "API_KEY_MISSING"
}
Response fields (4)
FieldTypeDescription
successboolean

Example false.

messagestring

Example Invalid API key. Org and user tier keys must send an X-Tenant-ID header naming the organization the key was issued for..

errorsany or null

Null on this status.

codestring

Machine-readable reason, for branching on in client code.

One of: API_KEY_MISSING, API_KEY_INVALID, API_KEY_EXPIRED. Example API_KEY_MISSING.

403 Not allowed

The caller is not an assigned provider on this assignment or shift, or no work item has this id

JSON
{
  "success": false,
  "message": "You don't have permission to access this endpoint. This API key is missing the 'assignments:write' scope.",
  "errors": null,
  "code": ""
}
Response fields (4)
FieldTypeDescription
successboolean

Example false.

messagestring

Example You don't have permission to access this endpoint. This API key is missing the 'assignments:write' scope..

errorsany or null

Null on this status.

codestring

Always empty on this status.

Example .

422 Validation failed

The work item requires verified time documentation and the caller's sign-in/sign-out is incomplete. errors.missing_fields lists the empty check-in fields — all eight when the caller has no check-in at all.

JSON
{
  "success": false,
  "message": "Sign in & out fields are required.",
  "errors": {
    "missing_fields": [
      "sign_out_date",
      "sign_out_time",
      "sign_out_sign",
      "sign_out_by"
    ]
  },
  "code": ""
}
Response fields (5)
FieldTypeDescription
successboolean

Example false.

messagestring

Example Sign in & out fields are required..

errorsobject
errors.missing_fieldsarray of string
codestring

Example .

429 Too many requests

Rate limit exceeded. See Retry-After.

JSON
{
  "success": false,
  "message": "You've exceeded this API key's rate limit of 120 requests per minute. Try again in 37 seconds.",
  "errors": null,
  "code": "RATE_LIMITED"
}
Response fields (4)
FieldTypeDescription
successboolean

Example false.

messagestring

Example You've exceeded this API key's rate limit of 120 requests per minute. Try again in 37 seconds..

errorsany or null

Null on this status.

codestring

Machine-readable reason, for branching on in client code.

One of: RATE_LIMITED. Example RATE_LIMITED.

500 Server error

Internal Server Error

JSON
{
  "success": false,
  "message": "Failed to complete assignment"
}
Response fields (2)
FieldTypeDescription
successboolean

Example false.

messagestring

Example Failed to complete assignment.