Get Member List

• Summary
• Parameters
• Selecting the time range
• Time Zones and timestamps
• contractDate and convertedDate
• contractStartTime
• contractEndTime
• convertedStartTime
• convertedEndTime
• createStartTime
• createEndTime
• signStartTime
• signEndTime
• updateStartTime
• updateEndTime
• memberStatus
• memberId
• barcode
• Response Data
• Status Section
• Request Section
• Result Section

Summary

This service will return details for selected members for a particular club in ABC's club management system. This member information includes items such as name, address, membership type, agreement details, and last check in time.

Parameters

The web service has no required parameters. You may use one of these optional parameters to specify members as individuals or by status:

• contractStartTime
• contractEndTime
• convertedStartTime
• convertedEndTime
• updateStartTime
• updateEndTime
• memberStatus
• agreementNumber
• memberId
• barcode

When you do not specify a parameter, the web service returns a list of all members, regardless of status.

Selecting the time range

All date range parameters for this service are optional. These can be used to limit the response set to include members with a contract date or converted date that falls in the selected time range.

Note: The member's contract date can be altered. Therefore, the same member might be retrieved by two separate, non-overlapping date ranges.
In some cases, the contract date may be a future value for clubs in presale mode.

Time Zones and Time Stamps

The updateStartTime and updateEndTime request parameters are assumed to be in the club's time zone. The member update timestamp is saved as a value in Central Time Zone. Responses for clubs in other time zones include a memberUpdateTimestamp relating to Central Time.
In the example below, the mismatch between timestamps is due to the fact that the lastCheckInTimestamp is saved as Eastern Time (where the club is located), while memberUpdateTimestamp is saved in Central Time.

<lastCheckInTimestamp>2014-10-1 14:11:27.000000</lastCheckInTimestamp> <totalCheckInCount>7</totalCheckInCount>
<memberUpdateTimestamp>2014-10-19 13:11:27.235180</memberUpdateTimestamp>

Contract Date and Converted Date

This service returns a response that includes the tag <contractDate>. For a member, this indicates when they joined the club. For a prospect, this indicates when they were created in the system. The <convertedDate> tag indicates when a prospect converted to member status.

Note: Use contractDate to determine when a member joined a club.
Use convertedDate to determine when a prospect became a member.

contractStartTime

Optional. This parameter is used to define the beginning of the contract date range. This will return both inactive and active members, unless memberStatus is otherwise specified. When specifying the contractStartTime, use the criteria outlined in simple datetime.

Use the following criteria when specifying contractStartTime:

• contractStartTime must be less than contractEndTime.
• If contractStartTime and contractEndTime are both specified, the contract date must be greater than or equal to contractStartTime and less than contractEndTime.

contractEndTime

Optional. This parameter is used to define the end of the contract date range. This will return both inactive and active members, unless memberStatus is otherwise specified. When specifying contractEndTime, use the criteria outlined in simple datetime.

Use the following criteria when specifying contractEndTime:

• contractEndTime must be greater than or equal to contractStartTime.
• If contractStartTime and contractEndTime are both specified, the contract date must be greater than or equal to contractStartTime and less than contractEndTime.

convertedStartTime

Optional. This parameter is used to define the beginning of the converted date range. When specifying the convertedStartTime, use the criteria outlined in simple datetime.

Use the following criteria when specifying convertedStartTime:

• convertedStartTime must be less than convertedEndTime.
• If convertedStartTime and convertedEndTime are both specified, the converted date must be greater than or equal to convertedStartTime and less than convertedEndTime.

convertedEndTime

Optional. This parameter is used to define the end of the converted date range. When specifying the convertedEndTime, use the criteria outlined in simple datetime.

Use the following criteria when specifying convertedEndTime:

• convertedStartTime must be less than convertedEndTime.
• If convertedStartTime and convertedEndTime are both specified, the converted date must be greater than or equal to convertedStartTime and less than convertedEndTime.

createStartTime

Optional. This parameter is used to define the beginning of the time range in which the agreement was created.

Use the following criteria when specifying createStartTime:

• createStartTime must be less than createEndTime.
• If createStartTime and createEndTime are both specified, the create date must be greater than or equal to createStartTime and less than createEndTime.

createEndTime

