GET Exchange Mailing List

From Hostway API Documentation
Jump to: navigation, search

Retrieve details for a particular Exchange mailing list

GET /accounts/{account-number}/exchange/{domain-name}/mailingLists/{name}


Parameters

account-number - string
The account-number that the Exchange resource belongs to
domain-name - string
The domain-name that is associated with the Exchange resource
name - string
Name of the requested mailing list

Response Body

{
  "name" : "test_list2",
  "links" : [ {
    "href" : "http://coreapi01.ote.chicago.hostway:8094/accounts/dinh754963/exchange/ng-test-dinh-123.com/mailingLists/test_list2/",
    "rel" : "self"
  } ],
  "members" : "http://coreapi01.ote.chicago.hostway:8094/accounts/dinh754963/exchange/ng-test-dinh-123.com/mailingLists/test_list2/members",
  "owner" : "dinh.anh",
  "billingstatus" : "open",
  "description" : "test_list2"
}
 
name - string
the name of the mailing list
description - string
user defined description of the mailing list
billingstatus - string
Current status of the mailing list. Allowed values are pending, open, suspended, close_pending, closed and purge_pending
links - list
Hypermedia for this resource. Links to self.


Expected Response Codes

200
Success
304
The mailing list has not been modified since the time specified in the If-Modified-Since header of the request. The client should use its own cached copy of the mailing list resource.
401
Not authenticated
Returned when the request does not contain an authorization header
403
Forbidden
Returned when the authenticated user does not have permission to view the specified mailing list.
404
Non-existent resource
500
Internal server error
502
Bad gateway
Returned when an error was caused by another error in an upstream system, or if an upstream system is found to be in an inconsistent state.
Personal tools
Namespaces
Variants
Actions
APIs
Navigation
Toolbox