POST apiassetoauth/driive/documentstatus

Update a document status

Request Information

URI Parameters

None.

Body Parameters

The DriiveDocumentStausRequest

OAuthDriiveDocumentStatusRequest
NameDescriptionTypeAdditional information
DocumentId

The document id to update the status

integer

None.

Status

The status of this document

OAuthDocumentStatus

None.

Request Formats

application/json, text/json

Sample:
{
  "DocumentId": 1,
  "Status": 0
}

application/xml, text/xml

Sample:
<OAuthDriiveDocumentStatusRequest xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <DocumentId>1</DocumentId>
  <Status>Downloaded</Status>
</OAuthDriiveDocumentStatusRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Bool indicated if the status was saved correctly

DriiveDocumentStausResponse
NameDescriptionTypeAdditional information
Result

boolean

None.

Response Formats

application/json, text/json

Sample:
{
  "Result": true
}

application/xml, text/xml

Sample:
<DriiveDocumentStausResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Result>true</Result>
</DriiveDocumentStausResponse>