ErrorHandling

Summary

Huddle use a standard ErrorResult element to signal error information to a client. An ErrorResult will contain some human-readable description of the error, plus an enumerated error uri to distinguish classes of error. The uri should point to a human-readable description of the error with more information for developers, but can be treated as a error code programatically.

Syntax

Example

<?xml version="1.0" encoding="utf-8"?>
<ErrorResult xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <StatusCode>410</StatusCode>
  <ErrorMessages>
    <Message>The workspace is deleted.</Message>
  </ErrorMessages>
  <ErrorCode>WorkspaceDeleted</ErrorCode>
</ErrorResult>

Properties

Name	Description
StatusCode	DEPRECATED: The HTTP Status code that corresponds to this error. This element is deprecated and may be removed in a future version of the API
ErrorMessages	A list of messages giving more detail about the error
ErrorCode	A unique identifier for the specific error encountered

Schema

start = error

error = element ErrorResult {
  element StatusCode {xsd:int},
  element ErrorMessages {
    element Message {text}+
  },
  element ErrorCode {xsd:string}?
}

Example: Failed Validation

If validation of a request fails, we may return multiple error messages. The example below is the response to a create task operation where the title is null, and the due date is out of bounds.

HTTP/1.1 400 Bad Request
Cache-Control: private
Content-Length: 393
Content-Type: application/vnd.huddle.error+xml
Date: Thu, 17 Feb 2011 12:10:41 GMT

<?xml version="1.0" encoding="utf-8"?>
<ErrorResult xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <StatusCode>400</StatusCode>
  <ErrorMessages>
    <Message>DueDate: Must be later than PlannedStartDate</Message>
    <Message>Title: You must provide a value</Message>
  </ErrorMessages>
  <ErrorCode>Validation</ErrorCode>
</ErrorResult>

Example: Resource matching failed

If we are unable to match your request to a URI, or to match the body of your request to an acceptable resource, we will return a 404 with some debugging information The response below is the result of a GET request for a malformed folder URI.

HTTP/1.1 404 Not Found
Cache-Control: private
Content-Length: 394
Content-Type: application/vnd.huddle.error+xml
Date: Thu, 17 Feb 2011 12:14:35 GMT

<?xml version="1.0" encoding="utf-8"?>
<ErrorResult>
  <StatusCode>404</StatusCode>
  <ErrorMessages>
    <Message>We were unable to handle your request, there is no method for GET at this URI.

Request mapped to the uri /folders/{folderId}
the following parameters were bound:
folderId : foo is not a number
</Message>
  </ErrorMessages>
  <ErrorCode>ObjectNotFound</ErrorCode>
</ErrorResult>

Error Responses

Create a document

Case	Error	Description	Code	Error Message
When_an_empty_document_with_description_more_than_2048_characters_is_created	400	BadRequest	Validation	Description: Must be between 0 and 2048 characters"
When_an_empty_document_without_title_is_created	400	BadRequest	Validation	Title: Must be between 1 and 128 characters
When_an_empty_document_with_title_more_than_128_characters_is_created	400	BadRequest	Validation	Title: Must be between 1 and 128 characters
When_the_folder_id_is_a_string	404	NotFound
When_the_folder_id_is_invalid	404	NotFound
When_the_folder_id_is_omitted	404	NotFound
When_creating_a_document_in_a_folder_that_is_in_a_workspace_you_are_not_member_of	403	Forbidden	is not a member of the workspace
When_creating_a_document_in_the_document_library_folder	403	Forbidden	Not authorised to write in the DocumentLibrary folder
When_creating_a_document_in_a_folder_that_has_been_deleted	410	Gone	ObjectDeleted	The folder has been deleted
When_creating_a_document_and_the_user_has_no_available_space	403	Forbidden	NoSpaceAvailable	Storage capacity has been exceeded for workspace
When_a_member_creates_a_document_in_a_folder_that_has_only_read_permission	403	Forbidden

Retrieving a document

