EndPreviousNextEnd EndPrint This TopicEnd

Member

The Member API will return the full details of a single Contegro member

 

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

memberId

Integer

The member’s unique identifier

 

Data which is returned

Variable name

Data type

Description

member

XML

The details of a Contegro member, the fields in a member 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

 

member record

Variable name

Data type

Description

memberId

Integer

The member’s unique identifier

firstName

String


lastName

String


emailAddress

String


loginName

String


memberFields

XML

A list of ReturnMemberField records. The fields in a ReturnMemberField are described below

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)

 

ReturnMemberField record

Variable name

Data type

Description

fieldId

String

The fieldId for this member field (ie: CompanyName, Country, Region)

value

String

The value for the member field (ie: Labyrinth, New Zealand, Auckland)

 

Example XML for a Member 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

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

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

        <memberId>2001</memberId>

    </Member>

</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>

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

    <MemberResult>

        <errorCode>0</errorCode>

        <errorMessage/>

        <member>

            <memberId>2001</memberId>

            <firstName>Tom</firstName>

            <lastName>Smith</lastName>

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

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

            <memberFields>

                <ReturnMemberField>

                    <fieldId>LoginName</fieldId>

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

                </ReturnMemberField>

                <ReturnMemberField>

                    <fieldId>CompanyName</fieldId>

                    <value>test</value>

                </ReturnMemberField>

                <ReturnMemberField>

                    <fieldId>MemberTitle</fieldId>

                    <value>Mr</value>

                </ReturnMemberField>

                <ReturnMemberField>

                    <fieldId>Country</fieldId>

                    <value>New Zealand</value>

                </ReturnMemberField>

                <ReturnMemberField>

                    <fieldId>Region</fieldId>

                    <value>Auckland</value>

                </ReturnMemberField>

            </memberFields>

            <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>

        </member>

    </MemberResult>

</MemberResponse>

</soap:Body>

</soap:Envelope>

 

 

Topic Link