Delen via

API-verwijzing voor Intelligente afspraken

  • Artikel

Belangrijk

Met ingang van 22 mei 2024 zijn Intelligente afspraken verouderd en niet beschikbaar voor implementatie. Bestaande gebruikers kunnen de functie zoals gewoonlijk blijven gebruiken als ze deze al hebben geïmplementeerd en geconfigureerd.

Gebruik de API-reeks Intelligente afspraken om relevante adviseurs te zoeken en vergaderingen te plannen en te beheren. De API is gebaseerd op de Aangepaste API voor Power Platform.

Notitie

Alle opdrachten in deze API gebruiken POST-berichten.

Beschikbaarheids- en planningsopdrachten

Opdracht Omschrijving
GetSchedulingProperties Hiermee haalt u alle informatie op met betrekking tot soorten vergaderingen uit de Dataverse-omgeving.
GetAvailableMeetingTimeSlots Haalt de beschikbare tijdvakken van de relevante adviseur op op basis van de gevraagde locatie, het onderwerp, de vaardigheden en het datumbereik.
CreateMeeting Maakt het plannen van een vergadering met de gevraagde adviseursbronnen mogelijk.
GetMeeting Hiermee haalt u een geplande vergadering op voor een contactpersoon.
CancelMeeting Annuleert een bestaande vergadering.

GetSchedulingProperties

Beschrijving: Hiermee haalt u alle informatie op met betrekking tot soorten vergaderingen uit de Dataverse-omgeving.

Naam van invoegtoepassing: GetSchedulingPropertiesPlugin.cs

HTTP-aanvraag: POST {{url}}/api/data/v9.0/msfsi_GetSchedulingProperties

Invoerparameters opvragen (in hoofdtekst): Leeg

Uitvoerparameters voor respons:

Parameternaam Omschrijving Type Aantekeningen
Locaties Een matrix van locatie-objecten. Dit zijn locaties die zich in de MeetingType-objecten bevinden. Matrix van objecten Locatieobjecten worden gevuld wanneer de vergaderingen alleen op locatie plaatsvinden.
Onderwerpen Een matrix van onderwerp-objecten. Dit zijn onderwerpen die zich in de MeetingType-objecten bevinden. Matrix van objecten
Vergaderingtypen Een matrix van MeetingTypes Matrix van objecten
Locatieobject
ID De id van de locatie (OrganizationalUnit-entiteit). Tekenreeks
Naam De naam van de locatie (vestigingsentiteit). Tekenreeks
Address1 De eerste regel in het adres van de locatie (vestigingsentiteit). Tekenreeks
Address2 De tweede regel in het adres van de locatie (vestigingsentiteit). Tekenreeks
Plaats De stad van de locatie (vestigingsentiteit). Tekenreeks
Staat of provincie De provincie van de locatie (vestigingsentiteit). Tekenreeks
Land Het land van de locatie (vestigingsentiteit). Tekenreeks
PostalCode De postcode van de locatie (vestigingsentiteit). Tekenreeks
Telefoon Het telefoonnummer van de locatie (vestigingsentiteit). Tekenreeks
Onderwerpobject
ID De id van het onderwerp. Tekenreeks
Naam De naam van het onderwerp. Tekenreeks
Omschrijving Een beschrijving van het onderwerp. Tekenreeks
MeetingType-object
ID De id van het MeetingType. Tekenreeks
Naam De naam van het MeetingType. Tekenreeks
Omschrijving Een beschrijving van het MeetingType. Tekenreeks
Duur De duur van de vergadering die wordt beschreven door het MeetingType. Int
Aantekeningen De aantekeningen voor de deelnemer aan de vergadering om te volgen. Tekenreeks
Onderwerpen Een matrix van id's voor de onderwerpen die aan dit MeetingType zijn gekoppeld. Tekenreeks[] Een volledige gedetailleerde lijst is beschikbaar in de matrix Onderwerpen.
Locaties Een matrix van id's voor de locaties die aan dit MeetingType zijn gekoppeld. Tekenreeks[] Locatieobjecten worden gevuld wanneer de vergaderingen alleen op locatie plaatsvinden. Een volledige gedetailleerde lijst is te vinden in de matrix Locaties.
Kanaal Het kanaal dat is ingesteld voor dit MeetingType. Optieset
  • 104800000: alleen online
  • 104800001: online of op locatie
  • 104800002: alleen op locatie

Elke optieset wordt vertegenwoordigd door een object met de waarde en het label.
DefaultMethod De standaardmethode die is ingesteld voor dit MeetingType. Optieset
  • 104800000: online
  • 104800001: op locatie