Case	Error	Description	Code	Error Message
When_retrieving_a_document_that_does_not_exist_xml	404	NotFound	ObjectNotFound	The object could not be found
When_retrieving_a_document_that_is_deleted_xml	410	Gone	ObjectDeleted	The object has been deleted
When_retrieving_a_document_in_a_workspace_of_which_you_are_not_a_member_xml	403	Forbidden	Authorization	is not a member of the workspace
When_a_team_member_requests_a_document_in_a_folder_but_the_team_has_no_permissions_on_that_folder_xml	403	Forbidden	Authorization	The user is not a member of a team which has permissions to view this document
When_a_team_member_requests_a_document_created_by_himself_in_a_folder_but_the_team_has_no_permissions_on_that_folder_xml	403	Forbidden	Authorization	The user does not have permissions to view this document
When_the_users_account_is_suspended_xml	403	Forbidden	AccountStatus	Account suspended
When_a_member_retrieves_a_document_that_is_locked_by_someone_else	200	OK	created with no create version or delete link
When_the_doc_id_is_a_string_xml	404	NotFound
When_the_doc_id_is_ommited	404	NotFound
When_a_manager_retrieves_a_document_and_the_document_has_moving_status	200	OK	should not have an unlock link
When_we_change_the_permissions_of_the_current_user_to_none_between_two_calls

Downloading document content

Case	Error	Description	Code	Error Message
When_a_manager_downloads_a_deleted_document	410	Gone	ObjectDeleted	The object has been deleted
When_a_members_team_has_no_permissions	403	Forbidden	Authorization	The user is not a member of a team which has permissions to view this document
When_the_user_is_manager_of_a_payment_failed_account	403	Forbidden	AccountStatus	Account payment failed
When_the_user_is_not_a_member_of_the_workspace	403	Forbidden	Authorization	is not a member of the workspace
When_the_version_id_is_a_string	404	NotFound	ResourceMatchingFailed
When_the_version_id_is_invalid	404	NotFound	ObjectNotFound	The DocumentVersion is invalid
When_the_version_id_is_omitted	404	NotFound
When_the_document_has_no_content	204	NoContent
When_the_document_doesnt_have_a_media_type	200	OK
When_downloading_document_content_and_the_document_has_moving_status	409	Conflict	DocumentProcessingStatus	The document is currently being moved

Uploading document content

Case	Error	Description	Code	Error Message
When_a_workspace_manager_tries_to_upload_the_contents_of_a_document_locked_by_someone_else	409	Conflict	Conflict	The document is locked by another user
When_a_workspace_manager_tries_to_upload_the_contents_of_a_document_and_he_is_not_the_owner_of_the_upload_process	403	Forbidden	Authorization	The user is not the owner of this version
When_i_upload_the_content_of_a_file_but_I_do_not_have_permissions_on_the_folder	403	Forbidden
When_a_manager_uploads_the_content_of_a_file_in_a_folder_in_which_he_does_not_have_permission	200	OK??
When_i_upload_the_content_of_a_file_in_a_locked_workspace	403	Forbidden	WorkspaceStatus	The workspace has been locked
When_the_account_is_suspended	403	Forbidden	AccountStatus	Account suspended
When_the_document_is_deleted	410	Gone	ObjectDeleted	The object has been deleted
When_there_is_no_available_space_on_the_account	403	Forbidden	NoSpaceAvailable	Storage capacity has been exceeded for workspace
When_a_document_owner_tries_to_upload_the_contents_of_a_document_locked_by_the_workspace_manager	409	Conflict	The document is locked by another user
When_the_upload_guid_has_already_been_used	403	Forbidden	Authorization	This upload URI has already been used
When_the_upload_id_does_not_exist	404	NotFound	ObjectNotFound	The upload id does not exist

Updating document title and description

