Érdeklődők és lehetőségek listájának lekérése
Ez a cikk bemutatja, hogyan szerezheti be az érdeklődők és az együttes értékesítési lehetőségek listáját. Ezek az érdeklődők a Microsoft Megoldásszolgáltató oldaláról érkeznek, míg az együttes értékesítési lehetőségek a Microsoft értékesítőitől vagy más partnerektől érkeznek. Ez a folyamat lekéri a szervezet által létrehozott együttes értékesítési lehetőségek vagy folyamatok listáját is.
Feljegyzés
A Microsoft kereskedelmi piactérről (Azure Marketplace és AppSource) fogadott érdeklődők nem támogatottak.
Előfeltételek
- Hitelesítő adatok a Referrals API-hitelesítésben leírtak szerint. Ez a forgatókönyv támogatja az App+Felhasználói hitelesítő adatokkal való hitelesítést.
- Ez az API jelenleg csak olyan felhasználók hozzáférését támogatja, ahol a partnereknek az alábbi szerepkörök egyikében kell lenniük: Átirányítási rendszergazda vagy átirányítási felhasználó.
REST-kérés
Kérés szintaxisa
Metódus | Kérés URI-ja |
---|---|
GET | https://api.partner.microsoft.com/v1.0/engagements/referrals |
Támogatott OData-műveletek
Név | Leírás | Kötelező | Példa |
---|---|---|---|
$select | Mezők kijelölése | Nem | /referrals?$select=id,status,customerProfile |
$filter | Eredmények szűrése | Ajánlott | /referrals?$filter=engagementId eq '65edc0b5-3485-41b7-a17e-dfa9ef4706e2' /referrals?$filter=status eq 'New' and qualification eq 'SalesQualified' /referrals?$filter=customerProfile/address/country eq 'US' and direction eq 'Incoming' |
$orderby | Rendelések eredményei | Ajánlott | /referrals?$orderby=createdDateTime desc |
Támogatott orderby paraméterek
Az érdeklődők és lehetőségek listájának rendezéséhez használja az alábbi $orderby paramétereket
Név | Típus | Leírás |
---|---|---|
createdDateTime | Dátum/idő | Az érdeklődő vagy lehetőség létrehozási dátuma és időpontja |
updatedDateTime | Dátum/idő | Az érdeklődő vagy lehetőség dátumának és időpontjának frissítése |
Kérésfejlécek
További információ: Partner REST-fejlécek.
Kérés törzse
Nincs.
Példa kérése
GET https://api.partner.microsoft.com/v1.0/engagements/referrals?$orderby=createdDateTime desc HTTP/1.1
Authorization: Bearer <token>
Content-Type: application/json
REST-válasz
Ha sikeres, a válasz törzse érdeklődők és/vagy lehetőségek gyűjteményét tartalmazza.
Válasz sikeresség és hibakódok
Minden válaszhoz tartozik egy HTTP-állapotkód , amely jelzi a sikert vagy a hibát, valamint egyéb hibakeresési információkat. Használja a hálózati nyomkövetési eszközt a kód, a hiba típusa és további paraméterek olvasásához.
Példa válaszra
HTTP/1.1 200 OK
Request-ID: 9f8bed52-e4df-4d0c-9ca6-929a187b0731
Content-Type: application/json
{
"@odata.context": "http://api.partner.microsoft.com/v1.0/$metadata#Referrals",
"@odata.count": 1,
"value": [
{
"id": "c5fbb3b6-be74-4795-9fb5-4324c73fed37",
"engagementId": "65edc0b5-3485-41b7-a17e-dfa9ef4706e2",
"organizationId": "00aa00aa-bb11-cc22-dd33-44ee44ee44ee",
"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 for support 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/referrals/c5fbb3b6-be74-4795-9fb5-4324c73fed37",
"method": "GET"
}
}
}
],
"@odata.nextLink": "http://api.partner.microsoft.com/v1.0/referrals?$skiptoken=k181pEdP0ykypkieJfcxX"
}
@odata.nextLink
Az eredmény következő oldalának lekéréséhez használja a következő lapot.
Feljegyzés
A példában szereplő mezők nem teljesek. A tényleges API-válasz több mezőt tartalmaz, például az ügyfél- és partnercsapatokat. A támogatott mezők teljes listájáért tekintse meg az átirányítási erőforrásokat.
Mintakérések
Az alábbi példa beolvassa a 10 legutóbbi bejövő együttes értékesítési lehetőséget. A kérés beolvassa a Microsoft értékesítési képviselője vagy egy másik partner által kezdeményezett lehetőségeket, és meghívja a szervezetet, hogy vegyen részt egy közös értékesítési tevékenységben.
GET https://api.partner.microsoft.com/v1.0/engagements/referrals?$top=10&$filter=(type eq 'Shared' and direction eq 'Incoming')&$orderby=createdDateTime desc HTTP/1.1
Authorization: Bearer <token>
Content-Type: application/json
Az alábbi példa beolvassa a legutóbbi bejövő érdeklődőket és lehetőségeket, amelyekre nem válaszolnak.
GET https://api.partner.microsoft.com/v1.0/engagements/referrals?$top=10&$filter=(direction eq 'Incoming' and substatus eq 'Pending')&$orderby=createdDateTime desc HTTP/1.1
Authorization: Bearer <token>
Content-Type: application/json
Fontos
Ha a megadott időn belül (jelenleg 14 napon belül) nem válaszol egy érdeklődőre vagy lehetőségre, akkor lejártként archiváljuk, és értesítjük a Microsoftot vagy a lehetőséget küldő partnert.
Az alábbi példa bemutatja a szervezet által kezdeményezett és egy adott értékesítő által végzett legutóbbi aktív együttes értékesítési lehetőségeket.
GET https://api.partner.microsoft.com/v1.0/engagements/referrals?$filter=status eq 'Active' and direction eq 'Outgoing' and type eq 'Shared' and team/any(t:t/email eq 'r2d2@contoso.com')&$orderby=createdDateTime desc HTTP/1.1
Authorization: Bearer <token>
Content-Type: application/json