Optional. This parameter is used to define the end of the time range in which the agreement was created.

Use the following criteria when specifying createStartTime:

• createStartTime must be less than createEndTime.
• If createStartTime and createEndTime are both specified, the create date must be greater than or equal to createStartTime and less than createEndTime.

signStartTime

Optional. This parameter is used to define the beginning of the time range in which the agreement was signed.

Use the following criteria when specifying signStartTime:

• signStartTime must be less than signEndTime.
• If signStartTime and signEndTime are both specified, the sign date must be greater than or equal to signStartTime and less than signEndTime.

signEndTime

Optional. This parameter is used to define the end of the time range in which the agreement was signed.

Use the following criteria when specifying signStartTime:

• signStartTime must be less than signEndTime.
• If signStartTime and signEndTime are both specified, the sign date must be greater than or equal to signStartTime and less than signEndTime.

updateStartTime

Optional. This parameter is used to define the beginning of the date range in which member information was updated (designated with the memberUpdateTimestamp tag). This will return both inactive and active members, unless memberStatus is otherwise specified. When specifying the updateStartTime, use the criteria outlined in simple datetime.

Note: See the values that will cause memberUpdateTimeStamp to change. Not all changes will be returned in the web service.

Use the following criteria when specifying updateStartTime:

• updateStartTime must be less than updateEndTime.
• If updateStartTime and updateEndTime are both specified, the date of the member update must be greater than or equal to updateStartTime and less than updateEndTime.

updateEndTime

Optional. This parameter is used to define the end of the date range in which member information was updated (designated with the memberUpdateTimestamp tag). This will return both inactive and active members, unless memberStatus is otherwise specified. When specifying the updateEndTime, use the criteria outlined in simple datetime.

Note: See the values that will cause memberUpdateTimeStamp to change. Not all changes will be returned in the web service.

Use the following criteria when specifying updateEndTime:

• updateStartTime must be less than updateEndTime.
• If updateStartTime and updateEndtime are both specified, the date of the member update must be greater than or equal to updateStartTime and less than updateEndTime.

memberStatus

Optional. The memberStatus parameter allows you to specify whether you want active members, inactive members, or all members. Using the prospect setting (memberStatus=prospect) will return only members with the agreement number "PROSP". Prospects can also be found by using the "inactive" or "all" setting, but they will not be separated from other inactive members.

agreementNumber

Optional. This is the five-digit agreement number. It does not include the first four digits that define the club number.

memberId

Optional. The memberId uniquely identifies a member within a particular club. ABC assigns memberIds in the form of a GUID.

barcode

Optional. Clubs assign barcode values to members.

Response Data

The Response is a standard HTTPS GET Request object containing a message in XML. The XML message contains three sections:

• Status
• Request
• Result

The root tag is getMemberList.

Status Section

This section describes the overall status of the request. The Status Section's tag name is <status>. The <status> tag contains the following tags:

Request Section

This section lists what the original request contained. The Request section's tag name is request.

Tags included in the request tag include:

Result Section

This section contains specific information about each member returned. The Result section's tag name is result.

The result tag contains the following tags:

• members
• member
• homeClub
• status
• active
• joinType
• alert
• alertReason
• alertDate
• barcode
• group
• lastCheckInTimeStamp
• totalCheckInCount
• memberUpdateTimestamp
• personal
• firstName
• middleInitial
• lastName
• birthDate
• gender
• contact
• address
• city
• state
• zip
• email
• homePhone
• cellPhone
• workPhone
• membership
• createTimestamp
• type
• managedBy
• campaign
• agreement
• number
• stationName
• primaryMember
• ordinal
• renewalType
• referringMember
• homeClub
• salesperson
• homeClub
• payment
• plan
• terms
• downPayment
• method
• card
• type
• lastFour
• expiration
• dues
• pastDueBalance
• lateFeeAmount
• serviceFeeAmount
• totalPastDueBalance
• nextDueAmount
• nextDueDate
• queue
• name
• entryDate
• entrySource
• name
• report
• autoPost
• dates
• contract
• sign
• effective
• expiration
• converted
• lastRenewal
• lastRewrite
• renewal

The root tag is members.

ABC Financial Web Services
© 2014 ABC Financial Services, Inc. All rights reserved.