Case	Error	Description	Code	Error Message
When_a_member_with_full_permissions_on_the_folder_edits_the_details_of_a_document_created_by_another_member	403	Forbidden	Authorization	The user is not the owner of the document or the workspace manager
When_a_member_with_see_only_permissions_edits_the_details_of_a_document_created_by_the_member	204	NoContent
When_a_member_with_no_permissions_edits_the_details_of_a_document_created_by_the_member	403	Forbidden	Authorization	The user is not a member of a team which has permissions to view folder " + folderId
When_a_member_with_full_permissions_edits_the_details_of_a_document_created_by_the_member	204	NoContent
When_editing_the_details_of_a_document_of_another_workspace	403	Forbidden	Authorization	User " + TheActingUser.Username + " is not a member of the workspace
When_the_current_user_account_is_suspended	403	Forbidden	AccountStatus
When_the_current_user_account_is_payment_failed	403	Forbidden	AccountStatus	Account payment failed
When_the_current_user_account_is_deleted	403	Forbidden	AccountStatus	Account deleted
When_the_current_user_account_is_subscribing	403	Forbidden	AccountStatus	Account not activated
When_the_workspace_is_locked	403	Forbidden	WorkspaceStatus	The workspace has been locked
When_the_workspace_is_deleted	410	Gone	WorkspaceDeleted	The workspace has been deleted.
When_the_workspace_is_finalised	403	Forbidden	WorkspaceStatus
When_the_document_is_locked_and_the_destination_folder_remains_the_same	204	NoContent
When_editing_a_deleted_document	410	Gone	ObjectDeleted	The object has been deleted
When_putting_an_empty_title	400	BadRequest	Validation	Title: Must be between 1 and 128 characters
When_putting_an_title_of_more_that_128_characters	400	BadRequest	Validation	Title: Must be between 1 and 128 characters
When_putting_an_description_of_more_that_2048_characters	400	BadRequest	Validation	Description: Must be between 0 and 2048 characters
When_the_title_is_not_posted	400	BadRequest	Validation	Title: You must provide a value
When_the_description_is_not_posted	400	BadRequest	Validation	Description: You must provide a value
When_putting_a_string_as_a_document_id	404	NotFound
When_omitting_the_document_id	404	NotFound
When_putting_a_non_existing_document_id	404	NotFound
When_editing_document_details_and_the_document_has_moving_in_process_status	409	Conflict	DocumentProcessingStatus	The document is currently being moved

Move a document

Case	Error	Description	Code	Error Message
When_the_workspace_is_locked_and_a_move_is_perfomed	403	Forbidden	WorkspaceStatus	The workspace has been locked
When_the_account_is_payment_failed_and_a_move_is_performed	403	Forbidden	WorkspaceStatus	Account payment failed
When_moving_a_document_to_a_workspace_that_the_user_is_not_a_member_of	403	Forbidden	Authorization	is not a member of the workspace
When_moving_a_locked_document_from_a_workspace_that_the_user_is_not_a_member_of	403	Forbidden	Authorization	User is not a member of the workspace
When_a_manager_with_see_only_permissions_moves_a_document_locked_by_himself_to_a_folder_with_see_only_permissions	204	NoContent
When_a_manager_with_see_only_permissions_moves_a_document_locked_by_someone_else_to_a_folder_with_see_only_permissions	409	Conflict	Conflict	The document is locked by another user
When_a_manager_with_see_only_permissions_moves_and_edit_a_document_created_by_a_member_to_a_folder_with_see_only_permissions	204	NoContent
When_a_manager_with_see_only_permissions_moves_a_document_to_a_folder_with_edit_permissions	204	NoContent
When_a_manager_with_see_only_permissions_moves_a_document_to_a_folder_with_no_permissions	204	NoContent
When_a_manager_with_edit_permissions_moves_a_document_to_a_folder_with_see_only_permissions	204	NoContent
When_a_manager_with_edit_permissions_moves_a_document_to_a_folder_with_edit_permissions	204	NoContent
When_a_manager_with_edit_permissions_moves_a_document_to_a_folder_with_no_permissions	204	NoContent
When_a_manager_with_no_permissions_moves_a_document_to_a_folder_with_see_only_permissions	204	NoContent
When_a_manager_with_no_permissions_moves_a_document_to_a_folder_with_edit_permissions	204	NoContent
When_a_manager_with_no_permissions_moves_a_document_to_a_folder_with_no_permissions	204	NoContent
When_a_document_owner_with_see_only_permissions_moves_a_document_to_a_folder_with_edit_permissions	403	Forbidden	Authorization	User does not have edit permission on folder " + originalFolderId + " or its contents
When_a_document_owner_with_edit_permissions_moves_a_document_to_a_folder_with_see_only_permissions	403	Forbidden	Authorization	User does not have edit permission on target folder
When_a_document_owner_with_edit_permissions_moves_a_document_to_a_folder_with_no_permissions_and_changing_title_and_descriptio	403	Forbidden	Authorization	User does not have edit permission on target folder {0}", destinationFolderId
When_a_document_owner_with_no_permissions_moves_a_document_to_a_folder_with_edit_permissions	403	Forbidden	Authorization	User does not have edit permission on folder " + originalFolderId + " or its contents
When_a_workspace_member_with_edit_permissions_moves_a_document_to_a_folder_with_see_only_permissions	403	Forbidden	Authorization	User does not have edit permission on target folder " + destinationFolderId
When_a_workspace_member_with_edit_permissions_moves_a_document_locked_by_himself_to_a_folder_with_see_permissions	403	Forbidden	Authorization	User does not have edit permission on target folder " + destinationFolderId
When_a_workspace_member_with_edit_permissions_moves_a_document_locked_by_himself_to_a_folder_with_edit_permissions	204	NoContent
When_a_document_owner_with_edit_permissions_moves_a_document_locked_by_himself_to_a_folder_with_edit_permissions	204	NoContent
When_a_document_owner_with_edit_permissions_moves_a_document_locked_by_someone_else_to_a_folder_with_edit_permissions	409	Conflict	Conflict	The document is locked by another user
When_the_destination_folder_is_deleted	403	Forbidden	Authorization	The target parent has been deleted
When_the_destination_folder_does_not_exist	400	BadRequest	BadDataFormat	The target folder does not exist.
When_the_destination_folder_id_is_a_string	400	BadRequest	BadRequest	Parent link format is not valid.
When_the_destination_folder_id_is_ommited	400	BadRequest	BadRequest	Parent link format is not valid.
When_the_destination_folder_is_not_posted	400	BadRequest	BadRequest	Parent link was not provided.
When_moving_a_document_that_has_moving_in_process_status	409	Conflict	Conflict	The document processing status is not complete

