feedback-poll.md

poll feedback

Request for result to the feedback service request. A call to Startup must have been performed first before the poll service is invoked. The orchestrate service will return a cookie called mdtpapi and this cookie must be supplied to the poll service. This service should be invoked every 2-3 seconds to verify the outcome of the Startup service call which created the async task.

• URL

  /native-app/{nino}/poll

• Method:

  GET

• Success Response:

  • Code: 200
    Content:

If the task has not completed, the below will be returned.

{
  "status" : "poll"
}

On success the below JSON will be returned.

{
  "OrchestrationResponse": {
    "response": [
      {
        "serviceName": "feedback",
        "responseData": {
          "ticket_id": 1234567890
        }
      }
    ]
  },
  "status": {
    "code": "complete"
  }
}

When a failure occurs submitting the feedback, the below response (based on a single request) will be returned. Please note the JSON attribute called "failure".

{
  "OrchestrationResponse": {
    "response": [
      {
        "serviceName": "deskpro-feedback",
        "failure": true
      }
    ]
  },
  "status": {
    "code": "complete"
  }
}

Please note the above "status" attribute could be complete, poll, error or timeout. If the response status is "poll", the request has not completed processing. A new call is required to the /native-app/{nino}/poll service to understand the outcome of the call. If the response status is "error" then a server-side failure occurred building mandatory response data. If the response status is "timeout" then the server-side timed-out waiting for the backend services to reply.

If the response status is complete then the async service call has completed. The response will contain a list of response objects containing responseData, which is the response of the service call made.

• Error Response:

  • Code: 400 BADREQUEST
    Content: {"code":"BADREQUEST","message":"Bad Request"}

  • Code: 404 NOTFOUND
    

  • Code: 406 NOT ACCEPTABLE
    Content: {"code":"ACCEPT_HEADER_INVALID","message":"The accept header is missing or invalid"}

  OR when there is a server failure

  • Code: 500 INTERNAL_SERVER_ERROR