eQuipAPI

GetJobStatus

Returns status of an asynchronously queued 947I job

The following routes are available for this service:
GET	/dlms/transactions/jobstatus	Returns job status for a queued 947I generation request

**GetJobStatus** Parameters:
Name	Parameter	Data Type	Required	Description
UserID	query	Guid	Yes	The UserID that authorizes the caller to complete the request.
JobId	query	string	Yes	The job identifier returned when the async request was queued.

**JobStatusResponse** Parameters:
Name	Parameter	Data Type	Required
JobId	body	string	No
Status	body	string	No
Completed	body	string	No
Error	body	string	No
Warnings	body	List<string>	No

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /xml/reply/GetJobStatus HTTP/1.1 
Host: equipstage3.e-isg.com 
Content-Type: application/xml
Content-Length: length

<GetJobStatus xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/eQuipModel.Dlms.Transactions">
  <JobId>String</JobId>
  <UserID>String</UserID>
</GetJobStatus>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<JobStatusResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/eQuipModel.Dlms.Transactions">
  <Completed>String</Completed>
  <Error>String</Error>
  <JobId>String</JobId>
  <Status>String</Status>
  <Warnings xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Warnings>
</JobStatusResponse>