Moving a document to a new workspace

Case	Error	Description	Code	Error Message
When_moving_a_document_that_is_processing	409	Conflict	Conflict	The document processing status is not complete
When_editing_a_document_and_moving_it_to_a_deleted_folder	403	Forbidden	Authorization	The target parent has been deleted
When_user_is_manager_in_the_source_workspace_but_not_in_the_destination_workspace_and_has_readonly_permissions_on_both_source_and_target_folders	403	Forbidden	Authorization	Not authorised to write inside this folder
When_moving_a_document_to_a_workspace_where_the_account_is_suspended	403	Forbidden	AccountStatus	Account suspended
When_moving_a_document_to_a_workspace_where_the_account_is_payment_required	403	Forbidden	AccountStatus	Account payment failed
When_moving_a_document_to_a_workspace_where_the_account_is_subscribing	403	Forbidden	AccountStatus	Account not activated
When_moving_a_document_to_a_workspace_where_the_account_is_deleted	403	Forbidden	AccountStatus	Account deleted
When_moving_a_document_to_a_workspace_that_is_deleted	410	Gone	WorkspaceDeleted	The workspace has been deleted
When_moving_a_document_to_a_workspace_that_is_locked	403	Forbidden	WorkspaceStatus	The workspace has been locked
When_moving_a_document_to_a_workspace_that_is_finalized	403	Forbidden	Authorization	The workspace has been finalised

Creating a new version of a document

