GET api/v100/messages?latitude={latitude}&longitude={longitude}&language={language}

Get a list of messages.

Request Information

URI Parameters

Name	Description	Type	Additional information
latitude	Current Mobile Latitude	decimal number	None.
longitude	Current Mobile Longitude	decimal number	None.
language	Language ISO Code for the messages.	string	None.

Headers

Name	Description	Type	Additional information
appkey	Ej. abcdefghijk		None.
session	Ej. 1234567890		None.

Body Parameters

None.

Response Information

Resource Description

Collection of RsMessages

Name	Description	Type	Additional information
id	Identifier	integer	Required
messageTitle	Optional Message Title (this string will be displayed highlighted).	string	String length: inclusive between 0 and 500
messageBody	Optional Message Body (this string will be displayed in normal text).	string	String length: inclusive between 0 and 500
imageBody	Optional Image to be displayed in the message placeholder.	string	String length: inclusive between 0 and 100
url	URL to a web page that will be opened if the user selects the message.	string	String length: inclusive between 0 and 200
duration	Duration in seconds that the message will be displayed and then the next message will be presented.	integer	Required

Response Formats

application/json, text/json

Sample:

[
  {
    "id": 1,
    "messageTitle": "sample string 2",
    "messageBody": "sample string 3",
    "imageBody": "sample string 4",
    "url": "sample string 5",
    "duration": 6
  },
  {
    "id": 1,
    "messageTitle": "sample string 2",
    "messageBody": "sample string 3",
    "imageBody": "sample string 4",
    "url": "sample string 5",
    "duration": 6
  }
]