<back to all web services
DoCheckInRequest
Check a user into a club
The following routes are available for this service:POST | /users/checkin | Check User Into Club | |
---|
DoCheckInRequest Parameters:Name | Parameter | Data Type | Required | Description |
---|
ApiKey | query | string | Yes | Api Key - grants access to resources |
Barcode | query | string | Yes | User barcode |
StoreId | query | integer | Yes | ClubReady StoreId required |
UserId | query | integer | No | UserId to check into club |
RestrictedId | body | int? | No | |
RestrictedResourceType | body | RestrictedResourceType | No | |
DoCheckInRequestDto Parameters:Name | Parameter | Data Type | Required | Description |
---|
Barcode | form | string | No | |
UserId | form | int? | No | |
UtcTimeStamp | form | DateTime | No | |
ApiDtoBase Parameters:Name | Parameter | Data Type | Required | Description |
---|
ApiKey | form | string | No | |
StoreId | form | int? | No | |
ChainId | form | int? | No | |
RestrictedResourceType Enum:Store | |
Chain | |
User | |
Undefined | |
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
HTTP + XML
The following are sample HTTP requests and responses.
The placeholders shown need to be replaced with actual values.
POST /users/checkin HTTP/1.1
Host: clubready.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<DoCheckInRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Web.Api.ClubAccess.Model">
<ApiKey xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">String</ApiKey>
<ChainId xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">0</ChainId>
<StoreId xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">0</StoreId>
<Barcode xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">String</Barcode>
<UserId xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">0</UserId>
<UtcTimeStamp xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">0001-01-01T00:00:00</UtcTimeStamp>
</DoCheckInRequest>