Case	Error	Description	Code	Error Message
When_the_member_creates_new_document_version_on_a_folder_in_which_he_has_readonly_permission	403	Forbidden	Authorization	Not authorised to write inside this folder
When_the_member_creates_new_document_version_on_a_folder_in_which_he_has_no_permission	403	Forbidden	Authorization	Not authorised to write inside this folder
When_the_user_is_not_member_of_the_workspace	403	Forbidden	Authorization	is not a member of the workspace
When_the_manager_creates_new_document_version_on_a_document_locked_by_someone_else	409	Conflict	Conflict	The document is locked by another user
When_the_title_is_empty	400	BadRequest	Validation	Title: Must be between 1 and 128 characters
When_an_empty_document_with_description_more_than_2048_characters_is_created	400	BadRequest	Validation	Description: Must be between 0 and 2048 characters"
When_an_empty_document_with_title_more_than_128_characters_is_created	400	BadRequest	Validation	Title: Must be between 1 and 128 characters
When_adding_a_new_version_and_the_document_id_is_a_string	404	NotFound
When_adding_a_new_version_and_the_document_id_is_omitted	404	NotFound
When_adding_a_new_version_and_the_document_id_is_invalid	404	NotFound
When_creating_a_new_version_and_the_account_is_suspended	403	Forbidden	AccountStatus	Account suspended
When_creating_a_new_version_and_the_account_is_payment_failed	403	Forbidden	AccountStatus	Account payment failed
When_creating_a_new_version_and_the_account_is_deleted	403	Forbidden	AccountStatus	Account deleted
When_creating_a_new_version_and_the_account_is_subscribing	403	Forbidden	AccountStatus	Account not activated
When_creating_a_new_version_in_a_deleted_workspace	410	Gone	WorkspaceDeleted	The workspace has been deleted.
When_creating_a_new_version_in_a_locked_workspace	403	Forbidden	WorkspaceStatus	The workspace has been locked
When_creating_a_new_version_and_the_document_is_deleted	410	Gone	ObjectDeleted	The object has been deleted
When_posting_without_title_but_with_description	201	Created
When_creating_a_new_version_and_the_document_has_moving_status	409	Conflict	DocumentProcessingStatus	The document is currently being moved

Deleting a document

Case	Error	Description	Code	Error Message
When_a_manager_deletes_a_document_owned_by_someone_else_in_a_folder_on_which_he_has_readonly_permission	200	OK
When_a_member_deletes_the_document_created_by_someone_else	403	Forbidden	Authorization	The user is not the owner of the document or the workspace manager
When_a_member_deletes_a_document_they_own_in_a_folder_on_which_he_has_readonly_permission	200	OK
When_a_member_deletes_a_document_they_own_in_a_folder_on_which_he_has_no_permission	403	Forbidden	Authorization	The user is not a member of a team which has permissions to view folder
When_a_member_deletes_the_document_in_a_workspace_he_is_not_member_of	403	Forbidden	Authorization	User " + anotherUser.Username +" is not a member of the workspace
When_a_document_owner_deletes_the_document_in_a_workspace_he_is_no_longer_a_member_of	403	Forbidden	Authorization	User " + anotherUser.Username + " is not a member of the workspace
When_deleting_the_document_and_the_account_is_suspended	403	Forbidden	AccountStatus	Account suspended
When_deleting_the_document_and_the_account_is_payment_required	403	Forbidden	AccountStatus	Account payment failed
When_deleting_the_document_and_the_account_is_deleted	403	Forbidden	AccountStatus	Account deleted
When_deleting_the_document_and_the_account_is_subscribing	403	Forbidden	AccountStatus	Account not activated
When_deleting_the_document_and_the_workspace_is_deleted	410	Gone	WorkspaceDeleted	The workspace has been deleted
When_deleting_the_document_and_the_workspace_is_locked	403	Forbidden	WorkspaceStatus	The workspace has been locked
When_deleting_the_document_and_the_workspace_is_finalised	403	Forbidden	WorkspaceStatus	The workspace has been finalised
When_deleting_an_already_deleted_document	410	Gone	ObjectDeleted	The object has been deleted
When_deleting_a_document_and_the_id_is_a_string	404	NotFound
When_deleting_a_document_and_the_id_is_invalid	404	NotFound
When_deleting_a_document_and_the_id_is_omitted	404	NotFound
When_deleting_the_document_and_the_document_has_moving_status	409	Conflict	DocumentProcessingStatus	The document is currently being moved

Restoring a document

