Webmailnames:GET

From Hostway API Documentation
(Difference between revisions)
Jump to: navigation, search
(Response)
 
m (1 revision)
 
(2 intermediate revisions by 2 users not shown)
Line 13: Line 13:
  
 
== Response ==
 
== Response ==
Returns a dictionary containing WebMail plan names mapping set in "ConfigDB->PublicAPI->Webmail Plan Names" variable
+
Returns a dictionary containing the full list of available OpenXchange types by text key and WebMail plan names.
  
 
=== Status Code ===
 
=== Status Code ===

Latest revision as of 13:36, 30 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


blog comments powered by Disqus

Personal tools
Namespaces
Variants
Actions
APIs
Navigation
Toolbox