Forms/JobStatus

Summary:Forms/JobStatus API used to see the status of the created EDI job. User gets the response in the form of multiple fields to observe the job status

Description: API [GET] to return a list of form statuses and job Status exclusive for Forms Generation Job

API Name: /Forms/JobStatus

HTTP Method: Get

HTTP Status Codes:

HTTP Status Codes Description
1 200 OK
2 404 Job and Form GUID Record not Found
3 400 Bad Request 
    /// OK example [200]
    ///
    ///     GET /api/Forms/JobStatus
    ///{
    ///  "data": {
    ///    "result": [
     ///     {
    ///        "jobStatus": 5,
    ///        "jobStatusFormDataEntries": [
    ///          {
    ///            "formId": "032da3ad-1a00-4c1e-b6e1-f1555954e100",
    ///            "formName": "Sales tax",
    ///            "status": 3,
    ///            "logMessage": "FormGenerationErrorDummy",
    ///            "mime": "pdf",
    ///            "processingTime": 40
    ///          }
    ///        ]
    ///      }
    ///    ]
    ///  },
    ///  "status": "OK",
    ///  "errors": null
    ///}

Api Request

Request Parameter DataType Validations Mandatory Description
1 Access Token Header Yes Security Token
2 UserId Header No Client Identifier
3 JobId GUID Yes Job Identifier
4 FormId GUID No Form Identifier

API GET Response

Response Field DataType Description
0 JobStatus JobQueueInfoStatus Individual Job Status
List of Below Fields:
1 FormId Guid Identifier for Individual Form
2 FormName string (100) Name of Individual Form
3 Status FormFilingStatus Status of Individual Form
4 LogMessage string (Max) Log for Form/Job
5 MIME string (Max) File Type
6 ProcessingTime Int Amount of Time to Process Job
7 LocationId Int Location

JobQueueInfoStatus Values

  1. Created = 1,
  2. Started = 2,
  3. InProgress = 3,
  4. Completed = 4,
  5. CompletedWithFailedReturns = 5,
  6. CompletedWithTimeOut = 6,
  7. Failed = 7

FormFilingStatus Values:

  1. Pending = 1,
  2. FailedToGenerate = 2,
  3. NotReconciled = 3,
  4. Reconciled = 4,
  5. FailedToFile = 5,
  6. Filed = 6

Use case for JobStatus API

1. Consider user has executed the SubmitEDI API request. As a response, user gets a JobId.

2. If user wants to see the status of submitEDI job, user can pass JobId as parameter.

3. If the request is valid, user gets all the information he wants related to forms and status of the EDI trigger as well.