Finden von Leads oder Verkaufschancen anhand der ID

Gilt für:

  • Partner-API

In diesem Thema wird erläutert, wie Sie eine Lead- oder Co-Selling-Verkaufschance nach ID erhalten.

Hinweis

Leads, die vom kommerziellen Microsoft Marketplace (Azure Marketplace und AppSource) empfangen werden, werden nicht unterstützt.

Voraussetzungen

  • Anmeldeinformationen, wie unter Partner-API-Authentifizierung beschrieben. In diesem Szenario wird die Authentifizierung mit App- und Benutzeranmeldeinformationen unterstützt.
  • Diese API unterstützt derzeit nur den Benutzerzugriff, bei dem Partner eine der folgenden Rollen haben müssen: Globaler Administrator, Empfehlungsadministrator oder Empfehlungsbenutzer.

REST-Anforderung

Anforderungssyntax

Methode Anforderungs-URI
GET https://api.partner.microsoft.com/v1.0/engagements/referrals/{Id}

URI-Parameter

Name Typ Erforderlich BESCHREIBUNG
Id Zeichenfolge Ja Der eindeutige Bezeichner für eine Lead- oder Co-Selling-Verkaufschance

Anforderungsheader

Weitere Informationen findest du unter Partner-API: REST-Header.

Anforderungstext

Keine.

Anforderungsbeispiel

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

REST-Antwort

Bei Erfolg enthält der Antworttext den Lead oder die Verkaufschance, der bzw. die mit der ID übereinstimmt.

Erfolgs- und Fehlercodes der Antwort

Jede Antwort enthält einen HTTP-Statuscode, der den Erfolg oder Fehler sowie zusätzliche Debuginformationen angibt. Verwende ein Tool für die Netzwerkablaufverfolgung, um diesen Code, den Fehlertyp und zusätzliche Parameter zu lesen.

Antwortbeispiel

HTTP/1.1 200 OK
Content-Type: application/json
Request-ID: 9f8bed52-e4df-4d0c-9ca6-929a187b0731

{
    "@odata.context": "https://api.partner.microsoft.com/v1.0/engagments/referrals/$metadata#Referrals/$entity",
    "id": "c5fbb3b6-be74-4795-9fb5-4324c73fed37",
    "engagementId": "65edc0b5-3485-41b7-a17e-dfa9ef4706e2",
    "organizationId": "7d23e5ca-19dc-4eaa-aac8-5e6b559f0d1d",
    "organizationName": "Contoso Company",
    "createdDateTime": "2020-10-30T21:03:00.0000000Z",
    "updatedDateTime": "2020-10-30T21:03:00.0000000Z",
    "status": "New",
    "substatus": "Pending",
    "qualification": "Direct",
    "type": "Independent",
    "direction": "Incoming",
    "customerProfile": {
      "name": "Fabrikam Customer Inc",
      "address": {
        "addressLine1": "One Microsoft Way",
        "addressLine2": "",
        "city": "Redmond",
        "state": "WA",
        "postalCode": "98052",
        "country": "US"
      }
    },
    "details": {
      "notes": "We are interested in deploying Microsoft 365 and are looking forsupport in training our employees. Can you help?",
      "dealValue": 10000,
      "currency": "USD",
      "closingDateTime": "2020-12-01T00:00:00Z",
      "requirements": {
          "industries": [ { "id": "Education" } ],
          "products": [ { "id": "Microsoft365" } ],
          "services": [ { "id": "LearningAndCertification" } ],
          "solutions": [ { "id": "SOL-Microsoft365", "name": "Microsoft365" }
        ]
      }
    },
    "links": {
      "relatedReferrals": {
        "uri": "https://api.partner.microsoft.com/v1.0/engagements/referrals$filter=engagementId eq '65edc0b5-3485-41b7-a17e-dfa9ef4706e2'",
        "method": "GET"
      },
      "self": {
        "uri": "https://api.partner.microsoft.com/v1.0/engagements/referralsc5fbb3b6-be74-4795-9fb5-4324c73fed37",
        "method": "GET"
      }
    },
    "eTag": "\"2500ec5a-0000-0000-0000-5bf4967d0000\""
}

Hinweis

Die Felder in der obigen Beispielanschauung sind nicht vollständig. Die tatsächliche API-Antwort enthält weitere Felder wie die Kunden- und Partnerteams. Die vollständige Liste der unterstützten Felder finden Sie unter Referenzressourcen.