Submit crew sheets
POST/api/v1/crew_sheets/submit
Submit one or more of another user's sheets for approval, on their behalf. This is the action behind the Submit button on the Crew Entry screen.
This endpoint does not necessarily follow the
standard REST conventions. In particular, it uses the POST
method for operations that would typically use GET, PUT or DELETE in a
RESTful API endpoint.
The request body is a JSON array of sheets. Each is submitted in its own transaction, so a problem with one sheet does not prevent the others going through.
A partial failure, and even a total failure, still returns HTTP 200.
Inspect success and the errors array to find out what actually
happened. See the response schema for details.
A sheet can be named either by its id_sheet, or by id_user plus
sheet_date when the user has no sheet for the period yet, in which case
the sheet is created and then submitted.
You must hold at least one of Authority - Timekeeper,
Authority - Expensekeeper, or Authority - Custom Entry keeper, or be an
administrator.
Request
Responses
- 200
- 400
- 401
- 403
- 404
- 500
- 503
The outcome of the submit request. The results object is always empty; the
outcome is reported in status and errors.
A partial failure still returns HTTP 200. Treat a non-empty errors array,
or success being false, as the signal that at least one sheet did not
submit. Each failed sheet contributes one message, prefixed with the
user_name and sheettype_label you supplied.
A 400 Bad Request is returned when the client request was malformed,
invalid, or otherwise could not be processed as-is. Usually, the cause for
the error is included in the error.message field of the response, and the
client should correct the request and try again.
See also Core Concepts#Error Responses.
Not authenticated - you must be signed in to access this resource. Please check the section of the documentation on authentication.
A 403 Forbidden response means that you are not authorized to perform
this action or access this object, or the object does not exist at all.
The client request may have been valid but the client does not have permission to access the requested resource or perform the requested action.
In most cases, the system will not return a 404 Not Found error response;
it returns 403 Forbidden both when the object doesn't exist at all,
and also when it exists but the client does not have permission to access it.
This is a security measure to prevent unauthorized users from determining
whether an object exists or not.
See also Core Concepts#Error Responses.
Not found - the requested resource could not be found or does not exist. This may also include cases where the resource does exist, but the client does not have permission to access that resource.
In most cases, the system will not return a 404 Not Found error response;
it returns 403 Forbidden both when the object doesn't exist at all,
and also when it exists but the client does not have permission to access it.
This is a security measure to prevent unauthorized users from determining
whether an object exists or not.
See also Core Concepts#Error Responses.
Internal server error; an unexpected error occurred on the server. This could be due to a temporary condition or might be the result of a bug in the server software. Also, in some cases, an incorrect client input can trigger this error, and can be resolved by correcting the input.
If the error persists, please contact support along along with the following details when possible:
- any error messages received from the server
- the full request and response details (full headers and body)
- a description of the steps that led to the error
- the time range when it occurred.
Service unavailable - the server is currently unable to handle the request, usually due to maintenance activity on the server. Check if the server's web interface is currently available, or try again later.