The Lookup service allows you to retrieve details about members. It includes one operation: membersearch.
| Service Name | Lookup |
| Operations | membersearch |
The membersearch operation allows you to retrieve details about members. You may identify a membership by barcode, agreement number, or member ID.
When you look up a primary member, the service lists the secondary members on the account. The details displayed by lookup also include member check-ins and agreement details.
| Service Type | SOAP |
| Service Name | Agreements |
| Operation | membersearch |
| Required Request Parameters | club |
When you search for members, keep in mind the following:
If you specify more than one search parameter (memberId, barcode, agreementNumber), and they do not refer to the same member,you will not receive any results.
If you include more than one set of search parameters, the service only uses the last set.
If you specify no search parameters, then you will receive all members (*.*).
The request has the following parameter hierarchy:
| Parameter Name | Required? | Format | Parent Parameter | Description |
|---|---|---|---|---|
| club | Y | club number | The club number. | |
| search |
Contains the information to use in the search. Must include the following child tags:
Note: All tags must be present, but they may have no value assigned. |
|||
| memberId | GUID | search | The memberId to search for. Required if search is present. | |
| barcode | barcode | search | The barcode to search for. Required if search is present. | |
| agreementNumber | agreement number | search | The agreement number to search for. Required if search is present. |
The return data includes the following tag hierarchy:
| Parameter Name | Format | Parent Parameter | Description |
|---|---|---|---|
| club | club number | ||
| members | Contains details of multiple members. Each member is in the child tag member. | ||
| member | members |
Contains details of a single member. May be repeated for multiple members.
Includes the following tags and their child tags:
|
|
| memberId | GUID | member | An ABC-generated string to uniquely identify the member. |
| barcode | barcode | member | The barcode assigned to the member. |
| lastCheckInTimestamp | simple datetime | member | The date and time of the member's most recent check-in, if any. |
| totalCheckInCount | # | member | The total number of check-ins for the member. |
| abcStatus | string | member |
Describes the current status of the member as defined by ABC.
Sample values:
Note: An member may, for example, need both an address or phone number update, but only one status is included. |
| personal | member |
Contains personal member details.
Child tags:
|
|
| firstName | string | personal | The first 15 characters of the member's first name in uppercase. |
| middleInitial | string | personal | The member's middle initial. One character long. |
| lastName | string | personal | The first 19 characters of the member's last name in uppercase. |
| birthDate | YYYY-MM-DD | personal | The member's birthdate. |
| gender | string | personal |
The member's gender.
One of three values:
|
| contact |
Contains the details of the member's contact information.
Child tags:
|
||
| address | string | contact | The member's mailing address. |
| city | string | contact | The member's city. |
| state | state codes | contact | The member's state. |
| zip | string | contact | The member's ZIP or postal code. |
| string | contact | The member's email address. | |
| homePhone | phone number | contact | The member's home phone number. |
| cellPhone | phone number | contact | The member's cell phone number. |
| workPhone | phone number | contact | The member's work phone number. |
| membership | member |
Contains details to classify the membership.
Child tags:
|
|
| type | string | membership | The membership type as defined by the club. |
| managedBy | string | membership |
Whether ABC or the club manages the members.
Possible values:
|
| agreement | member |
Contains the details of the member's agreement with the club.
|
|
| number | agreement number | agreement | The agreement number assigned to the member. |
| primaryMember | boolean | agreement |
Whether the member is primary or secondary.
|
| ordinal | 0 or 1 | agreement |
Describes whether the member is the primary member, using an ordinal:
0: primary 1: secondary |
| renewalType | string | agreement |
The member's renewal type.
Possible values:
|
| payment | string | agreement |
Contains the following details
|
| terms | string | payment |
The agreement term for the payment plan.
Allowable values:
|
| downPayment | number | payment |
The down payment amount. Uses a number up to two decimal places. |
| method | string | payment |
Describes how dues will be collected.
Allowed values:
|
| dues | number | payment | The amount of the member's dues. Uses a number up to two decimal places. |
| pastDueBalance | number | payment |
The amount past due on the agreement, excluding fees and club accounts, up to 9999.99. Uses a number up to two decimal places. |
| dates | agreement |
Contains agreement dates:
|
|
| contract | YYYY-MM-DD | dates | Required. Contains the date the member signed the contract. |
| effective | YYYY-MM-DD | dates | Required. Contains the date the member can access the club. |
| expiration | YYYY-MM-DD | dates | Contains the date the agreement expires. |
| converted | YYYY-MM-DD | dates | Contains the date the agreement was converted. |
| lastRenewal | YYYY-MM-DD | dates | Contains the date the agreement was renewed. |
| lastRewrite | YYYY-MM-DD | dates | Contains the date the agreement was rewritten. |
| renewal | YYYY-MM-DD | dates | Contains the date the agreement must be renewed. |