Case	Error	Description	Code	Error Message
When_a_member_restores_a_document_that_they_did_not_delete	403	Forbidden	Authorization	The user does not have permission to delete document
When_a_user_restores_a_document_in_a_workspace_he_is_not_member_of	403	Forbidden	Authorization	User " + anotherUser.Username +" is not a member of the workspace
anotherUser.Username + " is not a member of the workspace
When_restoring_the_document_and_the_account_is_suspended	403	Forbidden	AccountStatus	Account suspended
When_restoring_the_document_and_the_account_is_payment_required	403	Forbidden	AccountStatus	Account payment failed
When_restoring_the_document_and_the_account_is_deleted	403	Forbidden	AccountStatus	Account deleted
When_restoring_the_document_and_the_account_is_subscribing	403	Forbidden	AccountStatus	Account not activated
When_restoring_the_document_and_the_workspace_is_deleted	410	Gone	WorkspaceDeleted	The workspace has been deleted
When_restoring_the_document_and_the_workspace_is_locked	403	Forbidden	WorkspaceStatus	The workspace has been locked
When_restoring_the_document_and_the_workspace_is_finalised	403	Forbidden	WorkspaceStatus	The workspace has been finalised
When_restoring_a_document_and_the_id_is_a_string	404	NotFound
When_restoring_a_document_and_the_id_is_invalid	404	NotFound
When_restoring_a_document_and_the_id_is_omitted	404	NotFound
When_restoring_a_permanently_deleted_document	410	Gone	ObjectDeleted	The object has been permanently deleted

Creating a document lock

Case	Error	Description	Code	Error Message
When_an_owner_locks_a_document_in_a_folder_on_which_he_has_readonly_permission	403	Forbidden	Authorization	User does not have edit permission on folder " + expectedFolderId + " or its contents
When_an_owner_locks_a_document_in_a_folder_on_which_he_has_no_permission	403	Forbidden	Authorization	User does not have edit permission on folder " + expectedFolderId + " or its contents
When_a_member_locks_a_document_in_a_workspace_he_is_not_member_of	403	Forbidden	Authorization	User is not a member of the workspace
When_a_member_locks_a_document_that_is_already_locked_in_a_workspace_he_is_not_member_of	403	Forbidden	Authorization	User is not a member of the workspace
When_a_manager_locks_an_already_locked_document_by_himself	409	Conflict	Conflict	The document is already locked
When_a_manager_locks_an_already_locked_document_by_someone_else	409	Conflict	Conflict	The document is already locked
When_a_manager_locks_a_deleted_document	410	Gone	ObjectDeleted	The object has been deleted
When_locking_the_document_and_the_account_is_suspended	403	Forbidden	AccountStatus	Account suspended
When_locking_the_document_and_the_account_is_payment_required	403	Forbidden	AccountStatus	Account payment failed
When_locking_the_document_and_the_account_is_deleted	403	Forbidden	AccountStatus	Account deleted
When_locking_the_document_and_the_account_is_subscribing	403	Forbidden	AccountStatus	Account not activated
When_locking_the_document_and_the_workspace_is_deleted	410	Gone	WorkspaceDeleted	The workspace has been deleted.
When_locking_the_document_and_the_workspace_is_locked	403	Forbidden	WorkspaceStatus	The workspace has been locked
When_locking_the_document_and_the_workspace_is_finalised	403	Forbidden	WorkspaceStatus
When_locking_the_document_and_the_id_is_a_string	404	NotFound
When_locking_the_document_and_the_id_is_omitted	404	NotFound
When_locking_the_document_and_the_id_is_invalid	404	NotFound
When_locking_the_document_and_the_document_has_moving_status	409	Conflict	DocumentProcessingStatus	The document is currently being moved

Deleting a document lock

