Mike.robski: 1 revision: Release 95

2014-07-02T05:59:33Z

1 revision: Release 95

Dragomir.penev at 16:17, 12 August 2013

2013-08-12T16:17:37Z

New page

= '''POST''' <code>/accounts/''{account_number}''/exchange/''{domain_name}''/malingLitsts/''{username}''/members</code> =
Add a new member to a given mailing list
__TOC__

== Request ==
'''POST''' <code>/accounts/''{account_number}''/exchange/''{domain_name}''/malingLitsts/''{username}''/members</code>

==== Request 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

; username - ''string''
: The username that is associated with the Mailing List resource

=== Request Body ===
<nowiki>
{
"username": {username}
}
</nowiki>

==== Parameters ====
;username - ''string''
:username of a '''global contact''' or '''mailbox''' to be added to the given mailing list

== Response ==

=== Status Code ===
;201
: Created

;404
: Non-existent resource. Returned if:
: - no Exchange service could be found for the given domain name OR
: - there is no mailing list with the given username for the given domain name

;400
: Not qualified member. The username provided is neither a mailbox nor a global contact username.

;409
: A member with that particular "username" has already been added.

;405
: Unsupported method

;415
: Validation error

;502
: Internal server error

=== Response Headers ===
;Location
:Contains the URL to the new resource

=== Response Body ===
''None'' - the response body is empty

== Examples ==

=== Adding a member and check that the member has been added successfully ===
==== Get a members list before adding ====

'''Request'''
<nowiki>
GET http://localhost:6543/accounts/anh74902/exchange/ng-test-anh-080613.com/mailingLists/test_list/members
</nowiki>

'''Response'''
'''HTTP/1.0 200 OK'''
<nowiki>
{
"list" : [ {
"username" : "test_mail3",
"type" : "mailbox",
"name" : "Test Exchange2010 Mailbox 3",
"links" : [ {
"href" : "http://localhost:6543/accounts/anh74902/exchange/ng-test-anh-080613.com/mailingLists/test_list/members/test_mail3",
"rel" : "self"
}, {
"href" : "http://localhost:6543/accounts/anh74902/exchange/ng-test-anh-080613.com/mailboxes/test_mail3",
"rel" : "related"
} ]
}, {
"username" : "00000140538bfdc52362a80b007f000000010001",
"type" : "globalContact",
"name" : "Anh Hostway",
"links" : [ {
"href" : "http://localhost:6543/accounts/anh74902/exchange/ng-test-anh-080613.com/mailingLists/test_list/members/00000140538bfdc52362a80b007f000000010001",
"rel" : "self"
}, {
"href" : "http://localhost:6543/accounts/anh74902/exchange/ng-test-anh-080613.com/globalContacts/00000140538bfdc52362a80b007f000000010001",
"rel" : "related"
} ]
} ],
"links" : [ {
"href" : "http://localhost:6543/accounts/anh74902/exchange/ng-test-anh-080613.com/mailingLists/test_list/members/",
"rel" : "self"
} ]
}
</nowiki>

==== Add a member ====

'''Request'''
<nowiki>
POST http://localhost:6543/accounts/anh74902/exchange/ng-test-anh-080613.com/mailingLists/test_list/members
</nowiki>

<nowiki>
{ "username": "test_mail" }
</nowiki>

'''Response'''
<nowiki>
HTTP/1.0 201 Created
</nowiki>

==== Get a members list after adding ====

'''Request'''
<nowiki>
GET http://localhost:6543/accounts/anh74902/exchange/ng-test-anh-080613.com/mailingLists/test_list/members
</nowiki>

'''Response'''
'''HTTP/1.0 200 OK'''
<nowiki>
{
"list" : [ {
"username" : "test_mail3",
"type" : "mailbox",
"name" : "Test Exchange2010 Mailbox 3",
"links" : [ {
"href" : "http://localhost:6543/accounts/anh74902/exchange/ng-test-anh-080613.com/mailingLists/test_list/members/test_mail3",
"rel" : "self"
}, {
"href" : "http://localhost:6543/accounts/anh74902/exchange/ng-test-anh-080613.com/mailboxes/test_mail3",
"rel" : "related"
} ]
}, {
"username" : "test_mail",
"type" : "mailbox",
"name" : "Test mail",
"links" : [ {
"href" : "http://localhost:6543/accounts/anh74902/exchange/ng-test-anh-080613.com/mailingLists/test_list/members/test_mail",
"rel" : "self"
}, {
"href" : "http://localhost:6543/accounts/anh74902/exchange/ng-test-anh-080613.com/mailboxes/test_mail",
"rel" : "related"
} ]
}, {
"username" : "00000140538bfdc52362a80b007f000000010001",
"type" : "globalContact",
"name" : "Anh Hostway",
"links" : [ {
"href" : "http://localhost:6543/accounts/anh74902/exchange/ng-test-anh-080613.com/mailingLists/test_list/members/00000140538bfdc52362a80b007f000000010001",
"rel" : "self"
}, {
"href" : "http://localhost:6543/accounts/anh74902/exchange/ng-test-anh-080613.com/globalContacts/00000140538bfdc52362a80b007f000000010001",
"rel" : "related"
} ]
} ],
"links" : [ {
"href" : "http://localhost:6543/accounts/anh74902/exchange/ng-test-anh-080613.com/mailingLists/test_list/members/",
"rel" : "self"
} ]
}
</nowiki>

== See also ==
* [[Exchange]]
* [[Common Features]]

{{disqus}}
[[Category:Hostway API]]
[[Category:Exchange API]]

POST Exchange Mailing List Members List - Revision history

Mike.robski: 1 revision: Release 95

Dragomir.penev at 16:17, 12 August 2013