GET api/Pdf?requestKey={requestKey}
Get The Job Status
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| requestKey |
Request Key which return when starting jobs |
string |
Required |
Body Parameters
None.
Response Information
Resource Description
JobStates| Name | Description | Type | Additional information |
|---|---|---|---|
| RequestKey |
RequestKey for the job |
string |
None. |
| Counter |
The Student Counter |
integer |
None. |
| TestDate |
The TestDate for workBook |
integer |
None. |
| Type |
The type of workbook |
integer |
None. |
| DownloadUrl |
The url for downloading the pdf |
string |
None. |
| JobSate |
The State of job |
string |
None. |
| JobSateId |
The State Id of job |
integer |
None. |
| JobState |
The State of job |
WorkBookPdfStateResult |
None. |
| JobStateStr |
The State Id of job |
string |
None. |
| PdfCheckStateUrl |
The Url for Check State of job |
string |
None. |
| FileName | string |
None. |
|
| LandScape | boolean |
None. |
Response Formats
application/json, text/json
Sample:
{
"RequestKey": "sample string 1",
"Counter": 2,
"TestDate": 3,
"Type": 4,
"DownloadUrl": "sample string 5",
"JobSate": "sample string 6",
"JobSateId": 7,
"JobState": 0,
"JobStateStr": "sample string 8",
"PdfCheckStateUrl": "sample string 9",
"FileName": "sample string 10",
"LandScape": true
}
application/xml, text/xml
Sample:
<JobStates xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/KanoonExamPdfServiceDb.Models"> <Counter>2</Counter> <DownloadUrl>sample string 5</DownloadUrl> <FileName>sample string 10</FileName> <JobSate>sample string 6</JobSate> <JobSateId>7</JobSateId> <JobState>Success</JobState> <JobStateStr>sample string 8</JobStateStr> <LandScape>true</LandScape> <PdfCheckStateUrl>sample string 9</PdfCheckStateUrl> <RequestKey>sample string 1</RequestKey> <TestDate>3</TestDate> <Type>4</Type> </JobStates>