Viviot.Api

<back to all web services

GetReservationGuestInfo

Requires Authentication
Requires any of the roles:Admin, TenantAdmin, Receptionist
The following routes are available for this service:
GET/reservation/guestinfoGets guest personal data as provided by guests.
BaseReservation Parameters:
NameParameterData TypeRequiredDescription
ReservationIdformstringYesReservation Id (GUID)
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
VersionformintegerNoApi version
ReservationGuestInfoResponse Parameters:
NameParameterData TypeRequiredDescription
DataformList<ReservationGuestInfoDto>No
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
ReservationGuestInfoDto Parameters:
NameParameterData TypeRequiredDescription
GuestFirstNameformstringNo
GuestLastNameformstringNo
CountryformstringNo
DateOfBirthformDateTimeNo
DocumentTypeformIdDocumentTypeNo
DocumentNumberformstringNo
GenderformGenderNo
TimestampformDateTimeNo
EmailformstringNo
IdDocumentType Enum:
NameValue
ObmejnaPrepustnica1
PotneListinePoMednarodniPogodbi2
OsebnaIzkaznica3
OrozniList4
PotniList5
UpravneListine6
VozniskoDovoljenje7
Gender Enum:
NameValue
Male1
Female2

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /reservation/guestinfo HTTP/1.1 
Host: api.4spaces.io 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ReservationGuestInfoResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Viviot.Api.ServiceModel.Api.Business">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types" xmlns="http://schemas.datacontract.org/2004/07/Viviot.Api.ServiceModel.Api.Base">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/Viviot.Infrastructure.Dto.Reservation">
    <d2p1:ReservationGuestInfoDto>
      <d2p1:Country>String</d2p1:Country>
      <d2p1:DateOfBirth>0001-01-01T00:00:00</d2p1:DateOfBirth>
      <d2p1:DocumentNumber>String</d2p1:DocumentNumber>
      <d2p1:DocumentType>ObmejnaPrepustnica</d2p1:DocumentType>
      <d2p1:Email>String</d2p1:Email>
      <d2p1:Gender>Male</d2p1:Gender>
      <d2p1:GuestFirstName>String</d2p1:GuestFirstName>
      <d2p1:GuestLastName>String</d2p1:GuestLastName>
      <d2p1:Timestamp>0001-01-01T00:00:00</d2p1:Timestamp>
    </d2p1:ReservationGuestInfoDto>
  </Data>
</ReservationGuestInfoResponse>