Viviot.Api

GetOrganizationDetails

The following routes are available for this service:
GET	/organization/details	Gets an organization available to a business user with its details.

**GetOrganizationDetails** Parameters:
Name	Parameter	Data Type	Required	Description
OrganizationId	query	string	Yes	Organization Id
LoadSmartSpaces	query	boolean	No	Include smart spaces in organization response data
LoadSmartSpaceThings	query	boolean	No	Include things into organization smart spaces
LoadServices	query	boolean	No	Include services in organization response data

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

**OrganizationDetailsResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Data	form	OrganizationView	No

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

**OrganizationView** Parameters:
Name	Parameter	Data Type	Required
Id	form	Guid	No
Name	form	string	No
Code	form	string	No
SmartSpaces	form	List<ThingViewExtended>	No
Services	form	List<ServiceView>	No
ReservationConfig	form	Dictionary<string, Object>	No
FeatureConfig	form	IEnumerable<FeatureConfig>	No
DashboardConfig	form	DashboardConfig	No

**ThingViewExtended** Parameters:
Name	Parameter	Data Type	Required
ImageUrl	form	string	No
ThingType	form	ThingTypeBasicView	No
ThingDefinition	form	ThingDefinitionView	No
UserAccesses	form	List<UserAccessView>	No
States	form	Dictionary<string, List<StateValueView>>	No
Properties	form	Dictionary<string, string>	No
ThingsByCategory	form	List<ThingCategoryView>	No
Organization	form	OrganizationDto	No

**ThingViewBasic** Parameters:
Name	Parameter	Data Type	Required
Id	form	Guid	No
OrganizationId	form	Guid	No
Name	form	string	No
Order	form	int	No

**ThingTypeBasicView** Parameters:
Name	Parameter	Data Type	Required
Id	form	Guid	No
Name	form	string	No
SysTypeName	form	string	No

**ThingDefinitionView** Parameters:
Name	Parameter	Data Type	Required
Id	form	Guid	No
OrganizationId	form	Guid	No
Name	form	string	No
Description	form	string	No
Properties	form	Dictionary<string, Object>	No

**UserAccessView** Parameters:
Name	Parameter	Data Type	Required
Id	form	Guid	No
UserId	form	int	No
BusinessUserId	form	int	No
ValidFrom	form	DateTime	No
ValidTo	form	DateTime?	No
ActiveFrom	form	DateTime	No
AccessCount	form	int?	No
TicketNumber	form	string	No
QueuePosition	form	int?	No
CanEnterWithTicket	form	bool	No
Permission	form	List<string>	No

**ThingCategoryView** Parameters:
Name	Parameter	Data Type	Required	Description
Things	form	List<ThingViewExtended>	No

**ThingCategoryBasicView** Parameters:
Name	Parameter	Data Type	Required	Description
Id	form	Guid	No
Name	form	string	No

**OrganizationDto** Parameters:
Name	Parameter	Data Type	Required	Description
Id	form	Guid?	No
Code	form	string	No

**ServiceView** Parameters:
Name	Parameter	Data Type	Required
Id	form	Guid	No
OrganizationId	form	Guid	No
ServiceType	form	ServiceType	No
Name	form	string	No
Description	form	string	No
SubTitle	form	string	No
ImageUrl	form	string	No
IsPublic	form	bool	No
RequireConfirmation	form	bool?	No
RequirePayment	form	bool?	No
Latitude	form	decimal?	No
Longitude	form	decimal?	No
Currency	form	CurrencyDto	No
VATPercentage	form	decimal?	No
Products	form	List<ServiceProductView>	No
Addons	form	List<ServiceAddonDto>	No
TimeOption	form	ServiceTimeOptionDto	No
PersonOption	form	ServicePersonOptionDto	No
Providers	form	Dictionary<string, Guid>	No
Organization	form	OrganizationDto	No

**ServiceType** Enum:
Name	Value
Reservation	1
Request	2
External	3
Ticket	4

**CurrencyDto** Parameters:
Name	Parameter	Data Type	Required
Id	form	Guid	No
Name	form	string	No
Code	form	string	No
Symbol	form	string	No

**ServiceProductView** Parameters:
Name	Parameter	Data Type	Required
Id	form	Guid	No
Name	form	string	No
Description	form	string	No
UnitPrice	form	decimal?	No
MinimalPrice	form	decimal?	No
VATPercentage	form	decimal?	No
ImageUrl	form	string	No
ExternalId	form	List<string>	No
ReservationData	form	ServiceProductReservationDto	No
RequestData	form	ServiceProductRequestDto	No
ExternalData	form	ServiceProductExternalDto	No
TicketData	form	ServiceProductTicketDto	No

**ServiceProductReservationDto** Parameters:
Name	Parameter	Data Type	Required
Id	form	Guid?	No
AccessTemplateGroupId	form	Guid?	No
AccessTemplateId	form	Guid?	No
AutoAssignAccessTemplate	form	bool?	No

