1.Overview
Developers must supply the required parameters to cancel multi-room cards. To use the contactless card issuance, reading, and cancellation APIs, users must
download the QR Master application. Administrators must enable issuance and printing permissions for the member in Member Management.
Tips:
If you need to use induction card issuance, card reading and other functions, please first connect creatorMobile/creatorEmail to the mobile phone or email field in the lock shopkeeper-management-member management. At the same time as the interface is docked, you need to go to the member management To enable members to issue printing permissions, the specific operations are as follows: Login lock shopkeeper-management-member management-select room permissions-after you choose, to issue printing permissions / sharing passwords
Canceling a multi-room card cancels access to all rooms on the card by default. Call readCard again after cancellation to get the latest card status.
2. Request URL
3. Request method
4. Parameter specification
| Attribute |
Type |
Constraint |
Explanation |
| sig |
String |
Required |
Request signature |
| accountSid |
String |
Required |
Developer Account SID, the unique identifier of developer(32 characters of letters and numbers). |
| communityNo |
String |
Required |
Community No. |
| issueMac |
String |
Required |
Card issuer MAC address |
| serialNum |
String |
Required |
Existing issuance record ID (serialNum returned by readCard), used to locate the existing record. An empty string may be supplied as a placeholder; cancellation is skipped when it is empty. |
| creatorAreaCode |
String |
Optional |
Area code in front of the app phone number(corresponding to creatorMobile, if creatorMobile is passed, the current parameters are required) |
| creatorMobile |
String |
Optional |
Mobile number, this mobile number user should be the same as the application user(Either CreatorMobile or CreatoreMail must be filled in. If both are filled in, CreatorMobile will prevail) |
| creatorEmail |
String |
Optional |
The mailbox, this mailbox user should be the same as the application user(Either CreatorMobile or CreatoreMail must be filled in. If both are filled in, CreatorMobile will prevail) |
| creatorPassword |
String |
Required |
User password encrypted by md5, corresponding to the user in the creator account field |
| operateCardType |
String |
Required |
Card type to operate on. Multi-room cards currently support only 4 (Bluetooth contactless card). |
5. Signature generation rules
Concatenate accountSid, communityNo, issueMac, serialNum, roomIds, door_types, creatorAreaCode, creatorMobile, creatorPassword, operateCardType, and authToken in that order, then calculate the MD5 hash to obtain sig. Note: when signing in with creatorEmail, omit creatorAreaCode/creatorMobile if they are empty.
6. Request example
content-type:application/x-www-form-urlencoded
accountSid=98651082ab89c3f1b50f35caf794179f&communityNo=1316879946&issueMac=7C778A6C7D9C&serialNum=42873467&roomIds=&door_types=&creatorAreaCode=86&creatorMobile=10000000000&creatorPassword=49dec5fb8af4eeef7c95e7f5c66c8ae6&operateCardType=4&sig=ffe16ee6d771a575216e8be573b7e51a
Successful result:
{"status":200,"info":"success","data":{"serialNum":"0","more":"0","moreRoom":[],"door_types":"","writeStatus":"0"}}
Fields: serialNum=0 (all room access canceled), more=0 (no longer a multi-room card), moreRoom=empty (no rooms remaining), door_types=empty string, writeStatus=0 (always 0 for full cancellation, with no issuance record to query). The same structure is returned if no matching existing record is found, indicating that cancellation was skipped.
Failure reason returning:
{"status": 5302,"info": "cancel card failed","message": "Error"}
If a room ID submitted for issuance/cancellation does not exist or does not belong to the community, the following errors are returned respectively. Use the info text to distinguish them:
{"status":6113,"info":"Room not found"}
{"status":6113,"info":"Room does not belong to the current community"}
7. SDK
For PHP, SDK method: cancelMoreCard