EndPreviousNextEnd EndPrint This TopicEnd

Members

The Members API will return a list of Contegro members

 

This can be optionally filtered by status or updated date / time, and can be paged

 

Data to be passed to the webservice

 

Variable name

Data type

Description

authToken

String

An auth token which you got by calling the GetAuthToken API

status

String

An optional status name to limit your member request by. The options are Active or Inactive

groupName

String

An optional group name to limit your member request by. Valid group names can be found by running the MemberGroups API

lastUpdatedFrom

DateTime

Optional date/time stamps representing the minimum and maximum “last updated date” value for the members to be returned

 

You could use this to only get a list of members which have been updated since the last time that you did an API request

lastUpdatedTo

DateTime

page

Integer

The optional page number (the first page has a Page value of 1)

pageSize

Integer

The optional page size, to limit the number of results which are returned

 

Data which is returned

Variable name

Data type

Description

members

XML

A list of MemberDetails records, the fields in a MemberDetails record is described below

errorCode

String

If your request was successful, the errorCode will be 0

If your request had a problem, there will be an error code for each kind of problem

errorMessage

String

A description of the problem with your error request (if there was a problem)

If your request was successful, this will be an empty string

 

MemberDetails record

Variable name

Data type

Description

memberId

Integer

The member’s unique identifier

firstName

String


lastName

String


emailAddress

String


loginName

String


groups

String array

A list of the groups that the member belongs to

createdDate

DateTime

The date/time that the member was created

lastUpdatedDate

DateTime

The date/time that the member was last updated

status

String

The status name of the user (ie: Active / Inactive)

 

Example XML for a Members request

<?xml version="1.0" encoding="utf-8"?>

<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">

<soap:Body>

    <Members xmlns="http://contegro.com/">

        <authToken>77a91347-04d0-4b7c-95eb-e120780b5711</authToken>

        <status>Active</status>

        <groupName>Travel Agents</groupName>

        <lastUpdatedFrom>2014-01-01T00:00:00.000</lastUpdatedFrom>

        <lastUpdatedTo>2014-12-31T23:59:59.000</lastUpdatedTo>

        <page>1</page>

        <pageSize>50</pageSize>

    </Members>

</soap:Body>

</soap:Envelope>

 

 

 

Example XML which is returned

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">

<soap:Body>

<MembersResponse xmlns="http://contegro.com/">

<MembersResult>

    <errorCode>0</errorCode>

    <errorMessage/>

    <members>

        <MemberDetails>

            <memberId>2001</memberId>

            <firstName>Tom</firstName>

            <lastName>Smith</lastName>

            <emailAddress>tomsmith@email.com</emailAddress>

            <loginName>tomsmith@email.com</loginName>

            <groups>

                <string>Travel Agents</string>

            </groups>

            <createdDate>2014-05-19T13:24:48.733</createdDate>

            <lastUpdatedDate>2014-05-19T13:24:48.75</lastUpdatedDate>

            <status>Active</status>

        </MemberDetails>

        <MemberDetails>

            <memberId>2002</memberId>

            <firstName>Bob</firstName>

            <lastName>Brown</lastName>

            <emailAddress>bobbrown@email.com</emailAddress>

            <loginName>bobbrown@email.com</loginName>

            <groups>

                <string>Travel Agents</string>

            </groups>

            <createdDate>2014-05-19T13:27:24.217</createdDate>

            <lastUpdatedDate>2014-05-19T13:27:24.23</lastUpdatedDate>

            <status>Active</status>

        </MemberDetails>

    </members>

</MembersResult>

</MembersResponse>

</soap:Body>

</soap:Envelope>

 

Topic Link