**ServiceProductRequestDto** Parameters:
Name	Parameter	Data Type	Required
Id	form	Guid?	No
Options	form	List<string>	No
AllowComments	form	bool	No
ApprovedTemplate	form	string	No
DeniedTemplate	form	string	No
ProcessingTemplate	form	string	No

**ServiceProductExternalDto** Parameters:
Name	Parameter	Data Type	Required
Id	form	Guid?	No
ServiceUrl	form	string	No
Latitude	form	decimal?	No
Longitude	form	decimal?	No
Rating	form	decimal?	No

**ServiceProductTicketDto** Parameters:
Name	Parameter	Data Type	Required	Description
Id	form	Guid?	No
AccessTemplateId	form	Guid	No

**ServiceAddonDto** Parameters:
Name	Parameter	Data Type	Required
Id	form	Guid?	No
Name	form	string	No
UnitPrice	form	decimal?	No
VATPercentage	form	decimal?	No
MaxQuantity	form	int?	No
ExternalId	form	string	No

**ServiceTimeOptionDto** Parameters:
Name	Parameter	Data Type	Required
Id	form	Guid?	No
Type	form	ServiceTimeOptionType	No
DailyOptions	form	TimeDailyDto	No
TimespanOptions	form	TimespanDto	No

**ServiceTimeOptionType** Enum:
Name	Value
Daily	0
Timespan	1

**TimeDailyDto** Parameters:
Name	Parameter	Data Type	Required	Description
Checkin	form	TimeSpan?	No
Checkout	form	TimeSpan?	No

**TimespanDto** Parameters:
Name	Parameter	Data Type	Required
MinDuration	form	int	No
MaxDuration	form	int	No
Increment	form	int?	No
IncrementPriceMultiplier	form	decimal?	No

**ServicePersonOptionDto** Parameters:
Name	Parameter	Data Type	Required
Id	form	Guid?	No
CanSelectChildren	form	bool	No
MaxAdultCount	form	int?	No
MaxChildrenCount	form	int?	No
AdultPriceMultiplier	form	decimal	No
ChildPriceMultiplier	form	decimal	No

**FeatureConfig** Parameters:
Name	Parameter	Data Type	Required	Description
Feature	form	Feature	No
Enabled	form	bool	No

**Feature** Enum:
Name	Value
Dashboard	0
Reservations	1
Spaces	2
SpacesGuestSetpoints	3
SpacesAccesses	4
SpacesActivityLog	5
AccessManagement	6
Staff	7
Workflow	8
Communication	9
Marketplace	10
AccessTemplateGroups	11
SpacesOverviewAlarms	12
SpacesOverviewOoo	13
SpacesDetails	14
SpacesOverviewStatuses	15
SpacesOverviewFireAlert	16
SpacesOverviewSos	17
SpacesOverviewUnauthorized	18
SpacesOverviewMur	19
SpacesOverviewDnd	20

**DashboardConfig** Parameters:
Name	Parameter	Data Type	Required	Description
SpaceLabel	form	string	No

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.

GET /organization/details HTTP/1.1 
Host: api.4spaces.io 
Accept: text/jsv

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

