passagetries
API-key level needed: Change / showByCardnumber
Create passage
Creates a passage through a specific card reader. This is the same thing as if the card was swiped in a physical card reader.
Request
Example:
POST:APIURL/passagetries.xmlapikey=338934897438cardnumber=12345 cardreaderid=1 opengate=false |
Parameters
| Tag | Example | Data type | Description |
|---|---|---|---|
| cardnumber | 57114 | String | Card number to create passage from |
| cardreaderid | 14 | ID | Id of card reader |
| opengate | false | Boolean | Should physical gate be opened by successful passage |
| manual | true | Boolean | Circumvents the card readers conversion of the card number |
| printticket | false | Boolean | Should tickets be printed if entry leads to customer being marked as arrived for one or more class. Default false and only works for network connected printers connected to the card reader in BRP |
Response
A passage attempt. Please note that person/product/subscription/valuecard can be empty. For example a passage with an anonymous discount card will only have values for valuecard and product.
| Tag | Example | Date type | Description |
|---|---|---|---|
id | <id>23</id> | ID | Unique ID |
resultcode | <resultcode>100</resultcode> | Integer | Result code, 0 = OK, for others pelase see result message field |
resultmessage | <resultmessage>Unknown card number, id-nr=1234</resultmesage> | String | Information about the passage, for example number of passages left on card, error messages etc. |
person | <person>...</person> | Person | The person affiliated with the passage. See persons. |
product | <product>...</product> | Product | ID and name of product used for the passage. |
subscription | <subscription>...</subscription> | Subscription | The subscription/membership used for the passage. See subscriptions. |
| valuecard | <valuecard>...</valuecard> | Value card | The value card used for the passage. See Valuecards. |
| created | <created>...</created> | Time | The time of entry |
| newvisit | <newvisit>true</newvisit> | Boolean | If the passage was the first entry of the day (passage in a turnstyle for example) or not (i.e. an internal card reader by a locker room) |
| consumecarrier | <consumecarrier>true</consumecarrier> | Boolean | Should the carrier be consumed. Usually RFID-bracelets containing valuecards or entries. This could instruct the card reader to keep the data carrier. |
<passagetry>
<id>618</id>
<result>Unknown card number, id-nr=1234</result>
<message>id-nr=1234</message>
<person></person>
<product></product>
<subscription></subscription>
<valuecard></valuecard>
<created>
<timepoint>
<timestamp>1371633226.454</timestamp>
<datetime>2013-06-19 11:13</datetime>
<date>2013-06-19</date>
<time>11:13</time>
</timepoint>
</created>
<newvisit>false</newvisit>
<consumecarrier>true</consumecarrier>
</passagetry>
Error codes
| Code | Reason |
|---|---|
| 0 | OK |
| 100 | Unknown card number |
| 101 | Missing valid subscription |
| 102 | Person suspended |
| 103 | Unpaid invoice |
| 104 | Unpaid invoice |
| 105 | Already passed |
| 106 | Error |
| 107 | Time out |
| 108 | Undone |
| 109 | Unable to book class |
| 110 | Maximum visit length exceeded |
| 111 | Unpaid products |
| 112 | Wrong time |
| 113 | Missing membership |
| 114 | Prepaid amount left |
| 115 | Entry is consumed |
| 116 | Too soon since last passage |
| 117 | Incorrect fingerprint |
| 118 | Waiting for fingerprint |
| 119 | Waiting for feedback |
| 120 | Passage not allowed |
| 121 | Could not write locker data |
| 122 | Too many inside |
| 123 | Unsigned contract |
| 400 | License missing for addon feature |