| 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 | |
| IncludeInactive | query | bool? | No | |
| IncludeExpired | query | bool? | 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 | |
| IsActive | form | bool | No | |
| ValidFromDate | form | DateTime? | No | |
| ValidToDate | form | DateTime? | No | |
| LastModifiedDate | form | DateTime? | No | |
| RevokedDate | form | DateTime? | No | |
| RevokedReason | form | string | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
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-app.azurewebsites.net
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"id":0,"ksiClubId":"String","expiryYear":"String","ksiCardType":"String","fullPhoneNumber":"String","onlyValidForEventId":0,"includeInactive":false,"includeExpired":false,"requestUnixUTCTimeStamp":0,"signature":{"systemId":"String","systemSecret":"String","signature":"String"}}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"cards":[{"id":0,"creationDate":"0001-01-01T00:00:00.0000000","phoneFullVerificationNumber":"String","deviceId":"String","ksiCardTypeId":"String","ksiClubId":"String","holderName":"String","canTransferToPhoneFullNumber":"String","canTransferToNName":"String","expYear":"String","expMonth":"String","isActive":false,"validFromDate":"0001-01-01T00:00:00.0000000","validToDate":"0001-01-01T00:00:00.0000000","lastModifiedDate":"0001-01-01T00:00:00.0000000","revokedDate":"0001-01-01T00:00:00.0000000","revokedReason":"String"}],"statusCode":0,"message":"String"}