{
	data: 
	{
		id: 00000000000000000000000000000000,
		name: String,
		code: String,
		smartSpaces: 
		[
			{
				imageUrl: String,
				thingType: 
				{
					id: 00000000000000000000000000000000,
					name: String,
					sysTypeName: String
				},
				thingDefinition: 
				{
					id: 00000000000000000000000000000000,
					organizationId: 00000000000000000000000000000000,
					name: String,
					description: String,
					properties: 
					{
						String: {}
					}
				},
				userAccesses: 
				[
					{
						id: 00000000000000000000000000000000,
						userId: 0,
						businessUserId: 0,
						validFrom: -62135596800000,
						validTo: -62135596800000,
						activeFrom: -62135596800000,
						accessCount: 0,
						ticketNumber: String,
						queuePosition: 0,
						canEnterWithTicket: False,
						permission: 
						[
							String
						]
					}
				],
				states: 
				{
					String: 
					[
						{
							ts: -62135596800000,
							value: String
						}
					]
				},
				properties: 
				{
					String: String
				},
				thingsByCategory: 
				[
					{
						things: 
						[
							{
								imageUrl: String,
								thingType: 
								{
									id: 00000000000000000000000000000000,
									name: String,
									sysTypeName: String
								},
								thingDefinition: 
								{
									id: 00000000000000000000000000000000,
									organizationId: 00000000000000000000000000000000,
									name: String,
									description: String,
									properties: 
									{
										String: {}
									}
								},
								userAccesses: 
								[
									{
										id: 00000000000000000000000000000000,
										userId: 0,
										businessUserId: 0,
										validFrom: -62135596800000,
										validTo: -62135596800000,
										activeFrom: -62135596800000,
										accessCount: 0,
										ticketNumber: String,
										queuePosition: 0,
										canEnterWithTicket: False,
										permission: 
										[
											String
										]
									}
								],
								states: 
								{
									String: 
									[
										{
											ts: -62135596800000,
											value: String
										}
									]
								},
								properties: 
								{
									String: String
								},
								thingsByCategory: 
								[
									{
										things: 
										[
											{
												imageUrl: String,
												thingType: 
												{
													id: 00000000000000000000000000000000,
													name: String,
													sysTypeName: String
												},
												thingDefinition: 
												{
													id: 00000000000000000000000000000000,
													organizationId: 00000000000000000000000000000000,
													name: String,
													description: String,
													properties: 
													{
														String: {}
													}
												},
												userAccesses: 
												[
													{
														id: 00000000000000000000000000000000,
														userId: 0,
														businessUserId: 0,
														validFrom: -62135596800000,
														validTo: -62135596800000,
														activeFrom: -62135596800000,
														accessCount: 0,
														ticketNumber: String,
														queuePosition: 0,
														canEnterWithTicket: False,
														permission: 
														[
															String
														]
													}
												],
												states: 
												{
													String: 
													[
														{
															ts: -62135596800000,
															value: String
														}
													]
												},
												properties: 
												{
													String: String
												},
												thingsByCategory: 
												[
													{
														id: 00000000000000000000000000000000,
														name: String
													}
												],
												organization: 
												{
													id: 00000000000000000000000000000000,
													code: String
												},
												id: 00000000000000000000000000000000,
												organizationId: 00000000000000000000000000000000,
												name: String,
												order: 0
											}
										],
										id: 00000000000000000000000000000000,
										name: String
									}
								],
								organization: 
								{
									id: 00000000000000000000000000000000,
									code: String
								},
								id: 00000000000000000000000000000000,
								organizationId: 00000000000000000000000000000000,
								name: String,
								order: 0
							}
						],
						id: 00000000000000000000000000000000,
						name: String
					}
				],
				organization: 
				{
					id: 00000000000000000000000000000000,
					code: String
				},
				id: 00000000000000000000000000000000,
				organizationId: 00000000000000000000000000000000,
				name: String,
				order: 0
			}
		],
		services: 
		[
			{
				id: 00000000000000000000000000000000,
				organizationId: 00000000000000000000000000000000,
				serviceType: 1,
				name: String,
				description: String,
				subTitle: String,
				imageUrl: String,
				isPublic: False,
				requireConfirmation: False,
				requirePayment: False,
				latitude: 0,
				longitude: 0,
				currency: 
				{
					id: 00000000000000000000000000000000,
					name: String,
					code: String,
					symbol: String
				},
				vatPercentage: 0,
				products: 
				[
					{
						id: 00000000000000000000000000000000,
						name: String,
						description: String,
						unitPrice: 0,
						minimalPrice: 0,
						vatPercentage: 0,
						imageUrl: String,
						externalId: 
						[
							String
						],
						reservationData: 
						{
							id: 00000000000000000000000000000000,
							accessTemplateGroupId: 00000000000000000000000000000000,
							accessTemplateId: 00000000000000000000000000000000,
							autoAssignAccessTemplate: False
						},
						requestData: 
						{
							id: 00000000000000000000000000000000,
							options: 
							[
								String
							],
							allowComments: False,
							approvedTemplate: String,
							deniedTemplate: String,
							processingTemplate: String
						},
						externalData: 
						{
							id: 00000000000000000000000000000000,
							serviceUrl: String,
							latitude: 0,
							longitude: 0,
							rating: 0
						},
						ticketData: 
						{
							id: 00000000000000000000000000000000,
							accessTemplateId: 00000000000000000000000000000000
						}
					}
				],
				addons: 
				[
					{
						id: 00000000000000000000000000000000,
						name: String,
						unitPrice: 0,
						vatPercentage: 0,
						maxQuantity: 0,
						externalId: String
					}
				],
				timeOption: 
				{
					id: 00000000000000000000000000000000,
					type: 0,
					dailyOptions: 
					{
						checkin: PT0S,
						checkout: PT0S
					},
					timespanOptions: 
					{
						minDuration: 0,
						maxDuration: 0,
						increment: 0,
						incrementPriceMultiplier: 0
					}
				},
				personOption: 
				{
					id: 00000000000000000000000000000000,
					canSelectChildren: False,
					maxAdultCount: 0,
					maxChildrenCount: 0,
					adultPriceMultiplier: 0,
					childPriceMultiplier: 0
				},
				providers: 
				{
					String: 00000000000000000000000000000000
				},
				organization: 
				{
					id: 00000000000000000000000000000000,
					code: String
				}
			}
		],
		reservationConfig: 
		{
			String: {}
		},
		dashboardConfig: 
		{
			spaceLabel: String
		}
	},
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}