Requires any of the roles: | Admin, TeamAdmin, MobileApp | Requires the permission: | ReadData |
All Verbs | /ksiCards/Search | ||
---|---|---|---|
All Verbs | /ksiCards/Search/{Id} | ||
All Verbs | /ksiCards/Search/Club/{KsiClubId}/{ExpiryYear} | ||
All Verbs | /ksiCards/Search/Club/CardType/{KsiClubId}/{KsiCardType}/{ExpiryYear} |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | path | int? | No | |
KsiClubId | path | string | No | |
ExpiryYear | path | string | No | |
KsiCardType | path | string | No | |
FullPhoneNumber | query | string | No | |
OnlyValidForEventId | query | int? | No | |
RequestUnixUTCTimeStamp | query | long | No | |
Signature | query | RequestSignature | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
SystemId | form | string | No | |
SystemSecret | form | string | No | |
Signature | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Cards | form | List<KsiCards> | No | |
StatusCode | form | int | No | |
Message | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | int | No | |
CreationDate | form | DateTime? | No | |
PhoneFullVerificationNumber | form | string | No | |
DeviceId | form | string | No | |
KsiCardTypeId | form | string | No | |
KsiClubId | form | string | No | |
HolderName | form | string | No | |
CanTransferToPhoneFullNumber | form | string | No | |
CanTransferToNName | form | string | No | |
ExpYear | form | string | No | |
ExpMonth | form | string | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /ksiCards/Search HTTP/1.1
Host: stubbur-autoupdates-live.smartnewapis.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
id: 0,
ksiClubId: String,
expiryYear: String,
ksiCardType: String,
fullPhoneNumber: String,
onlyValidForEventId: 0,
requestUnixUTCTimeStamp: 0,
signature:
{
systemId: String,
systemSecret: String,
signature: String
}
}
HTTP/1.1 200 OK Content-Type: text/jsv Content-Length: length { cards: [ { id: 0, creationDate: 0001-01-01, phoneFullVerificationNumber: String, deviceId: String, ksiCardTypeId: String, ksiClubId: String, holderName: String, canTransferToPhoneFullNumber: String, canTransferToNName: String, expYear: String, expMonth: String } ], statusCode: 0, message: String }