GET api/Doc/GetAllJobDocs

Request Information

URI Parameters

None.

Body Parameters

GetAllDocsParams
NameDescriptionTypeAdditional information
companyid

integer

None.

jaid

integer

None.

Request Formats

application/json, text/json

Sample:
{
  "companyid": 1,
  "jaid": 2
}

application/xml, text/xml

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

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

GeAllDocsResponse
NameDescriptionTypeAdditional information
Documents

Collection of JobDoc

None.

Result

boolean

None.

StatusCode

integer

None.

Status

string

None.

Messages

Collection of string

None.

Response Formats

application/json, text/json

Sample:
{
  "Documents": [
    {
      "DocId": 1,
      "Size": 2,
      "FileName": "sample string 3",
      "Extension": "sample string 4",
      "LastModified": "sample string 5"
    },
    {
      "DocId": 1,
      "Size": 2,
      "FileName": "sample string 3",
      "Extension": "sample string 4",
      "LastModified": "sample string 5"
    }
  ],
  "Result": true,
  "StatusCode": 2,
  "Status": "sample string 3",
  "Messages": [
    "sample string 1",
    "sample string 2"
  ]
}

application/xml, text/xml

Sample:
<GeAllDocsResponse 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 3</Status>
  <StatusCode>2</StatusCode>
  <Documents>
    <JobDoc>
      <DocId>1</DocId>
      <Extension>sample string 4</Extension>
      <FileName>sample string 3</FileName>
      <LastModified>sample string 5</LastModified>
      <Size>2</Size>
    </JobDoc>
    <JobDoc>
      <DocId>1</DocId>
      <Extension>sample string 4</Extension>
      <FileName>sample string 3</FileName>
      <LastModified>sample string 5</LastModified>
      <Size>2</Size>
    </JobDoc>
  </Documents>
</GeAllDocsResponse>