Skip to main content

CrewSheetSubmitResponse

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.

response_codeinteger

HTTP status code of the response for reference purposes.

Default value: 200
Example: 200
successboolean

Indicates whether the request was successful (normally true if it's not an error response).

Default value: true
uristring

URL of the current request / resource, for reference purposes.

Example: https://example.apps.journyx.com/api/v1/users
statusstring[]

Confirmation messages. A single summary message is returned when at least one sheet submitted successfully.

Example: ["2 of 3 sheets were submitted successfully."]
errorsstring[]

One message per sheet that failed, preceded by a summary line when more than one sheet was requested and none succeeded.

Example: ["No sheets were submitted successfully.","Bob Dev Expense sheet: User is inactive for requested period."]
warningsstring[]

An array of warning messages that occurred during the request. This field may be empty.

In the UI, these are sometimes displayed with a yellow warning icon.

infostring[]

An array of informational messages that occurred during the request. This field may be empty.

In the UI, these are sometimes displayed with a blue info icon.

resultsobject

Always an empty object. Re-read the collection to see the new sheet states.

CrewSheetSubmitResponse
{
  "response_code": 200,
  "success": true,
  "uri": "https://example.apps.journyx.com/api/v1/users",
  "status": [
    "2 of 3 sheets were submitted successfully."
  ],
  "errors": [
    "No sheets were submitted successfully.",
    "Bob Dev Expense sheet: User is inactive for requested period."
  ],
  "warnings": [
    "string"
  ],
  "info": [
    "string"
  ],
  "results": {}
}