Case	Error	Description	Code	Error Message
When_the_member_unlocks_a_document_that_someone_else_locked_in_a_folder_with_edit_permission	403	Forbidden	Authorization	The document is locked by another user
When_the_owner_unlocks_a_document_that_someone_else_locked_in_a_folder_with_read_only_permission	403	Forbidden	Authorization	User does not have edit permission on folder " + expectedFolderId + " or its contents
When_the_owner_unlocks_a_document_that_they_locked_in_a_folder_with_read_only_permission	403	Forbidden	Authorization	User does not have edit permission on folder " + expectedFolderId + " or its contents
When_the_owner_unlocks_a_document_that_they_locked_in_a_folder_with_no_permission	403	Forbidden	Authorization	User does not have edit permission on folder " + expectedFolderId + " or its contents
When_the_owner_unlocks_a_document_that_somebody_else_locked_in_a_folder_with_edit_permission	403	Forbidden	Authorization	The document is locked by another user
When_a_manager_unlocks_a_document_in_a_workspace_they_dont_belong_to	403	Forbidden	Authorization	not a member of the workspace
When_a_manager_unlocks_a_document_in_a_workspace_they_dont_belong_to_and_the_document_is_not_locked	403	Forbidden	Authorization	not a member of the workspace
When_a_manager_unlocks_a_document_and_the_account_is_suspended	403	Forbidden	AccountStatus	Account suspended
When_a_manager_unlocks_a_document_and_the_account_is_payment_required	403	Forbidden	AccountStatus	Account payment failed
When_a_manager_unlocks_a_document_and_the_account_is_deleted	403	Forbidden	AccountStatus	Account deleted
When_a_manager_unlocks_a_document_and_the_account_is_subscribing	403	Forbidden	AccountStatus	Account not activated
When_a_manager_unlocks_a_document_and_the_workspace_is_deleted	410	Gone	ObjectDeleted	The workspace has been deleted
When_a_manager_unlocks_a_document_and_the_workspace_is_locked	403	Forbidden	WorkspaceStatus	The workspace has been locked
When_a_manager_unlocks_a_document_and_the_workspace_is_finalized	403	Forbidden	WorkspaceStatus	The workspace has been finalised
When_a_manager_unlocks_a_document_and_the_document_is_deleted	410	Gone	ObjectDeleted	The object has been deleted
When_a_manager_unlocks_a_document_and_the_document_is_not_locked	404	NotFound	ObjectNotFound	There is no lock on the document
When_a_manager_unlocks_a_document_and_the_document_id_is_a_string	404	NotFound	ResourceMatchingFailed
When_a_manager_unlocks_a_document_and_the_document_id_is_ommitted	404	NotFound	ResourceMatchingFailed
When_a_manager_unlocks_a_document_and_the_document_id_is_invalid	404	NotFound	ResourceMatchingFailed
When_a_manager_unlocks_a_document_and_the_document_has_moving_status	409	Conflict	DocumentProcessingStatus	The document is currently being moved

Retrieving document version history lock

Case	Error	Description	Code	Error Message
When_the_filename_is_empty	400	BadRequest	Validation	FileName: Must be between 1 and 2048 characters
When_a_member_gets_the_history_of_a_document_created_by_himself_in_a_folder_with_no_permissions	403	Forbidden	Authorization	The user does not have permissions to view this document
When_a_member_gets_the_history_of_a_document_in_a_workspace_he_is_not_member_of	403	Forbidden	Authorization	User " + member.Username + " is not a member of the workspace
When_getting_the_history_and_the_account_is_suspended	403	Forbidden	AccountStatus	Account suspended
When_getting_the_history_and_the_account_is_payment_failed	403	Forbidden	AccountStatus	Account payment failed
When_getting_the_history_and_the_account_is_deleted	403	Forbidden	AccountStatus	Account deleted
When_getting_the_history_and_the_account_is_subscribing	403	Forbidden	AccountStatus	Account not activated
When_getting_the_history_and_the_workspace_is_deleted	410	Gone	WorkspaceDeleted	The workspace has been deleted
When_getting_the_history_and_the_workspace_is_locked	403	Forbidden	WorkspaceStatus	The workspace has been locked
When_getting_the_history_and_the_document_has_been_deleted	410	Gone	ObjectDeleted	The object has been deleted
When_getting_the_history_and_the_document_id_is_a_string	404	NotFound
When_getting_the_history_and_the_document_id_is_invalid	404	NotFound
When_getting_the_history_and_the_document_id_is_omitted	404	NotFound

Restoring a folder

