Web service API

How to use PageSeeder's Web service API

member

/members/{member} [GET]

com.pageseeder.member.GetMember

Description

Get the member's personal details.

This service can also be used to return the details of a member prior to activation if a valid and current activation token matching the member is provided as a parameter on the request.

This service will not activate the member but will use the activation token to return the member details.

Parameters

NameDescriptionRequiredTypeDefault value
token An activation token for the member no string

Permission

Only the member herself or an administrator can invoke this service unless an activation token issued for this member is used in lieu of authentication.

Response

This service returns the extended <member>element and will include the email address.

If the activation token parameter was included, valid and current, the XML will also include the admin flag.

The XML returned is always:

<member id="[member id]"
        firstname="[first name]"
        surname="[surname]"
        username="[username]"
        status="[activated|set-password|unactivated]"
       [onvacation="true"]
       [attachments="true"]
       [created="[date]"]
       [activated="[date]"]
       [lastpasswordchange="[date]"]
       [lastlogin="[date]"]
       [locked="true"]
       [admin="date"] >
  <fullname>[full name]</fullname>
</member>

For example:

<member id="123" 
 firstname="Joan" 
   surname="Smith"
  username="jsmith" 
    status="activated">
   <fullname>Joan Smith</fullname>
</member>

Error handling

No specific errors expected for this service.

Created on , last edited on