Elke optieset wordt vertegenwoordigd door een object met de waarde en het label.

Notitie

Niet alle parameters worden geretourneerd:

  • Vergaderingen die alleen op locatie zijn en waarvoor geen vestigingen worden niet weergegeven.

  • Vergaderingen zonder verplichte velden worden niet weergegeven.

  • Entiteiten in een inactieve status worden niet weergegeven.

  • De volgende parameters retourneren mogelijk geen waarden:

  • De parameters Channel en DefaultMethod worden niet geretourneerd indien ze null zijn.

    • Als er geen locaties zijn verbonden aan het MeetingType, heeft dit niet de matrix Locaties. Dit kan alleen als het kanaal een andere waarde heeft dan Op locatie.

    • De parameter Onderwerpen wordt mogelijk niet weergegeven als er geen onderwerpen zijn verbonden aan het MeetingType (via de entiteit Verbinding).

    • De parameters Id, Naam, Beschrijving en Duur maken altijd deel uit van elk element in de respons.

    • Onderwerp en Locatie zijn matrices die entiteiten bevatten. Id is de enige verplichte parameter voor de objecten Onderwerp en Locatie.

Voorbeeldrespons:

{
    "@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

Beschrijving: Haalt de beschikbare tijdvakken van de relevante adviseur op op basis van de gevraagde locatie, het onderwerp, de vaardigheden en het datumbereik.

Naam van plug-in: GetTimeSlotsPlugin.cs

HTTP-verzoek: POST {{url}}/api/data/v9.0/msfsi_GetAvailableMeetingTimeSlots

Invoerparameters opvragen (in hoofdtekst):

Parameternaam Omschrijving Type Vereist Aantekeningen
MeetingType De id van het MeetingType waarin de gebruiker wil zoeken. Tekenreeks (msfsi_meetingtype Id) Ja De waarde van deze parameter moet een geldige GUID zijn.
StartDateTime De startdatum en -tijd om naar beschikbaarheid te zoeken. Datum en tijd Ja De opgegeven tijd moet in UTC zijn.
EndDateTime De einddatum en -tijd om naar beschikbaarheid te zoeken. Datum en tijd Ja De opgegeven tijd moet in UTC zijn.
RequestedMeetingLocation De id van de locatie (OrganizationalUnit) waarin de gebruiker wil zoeken. Tekenreeks (msdyn_organizationalunit Id) Nee Verplicht wanneer IsOnlineMeeting is ingesteld op onwaar.

De waarde van deze parameter moet een geldige GUID zijn.
IsOnlineMeeting Geeft aan of de afspraak een online vergadering is of niet. Booleaans Ja
SkillFilter Een tekenreeksmatrix met alle vaardigheid-id's die moeten worden opgenomen in de aanvraag voor het zoeken naar beschikbaarheid. Tekenreeks[] (kenmerk id's) Nee Het toevoegen van filters die al als standaard zijn ingesteld op de resourcegroepsjabloon resulteert in een fout.

De waarde van deze parameter moet een geldige GUID zijn.
Paginering De paginering-tekenreeks. Als er geen is opgegeven, wordt de eerste pagina opgehaald, anders wordt de bijbehorende pagina geretourneerd. Tekenreeks Nee

Voorbeeld aanvragen:

{
    "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": ""
}

Uitvoerparameters voor respons:

Parameternaam Omschrijving Type Aantekeningen
Tijdvakken Een matrix van Timeslots-objecten, die de beschikbare tijdvakken vertegenwoordigen die zijn geretourneerd voor de gevraagde adviseurs, het type vergadering en de locatie. Matrix van Timeslots-objecten
Volgende paginering De paginering-tekenreeks die wordt gebruikt voor paginering. Als er geen resultaten beschikbaar zijn, is deze waarde null. Tekenreeks Ga voor meer informatie naar de URS-documentatie
Tijdvakken-object
StartTime De startdatum en -tijd gespecificeerd in de zoekopdracht. Datum en tijd De tijd wordt teruggegeven in UTC.
EndTime De einddatum en -tijd gespecificeerd in de zoekopdracht. Datum en tijd De tijd wordt teruggegeven in UTC.
Adviseurs Een lijst met objecten die de adviseurs vertegenwoordigen. Elk object bevat een id en de naam van een adviseur. Matrix van objecten Deze id's worden gebruikt bij het maken van de vergadering met behulp van CreateMeeting en het ophalen van de resourceinformatie voor weergave. Per tijdvak wordt slechts één set adviseurs geretourneerd. Als de vereiste voor een vergaderingstype geldt voor één adviseur in de vergadering, heeft elk tijdslot slechts één waarde. Als er meer dan één adviseur beschikbaar is, geeft de planningsengine prioriteit aan de adviseurs op basis van context en capaciteit.

