Intelligente Termine API-Referenz
Verwenden Sie die auf „Intelligente Termine“ festgelegte API, um nach relevanten Beratern zu suchen und um Besprechungen zu planen und zu verwalten. Die API basiert auf der Power Platform angepassten API.
Notiz
Alle Befehle in dieser API verwenden POST-Nachrichten.
Verfügbarkeit und Zeitplanungsbefehle
| Befehl | Beschreibung des Dataflows |
|---|---|
| GetSchedulingProperties | Ruft alle Informationen zu Besprechungstypen aus der Dataverse-Umgebung ab. |
| GetAvailableMeetingTimeSlots | Holt die verfügbaren Zuteilungen von Zeitfenstern des jeweiligen Beraters auf der Grundlage des angeforderten Ortes, des Themas, der Fertigkeiten und des Datumsbereichs. |
| CreateMeeting | Ermöglicht die Planung eines Meetings mit den angeforderten Beraterressourcen. |
| GetMeeting | Ruft eine geplante Besprechung für einen Kontakt ab. |
| CancelMeeting | Sagt eine bestehende Besprechung ab. |
GetSchedulingProperties
Breschreibung: Ruft alle Informationen zu Besprechungstypen aus der Dataverse-Umgebung ab.
Plugin-Name: GetSchedulingPropertiesPlugin.cs
HTTP-Anfrage: POST {{url}}/api/data/v9.0/msfsi_GetSchedulingProperties
Anfrage-Eingabeparameter (im Textkörper): Leer
Antwort Ausgabeparameter:
| Parametername | Beschreibung des Dataflows | Typ | Anmerkungen |
|---|---|---|---|
| Standorte | Ein Array von Standortobjekten. Dies sind Standorte, die sich in den MeetingType-Objekten befinden. | Array von Objekten | Standortobjekte werden gefüllt, wenn die Besprechungen nur vor Ort stattfinden. |
| Themen | Ein Array von Themenobjekten. Dies sind Themen, die sich in den MeetingType-Objekten befinden. | Array von Objekten | |
| Besprechungstypen | Ein MeetingTypes-Array | Array von Objekten | |
| Standortsobjekt | |||
| Id | Die Id des Stadtorts (OrganizationalUnit-Entität). | Zeichenfolge | |
| Name des Dataflows | Der Name des Standorts (Filial-Entität). | Zeichenfolge | |
| Address1 | Die erste Zeile in der Adresse des Standorts (Filial-Entität). | Zeichenfolge | |
| Address2 | Die zweite Zeile in der Adresse des Standorts (Filial-Entität). | Zeichenfolge | |
| Stadt | Die Stadt des Standorts (Filial-Entität). | Zeichenfolge | |
| StateOrProvince | Das Bundesland/den Kanton des Standorts (Filial-Entität). | Zeichenfolge | |
| Land / Region | Das Land des Standorts (Filial-Entität). | Zeichenfolge | |
| PostalCode | Die Postleitzahl des Standorts (Filial-Entität). | Zeichenfolge | |
| Telefon | Die Telefonnummer des Standorts (Filial-Entität). | Zeichenfolge | |
| Thema-Objekt | |||
| Id | Die Id des Themas. | Zeichenfolge | |
| Name des Dataflows | Der Name des Themas. | Zeichenfolge | |
| Beschreibung des Dataflows | Eine Beschreibung des Themas. | Zeichenfolge | |
| MeetingType-Object | |||
| Id | Die Id des MeetingType-Elements. | Zeichenfolge | |
| Name des Dataflows | Der Namen des MeetingType-Elements. | Zeichenfolge | |
| Beschreibung des Dataflows | Eine Beschreibung des MeetingType-Elements. | Zeichenfolge | |
| Dauer | Die Dauer der Besprechung wie vom MeetingType beschrieben. | Int | |
| Anmerkungen | Die Notizen, denen die Besprechungsteilnehmer folgen sollen. | Zeichenfolge | |
| Themen | Ein Array von Ids für die Themen, die mit diesem MeetingType verbunden sind. | Zeichenfolge[] | Eine vollständige und detaillierte Liste ist im Topics-Array verfügbar. |
| Standorte | Ein Array von Ids für die Standorte, die mit diesem MeetingType verbunden sind. | Zeichenfolge[] | Standortobjekte werden gefüllt, wenn die Besprechungen nur vor Ort stattfinden. Eine vollständige detaillierte Liste finden Sie im Locations-Array. |
| Kanal | Der für diesen MeetingType festgelegte Kanal. | Optionssatz |
Jeder Optionssatz wird durch ein Objekt dargestellt, das den Wert und das Etikett enthält. |
| DefaultMethod | Die Standardmethode, die für dieses MeetingType-Element festgelegt ist. | Optionssatz |
Jeder Optionssatz wird durch ein Objekt dargestellt, das den Wert und das Etikett enthält. |
Notiz
Nicht alle Parameter werden zurückgegeben:
Besprechungen, die nur vor Ort stattfinden und keine Verzweigungen haben, werden nicht angezeigt.
Besprechungen ohne Pflichtfelder werden nicht angezeigt.
Entitäten in einem inaktiven Zustand werden nicht angezeigt.
Die folgenden Parameter geben möglicherweise keine Werte zurück:
Die Parameter Channel und DefaultMethod werden nicht zurückgegeben, wenn sie null sind.
Wenn keine Standorte mit dem MeetingType verbunden sind, verfügt er nicht über das Locations-Array. Dies ist nur möglich, wenn der Kanal einen anderen Wert als On-Location hat.
Der Topics-Parameter wird möglicherweise nicht angezeigt, wenn keine Themen mit dem MeetingType-Element verbunden sind (über die Connection-Entität).
Die Parameter „ID“, „Name“, „Beschreibung“ und „Dauer“ sind immer Teil jedes Elements in der Antwort.
Thema und Location sind Arrays, die Entitäten enthalten. Id ist der einzige obligatorische Parameter für die Objekte Topic und Location.
Antwortbeispiel:
{
"@odata.context": "https://orgc7816042.crm.dynamics.com/api/data/v9.0/$metadata#Microsoft.Dynamics.CRM.msfsi_GetSchedulingPropertiesResponse",
"Locations": [
{
"@odata.type": "#Microsoft.Dynamics.CRM.expando",
"Id": "0781fd19-f1a8-ec11-983f-000d3a323337",
"Name": "Woodgrove Oklahoma City branch",
"Address1": "91011 East Blue Stone Drive",
"Address2": "91011 East Blue Stone Drive",
"City": "Oklahoma City",
"Country": "USA",
"PostalCode": "64555",
"Telephone": "+1(917)145-4533"
},
{
"@odata.type": "#Microsoft.Dynamics.CRM.expando",
"Id": "600ef125-f1a8-ec11-983f-000d3a323337",
"Name": "Woodgrove Savannah branch",
"Address1": "678 Van Hoose Drive",
"Address2": "678 Van Hoose Drive",
"City": "Savannah",
"Country": "USA",
"PostalCode": "48645",
"Telephone": "+1(403)123-4567"
}
],
"Topics": [
{
"@odata.type": "#Microsoft.Dynamics.CRM.expando",
"Id": "5a007aa3-809f-ec11-b400-0022480b8113",
"Name": "Everyday banking",
"Description": "Account opening, credit cards, financial health check ups and general assistance subjects"
},
{
"@odata.type": "#Microsoft.Dynamics.CRM.expando",
"Id": "eb4e85b5-819f-ec11-b400-0022480b8113",
"Name": "Loans",
"Description": "Mortgage, Loan consults, follow up and contracting meetings"
}
],
"MeetingTypes": [
{
"@odata.type": "#Microsoft.Dynamics.CRM.expando",
"Id": "5ce28b83-899f-ec11-b400-0022480b8113",
"Name": "Apply for credit card",
"Description": "Submitting an application for a credit card program",
"Duration": 30,
"Topics@odata.type": "#Collection(String)",
"Topics": [
"5a007aa3-809f-ec11-b400-0022480b8113"
],
"Locations@odata.type": "#Collection(String)",
"Locations": [
"0781fd19-f1a8-ec11-983f-000d3a323337",
"600ef125-f1a8-ec11-983f-000d3a323337"
],
"Channel": {
"@odata.type": "#Microsoft.Dynamics.CRM.expando",
"Value": 104800002,
"Label": "Online or on location"
},
"DefaultMethod": {
"@odata.type": "#Microsoft.Dynamics.CRM.expando",
"Value": 104800000,
"Label": "Online"
}
},
{
"@odata.type": "#Microsoft.Dynamics.CRM.expando",
"Id": "1167906a-8d9f-ec11-b400-0022480b8113",
"Name": "Mortgage Application phase 1",
"Description": "Onboarding meeting to submit a loan application for a specific property",
"Duration": 30,
"Topics@odata.type": "#Collection(String)",
"Topics": [
"eb4e85b5-819f-ec11-b400-0022480b8113"
],
"Locations@odata.type": "#Collection(String)",
"Channel": {
"@odata.type": "#Microsoft.Dynamics.CRM.expando",
"Value": 104800002,
"Label": "Online only"
},
"DefaultMethod": {
"@odata.type": "#Microsoft.Dynamics.CRM.expando",
"Value": 104800000,
"Label": "Online"
}
}
]
}
GetAvailableMeetingTimeSlots
Beschreibung: Holt die verfügbaren Zuteilungen von Zeitfenstern des entsprechenden Beraters auf der Grundlage des angeforderten Ortes, des Themas, der Fertigkeiten und des Datumsbereichs.
Plugin-Name: GetTimeSlotsPlugin.cs
HTTP-Anforderung: POST {{url}}/api/data/v9.0/msfsi_GetAvailableMeetingTimeSlots
Anfrage-Eingabeparameter (im Textkörper):
| Parametername | Beschreibung des Dataflows | Typ | Erforderlich | Anmerkungen |
|---|---|---|---|---|
| MeetingType | Die Id des MeetingType-Elements, nach dem der Benutzer suchen möchte. | Zeichenfolge (msfsi_meetingtype Id) | Ja | Der Wert dieses Parameters; muss ein gültiger GUID-Wert sein. |
| StartDateTime | Das Startdatum und die Startzeit für die Suche nach Verfügbarkeit. | DateTime | Ja | Die angegebene Zeit muss in UTC sein. |
| EndDateTime | Das Enddatum und die Endzeit für die Suche nach Verfügbarkeit. | DateTime | Ja | Die angegebene Zeit muss in UTC sein. |
| RequestedMeetingLocation | Die Id des Standorts (OrganizationalUnit), nach dem der Benutzer suchen möchte. | Zeichenfolge (msdyn_organizationalunit Id) | Nein | Obligatorisch, wenn IsOnlineMeeting auf „Falsch“ gesetzt ist. Der Wert dieses Parameters; muss ein gültiger GUID-Wert sein. |
| IsOnlineMeeting | Zeigt an, ob es sich bei dem Termin um ein Online-Meeting handelt oder nicht. | Boolesch | Ja | |
| SkillFilter | Eine Zeichenfolge mit allen Ids für Qualifikationen, die bei der Suche nach einer Verfügbarkeitsanforderung enthalten sein sollen | Zeichenfolge[] (Merkmal-IDs) | Nein | Das Hinzufügen von Filtern, die bereits als Standard für die Ressourcengruppenvorlage festgelegt sind, führt zu einem Fehler. Der Wert dieses Parameters; muss ein gültiger GUID-Wert sein. |
| Seitenwechsel | Die Paging-Zeichenfolge. Wenn keine angegeben ist, wird die erste Seite geholt, andernfalls wird die entsprechende Seite zurückgegeben. | Zeichenfolge | Nein |
Beispiel für eine Anfrage:
{
"MeetingType": "5ce28b83-899f-ec11-b400-0022480b8113",
"StartDateTime": "2022-08-21T11:00:00+03:00",
"EndDateTime": "2022-08-23T12:00:00+03:00",
"IsOnlineMeeting": false,
"RequestedMeetingLocation": "cfc7f51f-f1a8-ec11-983f-000d3a323337",
"SkillFilter": [
"2953c0d2-d2d9-ec11-a7b6-000d3a3089fb"
],
"Paging": ""
}
Antwort Ausgabeparameter:
| Parametername | Beschreibung des Dataflows | Typ | Anmerkungen |
|---|---|---|---|
| Zeitslot | Ein Array von Timeslots-Objekten, die die verfügbaren Zeitfenster darstellen, die für die angeforderten Berater, den Besprechungstyp und den Ort zurückgegeben wurden. | Array der Timeslots-Objekte | |
| Nächstes Paging | Der Paging-Zeichenfolge wird für die Paginierung verwendet. Wenn keine Ergebnisse verfügbar sind, ist dieser Wert Null. | Zeichenfolge | Weitere Informationen finden Sie in der URS-Dokumentation. |
| Objekt Timeslots | |||
| StartTime | Das in der Suchanfrage angegebene Startdatum und die Startzeit. | DateTime | Die Uhrzeit wird in UTC zurückgegeben. |
| EndTime | Das in der Suchanfrage angegebene Enddatum und die Endzeit. | DateTime | Die Uhrzeit wird in UTC zurückgegeben. |
| Berater | Eine Liste der Objekte, die die Berater darstellen. Jedes Objekt enthält eine ID und einen Beraternamen. | Array von Objekten | Diese Ids werden beim Erstellen des Meetings mit CreateMeeting und beim Abrufen der Ressourceninformationen für die Anzeige verwendet. Für jede Zuteilung von Zeitfenstern wird nur ein Satz von Beratern zurückgegeben. Wenn die Anforderung für eine Besprechungsart darin besteht, dass nur ein Berater an der Besprechung teilnimmt, enthält jedes Zeitfenster nur einen Wert. Wenn mehr als ein Berater zur Verfügung steht, priorisiert die Planungsmaschine die Berater auf der Grundlage von Kontext und Kapazität. |
Antwortbeispiel: Einige der zurückgegebenen Zeitfenster wurden aus Platzgründen entfernt.
Notiz
NextPaging wird hinzugefügt, wenn mehr als 20 Zeitschlitze zurückgegeben werden.
{
"@odata.context": "https://demoenvironment.crm.dynamics.com/api/data/v9.0/$metadata#Microsoft.Dynamics.CRM.msfsi_GetAvailableMeetingTimeSlotsResponse",
"NextPaging": "{\"nte\":\"1\",\"nti\":\"2022-08-21T17:30:00.0000000Z\",\"res\":{\"nfr\":20,\"nft\":20,\"rbd\":{\"2022-08-21T08:00:00.0000000Z\":{\"cpl\":1,\"nfr\":1,\"nft\":1,\"tic\":null,\"tid\":null},\"2022-08-21T08:30:00.0000000Z\":{\"cpl\":1,\"nfr\":1,\"nft\":1,\"tic\":null,\"tid\":null},\"2022-08-21T09:00:00.0000000Z\":{\"cpl\":1,\"nfr\":1,\"nft\":1,\"tic\":null,\"tid\":null},\"2022-08-21T09:30:00.0000000Z\":{\"cpl\":1,\"nfr\":1,\"nft\":1,\"tic\":null,\"tid\":null},\"2022-08-21T10:00:00.0000000Z\":{\"cpl\":1,\"nfr\":1,\"nft\":1,\"tic\":null,\"tid\":null},\"2022-08-21T10:30:00.0000000Z\":{\"cpl\":1,\"nfr\":1,\"nft\":1,\"tic\":null,\"tid\":null},\"2022-08-21T11:00:00.0000000Z\":{\"cpl\":1,\"nfr\":1,\"nft\":1,\"tic\":null,\"tid\":null},\"2022-08-21T11:30:00.0000000Z\":{\"cpl\":1,\"nfr\":1,\"nft\":1,\"tic\":null,\"tid\":null},\"2022-08-21T12:00:00.0000000Z\":{\"cpl\":1,\"nfr\":1,\"nft\":1,\"tic\":null,\"tid\":null},\"2022-08-21T12:30:00.0000000Z\":{\"cpl\":1,\"nfr\":1,\"nft\":1,\"tic\":null,\"tid\":null},\"2022-08-21T13:00:00.0000000Z\":{\"cpl\":1,\"nfr\":1,\"nft\":1,\"tic\":null,\"tid\":null},\"2022-08-21T13:30:00.0000000Z\":{\"cpl\":1,\"nfr\":1,\"nft\":1,\"tic\":null,\"tid\":null},\"2022-08-21T14:00:00.0000000Z\":{\"cpl\":1,\"nfr\":1,\"nft\":1,\"tic\":null,\"tid\":null},\"2022-08-21T14:30:00.0000000Z\":{\"cpl\":1,\"nfr\":1,\"nft\":1,\"tic\":null,\"tid\":null},\"2022-08-21T15:00:00.0000000Z\":{\"cpl\":1,\"nfr\":1,\"nft\":1,\"tic\":null,\"tid\":null},\"2022-08-21T15:30:00.0000000Z\":{\"cpl\":1,\"nfr\":1,\"nft\":1,\"tic\":null,\"tid\":null},\"2022-08-21T16:00:00.0000000Z\":{\"cpl\":1,\"nfr\":1,\"nft\":1,\"tic\":null,\"tid\":null},\"2022-08-21T16:30:00.0000000Z\":{\"cpl\":1,\"nfr\":1,\"nft\":1,\"tic\":null,\"tid\":null},\"2022-08-21T17:00:00.0000000Z\":{\"cpl\":1,\"nfr\":1,\"nft\":1,\"tic\":null,\"tid\":null},\"2022-08-21T17:30:00.0000000Z\":{\"cpl\":1,\"nfr\":1,\"nft\":1,\"tic\":null,\"tid\":null}}}}",
"Timeslots": [
{
"@odata.type": "#Microsoft.Dynamics.CRM.expando",
"StartTime": "2022-08-21T08:15:00Z",
"EndTime": "2022-08-21T08:45:00Z",
"Advisors@odata.type": "#Collection(Microsoft.Dynamics.CRM.crmbaseentity)",
"Advisors": [
{
"@odata.type": "#Microsoft.Dynamics.CRM.expando",
"Id": "876b4623-5d08-ed11-82e4-000d3a364a5d",
"Name": "Temp Admin"
}
]
},
{
"@odata.type": "#Microsoft.Dynamics.CRM.expando",
"StartTime": "2022-08-21T08:45:00Z",
"EndTime": "2022-08-21T09:15:00Z",
"Advisors@odata.type": "#Collection(Microsoft.Dynamics.CRM.crmbaseentity)",
"Advisors": [
{
"@odata.type": "#Microsoft.Dynamics.CRM.expando",
"Id": "876b4623-5d08-ed11-82e4-000d3a364a5d",
"Name": "Temp Admin"
}
]
}
]
}
CreateMeeting
Beschreibung: Ermöglicht die Planung eines Meetings mit den angeforderten Beraterressourcen.
Plugin-Name: CreateMeetingPlugin.cs
HTTP-Anforderung: POST {{url}}/api/data/v9.0/msfsi_CreateMeeting
Anfrage-Eingabeparameter (im Textkörper):
| Parametername | Beschreibung des Dataflows | Typ | Erforderlich | Anmerkungen |
|---|---|---|---|---|
| MeetingType | Die ID des ausgewählten MeetingType-Elements. | Zeichenfolge (msfsi_meetingtype) | Ja | Der Wert dieses Parameters; muss ein gültiger GUID-Wert sein. |
| StartDateTime | Das Startdatum und die Startzeit für die Besprechung. | DateTime | Ja | Vorbereitungs- und Zusammenfassungstermine werden dem Kalender des Beraters auf der Grundlage des Besprechungstyps und der Einrichtung des Administrators hinzugefügt. |
| Kontakt | Die Kontakt-ID, die den Kunden darstellt, der an der Besprechung teilnimmt. | Zeichenfolge (Vertrags-ID) | Ja | Der Wert dieses Parameters; muss ein gültiger GUID-Wert sein. |
| IsOnlineMeeting | Zeigt an, ob es sich bei dem Termin um ein Online-Meeting handelt oder nicht. | Boolesch | Ja | Wenn dieser Wert Falsch ist, müssen Sie stattdessen einen Besprechungsort angeben. |
| RequestedMeetingLocation | Die ID des Standorts (OrganizationalUnit), an dem die Besprechung stattfinden soll. | Zeichenfolge (OrganizationalUnit(OU) Id) | Nein | Im Falle eines Online-Meetings ist dieses Feld nicht erforderlich. Im Falle einer Implementierung eines Online-Meetings, bei dem die Online-Berater einer bestimmten OrganizationalUnit (OU) angehören, ist eine spezielle OU-Referenz erforderlich. |
| RequestedAdvisors | Ein Array der erforderlichen Berater-IDs (IDs buchbarer Ressourcen). Diese Ids werden dem Array Advisors entnommen, die in der GetAvailableMeetingTimeSlots-Antwort bereitgestellt wird. | EntityCollection ((Ressourcen) | Ja | Damit die Buchung erfolgreich ist, müssen die Ressourcen mit Systembenutzern verknüpft sein. Diese Benutzer erscheinen im Feld Erforderlich des Termins. Zeichenfolgen innerhalb des Arrays müssen gültige GUIDs sein. |
| CustomerAdditionalNotes | Notizen, die die Kunden über das bevorstehende Treffen mitteilen möchten. | Zeichenfolge | Nein | Dieser Parameter erscheint in der Kundenkommunikation und in der Terminbeschreibung in der CRM-Anwendung. |
Beispiel für eine Anfrage:
{
"MeetingType": "aaafeaad-8c9f-ec11-b400-0022480b8113",
"StartDateTime": "2022-8-17T12:30:00",
"Contact": "8788facf-828e-4333-8405-b825b0f29ea0",
"IsOnlineMeeting": false,
"RequestedMeetingLocation": "8bcdf8e8-eda8-ec11-983f-000d3a323337",
"RequestedAdvisors": ["8240fdbc-e20d-ed11-82e5-000d3a593e34"],
"CustomerAdditionalNotes": "Some test notes"
}
Antwort Ausgabeparameter:
| Parametername | Beschreibung des Dataflows | Typ | Anmerkungen |
|---|---|---|---|
| Id | Eine ID, die die geplante Besprechung darstellt. | Zeichenfolge | Repräsentiert eine GUID |
| StartTime | Das Startdatum und die Startzeit der Besprechung. | DateTime | Die Uhrzeit wird in UTC bereitgestellt. |
| EndTime | Das Enddatum und die Startzeit der Besprechung. | DateTime | Die Uhrzeit wird in UTC bereitgestellt. |
| Dauer | Die Dauer der geplanten Besprechung in Minuten. | Int | |
| IsOnline | Zeigt an, ob es sich bei dem Termin um ein Online-Meeting handelt oder nicht. | Boolesch | |
| CustomerAdditionalNotes | Notizen, die die Kunden über die geplanten Besprechung mitteilen möchten. | Zeichenfolge | |
| MeetingJoinUrl | Link zur Teilnahme an der geplanten Besprechung. | Zeichenfolge | |
| Bundesstaat | Der aktuelle Status der geplanten Besprechung. | Optionssatz (obect) |
Jeder Optionssatz wird durch ein Objekt dargestellt, das den Wert und das Etikett enthält. |
| Ort | Ein Objekt des Besprechungsortes für einen Vor-Ort-Termin. | Objekt | Dieser Parameter ist nur für Besprechungen vor Ort nicht leer. |
| Berater | Eine Liste von Objekten, die die Berater in der angesetzten Besprechung darstellen. | Array von Objekten | |
| MeetingType | Ein Objekt, das das MeetingType-Element darstellt. | Objekt | |
| Location-Objekt | |||
| Id | Die Id des Stadtorts (OrganizationalUnit-Entität). | Zeichenfolge | Repräsentiert eine GUID |
| Name des Dataflows | Der Name des Standorts (Filial-Entität). | Zeichenfolge | |
| Address1 | Die erste Zeile in der Adresse des Standorts (Filial-Entität). | Zeichenfolge | |
| Address2 | Die erste Zeile in der Adresse des Standorts (Filial-Entität). | Zeichenfolge | |
| Stadt | Die Stadt des Standorts (Filial-Entität). | Zeichenfolge | |
| StateOrProvince | Das Bundesland/den Kanton des Standorts (Filial-Entität). | Zeichenfolge | |
| Land / Region | Das Land des Standorts (Filial-Entität). | Zeichenfolge | |
| PostalCode | Die Postleitzahl des Standorts (Filial-Entität). | Zeichenfolge | |
| Telefon | Die Telefonnummer des Standorts (Filial-Entität). | Zeichenfolge | |
| Advisor-Objekt | |||
| Id | Die Id des Beraters (Entität der buchbaren Ressource). | Zeichenfolge | Repräsentiert eine GUID |
| Name des Dataflows | Der Name des Advisors. | Zeichenfolge | |
| MeetingType-Objekt | |||
| Id | Die Id des MeetingType-Elements. | Zeichenfolge | |
| Name des Dataflows | Der Namen des MeetingType-Elements. | Zeichenfolge | |
| Anmerkungen | Die Notizen, denen die Besprechungsteilnehmer folgen sollen. | Zeichenfolge | |
| Beschreibung des Dataflows | Die Beschreibung des MeetingType-Elements. | Zeichenfolge |
Antwort Beispiel:
{
"@odata.context": "https://aa-isdaily.crm.dynamics.com/api/data/v9.0/$metadata#expando/$entity",
"@odata.type": "#Microsoft.Dynamics.CRM.expando",
"Id": "4d6d4b05-4e0f-ed11-82e5-00224822509a",
"StartTime": "2022-08-17T12:30:00Z",
"EndTime": "2022-08-17T13:15:00Z",
"Duration": 45,
"IsOnline": false,
"CustomerAdditionalNotes": "Some test notes",
"State": {
"@odata.type": "#Microsoft.Dynamics.CRM.expando",
"Value": 3,
"Label": "Scheduled"
},
"Location": {
"@odata.type": "#Microsoft.Dynamics.CRM.expando",
"Id": "8bcdf8e8-eda8-ec11-983f-000d3a323337",
"Name": "Woodgrove Anchorage branch",
"Address1": "123 Eastview Lane",
"City": "Anchorage"
},
"Advisors@odata.type": "#Collection(Microsoft.Dynamics.CRM.crmbaseentity)",
"Advisors": [
{
"@odata.type": "#Microsoft.Dynamics.CRM.expando",
"Id": "f35a29b9-02b1-ec11-9840-000d3a9937ed",
"Name": "IS admin"
}
],
"MeetingType": {
"@odata.type": "#Microsoft.Dynamics.CRM.expando",
"Id": "aaafeaad-8c9f-ec11-b400-0022480b8113",
"Name": "Setting Investment goals",
"Notes": "If this is your first planning meeting, please bring:\n1. 401(k) and other investment plan statements\n2. Mortgage and other debt statements\n3. Pay stubs for you and/or your spouse\n4. Your most recent tax return\n5. Your monthly budget of income and expenses",
"Description": "Creating wealth management goals"
}
}
GetMeeting
Beschreibung: Ruft eine geplante Besprechung für einen Kontakt ab.
Plugin-Name: GetMeetingPlugin.cs
HTTP-Anforderung: POST {{url}}/api/data/v9.0/msfsi_GetMeeting
Anfrage-Eingabeparameter (im Textkörper):
| Parametername | Beschreibung des Dataflows | Typ | Erforderlich | Anmerkungen |
|---|---|---|---|---|
| Besprechung | Die Id der Besprechung. | Zeichenfolge | Ja | Die Besprechungs-ID wird aus der CreateMeeting-Antwort entnommen. Der Wert dieses Parameters; muss ein gültiger GUID-Wert sein. |
| Kontakt | Die ID des Kunden, für den das Treffen geplant ist. | Zeichenfolge | Ja | Der Wert dieses Parameters; muss ein gültiger GUID-Wert sein. |
Beispiel für eine Anfrage:
{
"Meeting": "4d6d4b05-4e0f-ed11-82e5-00224822509a",
"Contact": "8788facf-828e-4333-8405-b825b0f29ea0"
}
Antwort Ausgabeparameter:
| Parametername | Beschreibung des Dataflows | Typ | Anmerkungen |
|---|---|---|---|
| Id | Eine ID, die die geplante Besprechung darstellt. | Zeichenfolge | Repräsentiert eine GUID |
| StartTime | Das Startdatum und die Startzeit der Besprechung. | DateTime | Die Uhrzeit wird in UTC bereitgestellt. |
| EndTime | Das Enddatum und die Startzeit der Besprechung. | DateTime | Die Uhrzeit wird in UTC bereitgestellt. |
| Dauer | Die Dauer der geplanten Besprechung in Minuten. | Int | |
| IsOnline | Zeigt an, ob es sich bei dem Termin um ein Online-Meeting handelt oder nicht. | Boolesch | |
| CustomerAdditionalNotes | Notizen, die die Kunden über die geplanten Besprechung mitteilen möchten. | Zeichenfolge | |
| MeetingJoinUrl | Link zur Teilnahme an der geplanten Besprechung. | Zeichenfolge | |
| Bundesstaat | Der aktuelle Status der geplanten Besprechung. | Optionssatz (obect) |
Jeder Optionssatz wird durch ein Objekt dargestellt, das den Wert und das Etikett enthält. |
| Ort | Ein Objekt des Besprechungsortes für einen Vor-Ort-Termin. | Objekt | Dieser Parameter ist nur für Besprechungen vor Ort nicht leer. |
| Berater | Eine Liste von Objekten, die die Berater in der angesetzten Besprechung darstellen. | Array von Objekten | |
| MeetingType | Ein Objekt, das das MeetingType-Element darstellt. | Objekt | |
| Location-Objekt | |||
| Id | Die Id des Stadtorts (OrganizationalUnit-Entität). | Zeichenfolge | Repräsentiert eine GUID |
| Name des Dataflows | Der Name des Standorts (Filial-Entität). | Zeichenfolge | |
| Address1 | Die erste Zeile in der Adresse des Standorts (Filial-Entität). | Zeichenfolge | |
| Address2 | Die erste Zeile in der Adresse des Standorts (Filial-Entität). | Zeichenfolge | |
| Stadt | Die Stadt des Standorts (Filial-Entität). | Zeichenfolge | |
| StateOrProvince | Das Bundesland/den Kanton des Standorts (Filial-Entität). | Zeichenfolge | |
| Land / Region | Das Land des Standorts (Filial-Entität). | Zeichenfolge | |
| PostalCode | Die Postleitzahl des Standorts (Filial-Entität). | Zeichenfolge | |
| Telefon | Die Telefonnummer des Standorts (Filial-Entität). | Zeichenfolge | |
| Advisor-Objekt | |||
| Id | Die Id des Beraters (Entität der buchbaren Ressource). | Zeichenfolge | Repräsentiert eine GUID |
| Name des Dataflows | Der Name des Advisors. | Zeichenfolge | |
| MeetingType-Objekt | |||
| Id | Die Id des MeetingType-Elements. | Zeichenfolge | |
| Name des Dataflows | Der Namen des MeetingType-Elements. | Zeichenfolge | |
| Anmerkungen | Die Notizen, denen die Besprechungsteilnehmer folgen sollen. | Zeichenfolge | |
| Beschreibung des Dataflows | Die Beschreibung des MeetingType-Elements. | Zeichenfolge |
Antwort Beispiel:
{
"@odata.context": "https://aa-isdaily.crm.dynamics.com/api/data/v9.0/$metadata#expando/$entity",
"@odata.type": "#Microsoft.Dynamics.CRM.expando",
"Id": "4d6d4b05-4e0f-ed11-82e5-00224822509a",
"StartTime": "2022-08-17T12:30:00Z",
"EndTime": "2022-08-17T13:15:00Z",
"Duration": 45,
"IsOnline": false,
"CustomerAdditionalNotes": "Some test notes",
"State": {
"@odata.type": "#Microsoft.Dynamics.CRM.expando",
"Value": 3,
"Label": "Scheduled"
},
"Location": {
"@odata.type": "#Microsoft.Dynamics.CRM.expando",
"Id": "8bcdf8e8-eda8-ec11-983f-000d3a323337",
"Name": "Woodgrove Anchorage branch",
"Address1": "123 Eastview Lane",
"City": "Anchorage"
},
"Advisors@odata.type": "#Collection(Microsoft.Dynamics.CRM.crmbaseentity)",
"Advisors": [
{
"@odata.type": "#Microsoft.Dynamics.CRM.expando",
"Id": "f35a29b9-02b1-ec11-9840-000d3a9937ed",
"Name": "IS admin"
}
],
"MeetingType": {
"@odata.type": "#Microsoft.Dynamics.CRM.expando",
"Id": "aaafeaad-8c9f-ec11-b400-0022480b8113",
"Name": "Setting Investment goals",
"Notes": "If this is your first planning meeting, please bring:\n1. 401(k) and other investment plan statements\n2. Mortgage and other debt statements\n3. Pay stubs for you and/or your spouse\n4. Your most recent tax return\n5. Your monthly budget of income and expenses",
"Description": "Creating wealth management goals"
}
}
CancelMeeting
Beschreibung: Storniert eine bestehende Besprechung.
Name des Plugins: CancelMeetingPlugin.cs
HTTP-Anforderung: POST {{url}}/api/data/v9.0/msfsi_CancelMeeting
Anfrage-Eingabeparameter (im Textkörper):
| Parametername | Beschreibung des Dataflows | Typ | Erforderlich | Anmerkungen |
|---|---|---|---|---|
| Besprechung | Die ID der Besprechung, die abgesagt werden soll. | Zeichenfolge (appointment Id) | Ja | Die Meeting-ID wird aus der Abfrage der bestehenden Termine für den Kunden übernommen. Nur zukünftige, aktive Termine können abgesagt werden. Vorbereitungs- und Zusammenfassungstermine, die mit Kundenterminen verknüpft sind, werden ebenfalls abgesagt. Der Wert dieses Parameters; muss ein gültiger GUID-Wert sein. |
| Kontakt | Die ID des Kunden, für den das Treffen geplant ist. | Zeichenfolge (Vertrags-ID) | Ja | Der Wert dieses Parameters; muss ein gültiger GUID-Wert sein. |
Beispiel für eine Anfrage:
{
"Meeting": "5d98de42-8c9f-ec11-b400-0022480b81c4",
"Contact": "ce43d612-4d9d-ec11-b400-0022480b8d8e"
"Appointment": {
"activityid": "5d98de42-8c9f-ec11-b400-0022480b81c4"
},
"Contact": {
"contactid": "ce43d612-4d9d-ec11-b400-0022480b8d8e"
}
}
Antwort Ausgabeparameter:
| Parametername | Beschreibung des Dataflows | Typ | Anmerkungen |
|---|---|---|---|
| IsAppointmentCancelled | Zeigt an, ob der Termin abgesagt wurde oder nicht. | Boolesch | Nur zukünftige, aktive Termine können abgesagt werden. |
Antwort Beispiel:
{
"@odata.context": "https://#####.crm.dynamics.com/api/data/v9.0/$metadata#Microsoft.Dynamics.CRM.msfsi_CancelMeetingResponse",
"IsMeetingCancelled": true
}
Befehle zum Abrufen von Daten
Die für Intelligente Termine bereitgestellten APIs und Apps sollten Ihnen ausreichende Informationen liefern. OData-Abrufbefehle können verwendet werden, um Informationen zu den zugrunde liegenden Entitäten abzurufen, die für die APIs verwendet werden. Das Abrufen von Entitätsdaten erfolgt mithilfe von standardmäßigen FetchXML-Abfragen über Dataverse.
Erfahren Sie mehr darüber: Benutzen Sie FetchXML, um eine Abfrage zu erstellen.
Im Folgenden finden Sie die empfohlene Liste der abzurufenden Entitäten:
MeetingTopics: Ruft eine Liste mit den verfügbaren Besprechungsthemen ab. Ein Thema ist die Entität, auf deren Grundlage Sie die Sitzungen in verschiedene Container gruppieren können. Dies ist ein optionaler Wert.
MeetingTypeTopic: Stellt eine Zuordnung dar, um die Verbindung zwischen Besprechungstypen und einem Thema zu identifizieren. Ein bestimmter Besprechungstyp kann unter mehreren Themen verfügbar gemacht werden. Wenn Besprechungsthemen verwendet werden, stellen Sie sicher, dass Sie die Besprechungen in die entsprechenden Themen-Container gruppieren.
MeetingTypes: Ruft die Liste der verfügbaren Besprechungstypen ab.
MeetingType: Ruft die Details eines bestimmten Besprechungstyps ab, wie z.B.:
Unterstützte Meeting-Methoden (online, persönlich oder beides)
Beschreibung der Besprechung
Liste der Zweigstellen, die dieses Meeting anbieten
Dauer des Meetings
Kundenanweisungen für das Meeting bei der Terminierung.
Zweigstellen: Ruft eine Liste der Zweigstellen ab, die von der Lösung Intelligente Termine unterstützt werden. Diese Liste muss mit dem Meeting-Typ abgeglichen werden, um sicherzustellen, dass nur die Zweigstellen, die den spezifischen Meeting-Service unterstützen, den Kunden zur Auswahl angeboten werden.
Zweigstelle: Ruft die Details einer bestimmten Zweigstelle ab, z.B. den Namen der Zweigstelle, den Zweigstelle-Code und die Adresse.
Termine: Ruft eine Liste von Terminen für den Kunden ab.
Bestellung: Ruft die Details eines bestimmten Termins anhand der Kontakt-ID ab. Die Details umfassen:
Terminstatus
Link zum Online-Meeting
Zusätzliche Kundennotizen zum Meeting hinzugefügt
Besprechungsort
Erforderliche Berater, die an der Besprechung teilnehmen
Beschreibung des Dataflows
BookableResources: Ruft eine Liste der verfügbaren Ressourcen und ihrer Details, wie Name und Titel, ab.