POST api/eRegService/getRecords
Request Information
URI Parameters
None.
Body Parameters
RequestRecords| Name | Description | Type | Additional information |
|---|---|---|---|
| room_no | string |
None. |
|
| uDate | date |
None. |
Request Formats
application/json, text/json
Sample:
{
"room_no": "sample string 1",
"uDate": "2025-12-22T16:08:36.3157364+00:00"
}
application/xml, text/xml
Sample:
<RequestRecords xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/VicasCloud.API.Models"> <room_no>sample string 1</room_no> <uDate>2025-12-22T16:08:36.3157364+00:00</uDate> </RequestRecords>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
responseRecords| Name | Description | Type | Additional information |
|---|---|---|---|
| result | boolean |
None. |
|
| StatusCode | integer |
None. |
|
| Message | string |
None. |
|
| Records | Collection of DocumentDetail |
None. |
Response Formats
application/json, text/json
Sample:
{
"result": true,
"StatusCode": 2,
"Message": "sample string 3",
"Records": [
{
"DocumentID": 1,
"Name": "sample string 2",
"DocumentTypeID": 3,
"RoomNumber": 4,
"FamilyName": "sample string 5",
"GivenName": "sample string 6",
"Gender": "sample string 7",
"Nationality": 1,
"BirthDate": "2025-12-22T16:08:36.3157364+00:00",
"BirthPlace": "sample string 8",
"DocumentNumber": "sample string 9",
"IssueDate": "2025-12-22T16:08:36.3157364+00:00",
"ExpiryDate": "2025-12-22T16:08:36.3157364+00:00",
"CountryOfResident": 1,
"VisitPurpose": 1,
"ArrivalDate": "2025-12-22T16:08:36.3157364+00:00",
"Adults": 1,
"Children": 1,
"CheckOutDate": "2025-12-22T16:08:36.3157364+00:00",
"PrimaryEscortFlag": "sample string 10",
"ClientMachineID": "sample string 11",
"ClientMachineName": "sample string 12",
"UserID": "sample string 13",
"UDate": "2025-12-22T16:08:36.3157364+00:00",
"ActiveFlag": "sample string 14",
"ReferenceNumber": "sample string 15",
"IssuingCountry": 1,
"IssuingAuthority": "sample string 16",
"AddressLine1": "sample string 17",
"AddressLine2": "sample string 18",
"City": "sample string 19",
"State": "sample string 20",
"ZIP": "sample string 21",
"Country": "sample string 22",
"IsCheckout": true,
"ConfirmationNumber": "sample string 24",
"DocumentDetailID": 25,
"ReservationNo": "sample string 26",
"FirstName": "sample string 27",
"LastName": "sample string 28",
"MiddleName": "sample string 29",
"DocumentNo": "sample string 30",
"IssueCountry": "sample string 31",
"RoomNo": "sample string 32",
"CheckinDate": "2025-12-22T16:08:36.3157364+00:00",
"CreatedDatetime": "2025-12-22T16:08:36.3157364+00:00",
"KioskStationName": "sample string 33",
"NationalityThreeCode": "sample string 34",
"IssueCountryThreeCode": "sample string 35",
"IsManuallyAuthendicated": true,
"ManuallyAuthendicatedPerson": "sample string 36",
"PMSProfileID": "sample string 37"
},
{
"DocumentID": 1,
"Name": "sample string 2",
"DocumentTypeID": 3,
"RoomNumber": 4,
"FamilyName": "sample string 5",
"GivenName": "sample string 6",
"Gender": "sample string 7",
"Nationality": 1,
"BirthDate": "2025-12-22T16:08:36.3157364+00:00",
"BirthPlace": "sample string 8",
"DocumentNumber": "sample string 9",
"IssueDate": "2025-12-22T16:08:36.3157364+00:00",
"ExpiryDate": "2025-12-22T16:08:36.3157364+00:00",
"CountryOfResident": 1,
"VisitPurpose": 1,
"ArrivalDate": "2025-12-22T16:08:36.3157364+00:00",
"Adults": 1,
"Children": 1,
"CheckOutDate": "2025-12-22T16:08:36.3157364+00:00",
"PrimaryEscortFlag": "sample string 10",
"ClientMachineID": "sample string 11",
"ClientMachineName": "sample string 12",
"UserID": "sample string 13",
"UDate": "2025-12-22T16:08:36.3157364+00:00",
"ActiveFlag": "sample string 14",
"ReferenceNumber": "sample string 15",
"IssuingCountry": 1,
"IssuingAuthority": "sample string 16",
"AddressLine1": "sample string 17",
"AddressLine2": "sample string 18",
"City": "sample string 19",
"State": "sample string 20",
"ZIP": "sample string 21",
"Country": "sample string 22",
"IsCheckout": true,
"ConfirmationNumber": "sample string 24",
"DocumentDetailID": 25,
"ReservationNo": "sample string 26",
"FirstName": "sample string 27",
"LastName": "sample string 28",
"MiddleName": "sample string 29",
"DocumentNo": "sample string 30",
"IssueCountry": "sample string 31",
"RoomNo": "sample string 32",
"CheckinDate": "2025-12-22T16:08:36.3157364+00:00",
"CreatedDatetime": "2025-12-22T16:08:36.3157364+00:00",
"KioskStationName": "sample string 33",
"NationalityThreeCode": "sample string 34",
"IssueCountryThreeCode": "sample string 35",
"IsManuallyAuthendicated": true,
"ManuallyAuthendicatedPerson": "sample string 36",
"PMSProfileID": "sample string 37"
}
]
}
application/xml, text/xml
Sample:
<responseRecords xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/VicasCloud.API.Models">
<Message>sample string 3</Message>
<Records xmlns:d2p1="http://schemas.datacontract.org/2004/07/VicasCloud.Model.ViewModels.eReg">
<d2p1:DocumentDetail>
<d2p1:ActiveFlag>sample string 14</d2p1:ActiveFlag>
<d2p1:AddressLine1>sample string 17</d2p1:AddressLine1>
<d2p1:AddressLine2>sample string 18</d2p1:AddressLine2>
<d2p1:Adults>1</d2p1:Adults>
<d2p1:ArrivalDate>2025-12-22T16:08:36.3157364+00:00</d2p1:ArrivalDate>
<d2p1:BirthDate>2025-12-22T16:08:36.3157364+00:00</d2p1:BirthDate>
<d2p1:BirthPlace>sample string 8</d2p1:BirthPlace>
<d2p1:CheckOutDate>2025-12-22T16:08:36.3157364+00:00</d2p1:CheckOutDate>
<d2p1:CheckinDate>2025-12-22T16:08:36.3157364+00:00</d2p1:CheckinDate>
<d2p1:Children>1</d2p1:Children>
<d2p1:City>sample string 19</d2p1:City>
<d2p1:ClientMachineID>sample string 11</d2p1:ClientMachineID>
<d2p1:ClientMachineName>sample string 12</d2p1:ClientMachineName>
<d2p1:ConfirmationNumber>sample string 24</d2p1:ConfirmationNumber>
<d2p1:Country>sample string 22</d2p1:Country>
<d2p1:CountryOfResident>1</d2p1:CountryOfResident>
<d2p1:CreatedDatetime>2025-12-22T16:08:36.3157364+00:00</d2p1:CreatedDatetime>
<d2p1:DocumentDetailID>25</d2p1:DocumentDetailID>
<d2p1:DocumentID>1</d2p1:DocumentID>
<d2p1:DocumentNo>sample string 30</d2p1:DocumentNo>
<d2p1:DocumentNumber>sample string 9</d2p1:DocumentNumber>
<d2p1:DocumentTypeID>3</d2p1:DocumentTypeID>
<d2p1:ExpiryDate>2025-12-22T16:08:36.3157364+00:00</d2p1:ExpiryDate>
<d2p1:FamilyName>sample string 5</d2p1:FamilyName>
<d2p1:FirstName>sample string 27</d2p1:FirstName>
<d2p1:Gender>sample string 7</d2p1:Gender>
<d2p1:GivenName>sample string 6</d2p1:GivenName>
<d2p1:IsCheckout>true</d2p1:IsCheckout>
<d2p1:IsManuallyAuthendicated>true</d2p1:IsManuallyAuthendicated>
<d2p1:IssueCountry>sample string 31</d2p1:IssueCountry>
<d2p1:IssueCountryThreeCode>sample string 35</d2p1:IssueCountryThreeCode>
<d2p1:IssueDate>2025-12-22T16:08:36.3157364+00:00</d2p1:IssueDate>
<d2p1:IssuingAuthority>sample string 16</d2p1:IssuingAuthority>
<d2p1:IssuingCountry>1</d2p1:IssuingCountry>
<d2p1:KioskStationName>sample string 33</d2p1:KioskStationName>
<d2p1:LastName>sample string 28</d2p1:LastName>
<d2p1:ManuallyAuthendicatedPerson>sample string 36</d2p1:ManuallyAuthendicatedPerson>
<d2p1:MiddleName>sample string 29</d2p1:MiddleName>
<d2p1:Name>sample string 2</d2p1:Name>
<d2p1:Nationality>1</d2p1:Nationality>
<d2p1:NationalityThreeCode>sample string 34</d2p1:NationalityThreeCode>
<d2p1:PMSProfileID>sample string 37</d2p1:PMSProfileID>
<d2p1:PrimaryEscortFlag>sample string 10</d2p1:PrimaryEscortFlag>
<d2p1:ReferenceNumber>sample string 15</d2p1:ReferenceNumber>
<d2p1:ReservationNo>sample string 26</d2p1:ReservationNo>
<d2p1:RoomNo>sample string 32</d2p1:RoomNo>
<d2p1:RoomNumber>4</d2p1:RoomNumber>
<d2p1:State>sample string 20</d2p1:State>
<d2p1:UDate>2025-12-22T16:08:36.3157364+00:00</d2p1:UDate>
<d2p1:UserID>sample string 13</d2p1:UserID>
<d2p1:VisitPurpose>1</d2p1:VisitPurpose>
<d2p1:ZIP>sample string 21</d2p1:ZIP>
</d2p1:DocumentDetail>
<d2p1:DocumentDetail>
<d2p1:ActiveFlag>sample string 14</d2p1:ActiveFlag>
<d2p1:AddressLine1>sample string 17</d2p1:AddressLine1>
<d2p1:AddressLine2>sample string 18</d2p1:AddressLine2>
<d2p1:Adults>1</d2p1:Adults>
<d2p1:ArrivalDate>2025-12-22T16:08:36.3157364+00:00</d2p1:ArrivalDate>
<d2p1:BirthDate>2025-12-22T16:08:36.3157364+00:00</d2p1:BirthDate>
<d2p1:BirthPlace>sample string 8</d2p1:BirthPlace>
<d2p1:CheckOutDate>2025-12-22T16:08:36.3157364+00:00</d2p1:CheckOutDate>
<d2p1:CheckinDate>2025-12-22T16:08:36.3157364+00:00</d2p1:CheckinDate>
<d2p1:Children>1</d2p1:Children>
<d2p1:City>sample string 19</d2p1:City>
<d2p1:ClientMachineID>sample string 11</d2p1:ClientMachineID>
<d2p1:ClientMachineName>sample string 12</d2p1:ClientMachineName>
<d2p1:ConfirmationNumber>sample string 24</d2p1:ConfirmationNumber>
<d2p1:Country>sample string 22</d2p1:Country>
<d2p1:CountryOfResident>1</d2p1:CountryOfResident>
<d2p1:CreatedDatetime>2025-12-22T16:08:36.3157364+00:00</d2p1:CreatedDatetime>
<d2p1:DocumentDetailID>25</d2p1:DocumentDetailID>
<d2p1:DocumentID>1</d2p1:DocumentID>
<d2p1:DocumentNo>sample string 30</d2p1:DocumentNo>
<d2p1:DocumentNumber>sample string 9</d2p1:DocumentNumber>
<d2p1:DocumentTypeID>3</d2p1:DocumentTypeID>
<d2p1:ExpiryDate>2025-12-22T16:08:36.3157364+00:00</d2p1:ExpiryDate>
<d2p1:FamilyName>sample string 5</d2p1:FamilyName>
<d2p1:FirstName>sample string 27</d2p1:FirstName>
<d2p1:Gender>sample string 7</d2p1:Gender>
<d2p1:GivenName>sample string 6</d2p1:GivenName>
<d2p1:IsCheckout>true</d2p1:IsCheckout>
<d2p1:IsManuallyAuthendicated>true</d2p1:IsManuallyAuthendicated>
<d2p1:IssueCountry>sample string 31</d2p1:IssueCountry>
<d2p1:IssueCountryThreeCode>sample string 35</d2p1:IssueCountryThreeCode>
<d2p1:IssueDate>2025-12-22T16:08:36.3157364+00:00</d2p1:IssueDate>
<d2p1:IssuingAuthority>sample string 16</d2p1:IssuingAuthority>
<d2p1:IssuingCountry>1</d2p1:IssuingCountry>
<d2p1:KioskStationName>sample string 33</d2p1:KioskStationName>
<d2p1:LastName>sample string 28</d2p1:LastName>
<d2p1:ManuallyAuthendicatedPerson>sample string 36</d2p1:ManuallyAuthendicatedPerson>
<d2p1:MiddleName>sample string 29</d2p1:MiddleName>
<d2p1:Name>sample string 2</d2p1:Name>
<d2p1:Nationality>1</d2p1:Nationality>
<d2p1:NationalityThreeCode>sample string 34</d2p1:NationalityThreeCode>
<d2p1:PMSProfileID>sample string 37</d2p1:PMSProfileID>
<d2p1:PrimaryEscortFlag>sample string 10</d2p1:PrimaryEscortFlag>
<d2p1:ReferenceNumber>sample string 15</d2p1:ReferenceNumber>
<d2p1:ReservationNo>sample string 26</d2p1:ReservationNo>
<d2p1:RoomNo>sample string 32</d2p1:RoomNo>
<d2p1:RoomNumber>4</d2p1:RoomNumber>
<d2p1:State>sample string 20</d2p1:State>
<d2p1:UDate>2025-12-22T16:08:36.3157364+00:00</d2p1:UDate>
<d2p1:UserID>sample string 13</d2p1:UserID>
<d2p1:VisitPurpose>1</d2p1:VisitPurpose>
<d2p1:ZIP>sample string 21</d2p1:ZIP>
</d2p1:DocumentDetail>
</Records>
<StatusCode>2</StatusCode>
<result>true</result>
</responseRecords>