Case	Error	Description	Code	Error Message
When_a_member_with_permissions_restores_a_folder_deleted_by_the_member	204	NoContent
When_a_workspace_manager_with_permissions_restores_a_folder	204	NoContent
When_a_member_restores_a_folder_that_they_did_not_delete	403	Forbidden	Authorization	The user does not have permission to delete folder
When_a_member_restores_a_subfolder_they_own_in_a_folder_on_which_he_has_no_permission	403	Forbidden	Authorization	The user is not a member of a team which has permissions to view folder
When_a_member_deletes_the_folder_in_a_workspace_he_is_not_member_of	403	Forbidden	Authorization	User " + anotherUser.Username +" is not a member of the workspace
When_a_folder_owner_restores_the_folder_in_a_workspace_he_is_no_longer_a_member_of	403	Forbidden	Authorization	User " + anotherUser.Username + " is not a member of the workspace
When_restoring_the_folder_and_the_account_is_suspended	403	Forbidden	AccountStatus	Account suspended
When_restoring_the_folder_and_the_account_is_payment_required	403	Forbidden	AccountStatus	Account payment failed
When_restoring_the_folder_and_the_account_is_deleted	403	Forbidden	AccountStatus	Account deleted
When_restoring_the_folder_and_the_account_is_subscribing	403	Forbidden	AccountStatus	Account not activated
When_restoring_the_folder_and_the_workspace_is_deleted	410	Gone	WorkspaceDeleted	The workspace has been deleted
When_restoring_the_folder_and_the_workspace_is_locked	403	Forbidden	WorkspaceStatus	The workspace has been locked
When_restoring_the_folder_and_the_workspace_is_finalised	403	Forbidden	WorkspaceStatus	The workspace has been finalised
When_restoring_a_folder_and_the_id_is_a_string	404	NotFound
When_restoring_a_folder_and_the_id_is_invalid	404	NotFound
When_restoring_a_folder_and_the_id_is_omitted	404	NotFound
When_restoring_a_permanently_deleted_folder	410	Gone	ObjectDeleted	The object has been permanently deleted

Notification Headers

Case	Error	Description	Code	Error Message
When_the_x-notification-scope_has_no_value	400	BadRequest	BadRequest	Value required for notification scope header
When_the_x-notification-scope_has_a_non_valid_value	400	BadRequest	BadRequest	The notification scope of dfgdfg does not exist and is not valid
When_the_x-notification_scope_header_has_the_value_of_stakeholders_and_the_x-in_reply-to is missing	400	BadRequest	BadRequest	No x-in-reply-to header specified
When_the_x-in_reply_to_has_no_value	400	BadRequest	BadRequest	The notification provided is not a valid Guid for discussion 27229183
When_the_x-in_reply_to_value_is_not_a_guid	400	BadRequest	BadRequest	The notification provided is not a valid Guid for discussion 123
When_the_x-in_reply_to_is_a_guid_that_does_not_correspond_to_the_discussion	404	NotFound	ObjectNotFound	Cannot retrieve notifications group for notification id 123

Editing an assignment

Case	Error	Description	Code	Error Message
When_an_open_assignment_is_rejected_without_a_comment	400	BadRequest	Validation	A comment must be specified when rejecting an approval
When_an_open_assignment_is_rejected_with_an_empty_comment	400	BadRequest	Validation	A comment must be specified when rejecting an approval
When_a_complete_assignment_is_rejected	400	BadRequest	Validation	Assignment has already been completed
When_a_complete_assignment_is_marked_open	400	BadRequest	Validation	Assignment has already been completed
When_a_complete_assignment_is_marked_complete	400	BadRequest	Validation	Assignment has already been completed
When_an_open_assignment_is_rejected_with_a_comment_2049_chars_in_length	400	BadRequest	Validation	Comment: Must be between 0 and 2048 characters

Creating a new comment

Case	Error	Description	Code	Error Message
When_a_comment_is_posted_with_2049_chars	400	BadRequest	Validation	Content: Must be between 1 and 2048 characters
When_a_comment_is_posted_with_0_chars	400	BadRequest	Validation	Content: Must be between 1 and 2048 characters
When_a_comment_is_posted_with_a_stakeholder_notification_scope_but_no_id	400	BadRequest	BadRequest	No x-in-reply-to header specified

Retrieving progress for a cascade folder permissions operation

Case	Error	Description	Code	Error Message
When_the_folder_does_not_exist	404	NotFound	ObjectNotFound	The folder could not be found.
When_there_is_no_permission_cascade_progress_data_for_the_folder	404	NotFound	ObjectNotFound	No permission cascade progress data found for folder 123
When_the_user_is_authorised_to_edit_permissions_on_the_folder	403	Forbidden	Authorisation	The user does not have rights to edit permissions on this folder.