Voorbeeldrespons: enkele van de geretourneerde tijdvakken zijn verwijderd om ruimteredenen.

Notitie

NextPaging wordt toegevoegd wanneer er meer dan 20 tijdvakken worden geretourneerd.

{
    "@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

Beschrijving: maakt het plannen van een vergadering met de gevraagde adviseursbronnen mogelijk.

Naam van plug-in: CreateMeetingPlugin.cs

HTTP-aanvraag: POST {{url}}/api/data/v9.0/msfsi_CreateMeeting

Invoerparameters opvragen (in hoofdtekst):

Parameternaam Omschrijving Type Vereist Aantekeningen
MeetingType De id van het gekozen MeetingType. Tekenreeks (msfsi_meetingtype) Ja De waarde van deze parameter moet een geldige GUID zijn.
StartDateTime De begindatum en -tijd voor de vergadering. Datum en tijd Ja Voorbereidende en samenvattende afspraken worden toegevoegd aan de agenda van de adviseur op basis van het type vergadering en de configuratie van de beheerder.
Contactpersoon De contactpersoon-id die de klant vertegenwoordigt die de vergadering bijwoont. Tekenreeks (contactpersoon-id) Ja De waarde van deze parameter moet een geldige GUID zijn.
IsOnlineMeeting Geeft aan of de afspraak een online vergadering is of niet. Booleaans Ja Als deze waarde False is, is het verplicht om in plaats daarvan een vergaderlocatie op te geven.
RequestedMeetingLocation De id van de locatie (OrganizationalUnit) waar de vergadering zal worden gehouden. Tekenreeks (OrganizationalUnit(OU) id) No Voor een online vergadering is dit veld niet verplicht. Voor een implementatie van onlinevergaderingen waarbij de online adviseurs zich in een specifieke OrganizationalUnit(OU) bevinden, is een speciale OE-referentie vereist.
RequestedAdvisors Een matrix van de vereiste adviseur-id's (boekbare resource-id's). Deze id's zijn afkomstig uit de matrix Adviseurs die is opgegeven in de respons GetAvailableMeetingTimeSlots. EntityCollection ((Bronnen) Ja Om de boeking te laten slagen, moeten er systeemgebruikers aan de resources zijn gekoppeld. Deze gebruikers verschijnen in het veld Vereist van de afspraak. Tekenreeksen in de matrix moeten geldige GUID's zijn.
CustomerAdditionalNotes Notities die de klanten willen delen over de aanstaande vergadering. Tekenreeks Nee Deze parameter verschijnt in de klantcommunicatie en de afspraakbeschrijving in de CRM-applicatie.

Voorbeeld aanvragen:

{
    "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"
}

Uitvoerparameters voor respons:

Parameternaam Omschrijving Type Aantekeningen
ID Een id die staat voor de geplande vergadering. Tekenreeks Staat voor een GUID.
StartTime De begindatum en -tijd van de vergadering. Datum en tijd De tijd wordt weergegeven in UTC.
EndTime De einddatum en -tijd van de vergadering. Datum en tijd De tijd wordt weergegeven in UTC.
Duur De duur van de geplande vergadering in minuten. Int
IsOnline Geeft aan of de afspraak een online vergadering is of niet. Booleaans
CustomerAdditionalNotes Notities die de klanten willen delen over de geplande vergadering. Tekenreeks
MeetingJoinUrl De koppeling voor deelname aan de geplande vergadering. Tekenreeks
Provincie De status van de geplande vergadering. Optieset (object)
  • 0: Geopend
  • 1: Voltooid
  • 2: Geannuleerd
  • 3: Gepland

