Document authorization

Authorize document(s) after and before booking in Basecone.

Document can be authorized after and before booking , when they have authorizers set. This action can only be performed by a user with access to the document, with Authorizer role and must be the current authorizer.

This API resource is only available to Premium APPs.

POST authorization/:documentId/authorize

Successful Response

Upon successful operation a 200 status code will be returned.

Error Response

In the case an error occurs a 400 status code will be returned.

Example error response

{
    "message": "One or more validation errors occurred.",
    "code": "invalid_request_payload",
    "_metadata":[
        {
            "field": "documentId",
            "message": "error message will be here",
            "code": "error_code_will_be_here"
        }
    ],
    "_moreInfo": "http://developers.basecone.com/lookup/invalid_request_payload"
}

Possible error response codes

Status code Error code Details
400 invalid_request_payload Request properties are not valid to perform the requested operation.
400 validation_error Request failed with one or more validation errors (see below). For more information about how to handle validation errors, please consult client side errors section.
401 unauthorized User is not authorized to access the resource.
403 forbidden User has no rights to execute the requested operation.
404 resource_not_found Resource was not found.

Possible validation error responses

Status code Error code Details
400 document_not_valid_current_state Document can not be authorized because is not in a valid state.
400 document_already_authorized Document was already authorized.
400 user_is_not_valid_authorizer User is not the current authorizer.
400 user_is_not_next_valid_authorizer User is not the next valid authorizer.