msnp-wiki/docs/services/sharingservice/addmember.md

61 lines
2 KiB
Markdown
Raw Normal View History

# Introduction
`AddMember` is one of the SOAP actions the [Contact Sharing Service](../sharingservice.md) provides.
Adds a user to the Allow List (AL), Block List (BL),
or if the user is in the Pending List (PL), the Reverse List (RL).
# Client/Request
The template used in this action is described on the [Address Book Service](../abservice.md) main page.
## AddMember
This element has only one attribute:
* `xmlns:` Is always set to `http://www.msn.com/webservices/AddressBook`.
### serviceHandle
This element contains three children:
* `<Id>`: This is always set to `0`.
* `<Type>`: This has only been observed to be `Messenger`.
* `<ForeignId>`: This has only been observed have no content,
but is not an empty element.
### memberships
This element only contains `<Membership>` elements.
#### Membership
This element contains two children:
* `<MemberRole>`: The type of list:
* `Allow`: The Allow List (AL).
* `Block`: The Block List (BL).
* `Reverse`: The Reverse List (RL).
* `<Members>`: Explained below.
##### Members
This element only contains `<Member>` elements.
###### Member
This element has two attributes:
* `xsi:type`: The type of this `<Member>`:
* `PassportMember`
* `EmailMember`
* `PhoneMember`
* `xmlns:xsi`: This is always set to `http://www.w3.org/2001/XMLSchema-instance`.
This element contains two children:
* `<Type>`: The type of this `<Member>`:
* `Passport`
* `Email`
* `Phone`
* `<State>`: This is usually only set to `Accepted`, but `Pending` is a valid value.
This element also contains one of the following mutually exclusive children.
1. `<PassportName>`: The user handle associated with this membership.
2. `<Email>`: The e-mail address associated with this membership.
2. `<PhoneNumber>`: The phone number associated with this membership.
# Server/Response
The template used in this action is described on the [Address Book Service](../abservice.md) main page.
## AddMemberResponse
This empty element has only one attribute:
* `xmlns:` Is always set to `http://www.msn.com/webservices/AddressBook`.