Locations

Locations overview

The locations can be an address or a specific place, e.g. a conference room.

Object types

Location

type Location {
	projectId: ID!
	locationId: ID!
	shortId: NonEmptyString!
	title: NonEmptyString!
	description: NonEmptyString
	address: NonEmptyString
	latLng: LatLng
	slots: [Slot]
	media: [Media]
	labels: [NonEmptyString]
	createdAt: DateTime!
	updatedAt: DateTime!
}

Location fields

Field nameValue typeNon-nullDescription
projectId
ID
true
locationId
ID
true
shortId
ID
true
A human-readable identifier for the location.
title
NonEmptyString
true
description
String
false
address
String
false
latLng
LatLng
false
slots
[Slot]
false
media
[Media]
false
labels
[NonEmptyString]
false
createdAt
DateTime
true
The date and time when a location was created.
updatedAt
DateTime
true
The date and time when a location was updated.

LocationSlotStrategy

type LocationSlotStrategy {
	projectId: ID!
	locationId: ID!
	strategyId: ID!
	strategyType: StrategyType!
	discontinueStrategy: DiscontinueStrategy!
	dateTimeFrom: DateTime
	dateTimeTo: DateTime
	timeFrom: Time
	timeTo: Time
	daysOfWeek: [DayOfWeek]
	slotType: SlotType
	slotQuantity: NonNegativeInt
	slotDuration: Duration
	slotInterval: Duration
	createdAt: DateTime!
	updatedAt: DateTime!
}

LocationSlotStrategy fields

Field nameValue typeNon-nullDescription
projectId
ID
true
A globally-unique identifier.
locationId
ID
true
A globally-unique identifier.
strategyId
ID
true
A globally-unique identifier.
strategyType
StrategyType
true
discontinueStrategy
DiscontinueStrategy
true
dateTimeFrom
DateTime
false
dateTimeTo
DateTime
false
timeFrom
Time
false
timeTo
Time
false
daysOfWeek
[DayOfWeek]
false
slotType
SlotType
false
slotQuantity
NonNegativeInt
false
slotDuration
Duration
false
slotInterval
Duration
false
createdAt
DateTime
true
The date and time when an object was created.
updatedAt
DateTime
true
The date and time when an object was updated.

Queries

locations

locations(
	projectId: ID!
	limit: NonNegativeInt
	cursor: ID
): [Location]

locations arguments

Field nameValue typeRequiredDescription
projectId
ID
true
A globally-unique identifier.
limit
NonNegativeInt
false
cursor
ID
false
🔑

Minimal role required: STAFF

locationsSearch

locationsSearch(
	projectId: ID!
	query: String!
): [Location]

locationsSearch arguments

Field nameValue typeRequiredDescription
projectId
ID
true
A globally-unique identifier.
query
String
true
🔑

Minimal role required: STAFF

locationSlotsStrategies

locationSlotsStrategies(
	projectId: ID!
	locationId: ID!
): [LocationSlotStrategy]

locationSlotsStrategies arguments

Field nameValue typeRequiredDescription
projectId
ID
true
A globally-unique identifier.
locationId
ID
true
A globally-unique identifier.
🔑

Minimal role required: ADMIN / APIADMIN

Mutations

locationCreate

locationCreate(
	projectId: ID!
	title: NonEmptyString
	description: NonEmptyString
	address: NonEmptyString
	latLng: LatLngInput
	media: [MediaInput]
	labels: [NonEmptyString]
): Location

locationCreate arguments

Field nameValue typeRequiredDescription
projectId
ID
true
locationId
ID
false
title
NonEmptyString
false
description
NonEmptyString
false
address
NonEmptyString
false
latLng
LatLngInput
false
media
[MediaInput]
false
labels
[NonEmptyString]
false
🔑

Minimal role required: MANAGER

locationUpdate

locationUpdate(
	projectId: ID!
	locationId: String!
	title: NonEmptyString
	description: NonEmptyString
	address: NonEmptyString
	latLng: LatLngInput
	media: [MediaInput]
	labels: [NonEmptyString]
): Location

locationUpdate arguments

Field nameValue typeRequiredDescription
projectId
ID
true
locationId
ID
true
title
NonEmptyString
false
description
NonEmptyString
false
address
NonEmptyString
false
latLng
LatLngInput
false
media
[MediaInput]
false
labels
[NonEmptyString]
false
🔑

Minimal role required: MANAGER

locationDelete

locationDelete(
	projectId: ID!
	locationId: ID!
): String

locationDelete arguments

Field nameValue typeRequiredDescription
projectId
ID
true
A globally-unique identifier.
locationId
ID
true
A globally-unique identifier.
🔑

Minimal role required: MANAGER

locationSlotCreate

locationSlotCreate(
	projectId: ID!
	locationId: ID!
	quantity: NonNegativeInt!
	dateTimeFrom: DateTime!
	dateTimeTo: DateTime!
	slotType: SlotType!
	slotGroupId: ID
	title: String
): Slot

locationSlotCreate arguments

Field nameValue typeRequiredDescription
projectId
ID
true
A globally-unique identifier.
locationId
ID
true
A globally-unique identifier.
quantity
NonNegativeInt
true
dateTimeFrom
DateTime
true
dateTimeTo
DateTime
true
slotType
SlotType
true
slotGroupId
ID
false
A globally-unique identifier.
title
String
false
🔑

Minimal role required: MANAGER

locationSlotUpdate

locationSlotUpdate(
	projectId: ID!
	locationId: ID!
	slotId: String!
	quantity: NonNegativeInt
	dateTimeFrom: DateTime
	dateTimeTo: DateTime
	slotType: SlotType
	title: String
	slotGroupId: ID
): Slot

locationSlotUpdate arguments

Field nameValue typeRequiredDescription
projectId
ID
true
A globally-unique identifier.
locationId
ID
true
A globally-unique identifier.
slotId
ID
true
A globally-unique identifier.
quantity
NonNegativeInt
false
dateTimeFrom
DateTime
false
dateTimeTo
DateTime
false
slotType
SlotType
false
title
String
false
slotGroupId
ID
false
🔑

Minimal role required: MANAGER

locationSlotDelete

locationSlotDelete(
	projectId: ID!
	locationId: ID!
	slotId: ID!
): String

locationSlotDelete arguments

Field nameValue typeRequiredDescription
projectId
ID
true
A globally-unique identifier.
locationId
ID
true
A globally-unique identifier.
slotId
ID
true
A globally-unique identifier.
🔑

Minimal role required: MANAGER

locationSlotStrategyCreate

locationSlotStrategyCreate(
	projectId: ID!
	locationId: ID!
	slotType: SlotType!
	slotQuantity: NonNegativeInt!
	slotDuration: Duration!
	slotInterval: Duration!
	strategyType: StrategyType!
	discontinueStrategy: DiscontinueStrategyInput!
	daysOfWeek: [DayOfWeek!]
	dateTimeFrom: DateTime
	dateTimeTo: DateTime
	timeFrom: Time
	timeTo: Time
): LocationSlotStrategy

locationSlotStrategyCreate arguments

Field nameValue typeRequiredDescription
projectId
ID
true
A globally-unique identifier.
locationId
ID
true
A globally-unique identifier.
slotType
NonNegativeInt
true
slotQuantity
ID
true
A globally-unique identifier.
slotDuration
Duration
true
slotInterval
Duration
true
strategyType
StrategyType
true
discontinueStrategy
DiscontinueStrategyInput
true
daysOfWeek
[DayOfWeek]
true
dateTimeFrom
DateTime
false
dateTimeTo
DateTime
false
timeFrom
Time
false
timeTo
Time
false
🔑

Minimal role required: ADMIN / APIADMIN

locationSlotStrategyDelete

Deletes a strategy.

locationSlotStrategyDelete(
	projectId: ID!
	locationId: ID!
	strategyId: ID!
): String

locationSlotStrategyDelete arguments

Field nameValue typeRequiredDescription
projectId
ID
true
A globally-unique identifier.
locationId
ID
true
A globally-unique identifier.
strategyId
ID
true
A globally-unique identifier.
🔑

Minimal role required: ADMIN / APIADMIN