GET api/Doc/GetDocById

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
companyid	integer	None.
jaid	integer	None.
docid	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "companyid": 1,
  "jaid": 2,
  "docid": 3
}

application/xml, text/xml

Sample:

<GetDocByIdParams xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RMPAPI.Models">
  <CompanyId>1</CompanyId>
  <DocId>3</DocId>
  <JobAssId>2</JobAssId>
</GetDocByIdParams>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

GetDocByIdResponse

Name	Type	Additional information
filename	string	None.
bytes	string	None.
Result	boolean	None.
StatusCode	integer	None.
Status	string	None.
Messages	Collection of string	None.

Response Formats

application/json, text/json

Sample:

{
  "filename": "sample string 1",
  "bytes": "sample string 2",
  "Result": true,
  "StatusCode": 4,
  "Status": "sample string 5",
  "Messages": [
    "sample string 1",
    "sample string 2"
  ]
}

application/xml, text/xml

Sample:

<GetDocByIdResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RMPAPI.Models">
  <Messages xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Messages>
  <Result>true</Result>
  <Status>sample string 5</Status>
  <StatusCode>4</StatusCode>
  <Bytes>sample string 2</Bytes>
  <FileName>sample string 1</FileName>
</GetDocByIdResponse>