Een verwijzing maken

  • Artikel

In dit artikel wordt uitgelegd hoe u een verwijzing maakt. Er zijn twee typen ReferralType:

  • Onafhankelijk: waarbij een verwijzing zichtbaar is voor één partner.
  • Gedeeld: waarbij een verwijzing zichtbaar is voor twee partijen die samenwerken. Als Microsoft en een partner bijvoorbeeld samenwerken in een deal voor collectieve verkoop, kan een verwijzing tussen beide partijen worden gedeeld. Zie de sectie Een gedeelde verwijzing maken voor meer informatie.

Vereisten

  • Referenties zoals beschreven in Partner-API-verificatie. Dit scenario ondersteunt verificatie met App+User-referenties.

REST-aanvraag

Aanvraagsyntaxis

Methode Aanvraag-URI
VERZENDEN https://api.partner.microsoft.com/v1.0/engagements/referrals

Aanvraagheaders

Aanvraagbody

In deze tabel worden de verwijzingseigenschappen in de aanvraagtekst voor een gloednieuwe verwijzing beschreven.

Eigenschap Type Beschrijving
Naam tekenreeks De naam van de verwijzing.
ExternalReferenceID tekenreeks Een externe id voor de verwijzing. Bijvoorbeeld uw eigen Dynamics 365 lead- of verkoopkans-id.
Status ReferralStatus Een opsomming met waarden die de verwijzingsstatus aangeven.
Substatus ReferralSubstatus Een enum met waarden die de substatus van de verwijzing aangeven.
StatusReason tekenreeks Een beschrijvend bericht over de status. Leg bijvoorbeeld uit waarom de verwijzing verloren is gegaan.
ReferralType ReferralType Vertegenwoordigt het verwijzingstype. Vereist.
Kwalificatie VerwijzingKwaliteit Vertegenwoordigt de kwaliteit van de verwijzing.
CustomerProfile CustomerProfile Contactgegevens van de klant. Vereist.
Toestemming Toestemming Toestemmingsvlagmen rond het delen van informatie met andere organisaties en hen in staat te stellen contact met gebruikers op te halen. Vereist.
Details ReferralDetails Klantgegevens, notities, dealwaarde, valutaafsluitingsdatum. Vereist.
Team Lid Vertegenwoordigt gebruikers in de organisaties die betrokken zijn bij de partnerbetrokkenheid.
InviteContext InviteContext Vertegenwoordigt aanvullende informatie die een gebruiker kan verstrekken bij het uitnodigen van een andere organisatie voor de partnerbetrokkenheid.
Doel ReferralTarget Vertegenwoordigt aanvullende informatie die een gebruiker kan verstrekken bij het uitnodigen van een andere organisatie voor de partnerbetrokkenheid.

Status- en substatusovergangen

Status Toegestane statusovergang Toegestane substatus
Nieuw Nieuw, Actief, Gesloten In behandeling, ontvangen
Actief Actief, gesloten Geaccepteerd
Gesloten Gesloten Gewonnen, Verloren, Geweigerd, Verlopen

Voorbeeld van aanvraag

POST https://api.partner.microsoft.com/v1.0/engagements/referrals HTTP/1.1
Authorization: Bearer <token>
Host: api.partner.microsoft.com
Content-Type: application/json

 {
    "name": "Test Cosell Invite_20",
    "status": "New",
    "substatus": "Pending",
    "statusReason": "Customer engagement was a success!",
    "qualification": "SalesQualified",
    "type": "Shared",
    "target": [
        {
            "type": "SolutionProfile",
            "id": "SOL-34104-EBB"
        }
    ],
    "customerProfile": {
        "name": "Contoso Customer Inc",
        "address": {
            "addressLine1": "One Microsoft Way",
            "addressLine2": "34",
            "city": "Redmond",
            "state": "WA",
            "postalCode": "98052",
            "country": "US"
        },
        "size": "10to50employees",
        "team": [
            {
                "contactPreference": {
                    "locale": "en-us",
                    "disableNotifications": false
                },
                "firstName": "Sue",
                "lastName": "Smith",
                "phoneNumber": "1234567890",
                "email": "sue.smith@contoso.com"
            },
            {
                "contactPreference": {
                    "locale": "en-us",
                    "disableNotifications": false
                },
                "firstName": "Joe",
                "lastName": "Hansen",
                "phoneNumber": "4035698759",
                "email": "joe.hansen@contoso.com"
            }
        ],
        "ids": []
    },
    "consent": {
        "consentToToShareInfoWithOthers": true,
        "consentToContact": true
    },
    "details": {
        "notes": "Customer is looking to leverage Dynamics 365 to manage their supply chain. There is also a need to leverage a set of custom apps to enable their business processes.",
        "dealValue": 50000,
        "currency": "USD",
        "closingDateTime": "2018-11-14T00:00:00Z",
        "requirements": {
            "industries": [
                {
                    "id": "Manufacturing"
                }
            ],
            "products": [
                {
                    "id": "Dynamics365Enterprise"
                }
            ],
            "services": [
                {
                    "id": "DeploymentOrMigration"
                }
            ],
            "solutions": [
                {
                    "name": "Dynamics 365 for Field Service",
                    "type": "Category",
                    "id": "Dynamics365forFieldService"
                }
            ]
        }
    },
    "team": [
        {
            "contactPreference": {
                "locale": "en-us",
                "disableNotifications": false
            },
            "firstName": "John",
            "lastName": "Doe",
            "phoneNumber": "1231231234",
            "email": "john.doe@microsoft.com"
        }
    ],
    "inviteContext": {
        "notes": "Hi ABC Partner, hoping you can help this customer. Thanks, John @ Microsoft",
        "invitedBy": {
            "organizationId": "msft"
        }
    }
}

