Viviot.Api

GetExternalReservation

**Requires Authentication**
Requires the role:	ReservationReader

The following routes are available for this service:
GET	/client/reservation	Gets reservation data, including access codes, given the external reservation number.

**GetExternalReservation** Parameters:
Name	Parameter	Data Type	Required	Description
ExternalReservationId	query	string	Yes	External reservation ID

**BaseRequest** Parameters:
Name	Parameter	Data Type	Required	Description
Version	form	integer	No	Api version

**ExternalReservationResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Data	form	ExternalReservationView	No

**BaseResponse** Parameters:
Name	Parameter	Data Type	Required	Description
ResponseStatus	form	ResponseStatus	No

**ExternalReservationView** Parameters:
Name	Parameter	Data Type	Required
Id	form	Guid	No
OrganizationId	form	Guid	No
ReservationNumber	form	string	No
State	form	ReservationState	No
Guests	form	List<ExternalGuestView>	No
VisitData	form	ReservationVisitDataDto	No

**ReservationState** Enum:
Name	Value
New	0
Assigned	10
WaitingForConfirmation	15
PendingActivation	20
Active	30
Expired	40
Denied	50
Cancelled	60

**ExternalGuestView** Parameters:
Name	Parameter	Data Type	Required
GuestFirstName	form	string	No
GuestLastName	form	string	No
Email	form	string	No
Phone	form	string	No
Iso3166alpha2Code	form	string	No
AccessCodes	form	List<AccessCodeView>	No

**AccessCodeView** Parameters:
Name	Parameter	Data Type	Required
Space	form	string	No
AccessCode	form	string	No
RoomNumber	form	string	No

**ReservationVisitDataDto** Parameters:
Name	Parameter	Data Type	Required
VisitType	form	VisitType	No
Checkin	form	DateTime?	No
Checkout	form	DateTime?	No
DoesNotContainTimeInfo	form	bool?	No

**VisitType** Enum:
Name	Value
DateTime	1
AccessCount	2

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 /client/reservation HTTP/1.1 
Host: api.4spaces.io 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ExternalReservationResponse 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.Api.ServiceModel.Views.Business.Reservation">
    <d2p1:Guests>
      <d2p1:ExternalGuestView>
        <d2p1:AccessCodes>
          <d2p1:AccessCodeView>
            <d2p1:AccessCode>String</d2p1:AccessCode>
            <d2p1:RoomNumber>String</d2p1:RoomNumber>
            <d2p1:Space>String</d2p1:Space>
          </d2p1:AccessCodeView>
        </d2p1:AccessCodes>
        <d2p1:Email>String</d2p1:Email>
        <d2p1:GuestFirstName>String</d2p1:GuestFirstName>
        <d2p1:GuestLastName>String</d2p1:GuestLastName>
        <d2p1:Iso3166alpha2Code>String</d2p1:Iso3166alpha2Code>
        <d2p1:Phone>String</d2p1:Phone>
      </d2p1:ExternalGuestView>
    </d2p1:Guests>
    <d2p1:Id>00000000-0000-0000-0000-000000000000</d2p1:Id>
    <d2p1:OrganizationId>00000000-0000-0000-0000-000000000000</d2p1:OrganizationId>
    <d2p1:ReservationNumber>String</d2p1:ReservationNumber>
    <d2p1:State>New</d2p1:State>
    <d2p1:VisitData xmlns:d3p1="http://schemas.datacontract.org/2004/07/Viviot.Infrastructure.Dto.Reservation">
      <d3p1:Checkin>0001-01-01T00:00:00</d3p1:Checkin>
      <d3p1:Checkout>0001-01-01T00:00:00</d3p1:Checkout>
      <d3p1:DoesNotContainTimeInfo>false</d3p1:DoesNotContainTimeInfo>
      <d3p1:VisitType>DateTime</d3p1:VisitType>
    </d2p1:VisitData>
  </Data>
</ExternalReservationResponse>