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 .csv suffix or ?format=csv

HTTP + CSV

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: text/csv

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"data":{"id":"00000000000000000000000000000000","organizationId":"00000000000000000000000000000000","reservationNumber":"String","state":0,"guests":[{"guestFirstName":"String","guestLastName":"String","email":"String","phone":"String","iso3166alpha2Code":"String","accessCodes":[{"space":"String","accessCode":"String","roomNumber":"String"}]}],"visitData":{"visitType":1,"checkin":-62135596800000,"checkout":-62135596800000,"doesNotContainTimeInfo":false}},"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}