REST-antwoord

Als dit lukt, retourneert deze methode de ingevulde verwijzingsresource in de hoofdtekst van het antwoord.

Geslaagde en foutcodes voor antwoorden

Elk antwoord wordt geleverd met een HTTP-statuscode die aangeeft dat het is gelukt of mislukt en aanvullende informatie over foutopsporing. Gebruik een hulpprogramma voor netwerktracering om deze code, het fouttype en aanvullende parameters te lezen. Zie Foutcodes voor de volledige lijst.

Voorbeeld van antwoord

{
    "id": "4111fffc-f9ee-4d53-bba6-569135228642",
    "engagementId": "37ef26aa-1d15-4533-9f93-a69bd33ab1e5",
    "organizationId": "7d23e5ca-19dc-4eaa-aac8-5e6b559f0d1d",
    "organizationName": "Contoso Company",
    "name": "Test Cosell Invite_20",
    "externalReferenceId": null,
    "createdDateTime": "2019-02-23T02:05:23.2931817Z",
    "updatedDateTime": "2019-02-23T02:05:23.2931817Z",
    "expirationDateTime": null,
    "status": "Active",
    "substatus": "Accepted",
    "statusReason": "Customer engagement was a success!",
    "qualification": "SalesQualified",
    "type": "Shared",
    "eTag": "\"00006d10-0000-0000-0000-5c70aa630000\"",
    "target": [
        {
            "type": "SolutionProfile",
            "id": "SOL-34104-EBB"
        }
    ],
    "customerProfile": {
        "name": "Contoso Customer Inc",
        "address": {
            "addressLine1": "One Microsoft Way",
            "addressLine2": "34",
            "city": "Redmond",
            "state": "WA",
            "postalCode": "98052",
            "country": "US"
        },
        "size": "10to50employees",
        "team": [
            {
                "contactPreference": {
                    "locale": "en-us",
                    "disableNotifications": false
                },
                "firstName": "Sue",
                "lastName": "Smith",
                "phoneNumber": "1234567890",
                "email": "sue.smith@contoso.com"
            },
            {
                "contactPreference": {
                    "locale": "en-us",
                    "disableNotifications": false
                },
                "firstName": "Joe",
                "lastName": "Hansen",
                "phoneNumber": "4035698759",
                "email": "joe.hansen@contoso.com"
            }
        ],
        "ids": []
    },
    "consent": {
        "consentToToShareInfoWithOthers": true,
        "consentToContact": true
    },
    "details": {
        "notes": "Customer is looking to leverage Dynamics 365 to manage their supply chain. There is also a need to leverage a set of custom apps to enable their business processes.",
        "dealValue": 50000,
        "currency": "USD",
        "requirements": {
            "industries": [
                {
                    "id": "Manufacturing"
                }
            ],
            "products": [
                {
                    "id": "Dynamics365Enterprise"
                }
            ],
            "services": [
                {
                    "id": "DeploymentOrMigration"
                }
            ],
            "solutions": [
                {
                    "name": "Dynamics 365 for Field Service",
                    "type": "Category",
                    "id": "Dynamics365forFieldService"
                }
            ]
        }
    },
    "team": [
        {
            "contactPreference": {
                "locale": "en-us",
                "disableNotifications": false
            },
            "firstName": "John",
            "lastName": "Doe",
            "phoneNumber": "1231231234",
            "email": "john.doe@microsoft.com"
        }
    ],
    "inviteContext": {
        "notes": "Hi ABC Partner, hoping you can help this customer. Thanks, John @ Microsoft",
        "invitedBy": {
            "organizationId": "msft"
        }
    },
    "links": {
        "relatedReferrals": {
            "uri": "https://api.partner.microsoft.com/v1.0/engagments/referrals?$filter=engagementId eq '37ef26aa-1d15-4533-9f93-a69bd33ab1e5'",
            "method": "GET"
        },
        "self": {
            "uri": "https://api.partner.microsoft.com/v1.0/engagments/referrals/4111fffc-f9ee-4d53-bba6-569135228642",
            "method": "GET"
        }
    }
}

Een gedeelde verwijzing maken

Er zijn twee stappen om een verwijzing van het type Gedeeldeverwijzing te maken.

  1. Uw gedeelde verwijzing maken
  2. Een verbonden verwijzing maken voor de tweede partij

In het volgende stroomdiagram ziet u deze twee stappen voor het maken van een gedeelde verwijzing.

Stroomdiagram met een gedeelde verwijzing met 2 verwijzingen die zijn verbonden via de API.

Uw verwijzing maken

  1. Maak een verwijzing waarbij ReferralType is ingesteld op gedeeld.
  2. Kopieer de engagementID uit het retourantwoord.

ReferralTarget-voorbeeld voor verwijzing

"target": [
        {
            "type": "SolutionProfile",
            "id": "SOL-ABC-DEF"
        }
    ]

Een verbonden verwijzing maken

  1. Maak nog een verwijzing voor Microsoft.
  2. Neem de enagementID van uw verwijzing op, zodat deze aan elkaar zijn gekoppeld.

ReferralTarget-voorbeeld voor Microsoft-verwijzing

"target": [
        {
            "type": "BusinessProfileLocation",
            "id": "msft"
        }
    ]

Volgende stappen