This service will return a set of check in details for each check in that occurred at or after an indicated start time. The desired start time may be up to 24 hours old. Check ins may be requested for a particular club.
| Service Name | getCheckInDetails |
| Service Type | HTTP |
| Invoked by | HTTPS Get Request |
| Returns | HTTPS Response |
| URL Format | ] |
| Required Parameters | startTime |
| Root tag for response | getCheckInDetails |
There are no optional parameters for this service.
The startTime parameter is required.
When specifying the startTime, use the guidelines outlined in simple datetime.
The startTime value limits responses to include only check ins that have a timestamp greater than or equal to the start time.
startTime must fit the following criteria:
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.
Future timestamps are valid. However, no check ins are selected when you use a timestamp in the future.
The Response is a Standard HTTPS Get Response object containing a message in XML. The XML message contains three sections:
The root tag is getCheckInDetails.
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>
|
| checkInsReturned | integer, up to 10 digits | Contains a value equal to the number of check ins included in the response. A value of 0 indicates that no check ins were returned. |
| currentTimeStamp | timestamp |
Contains a value equal to the current timestamp, which represents the end time of the request. This timestamp can be used in subsequent requests as the next startTime to ensure that:
|
The request section lists the values in the original request for club number and start time.
The request section's tag name is request.
| Tag Name | Format | Description |
|---|---|---|
| clubNumber | #### | The club number specified in the request URL. |
| startTime | timestamp |
The startTime specified in the request URL. Learn more about the format of the time stamp in simple datetime. |
This section contains specific information about each member check in that occurred after the start time for the desired club. The Result Section's tag name is result.
The root tag is checkIn.
| Tag Name | Format | Parent Tag | Description |
|---|---|---|---|
| checkIn | GUID | checkIns |
The service returns a checkIn tag for each check in contained in the response, with an id attribute equal to a GUID.
The checkIn tag contains the following tags and their child tags:
|
| member | GUID | checkIn |
The member tag contains member-specific information relating to the check in, with an id attribute equal to GUID. This GUID uniquely identifies a check in recorded in the ABC system and can be used with other ABC web services to retrieve member-specific information.
The member tag contains the following tags and their child tags:
|
| homeClub | club number | member |
The homeClub tag contains the home club number for this member.
A member's agreement with a home club may allow the member to check into additional clubs. Hence, the member may check into club 1234, but actually have an agreement with club 4567. |
| status | member |
The status tag contains the status of the member, using the following tags:
|
|
| active | boolean | status |
The status tag contains a value of true or false. When the value is false, the member is inactive.
|
| joinType | string | status |
Contains one of two values:
|
| alert | string, up to 50 characters | status |
If an alert was created at the time of the check in, then this tag contains a description of the alert.
Example values include, but are not limited to:
The alert tag is optional. |
| alertReason | string, up to 150 characters | status |
If there was an alert at the time of check in, the alertReason tag contains an explanation of the alert status.
The alertReason tag is optional. |
| checkInTimestamp | timestamp | checkIn | Contains the timestamp value for when the check in occurred. This is the time used by the selection process.
The stored timestamp values are according to the local time zone of the selected club. |
| checkInMessage | string, up to 50 characters | checkIn |
The checkInMessage contains the text value of the highest alert message for when the check in occurred. This messages can be created and customized at the club level and will vary.
Example values include, but are not limited to:
There may be one , zero, or many check in alert messages for a single check in. However, only the highest message will be returned in this response. |
| station | string, up to 50 characters | checkIn |
The station tag contains the name of the DataTrak workstation that captured the check in data, when the check in occurred.
This value is determined by the club and is limited to 50 characters.
If the check in was recorded through a separate door access product, then the value is set to "Door Access." |
| status | string, up to 50 characters | checkIn |
Contains the check in status for when the check in occurred. The value is determined by the club. Example values include:
|