This service will return a small set of details for selected members for a particular club in ABC's club management system. This member information includes items such as member name, barcode, agreement number, and number of check ins. The total number of check ins is calculated based on a start time and optional end time.
| Service Name | getMemberCheckInSummaries |
| Service Type | HTTP |
| Invoked by | HTTPS GET Request |
| Returns | HTTPS Response |
| URL Format |
[server]/ws/getMemberCheckInSummaries/[club-number]?startTime=[timestamp] |
| Required Parameters | startTime |
This service has one required parameter: startTime.
There are several optional parameters:
The startTime parameter is required. Use startTime in conjunction with the optional endTime parameter to further narrow a time range for results.
The startTime parameter is required. The startTime value limits responses to include only check ins that have a timestamp greater than or equal to the start time.
When specifying the startTime, use the criteria outlined in simple datetime.
Use the following criteria when specifying startTime:
Optional. When specifying endTime, use the criteria outlined in simple datetime.
The endTime will default to the current time in the club's local time zone. The endTime returned in the response can be used in subsequent requests as the startTime to ensure that there are no time gaps.
| URL Format |
[server]/getMemberCheckInSummaries/[club-number]?startTime=[timestamp]&endTime=[timestamp] |
Optional. Use hasCheckIn to limit the response to members with one or more check ins. If no option is specified, then the option defaults to false, and does not use member check ins to determine which results to return.
When hasCheckIn = true, the web service uses only the date portion of startTime and endTime to select check ins. It does not include, for example, hours, minutes, or seconds.
Optional. Use the memberStatus parameter to limit the checkIn results to only active members, inactive members, or all.
The default value for the memberStatus parameter is all.
| URL Format |
[server]/getMemberCheckInSummaries/[club-number]?startTime=[timestamp]&memberStatus=[active|inactive|all] |
Use either memberId or barcode to specify individual members. Both memberId and barcode are optional parameters.
Optional. The memberId uniquely identifies a member within a particular club. ABC assigns memberIds in the form of a GUID.
Optional. Clubs assign barcode values to members.
| URL Format |
[server]/getMemberCheckInSummaries/[club-number]?startTime=[timestamp]&barcode=[barcode] |
The Response is a standard HTTPS GET Response object containing a message in XML.
The XML message contains three sections:
The root tag is getMemberCheckInSummaries.
This component describes the overall status of the request. The Status section's tag name is status. The status tag contains the following tags:
| Tag Name | Format | Description |
|---|---|---|
| response | string, up to 50 characters |
The response tag contains a value indicating the overall status of the request. The overall status will be one of three values:
|
| message | string, up to 125 characters |
The message tag provides a more specific description of the result value. Each message tag includes an attribute. The id attribute is assigned a unique id.
Example tags and values include: <message id="0">Service completed successfully</message> |
| membersReturned | integer | Contains a value equal to the number of members returned in the response. |
| currentTimestamp | timestamp |
Contains a value equal to the current timestamp of the database.
Use this value with subsequent requests to ensure that no check in internals are missed and no duplicate check ins are retrieved. |
The request section lists the values in the original request.
The request section's tag name is request. It contains the following tags (optional tags are omitted if not included in the URL):
| Tag Name | Format | Description | Default |
|---|---|---|---|
| clubNumber | #### | The club number specified in the request URL. | |
| startTime | timestamp | The startTime specified in the URL. | |
| endTime | timestamp | Optional. The endTime specified in the URL. | Current time at the club's local time zone. |
| memberStatus | Optional. The memberStatus specified in the URL. | All (active and inactive). | |
| barcode | barcode | Optional. The barcode specified in the URL. | |
| memberId | GUID | Optional. The memberId specified in the URL. | |
| hasCheckIn |
Optional. When given a value of "true", hasCheckIn limits the response to members who have one or more check ins during the selected time period.
Values:
|
false |
This section contains a specific information about each member for the desired club and parameters. The Result section's tag name is result. It contains the following tags:
| Tag Name | Format | Parent Tag | Description |
|---|---|---|---|
| member | GUID | result |
One member tag is present for each member in the response. The tag has a value of a GUID that uniquely identifies the member.
It contains tags summarizing member information and check ins. A result may contain zero, one, or many member tags.
Child tags:
|
| barcode | barcode | member | Contains the barcode value for the member. |
| firstName | string, up the 15 characters | member | Contains the first 15 characters of the member's first name in uppercase. |
| lastName | string, up to 19 characters | member | Contains the first 19 characters of the member's last name in uppercase. |
| agreementNumber | string, limited to 9 or 12 characters | member |
Contains the member's agreement number, using the following guidelines:
|
| checkInCount | member |
Contains one child tag.
Child tag:
|
|
| club | integer | checkInCount |
Contains both an attribute and a value. The attribute is number, and is equal to the club number. The value is the number of check ins for that club.
A single member may have one or more club tags. |