Remove Document on hold

Removes document "On Hold" state in Basecone.

Removes the state "On Hold" of Document waiting for authorization. This action can only be performed by a user with the Authorizer role that is also the current authorizer of the document.

This API resource is only available to Premium APPs.

POST authorization/:documentId/remove-onhold

Request details

The post request will contain all the required information to remove the document "on hold" state and it will be identified by the documentId.

Request properties

Property	Type	Description	Optional
reason	String	Reason to remove state "on hold" from a document waiting for authorization.	Field is mandatory for an User with role `Authorizer Administrator`. It is optional for an User with `Authorizers` as long as it has not role `Authorizer Administrator`.

Example request

{
    reason: "some reason must be sent"
}

Successful Response

Upon successful operation a 200 status code will be returned.

Error Response

In the case an error occurs an error 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_does_not_exist	Document does not exist.
400	no_reason_provided	No reason was provided to reject the document.
400	document_not_valid_current_state	Document can not be rejected because is not in a valid state.
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.