Forms/Status

Description: Update status of the form

API Name: /Forms/Status

HTTP Method: PUT

HTTP Status Codes:

HTTP Status Codes Description
1 200 Ok
2 400 Bad Request
3 404 Not Found
4 500 Internal Server Error 
/// OK [200]
{
 "response": null
 "status": "OK",
 "errors": null
}

Bad Request example [400]

    {
       "Response": null,
       "Status": "Failure",
       "Errors": [{
               "Code": "",
               "Message": "",
               "Detail": null,
               "Type": null,
               "TraceId": null,
               "ValidationErrors": [{
                       "Field": "FormFilingStatus",
                       "Code": 400,
                       "Message": "FormFilingStatus should be valid."
                   }
               ]
           }
       ]
    }

Not Found example [404]

   {
      "Response": null,
      "Status": "Failure",
      "Errors": [{
              "Code": "404",
              "Message": "Form not found",
              "Detail": null,
              "Type": null,
              "TraceId": null,
              "ValidationErrors": null
          }
      ]
   }

Internal Server Error example [500]  
{
       "Response": null,
       "Status": "Failure",
       "Errors": [
           {
               "Code": "1001",
               "Message": "Some error message from server",
               "Detail": null,
               "Type": null,
               "TraceId": "d0ce45e6-df15-4a04-aaa8-c1c762c6828c",
               "ValidationErrors": []
           }
       ]
}

API Request

List

UpdateStatusRequest model

Request Parameter DataType Validations Mandatory Description
1 FormId GUID Y Identifier for Individual Form
2 FormFilingStatus Enum Y Status of Individual Form

FormFilingStatus Values:

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

API Response

Response Field DataType Description
1 Response Object response
2 Status string Status of the response
3 Errors ErrorResponse If error, return message