Viviot.Api

ExternalReservations

**Requires Authentication**
Requires the role:	ReservationPublisher

The following routes are available for this service:
POST	/client/reservation	Accepts and stores a collection of reservations from an external system.

**ExternalReservationsResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Reservations	form	List<ReservationView>	No

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

**ReservationView** Parameters:
Name	Parameter	Data Type	Required
Id	form	Guid	No
State	form	ReservationState	No
ReasonDenied	form	string	No
Guests	form	List<ReservationGuestDto>	No
AdditionalData	form	ReservationAdditionalDataDto	No
VisitData	form	ReservationVisitDataDto	No
AccessTemplates	form	List<ReservationAccessTemplateDto>	No
ExternalId	form	string	No
ReservationGuestInfos	form	List<ReservationGuestInfoDto>	No

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

**ReservationGuestDto** Parameters:
Name	Parameter	Data Type	Required
Id	form	Guid?	No
ViviotId	form	string	No
GuestFirstName	form	string	No
GuestLastName	form	string	No
Email	form	string	No
Phone	form	string	No
GuestType	form	GuestType	No
Iso3166alpha2Code	form	string	No
SendInvitation	form	bool	No
SendAccountActivationEmail	form	bool	No

**GuestType** Enum:
Name	Value
Business	1
Leisure	2

**ReservationAdditionalDataDto** Parameters:
Name	Parameter	Data Type	Required
LicensePlates	form	List<string>	No
Comment	form	string	No
WelcomeMessage	form	string	No
Company	form	string	No
AccessCards	form	List<AccessCardDataDto>	No

**AccessCardDataDto** Parameters:
Name	Parameter	Data Type	Required	Description
CardNumber	form	string	No
ThingIds	form	List<Guid>	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

**ReservationAccessTemplateDto** Parameters:
Name	Parameter	Data Type	Required
Id	form	Guid	No
Name	form	string	No
Description	form	string	No
IsAvailable	form	bool	No
OccupiedUntil	form	DateTime?	No
ReservationIdentifier	form	string	No
AccessCodeInitializationStrategy	form	int	No
Tags	form	List<TagDto>	No
Smartspaces	form	List<ReservationSmartSpaceDto>	No
Things	form	List<ThingAccessTemplateDto>	No

**TagDto** Parameters:
Name	Parameter	Data Type	Required
Id	form	Guid	No
Name	form	string	No
TagGroupId	form	Guid	No

**ReservationSmartSpaceDto** Parameters:
Name	Parameter	Data Type	Required
Id	form	Guid	No
Name	form	string	No
AccessFrom	form	TimeSpan?	No
AccessTo	form	TimeSpan?	No
AccessCount	form	int?	No
AccessCardNumbers	form	string	No

**ThingAccessTemplateDto** Parameters:
Name	Parameter	Data Type	Required
Id	form	Guid?	No
OrganizationId	form	Guid	No
ThingId	form	Guid	No
ThingName	form	string	No
ThingTypeName	form	string	No
Exclusive	form	bool	No
AvailableFrom	form	int?	No
AvailableTo	form	int?	No
AccessCount	form	int?	No
AccessLevel	form	string	No
Permission	form	List<string>	No

**ReservationGuestInfoDto** Parameters:
Name	Parameter	Data Type	Required
GuestFirstName	form	string	No
GuestLastName	form	string	No
Country	form	string	No
DateOfBirth	form	DateTime	No
DocumentType	form	IdDocumentType	No
DocumentNumber	form	string	No
Gender	form	Gender	No
Timestamp	form	DateTime	No
Email	form	string	No

**IdDocumentType** Enum:
Name	Value
ObmejnaPrepustnica	1
PotneListinePoMednarodniPogodbi	2
OsebnaIzkaznica	3
OrozniList	4
PotniList	5
UpravneListine	6
VozniskoDovoljenje	7

**Gender** Enum:
Name	Value
Male	1
Female	2

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

HTTP + JSV

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

POST /client/reservation HTTP/1.1 
Host: api.4spaces.io 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	
}

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

{
	reservations: 
	[
		{
			id: 00000000000000000000000000000000,
			state: 0,
			reasonDenied: String,
			guests: 
			[
				{
					id: 00000000000000000000000000000000,
					viviotId: String,
					guestFirstName: String,
					guestLastName: String,
					email: String,
					phone: String,
					guestType: 1,
					iso3166alpha2Code: String,
					sendInvitation: False,
					sendAccountActivationEmail: False
				}
			],
			additionalData: 
			{
				licensePlates: 
				[
					String
				],
				comment: String,
				welcomeMessage: String,
				company: String,
				accessCards: 
				[
					{
						cardNumber: String,
						thingIds: 
						[
							00000000000000000000000000000000
						]
					}
				]
			},
			visitData: 
			{
				visitType: 1,
				checkin: -62135596800000,
				checkout: -62135596800000,
				doesNotContainTimeInfo: False
			},
			accessTemplates: 
			[
				{
					id: 00000000000000000000000000000000,
					name: String,
					description: String,
					isAvailable: False,
					occupiedUntil: -62135596800000,
					reservationIdentifier: String,
					accessCodeInitializationStrategy: 0,
					tags: 
					[
						{
							id: 00000000000000000000000000000000,
							name: String,
							tagGroupId: 00000000000000000000000000000000
						}
					],
					smartspaces: 
					[
						{
							id: 00000000000000000000000000000000,
							name: String,
							accessFrom: PT0S,
							accessTo: PT0S,
							accessCount: 0,
							accessCardNumbers: String
						}
					],
					things: 
					[
						{
							id: 00000000000000000000000000000000,
							organizationId: 00000000000000000000000000000000,
							thingId: 00000000000000000000000000000000,
							thingName: String,
							thingTypeName: String,
							exclusive: False,
							availableFrom: 0,
							availableTo: 0,
							accessCount: 0,
							accessLevel: String,
							permission: 
							[
								String
							]
						}
					]
				}
			],
			externalId: String,
			reservationGuestInfos: 
			[
				{
					guestFirstName: String,
					guestLastName: String,
					country: String,
					dateOfBirth: -62135596800000,
					documentType: 1,
					documentNumber: String,
					gender: 1,
					timestamp: -62135596800000,
					email: String
				}
			]
		}
	],
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}