Create Card
Create Card is the command used to create key cards.
Operationcode: CC
CC
Direction
SIHOT.PMS -> IF Partner
Message
This is an example for a check in for a guest with two cards and access to his room 101, the room 102 and to the area 2.
<?xml version="1.0" encoding="ISO-8859-1"?>
<SIHOT-Document>
<TN>4812</TN>
<OC>CI</OC>
<HN>4711</HN>
<PCIID>538</PCIID>
<SALUTATION>Herr</SALUTATION>
<TITLE>Dr.</TITLE>
<SN>Berger</SN>
<CN>Joerg</CN>
<GID>471168</GID>
<ARR>2002-05-31T13:20:00</ARR>
<DEP>2002-06-05T11:00:00</DEP>
<LN>DE</LN>
<RN>101</RN>
<PASSWD></PASSWD>
<PAY-TV>1</PAY-TV>
<PH0>00101</PH0>
<AP>010000000000000000000000001</AP>
<CS>2</CS>
<CA>1</CA>
<NC>2</NC>
<AI1>102</AI1>
<SRC>SIHOT</SRC>
<ORG>disp_4711</ORG>
</SIHOT-Document>
Attributes Message
In addition to the basic types (described in Definition of XML-Attributes) we for key card systems these attributes.
| Attribute | Denotation | Type |
|---|---|---|
| AP | Definition of the access points. The access point are defined in a key card system. | String |
| NC | Number of cards | uns. Byte |
| CS | Coding Station | String |
| CA | Card action | String |
| AI1 | Additional Information 1. This could be e.g. a number of an additional room. If this functions is used depends on the used door lock interface | String |
| AI2 | See AI1 | String |
| AI3 | See AI1 | String |
| AI4 | See AI1 | String |
| AI5 | See AI1 | String |
| CARDNO | This CardNo is sent from SIHOT in case that a operator has given a Card Number. This function is used in case that e.g. you don’t have a transponder reader but enter the card number manually. | String |
| CIO | Originates from a check-in or a check-out | Char |
| DCO | Direct Check Out | Bool |
| KCID | Using the keycard ID instead of the room number, if available. | String |
| BEDKCID | Using the keycard ID of the bed instead of the bed number, if available. | String |
Response
The answer can look like this in case of OK:
<?xml version="1.0" encoding="ISO-8859-1"?>
<SIHOT-Document>
<TN>4812</TN>
<OC>ACK</OC>
<RC>0</RC>
<ORG>disp_4711</ORG>
</SIHOT-Document>
Attributes Response
| Attribute | Denotation | Type |
|---|---|---|
| OC | ACK | String |
| TN | Transaction Number | uns. Long. |
| RC | Return Code. Here we refer to the content of the MSG tag. | uns. Long |
| MSG | Message Text, error message in plain text (optional) | String |
| ORG | Origin, this is the identifier of the SIHOT workstation that processed this operation. | String |
If an operation used the <TN> tag, this tag has also to be returned to the sender. The same procedure applies to the <ORG> tag.
Examples
Example 1 - Check-Out
In this example, we send a check out for room 2002. All cards will be
inactivated for this room.
<?xml version="1.0" encoding="ISO-8859-1"?>
<SIHOT-Document>
<TN>4813</TN>
<OC>CO</OC>
<HN>4711</HN>
<CA>0</CA>
<RN>101</RN>
<ORG>disp_4711</ORG>
<CS>2</CS>
</SIHOT-Document>
This could be the answer:
<?xml version="1.0" encoding="ISO-8859-1"?>
<SIHOT-Document>
<TN>4813</TN>
<OC>ACK</OC>
<RC>1</RC>
<MSG>Room not occupied</MSG>
<ORG>disp_4711</ORG>
</SIHOT-Document>
Example 2 - Room Move
Here we have a room move from 101 to 333. Two cards should be created
from the key card system and the guests have the right to use the area
4.
<?xml version="1.0" encoding="ISO-8859-1"?>
<SIHOT-Document>
<TN>4814</TN>
<OC>RM</OC>
<HN>4711</HN>
<CA>0</CA>
<RN>333</RN>
<ORN>101</ORN>
<NC>2</NC>
<ORG>disp_4711</ORG>
<AP>00010000000000000000000001</AP>
<CS>2</CS>
</SIHOT-Document>
The answer could look like:
<?xml version="1.0" encoding="ISO-8859-1"?>
<SIHOT-Document>
<TN>4814</TN>
<OC>ACK</OC>
<RC>0</RC>
</SIHOT-Document>
Example 3 - Create Card
Create Card is the command to create key cards e.g. for office rooms, banqueting rooms or guest rooms (e.g. for pre check-in). This function is an add-on for the check in command and enables the hotel to create key cards at any time.
<?xml version="1.0" encoding="ISO-8859-1"?>
<SIHOT-Document>
<TN>4829</TN>
<OC>CC</OC>
<HN>4711</HN>
<ARR>2002-05-31T13:20:00</ARR>
<DEP>2002-06-05T11:00:00</DEP>
<CA>1</CA>
<NC>2</NC>
<RN>101</RN>
<ORG>disp_4711</ORG>
<DCO>0</DCO>
<AP>010000000000000000000000001</AP>
<CS>2</CS>
<KCID>1101</KCID>
<USERID>ADM</USERID>
<WS>MARVIN</WS>
<PCIID>68</PCIID>
<AN>9901</AN>
<SN>Ostergard</SN>
<CN>Hanne Kristine</CN>
<TG></TG>
<EMAIL>ostergard@email.com</EMAIL>
<MOBILE>+4508154711</MOBILE>
<RN>100</RN>
<NR_FOR_THIS>100</NR_FOR_THIS>
<KCID_FOR_THIS>100ID</KCID_FOR_THIS>
<ROOMSIMPLIED>
<RN>101</RN>
</ROOMSIMPLIED>
</SIHOT-Document>
Note:
To simplify the creation of a card in case a suite contains more than one room or a room contains more than one bed, we introduced the
new tags <NR_FOR_THIS> and <KCID_FOR_THIS>. The tag <NR_FOR_THIS> always provides the number of the suite, room or bed
for which the card should be created. If a KCID for this number is defined in SIHOT, it will be provided through the tag
<KCID_FOR_THIS>.
The answer can look like this in case of OK.
<?xml version="1.0" encoding="ISO-8859-1"?>
<SIHOT-Document>
<TN>4829</TN>
<OC>ACK</OC>
<RC>0</RC>
<ORG>disp_4711</ORG>
</SIHOT-Document>
Example 4 - Create Card for one bed in a room
Create Card can also be used to create a card for a bed in a room:
<?xml version="1.0" encoding="ISO-8859-1"?>
<SIHOT-Document>
<TN>4878</TN>
<NC>1</NC>
<CA>1</CA>
<AP></AP>
<DCO>0</DCO>
<CS>4711</CS>
<ARR>2017-10-25T14:16:00</ARR>
<DEP>2017-10-28T12:00:00</DEP>
<OC>CC</OC>
<HN>4</HN>
<USERID>ADM</USERID>
<WS>MARVIN</WS>
<PCIID>2904</PCIID>
<AN>101</AN>
<SN>Ostergard</SN>
<CN>Hanne Kristine</CN>
<TG></TG>
<EMAIL>ostergard@email.com</EMAIL>
<MOBILE></MOBILE>
<RN>100</RN>
<NR_FOR_THIS>100A</NR_FOR_THIS>
<KCID_FOR_THIS>100AID</KCID_FOR_THIS>
<BEDSIMPLIED>
<BED>
<BEDNO>100A</BEDNO>
<BEDKCID>100AID</BEDKCID>
</BED>
</BEDSIMPLIED>
<CIO>I</CIO>
</SIHOT-Document>
The answer can look like this in case of OK.
<?xml version="1.0" encoding="ISO-8859-1"?>
<SIHOT-Document>
<TN>4879</TN>
<OC>ACK</OC>
<RC>0</RC>
<ORG>disp_4711</ORG>
</SIHOT-Document>
Example 5 - Create Card for a room with two beds
If there are two beds in the room that is being checked in, both beds
are sent within the <BEDSIMPLIED> tag.
<?xml version="1.0" encoding="ISO-8859-1"?>
<SIHOT-Document>
<TN>4879</TN>
<NC>1</NC>
<CA>1</CA>
<AP></AP>
<DCO>0</DCO>
<CS>4711</CS>
<ARR>2017-10-25T14:18:00</ARR>
<DEP>2017-10-27T12:00:00</DEP>
<OC>CC</OC>
<HN>4</HN>
<USERID>ADM</USERID>
<WS>MARVIN</WS>
<PCIID>2907</PCIID>
<AN>101</AN>
<SN>Ostergard</SN>
<CN>Hanne Kristine</CN>
<TG></TG>
<EMAIL>ostergard@email.com</EMAIL>
<MOBILE></MOBILE>
<RN>101</RN>
<NR_FOR_THIS>101</NR_FOR_THIS>
<KCID_FOR_THIS>101ID</KCID_FOR_THIS>
<BEDSIMPLIED>
<BED>
<BEDNO>101A</BEDNO>
<BEDKCID></BEDKCID>
</BED>
<BED>
<BEDNO>101B</BEDNO>
<BEDKCID></BEDKCID>
</BED>
</BEDSIMPLIED>
<CIO>I</CIO>
</SIHOT-Document>
The answer can look like this in case of OK.
<?xml version="1.0" encoding="ISO-8859-1"?>
<SIHOT-Document>
<TN>4879</TN>
<OC>ACK</OC>
<RC>0</RC>
<ORG>disp_4711</ORG>
</SIHOT-Document>
[See for more information](SXMLIF_OC_ACK.md