Elke optieset wordt vertegenwoordigd door een object met de waarde en het label.
Locatie Een object van de vergaderlocatie voor een afspraak op locatie. Object Deze parameter is alleen niet leeg voor de vergaderingen die op locatie plaatsvinden.
Adviseurs Een lijst met objecten die staan voor de adviseurs in de geplande vergadering. Matrix van objecten
MeetingType Een object dat het MeetingType vertegenwoordigt. Object
Locatieobject
ID De id van de locatie (OrganizationalUnit-entiteit). Tekenreeks Staat voor een GUID.
Naam De naam van de locatie (vestigingsentiteit). Tekenreeks
Address1 De eerste regel in het adres van de locatie (vestigingsentiteit). Tekenreeks
Address2 De eerste regel in het adres van de locatie (vestigingsentiteit). Tekenreeks
Plaats De stad van de locatie (vestigingsentiteit). Tekenreeks
Staat of provincie De provincie van de locatie (vestigingsentiteit). Tekenreeks
Land Het land van de locatie (vestigingsentiteit). Tekenreeks
PostalCode De postcode van de locatie (vestigingsentiteit). Tekenreeks
Telefoon Het telefoonnummer van de locatie (vestigingsentiteit). Tekenreeks
Adviseursobject
ID De id van de adviseur (entiteit boekbare resource). Tekenreeks Staat voor een GUID.
Naam De naam van de adviseur. Tekenreeks
MeetingType-object
ID De id van het MeetingType. Tekenreeks
Naam De naam van het MeetingType. Tekenreeks
Aantekeningen De aantekeningen voor de deelnemer aan de vergadering om te volgen. Tekenreeks
Omschrijving De beschrijving van het MeetingType. Tekenreeks

Voorbeeldrespons:

