This service will return a set of check in details for each check in that occurred equal to or after an indicated start time and before an (optional) end time. Check ins may be requested for a particular member, group of members (defined by status), or the check in rank.
This service will only return details on members who have one or more check ins.
Check ins are grouped by member. For each member, the check ins are ordered (ranked) by check in time.
| Service Name | getMemberCheckInDetails |
| Service Type | HTTP |
| Invoked by | HTTPS GET Request |
| Returns | HTTPS Response |
| URL Format |
[server]/ws/getMemberCheckInDetails/[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 timestamp will be interpreted as being in the time zone in which the club is located.
For example, if the club is in GMT, check ins are stored in GMT.
The startTime parameter is required. The startTime value limits response to include only check ins that have a timestamp greater than or equal to the start time.
When specifying the startTime parameter, use the criteria outlined in simple datetime.
Use the following criteria when specifying startTime:
Optional. When specifying endTime, use the guidelines 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]/getMemberCheckInDetails/[club-number]?startTime=[timestamp]&endTime=[timestamp] |
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]/ws/getMemberCheckInDetails/[club-number]?startTime=[timestamp]&memberStatus=[active|inactive|all] |
Click to read more about member status.
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.
| URL Format |
[server]/ws/getMemberCheckInDetails/[club-number]?startTime=[timestamp]&memberId=[GUID] |
Optional. Clubs assign barcode values to members.
| URL Format |
[server]/ws/getMemberCheckInDetails/[club-number]?startTime=[timestamp]&barcode=[barcode] |
With the rank parameter, you can limit results to specific check ins.
When this parameter is used without an entered value, the check in rank represents the order of each check in. If the rank equals one, then the check in is the first check in for a member within the time range defined by startTime and (optionally) endTime. Specify the rank parameter as an integer.
A value of zero is valid for this parameter, but it will return no members or check ins.
This is a useful parameter in determining which members have a certain number of check ins or greater within a specified time period.
For example, use the following URL to determine how many members checked in four times or more to club 0000 between 8 AM. on January 1 and 5 PM. on January 8.
[server]/ws/getMemberCheckInDetails/0000?startTime=2013-01-01 8:00:00&endTime=2013-01-08 17:00:00&rank=4
| URL Format |
[server]/ws/getMemberCheckInDetails/[club-number]?startTime=[timestamp]&rank=[#] |
The rankTime is the timestamp assigned to an individual check in. Setting the rankTime limits the check ins returned for each member. When specifying rankTime, use the criteria outlined in simple datetime.
| URL Format |
[server]/ws/getMemberCheckInDetails/[club-number]?startTime=[timestamp]&rankTime=[timestamp] |
The Response is a Standard HTTPS Get Response object containing a message in XML.
The XML message contains three sections:
The root tag is getMemberCheckInDetails.
This section 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>Service completed successfully</message>\\ |
| membersReturned | numeric, up to 10 digits | Contains a value equal to the number of members included in the response. Zero indicates that no members and no check ins were returned. |
| 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 intervals are missed or 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. | |
| rank | integer | Optional. The rank specified in the URL. | |
| rankTime | timestamp | Optional. The rankTime specified in the URL. |
This section contains specific information about each checkIn for the desired club and parameters. The Result section's tag name is result.
The result tag 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 describing the member's check ins. A result may contain zero, one, or many member tags.
Child tag:
|
| checkIn | GUID, rank | member |
One check in tag is present for each check in for a particular member in the response.
Child tags:
Each tag contains two attributes: id and rank. The ID uniquely identifies the check in on ABC systems. The check in rank represents the order of each check in. If the rank equals one, then the check in is the first check in for a member within the time range defined by startTime and (optionally) endTime. |
| clubNumber | #### | checkIn | Contains the club number for where this check in occurred. For example, the member may check into club 1234, but has an agreement with club 4567. |
| checkInTimestamp | timestamp | checkIn | The timestamp value for when the check in occurred. |