Skip to main content

Documentation

Poll - Terminal Response

Check via the poll method if the terminal has responded to a request.

Note

This method is rate limited to one call per second per pollId.

Parameters
Request Header Parameters
Request Path Parameters

    • pollId

    • The pollId that was provided in the initial request.

202 Accepted Response
400 Error Response

    • type

    • Example: https://tools.ietf.org/html/rfc7231#section-6.5.1

    • title

    • Bad Request

    • status

    • 400

    • detail

    • DeviceId not registered

429 Error Response

    • message

    • Too many requests

500 Error Response

    • Message

    • Server Error

  • /poll/terminalresponse/:pollID

  • 202 Poll Terminal Response Accepted

  • curl -X get https://CloudLinkApi/poll/terminalresponse/e02f7fbe-f3a2-49fb-9979-2f240e119499 
-H 'X-API-KEY: your-access-key-here'
  • {
  "message": "Accepted"	
}

  • 400 Poll Terminal Response Rejected - Unauthorized

  • curl -X get https://CloudLinkApi/poll/terminalresponse/e02f7fbe-f3a2-49fb-9979-2f240e119499 
-H 'X-API-KEY: your-access-key-here'
  • {
  "message": "Unauthorized"
}

  • 429 Poll Terminal Response - Too Many Requests

  • curl -X get https://CloudLinkApi/poll/terminalresponse/e02f7fbe-f3a2-49fb-9979-2f240e119499
-H 'X-API-KEY: your-access-key-here'
  • {
  "message": "Too Many Requests"
}

  • 500 Poll Terminal Response - Server Error

  • curl -X get https://CloudLinkApi/poll/terminalresponse/e02f7fbe-f3a2-49fb-9979-2f240e119499 
-H 'X-API-KEY: your-access-key-here'
  • {
  "message": "Server Error"
}
In this section: