Options
All
  • Public
  • Public/Protected
  • All
Menu

Beschreibt ein Modell das eine neu angelegte Filiale repräsentiert. Erweitert IStoreModel.

Hierarchy

Index

Properties

Optional additionalRatings

additionalRatings: number

Die Anzahl zusätzlicher Bewertungen. Dies hat keine Auswirkung auf den Durchschnitt der tatsächlich abgegebenen Bewertungen. Es wird lediglich die angezeigte Gesamtzahl der Bewertungen mit diesem Wert addiert.

Die Angabe kann zum Beispiel hilfreich sein, wenn die Filiale von einem anderen Anbieter importiert wird und die Bewertungen nicht übernommen werden können.

authToken

authToken: string

Der Authentifizierungstoken, der zur API-Anmeldung verwendet wird.

Dieser Token wird nur beim Einrichten einer Filiale zurückgeliefert. Zu einem späteren Zeitpunkt kann dieser Token nicht mehr abgefragt werden. Wenn der Token verloren geht, ist kein Zugriff auf den Kalender mehr möglich.
Bei der Anmeldung über /session/login wird der SHA256-Hash dieses Tokens erwartet. Wurde bei der Initialisierung ein individueller Passwort-Hash angegeben, muss der aus dem Token generierte Hash den Passwort-Hash als Salt verwenden.

Optional autoExpandCustomer

autoExpandCustomer: boolean

Ist gesetzt, wenn die Kundendaten beim Bearbeiten eines Termins automatisch aufgeklappt werden sollen.

Standardwert: false

Optional backendTimeInterval

backendTimeInterval: number

Das Interval in Minuten, in denen eine Buchung in der Filiale möglich ist. Der Wert muss ein ganzzahliger Teiler von 60 sein (z.B. 1, 2, 3, 4, 5, 10, 15, 20, 30).

Standardwert: 15

Optional bookingRequiresLogin

bookingRequiresLogin: boolean

Ist gesetzt, wenn sich der Kunde für die Online-Terminbuchung anmelden muss.

Standardwert: false

Optional cancellationText

cancellationText: string

Die Stornierungsbedingungen der Filiale.

contact

Die Kontaktdaten der Filiale.

Optional customFields

Die Auflistung der Definitionen für zusätzliche Eingabefelder in der Buchungsmaske.

Optional customerStatisticsEnabled

customerStatisticsEnabled: boolean

Ist gesetzt, wenn die Filiale Kundenstatistiken nutzt.

Standardwert: false

Optional dateMetaOnCancel

dateMetaOnCancel: DateMetaInformationMode

Steuert ob und wie der Kunde bei Terminabsage einen Grund (Freitext) angeben muss.

Standardwert: off DateMetaInformationMode.Off

Optional dateMetaOnDelete

dateMetaOnDelete: DateMetaInformationMode

Steuert ob und wie beim Löschen des Termins der Terminstatus angeben werden muss.

Wird nicht für die Absage des Termins durch den Kunden verwendet, diese wird über dateMetaOnCancel gesteuert.

Standardwert: off DateMetaInformationMode.Off

Optional dateMetaOnUpdate

dateMetaOnUpdate: DateMetaInformationMode

Steuert ob und wie beim Bearbeiten eines Termins der Terminstatus angeben werden muss.

Standardwert: off DateMetaInformationMode.Off

Optional description

description: string

Die Beschreibung der Filiale.

Optional editorMode

editorMode: EditorMode

Steuert ob bei Änderungen an Terminen der bearbeitende Mitarbeiter angegeben werden kann/muss.

Standardwert: 0 EditorMode.Off

externalCreatedAt

externalCreatedAt: Date

Zeitstempel der externen Erstellung.

externalModifiedAt

externalModifiedAt: Date

Zeitstempel der letzten externen Änderung.

Optional frontendAllowAllEmployees

frontendAllowAllEmployees: boolean

Optional frontendAllowManyEmployees

frontendAllowManyEmployees: boolean

Optional frontendEmployeeSelection

frontendEmployeeSelection: FrontendBookingUserDisplayMode

Optional frontendLeadMinutes

frontendLeadMinutes: number

Die Vorlaufzeit für Onlinebuchungen in Minuten.

Standardwert: 0

Optional frontendNoPrices

frontendNoPrices: boolean

Ist gesetzt, wenn die in der Frontendbuchung keine Preise angezeigt werden sollen.

Standardwert: false

Optional frontendTimeInterval

frontendTimeInterval: number

Das Interval in Minuten, in denen eine Onlinebuchung möglich ist. Der Wert muss ein ganzzahliger Teiler von 60 sein (z.B. 1, 2, 3, 4, 5, 10, 15, 20, 30).

Standardwert: 15

Optional frontendWeeksAhead

frontendWeeksAhead: number

Die maximale Anzahl Wochen, in denen eine Onlinebuchung im Voraus getätigt werden kann.

Standardwert: 10

Optional integrationHash

integrationHash: string

INTERN: Optional. Der Password-Hash des Stores für die Anmeldung aus einem integrierten System heraus (z.B. Kasse).

Dieser interne Wert wird nicht zurückgegeben und kann nicht gesetzt werden.

Optional integrationId

integrationId: number

Die korrespondierende ID in einem integrierten System (z.B. Kasse).

Diese ID muss vom integrierten System gesetzt werden und dient innerhalb der Kalendersoftware nur als externe Referenz.

Optional integrationTenant

integrationTenant: string

INTERN: Die eindeutige Tenant-ID des Stores für die Einbindung in ein integriertes System (z.B. Kasse). Die Tenant-ID wird bei der Ersteinrichtung vom integrierten System gesetzt.

Dieser interne Wert wird nicht zurückgegeben und kann nicht gesetzt werden.

internalCreatedAt

internalCreatedAt: Date

Zeitstempel der internen Erstellung.

internalModifiedAt

internalModifiedAt: Date

Zeitstempel der letzten internen Änderung.

logoUrl

logoUrl: string

Die URL zum Logo der Filiale.

name

name: string

Der Name der Filiale.

Optional openOnHolidays

openOnHolidays: boolean

Ist gesetzt, wenn die Filiale auch an Feiertagen geöffnet hat.

Standardwert: false

Optional parentStoreId

parentStoreId: number

Die ID der übergeordneten Filiale wenn es sich um eine Kette handelt.

Optional partnerStoreId

partnerStoreId: number

Die ID der übergeordneten (OEM-) Partner-Filiale.

Optional public

public: boolean

Ist gesetzt, wenn für diese Filiale Termine online gebucht werden können.

Standardwert: false

Optional publicEmployees

publicEmployees: boolean

Ist gesetzt, wenn Mitarbeiter grundsätzlich in der Online-Buchungsmaske angezeigt werden. Die tatsächliche Anzeige kann für jeden Mitarbeiter separat gesteuert werden.

Standardwert: true

Optional requireCustomerEmail

requireCustomerEmail: boolean

Ist gesetzt, wenn die E-Mailadresse des Kunden ein Pflichtfeld ist.

Standardwert: false

Optional requireCustomerFirstName

requireCustomerFirstName: boolean

Ist gesetzt, wenn der Vorname des Kunden ein Pflichtfeld ist.

Standardwert: false

Optional requireCustomerLastName

requireCustomerLastName: boolean

Ist gesetzt, wenn der Nachname des Kunden ein Pflichtfeld ist.

Standardwert: false

Optional requireCustomerPhone

requireCustomerPhone: boolean

Ist gesetzt, wenn die Telefonnummer des Kunden ein Pflichtfeld ist.

Standardwert: false

Optional requireCustomerTitle

requireCustomerTitle: boolean

Ist gesetzt, wenn die Anrede des Kunden ein Pflichtfeld ist.

Standardwert: false

Optional resetHashCode

resetHashCode: string

INTERN: Optional. Der Initialschlüssel für die Einrichtung eines bestehenden Stores.

Dieser interne Wert wird nicht zurückgegeben und kann nicht gesetzt werden.

Optional resetHashPending

resetHashPending: boolean

INTERN: Optional. Ruft ab ob der hinterlegte Token widerrufen wurde. In diesem Fall muss die Einrichtung des Stores vor der nächsten Anmeldung erneut aufgerufen werden.

Dieser interne Wert wird nicht zurückgegeben und kann nicht gesetzt werden.
Ist dieser Wert gesetzt, werden Anmeldeversuche mit dem [HTTP Status Code 403}(../#allgemeine-response-status-codes) und dem Fehlercode CommonErrorCodes.TokenRevoked quittiert.

Optional resetHashTill

resetHashTill: Date

INTERN: Optional. Ruft ab wie lange der Initialschlüssel für die Einrichtung eines bestehenden Stores gültig ist.

Dieser interne Wert wird nicht zurückgegeben und kann nicht gesetzt werden.

Optional sendEmail

sendEmail: boolean

Ist gesetzt, wenn die Filiale E-Mails über eingehende Terminbuchungen erhalten will.

Standardwert: true

Optional showDescriptions

showDescriptions: boolean

Ist gesetzt, wenn die Beschreibungen der Dienstleistungskategorien in der Online-Buchungsmaske angezeigt werden sollen..

Standardwert: true

Optional showShortTag

showShortTag: boolean

Ist gesetzt, wenn im Kalender der Tag bzw. das Kürzel der Verknüpfung von Dienstleistung zu Mitarbeitergruppe statt dem Kurznamen angezeigt werden soll.

Standardwert: true

Optional smsChange

smsChange: boolean

Ist gesetzt, wenn SMS aufgrund von Terminänderungen verschickt werden.

Standardwert: false

Der tatsächliche SMS-Versand ist von der Zustimmung des jeweiligen Kunden abhängig.

Optional smsConfirm

smsConfirm: boolean

Ist gesetzt, wenn SMS zur Terminbestätigung verschickt werden.

Standardwert: false

Der tatsächliche SMS-Versand ist von der Zustimmung des jeweiligen Kunden abhängig.

Optional smsRemind

smsRemind: boolean

Ist gesetzt, wenn SMS-Erinnerungen 24 Stunden vor Termin verschickt werden.

Standardwert: false

Der tatsächliche SMS-Versand ist von der Zustimmung des jeweiligen Kunden abhängig.

storeId

storeId: number

Der ID der Filiale.

Optional storeRole

storeRole: StoreRole

Optional termsLink

termsLink: string

Der Link zu den AGB oder weiteren Bestimmungen der Filiale.

Generated using TypeDoc. API-Dokumentation v2.0.1816. Zur Startseite © Copyright 2023 TERMINGO GmbH. All rights reserved.