GET api/v100/clientApps

Get current API Status. Each version of the mobile application in each platform will have its own unique apikey. The host may deprecate an application version.

Request Information

URI Parameters

None.

Headers

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

Body Parameters

None.

Response Information

Resource Description

ClientApps

Name	Description	Type	Additional information
name	Application Name	string	Required
version	Application Version	string	Required String length: inclusive between 0 and 50
platform	Supported Platform	string	Required String length: inclusive between 0 and 50
status	current: Latest version of client application legacy: Not current release(can be used against server with reduced functionality). Upgrade must be suggested to the user. obsolete: Deprecated application(cannot be used against server). Will not be able to transact. If unknown appkey, response code will be 404.	AppstatusEnum	Required
AboutURL	About URL Image...	string	String length: inclusive between 0 and 100
faqURL	FAQ URL	string	String length: inclusive between 0 and 100
PrimaryName	Primary Name	string	None.
SecondaryName	Secondary Name	string	None.
PrimaryBackgroundColor	Primary Background Color	string	None.
PrimaryFontColor	Primary Font Color	string	None.
PrimaryFontType	Primary Font Type	string	None.
SecondaryBackgroundColor	Secondary Background Color	string	None.
SecondaryFontColor	Secondary Font Color	string	None.
SecondaryFontType	Secondary Font Type	string	None.
QRKey	Key used when read QR codes	string	None.
ListButton	Buttons Attributes of the Main Menu	Collection of Button	None.

Response Formats

application/json, text/json

Sample:

{
  "name": "sample string 1",
  "version": "sample string 2",
  "platform": "sample string 3",
  "status": 0,
  "AboutURL": "sample string 4",
  "faqURL": "sample string 5",
  "PrimaryName": "sample string 6",
  "SecondaryName": "sample string 7",
  "PrimaryBackgroundColor": "sample string 8",
  "PrimaryFontColor": "sample string 9",
  "PrimaryFontType": "sample string 10",
  "SecondaryBackgroundColor": "sample string 11",
  "SecondaryFontColor": "sample string 12",
  "SecondaryFontType": "sample string 13",
  "QRKey": "sample string 14",
  "ListButton": [
    {
      "ID": "sample string 1",
      "Text": "sample string 2",
      "BackgroundColor": "sample string 3",
      "FontType": "sample string 4",
      "FontSize": "sample string 5",
      "imgURL": "sample string 6"
    },
    {
      "ID": "sample string 1",
      "Text": "sample string 2",
      "BackgroundColor": "sample string 3",
      "FontType": "sample string 4",
      "FontSize": "sample string 5",
      "imgURL": "sample string 6"
    }
  ]
}