Bir referans oluşturma
Bu makalede referans oluşturma açıklanmaktadır. İki tür ReferralType vardır:
- Bağımsız: Referansın bir iş ortağı tarafından görüleceği yer.
- Paylaşılan: Bir referansın birlikte çalışan iki taraf tarafından görüleceği yer. Örneğin, Microsoft ve iş ortağı ortak satış anlaşmasında birlikte çalışıyorsa, her iki taraf arasında bir referans paylaşılabilir. Daha fazla bilgi için Paylaşılan referans oluşturma bölümüne bakın.
Önkoşullar
- İş Ortağı API kimlik doğrulamasında açıklandığı gibi kimlik bilgileri. Bu senaryo, App+User kimlik bilgileriyle kimlik doğrulamayı destekler.
REST İsteği
İstek söz dizimi
Yöntem | İstek URI'si |
---|---|
POST | https://api.partner.microsoft.com/v1.0/engagements/referrals |
İstek üst bilgileri
- Daha fazla bilgi için bkz. İş Ortağı API'si REST üst bilgileri .
İstek gövdesi
Bu tabloda, yepyeni bir referans için istek gövdesindeki Referans özellikleri açıklanmaktadır.
Özellik | Tür | Açıklama |
---|---|---|
Ad | string | Referansın adı. |
ExternalReferenceID | string | Referans için bir dış tanımlayıcı. Örneğin, kendi Dynamics 365 müşteri adayınız veya fırsat kimliğiniz. |
Durum | ReferralStatus | Referans durumunu gösteren değerlerle bir Sabit Listesi . |
Alt durum | ReferralSubstatus | Referans alt durumunu gösteren değerlerle bir Sabit Listesi . |
StatusReason | string | Durum hakkında açıklayıcı bir ileti. Örneğin, referansın neden kaybolduğunu açıklayın. |
Referans Türü | Referans Türü | Referans türünü temsil eder. Gerekli. |
Eleme | Referans Niteleme | Referansın kalitesini temsil eder. |
CustomerProfile | CustomerProfile | Müşteri iletişim bilgileri. Gerekli. |
Onay | Onay | Diğer kuruluşlarla bilgi paylaşma ve kullanıcılarla iletişim kurmalarına izin verme konusunda onay bayrakları. Gerekli. |
Ayrıntılar | ReferralDetails | Müşteri ayrıntıları, notlar, anlaşma değeri, para birimi kapanış tarihi. Gerekli. |
Takım | Üye | İş ortağı katılımına dahil olan kuruluşlardaki kullanıcıları temsil eder. |
InviteContext | InviteContext | Bir kullanıcının başka bir kuruluşu iş ortağı katılımına davet ederken sağlayabilecekleri ek bilgileri temsil eder. |
Hedef | ReferralTarget | Bir kullanıcının başka bir kuruluşu iş ortağı katılımına davet ederken sağlayabilecekleri ek bilgileri temsil eder. |
Durum ve alt durum geçiş durumları
Durum | İzin verilen durum geçişi | İzin verilen alt durum |
---|---|---|
Yeni | Yeni, Etkin, Kapalı | Beklemede, Alındı |
Etkin | Etkin, Kapalı | Kabul edildi |
Kapatıldı | Kapatıldı | Kazanıldı, Kayboldu, Reddedildi, Süresi Doldu |
İstek örneği
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 Yanıtı
Başarılı olursa, bu yöntem yanıt gövdesinde doldurulmuş Başvuru kaynağını döndürür.
Yanıt başarısı ve hata kodları
Her yanıt, başarıyı veya başarısızlığı ve ek hata ayıklama bilgilerini gösteren bir HTTP durum koduyla birlikte gelir. Bu kodu, hata türünü ve ek parametreleri okumak için bir ağ izleme aracı kullanın. Tam liste için bkz. Hata Kodları.
Yanıt örneği
{
"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"
}
}
}
Paylaşılan referans oluşturma
Paylaşılan referans türünün referansını oluşturmak için iki adım vardır.
Aşağıdaki akış grafiğinde paylaşılan başvuru oluşturma işleminin bu iki adımı gösterilmektedir.
Referansınızı oluşturma
- ReferralType paylaşılan olarak ayarlanmış bir referans oluşturun.
- dönüş yanıtından engagementID değerini kopyalayın.
Referans için ReferralTarget örneği
"target": [
{
"type": "SolutionProfile",
"id": "SOL-ABC-DEF"
}
]
Bağlı referans oluşturma
- Microsoft için başka bir referans oluşturun.
- Birbirine bağlı olmaları için referansınızın enagementID değerini ekleyin.
Microsoft başvurusu için ReferralTarget örneği
"target": [
{
"type": "BusinessProfileLocation",
"id": "msft"
}
]