GET api/Members

Retrieves a list of members.

Request

Parameters

Name	Description	Default
`type`	The type of list to retrieve.	`all`

Response

Body

Content Type: application/xml or application/json
Data set containing the members, or an error message.

XML JSON
<Response> <Result> <Members> <!--Array of 'Item'--> <Item> <MemberID>long</MemberID> <!--Unique member ID--> <MemberCode>string</MemberCode> <!--Member code--> <ContactID>long</ContactID> <!--Contact number (unique ID)--> <GroupID>long</GroupID> <!--Primary member group ID--> <Group>string</Group> <!--Primary member group name--> <ShortName>string</ShortName> <!--Short name--> <LastName>string</LastName> <!--Last name--> <Initials>string</Initials> <!--Initials--> <LongName>string</LongName> <!--Name and member code--> <IsActive>bool</IsActive> <!--Whether the account is active--> </Item> </Members> <Self>long</Self> <!--Currently logged-in member--> </Result> <Message>string</Message> <!--Error message--> </Response>
{ "Result": { "Members": [{ "MemberID": "long", // Unique member ID "MemberCode": "string", // Member code "ContactID": "long", // Contact number (unique ID) "GroupID": "long", // Primary member group ID "Group": "string", // Primary member group name "ShortName": "string", // Short name "LastName": "string", // Last name "Initials": "string", // Initials "LongName": "string", // Name and member code "IsActive": "bool" // Whether the account is active }], "Self": "long" // Currently logged-in member }, "Message": "string" // Error message }

XML JSON

<Response>                                 
  <Result>                                 
    <Members>                              <!--Array of 'Item'--> 
      <Item>                               
        <MemberID>long</MemberID>          <!--Unique member ID--> 
        <MemberCode>string</MemberCode>    <!--Member code--> 
        <ContactID>long</ContactID>        <!--Contact number (unique ID)--> 
        <GroupID>long</GroupID>            <!--Primary member group ID--> 
        <Group>string</Group>              <!--Primary member group name--> 
        <ShortName>string</ShortName>      <!--Short name--> 
        <LastName>string</LastName>        <!--Last name--> 
        <Initials>string</Initials>        <!--Initials--> 
        <LongName>string</LongName>        <!--Name and member code--> 
        <IsActive>bool</IsActive>          <!--Whether the account is active--> 
      </Item>                              
    </Members>                             
    <Self>long</Self>                      <!--Currently logged-in member--> 
  </Result>                                
  <Message>string</Message>                <!--Error message--> 
</Response>

{                                   
   "Result": {                      
      "Members": [{                 
         "MemberID": "long",        // Unique member ID
         "MemberCode": "string",    // Member code
         "ContactID": "long",       // Contact number (unique ID)
         "GroupID": "long",         // Primary member group ID
         "Group": "string",         // Primary member group name
         "ShortName": "string",     // Short name
         "LastName": "string",      // Last name
         "Initials": "string",      // Initials
         "LongName": "string",      // Name and member code
         "IsActive": "bool"         // Whether the account is active
      }],                           
      "Self": "long"                // Currently logged-in member
   },                               
   "Message": "string"              // Error message
}

Status Codes

Code	Condition
200 OK	The operation completed successfully.
401 Unauthorized	Access token is invalid, expired or not specified.
406 Not Acceptable	Content type specified in the Accept header isn't supported.
500 Internal Server Error	An internal error occurred.

Remarks

The list type can be one of the following values:

Value	Description
`all`	All active members.
`restricted`	Members supervised by or collaborating with the current user.
`supervised`	Members supervised by the current user.
`calendar`	Members with shared calendars.