Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update soap-api.md #98

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update soap-api.md #98

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
51 changes: 51 additions & 0 deletions manual/customize/soap-api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,10 @@ The following functions are currently available through the Sympa SOAP server :
- `review`

Lists the members of a given list.

- `fullReview`

Lists the members, editors and owners of a given list.

- `subscribe`

Expand Down Expand Up @@ -534,6 +538,19 @@ Parameters:
Output example:

``` code
0
_homepage_
'http://domain.tld/sympa-dv/info/bluemambo'
_info_
'Description list of blue mambo. A long line.'
_isEditor_
'1'
_isOwner_
'1'
_listAddress_
'bluemambo@domain.tld'
_subject_
'Another mambo. This one is blue.'
```

#### which
Expand Down Expand Up @@ -666,6 +683,40 @@ review....
'mail3@renater.fr'
```

#### fullReview

Parameters:

- the name of the list for which we want the subscribers, editors and owner list (mandatory).

Output example:

``` code
review....
0
_email_
'mail1@renater.fr'
_gecos_
UNDEF
_isEditor_
'0'
_isOwner_
'0'
_isSubscriber_
'1'
1
_email_
'mail2@renater.fr'
_gecos_
'My name'
_isEditor_
'0'
_isOwner_
'1'
_isSubscriber_
'0'
```

#### subscribe

Parameters:
Expand Down