POST api/driive/documentstatus

Update a document status

Request Information

URI Parameters

None.

Body Parameters

The DriiveDocumentStausRequest

DriiveDocumentStausRequest
NameDescriptionTypeAdditional information
Token

The token returned after login used for authentication

string

None.

DriverId

The driver id returned after login used for authentication

unsigned integer

None.

DocumentId

The document id to update the status

integer

None.

Status

The status of this document

DocumentStatus

None.

Request Formats

application/json, text/json

Sample:
{
  "Token": "sample string 1",
  "DriverId": 2,
  "DocumentId": 3,
  "Status": 0
}

application/xml, text/xml

Sample:
<DriiveDocumentStausRequest xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Token>sample string 1</Token>
  <DriverId>2</DriverId>
  <DocumentId>3</DocumentId>
  <Status>Downloaded</Status>
</DriiveDocumentStausRequest>

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>