Webmailnames:GET
(Difference between revisions)
				
																
				
				
								
				Mike.robski  (Talk | contribs) m (1 revision: Release 97)  | 
		 (→Response)  | 
		||
| Line 13: | Line 13: | ||
== Response ==  | == Response ==  | ||
| − | Returns a dictionary containing WebMail plan names   | + | Returns a dictionary containing the full list of available OpenXchange types by text key and WebMail plan names.  | 
=== Status Code ===  | === Status Code ===  | ||
Revision as of 07:22, 9 May 2016
GET /webmailnames
Retrieves WebMail plan names mapping.
Contents | 
Request
GET /webmailnames
Request Parameters
None.
URI Parameters
None.
Response
Returns a dictionary containing the full list of available OpenXchange types by text key and WebMail plan names.
Status Code
- 200 OK
 - Success
 
Response Body
{
   "webmailNames": {
      "activesync": "SMX Sync Advanced", 
      "premium": "SMA Collaborate Premium", 
      "standard": "SMX Mail Basic"
   }, 
   "links": [
      {
         "href": "https://api.hostway.com/webmailnames/", 
         "rel": "self"
      }
   ]
}
  
Parameters
- webmailNames - dictionary
 - Dictionary containing WebMail plan names mapping
 
- links - list
 - Hypermedia for this resource.
 
See also