{
    "@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

Beschrijving: Hiermee haalt u een geplande vergadering op voor een contactpersoon.

Naam van de invoegtoepassing: GetMeetingPlugin.cs

HTTP-aanvraag: POST {{url}}/api/data/v9.0/msfsi_GetMeeting

Invoerparameters opvragen (in hoofdtekst):

Parameternaam Omschrijving Type Vereist Aantekeningen
Vergadering De id van de vergadering. Tekenreeks Ja De meeting-id is afkomstig uit de CreateMeeting-respons.

De waarde van deze parameter moet een geldige GUID zijn.
Contactpersoon De id van de klant voor wie de vergadering is gepland. Tekenreeks Ja De waarde van deze parameter moet een geldige GUID zijn.

Voorbeeld aanvragen:

{
    "Meeting": "4d6d4b05-4e0f-ed11-82e5-00224822509a",
    "Contact": "8788facf-828e-4333-8405-b825b0f29ea0"
}

Uitvoerparameters voor respons:

Parameternaam Omschrijving Type Aantekeningen
ID Een id die staat voor de geplande vergadering. Tekenreeks Staat voor een GUID.
StartTime De begindatum en -tijd van de vergadering. Datum en tijd De tijd wordt weergegeven in UTC.
EndTime De einddatum en -tijd van de vergadering. Datum en tijd De tijd wordt weergegeven in UTC.
Duur De duur van de geplande vergadering in minuten. Int
IsOnline Geeft aan of de afspraak een online vergadering is of niet. Booleaans
CustomerAdditionalNotes Notities die de klanten willen delen over de geplande vergadering. Tekenreeks
MeetingJoinUrl De koppeling voor deelname aan de geplande vergadering. Tekenreeks
Provincie De status van de geplande vergadering. Optieset (object)
  • 0: Geopend
  • 1: Voltooid
  • 2: Geannuleerd
  • 3: Gepland

Elke optieset wordt vertegenwoordigd door een object met de waarde en het label.
Locatie Een object van de vergaderlocatie voor een afspraak op locatie. Object Deze parameter is alleen niet leeg voor de vergaderingen die op locatie plaatsvinden.
Adviseurs Een lijst met objecten die staan voor de adviseurs in de geplande vergadering. Matrix van objecten
MeetingType Een object dat het MeetingType vertegenwoordigt. Object
Locatieobject
ID De id van de locatie (OrganizationalUnit-entiteit). Tekenreeks Staat voor een GUID.
Naam De naam van de locatie (vestigingsentiteit). Tekenreeks
Address1 De eerste regel in het adres van de locatie (vestigingsentiteit). Tekenreeks
Address2 De eerste regel in het adres van de locatie (vestigingsentiteit). Tekenreeks
Plaats De stad van de locatie (vestigingsentiteit). Tekenreeks
Staat of provincie De provincie van de locatie (vestigingsentiteit). Tekenreeks
Land Het land van de locatie (vestigingsentiteit). Tekenreeks
PostalCode De postcode van de locatie (vestigingsentiteit). Tekenreeks
Telefoon Het telefoonnummer van de locatie (vestigingsentiteit). Tekenreeks
Adviseursobject
ID De id van de adviseur (entiteit boekbare resource). Tekenreeks Staat voor een GUID.
Naam De naam van de adviseur. Tekenreeks
MeetingType-object
ID De id van het MeetingType. Tekenreeks
Naam De naam van het MeetingType. Tekenreeks
Aantekeningen De aantekeningen voor de deelnemer aan de vergadering om te volgen. Tekenreeks
Omschrijving De beschrijving van het MeetingType. Tekenreeks

Voorbeeldrespons:

{
    "@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

Beschrijving: Annuleert een bestaande vergadering.

Naam van invoegtoepassing: CancelMeetingPlugin.cs

HTTP-aanvraag: POST {{url}}/api/data/v9.0/msfsi_CancelMeeting

Invoerparameters opvragen (in hoofdtekst):

Parameternaam Omschrijving Type Vereist Aantekeningen
Vergadering De id van de te annuleren vergadering. Tekenreeks (afspraak id) Ja De vergadering-id wordt ontleend aan het ophaalverzoek van bestaande afspraken voor de klant. Alleen toekomstige, actieve vergaderingen kunnen worden geannuleerd.

Voorbereidings- en samenvattingsafspraken die zijn gekoppeld aan de klantvergadering worden ook geannuleerd.

De waarde van deze parameter moet een geldige GUID zijn.
Contactpersoon De id van de klant voor wie de vergadering is gepland. Tekenreeks (contactpersoon-id) Ja De waarde van deze parameter moet een geldige GUID zijn.

Voorbeeld aanvragen:

{
    "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"
    }
}

Uitvoerparameters voor respons:

Parameternaam Omschrijving Type Aantekeningen
IsAppointmentCancelled Geeft aan of de vergadering geannuleerd is of niet. Booleaans Alleen toekomstige, actieve vergaderingen kunnen worden geannuleerd.

Voorbeeldrespons:

{
    "@odata.context": "https://#####.crm.dynamics.com/api/data/v9.0/$metadata#Microsoft.Dynamics.CRM.msfsi_CancelMeetingResponse",
    "IsMeetingCancelled": true
}

Opdrachten voor ophalen van gegevens

De set API's en apps die voor Intelligente afspraken wordt geleverd, moet u voldoende informatie bieden. OData fetch-opdrachten kunnen worden gebruikt om informatie op te halen over de onderliggende entiteiten die voor de API's zijn gebruikt. Het ophalen van entiteitsgegevens gebeurt met behulp van standaard FetchXML query's Dataverse.
Meer informatie: gebruik FetchXML om een ​​query samen te stellen.

De aanbevolen lijst met op te halen entiteiten is als volgt:

  • MeetingTopics: haalt een lijst op met de beschikbare vergaderonderwerpen. Een onderwerp is de entiteit waarmee u de vergaderingen in verschillende containers kunt groeperen. Dit is een optionele waarde.

  • MeetingTypeTopic: Hiermee wordt een toewijzing aangeduid om de link tussen typen vergaderingen en een onderwerp te identificeren. Een bepaald type vergadering kan onder meerdere onderwerpen beschikbaar worden gesteld. Als vergaderonderwerpen worden gebruikt, zorg er dan voor dat u de vergaderingen groepeert in hun relevante onderwerp-containers.

  • MeetingTypes: haalt de lijst op met de beschikbare typen vergaderingen.

  • MeetingType: haalt de details van een specifiek type vergadering op, zoals:

    • Ondersteunde vergadermethoden (online, persoonlijk of beide)

    • Beschrijving van vergadering

    • Lijst met vestigingen die deze bijeenkomst aanbieden

    • Duur van de vergadering

    • Klantinstructies voor de vergadering bij het plannen ervan.

  • Branches : Haalt een lijst op met vestigingen die worden ondersteund in de Intelligente afspraken-oplossing. Deze lijst moet worden vergeleken met het type vergadering om te verifiëren dat alleen de vestigingen die de specifieke vergaderservice ondersteunen, beschikbaar worden gesteld aan de klanten om te selecteren.

  • Branch: haalt de details van een specifieke vestiging op, zoals de naam van de vestiging, vestigingscode en adres.

  • Appointments: haalt een lijst op met afspraken voor de klant.

  • Appointment: haalt de details op van een specifieke afspraak op contact-id. De details omvatten:

    • Status van afspraak

    • Koppeling naar de onlinevergadering

    • Extra klantnotities die aan de vergadering zijn toegevoegd

    • Vergaderlocatie

    • Vereiste adviseurs die de vergadering bijwonen

    • Omschrijving

  • BookableResources: haalt een lijst op van de beschikbare bronnen en hun details, zoals naam en titel.

Zie ook

De Microsoft Dataverse Web API gebruiken
Een tabelrij ophalen met de Web API
Intelligente afspraken
Intelligente afspraken configureren
Wat is Microsoft Cloud for Financial Services?