GET api/Poll?user={user}

Returns the next message in the queue

Request Information

URI Parameters

Name	Description	Type	Additional information
user	Optional user handle - if empty logged in user will be used	string	None.

Body Parameters

None.

Response Information

Resource Description

PollMessage on success
Collection of errors on failure
Return codes
200 - ok
404 - no more messages
500 - internal server error

PollMessage

Name	Description	Type	Additional information
Id	Message id	integer	None.
Count	Number of messages in the queue	integer	None.
Created	Message creation date	date	None.
Message	Message	string	None.
Data	Message details	Object	None.

Response Formats

application/json, text/json

Sample:

{
  "Id": 1,
  "Count": 2,
  "Created": "2025-04-05T14:17:20.6616892+02:00",
  "Message": "sample string 4",
  "Data": {}
}

application/xml, text/xml

Sample:

<PollMessage xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Namebay.Rest.Api.Models.Poll">
  <Count>2</Count>
  <Created>2025-04-05T14:17:20.6616892+02:00</Created>
  <Data />
  <Id>1</Id>
  <Message>sample string 4</Message>
</PollMessage>