Arama alanına göre filtrelenmiş bir müşteri listesini alma

  • Makale
  • Okumak için 3 dakika

Uygulama hedefi: Iş Ortağı Merkezi | 21Vianet tarafından işletilen iş ortağı Merkezi | Microsoft Bulut Almanya için iş ortağı Merkezi | Microsoft Cloud for US Government için iş ortağı Merkezi

Bir filtreyle eşleşen Müşteri kaynakları koleksiyonunu alır. İsteğe bağlı olarak bir sayfa boyutu ayarlayabilirsiniz. Şirket adına, etki alanına, dolaylı satıcıya veya dolaylı bulut çözümü sağlayıcısına (CSP) göre filtreleme yapabilirsiniz.

Önkoşullar

  • Iş ortağı merkezi kimlik doğrulamasındaaçıklandığı gibi kimlik bilgileri. Bu senaryo, hem tek başına uygulama hem de uygulama + kullanıcı kimlik bilgileriyle kimlik doğrulamayı destekler.

  • Kullanıcı tarafından oluşturulan bir filtre.

C#

Bir filtreyle eşleşen müşterilerin bir koleksiyonunu almak için ilk olarak filtreyi oluşturmak üzere bir Simplefieldfilter nesnesi oluşturun. Customersearchfield' ı içeren bir dize geçirmeniz ve filtre Işleminin türünü Fieldfilteroperation. StartsWitholarak belirtmeniz gerekir. Bu, müşterilerin bitiş noktası tarafından desteklenen tek alan filtresi işlemidir. Filtreleyecek dizeyi de sağlamanız gerekir.

Sonra, Buildsimplequery yöntemini çağırarak ve filtre geçirerek sorguya geçirilecek bir ıquery nesnesi örneği oluşturun. BuildSimplyQuery, Queryfactory sınıfının desteklediği sorgu türlerinden yalnızca biridir.

Son olarak, filtreyi yürütmek ve sonucu almak için, önce iş ortağının müşteri işlemlerine bir arabirim almak üzere ıaggregatepartner. Customers ' ı kullanın. Sonra Query veya queryasync yöntemini çağırın.

IAggregatePartner partnerOperations;

// Specify the partial string to filter by (to match Contoso).
string searchPrefix = "cont"

// Create a simple field filter.
var fieldFilter = new SimpleFieldFilter(
    CustomerSearchField.CompanyName.ToString(),
    FieldFilterOperation.StartsWith,
    searchPrefix);

// Create an iQuery object to pass to the Query method.
var myQuery = QueryFactory.Instance.BuildSimpleQuery(fieldFilter);

// Get the collection of matching customers.
var customers = partnerOperations.Customers.Query(myQuery);

Örnek: konsol test uygulaması. Project: iş ortağı merkezi SDK örnekleri sınıfı: filtercustomers. cs

REST isteği

İstek sözdizimi

Yöntem İstek URI'si
AL {BaseUrl}/v1/Customers? size = {size} filtre = {Filter} http/1.1

URI parametreleri

Aşağıdaki sorgu parametrelerini kullanın.

Ad Tür Gerekli Açıklama
boyut int No Tek seferde görüntülenecek sonuç sayısı. Bu parametre isteğe bağlıdır.
filtre filtre Yes Müşterilere uygulanacak filtre. Bu, kodlanmış bir dize olmalıdır.

Filtre sözdizimi

Filtre parametresini bir dizi virgülle ayrılmış anahtar-değer çiftleri olarak oluşturmanız gerekir. Her anahtar ve değer tek tek tırnak içine alınmalıdır ve iki nokta ile ayrılmalıdır. Filtrenin tamamının kodlanmış olması gerekir.

Kodlanamayan bir örnek şuna benzer:

?filter{"Field":"CompanyName","Value":"cont","Operator":"starts_with"}

Aşağıdaki tabloda gerekli anahtar-değer çiftleri açıklanmaktadır:

Anahtar Değer
Alan Filtrelenecek alan. Geçerli değerler Customersearchfieldiçinde bulunabilir.
Değer Filtrelenecek değer. Değerin durumu yok sayılır.
Operatör Uygulanacak işleç. Bu müşteri senaryosu için desteklenen tek değer "starts_with".

İstek üst bilgileri

Daha fazla bilgi için bkz. Iş ortağı MERKEZI Rest üstbilgileri.

İstek gövdesi

Yok.

İstek örneği

GET https://api.partnercenter.microsoft.com/v1/customers?size=0&filter=%7B%22Field%22%3A%22CompanyName%22%2C%22Value%22%3A%22Cont%22%2C%22Operator%22%3A%22starts_with%22%7D HTTP/1.1
Authorization: Bearer <token>
Accept: application/json
MS-RequestId: 5ce66de5-eea9-486f-a11c-c852aa3d1502
MS-CorrelationId: a2a912ee-d595-47e2-97ae-1b0ae1efa13d
X-Locale: en-US
Host: api.partnercenter.microsoft.com
Connection: Keep-Alive

REST yanıtı

Başarılı olursa, bu yöntem yanıt gövdesinde eşleşen Müşteri kaynakları koleksiyonunu döndürür.

Yanıt başarısı ve hata kodları

Her yanıt başarı veya başarısızlık ve ek hata ayıklama bilgilerini gösteren bir HTTP durum kodu ile gelir. Bu kodu, hata türünü ve ek parametreleri okumak için bir ağ izleme aracı kullanın. Tam liste için bkz. Iş ortağı MERKEZI Rest hata kodları.

Yanıt örneği

HTTP/1.1 200 OK
Content-Length: 1839
Content-Type: application/json; charset=utf-8
MS-CorrelationId: a2a912ee-d595-47e2-97ae-1b0ae1efa13d
MS-RequestId: dfeda56c-1af5-43fc-a9c0-346b9e85dc96
MS-CV: n0lMNyJtaUC802pO.0
MS-ServerId: 202010223
Date: Fri, 24 Feb 2017 22:08:20 GMT

{
    "totalCount": 3,
    "items": [{
            "id": "c5757d70-06f3-4f23-8367-5a9e55019f94",
            "companyProfile": {
                "tenantId": "c5757d70-06f3-4f23-8367-5a9e55019f94",
                "domain": "contoso190.onmicrosoft.com",
                "companyName": "Contoso190",
                "links": {
                    "self": {
                        "uri": "/customers/c5757d70-06f3-4f23-8367-5a9e55019f94/profiles/company",
                        "method": "GET",
                        "headers": []
                    }
                },
                "attributes": {
                    "objectType": "CustomerCompanyProfile"
                }
            },
            "relationshipToPartner": "reseller",
            "links": {
                "self": {
                    "uri": "/customers/c5757d70-06f3-4f23-8367-5a9e55019f94",
                    "method": "GET",
                    "headers": []
                }
            },
            "attributes": {
                "objectType": "Customer"
            }
        }, {
            "id": "7b26b357-9ca3-48b8-a58e-4febe2662a5d",
            "companyProfile": {
                "tenantId": "7b26b357-9ca3-48b8-a58e-4febe2662a5d",
                "domain": "ContosoCorpCo.onmicrosoft.com",
                "companyName": "Contoso",
                "links": {
                    "self": {
                        "uri": "/customers/7b26b357-9ca3-48b8-a58e-4febe2662a5d/profiles/company",
                        "method": "GET",
                        "headers": []
                    }
                },
                "attributes": {
                    "objectType": "CustomerCompanyProfile"
                }
            },
            "relationshipToPartner": "reseller",
            "links": {
                "self": {
                    "uri": "/customers/7b26b357-9ca3-48b8-a58e-4febe2662a5d",
                    "method": "GET",
                    "headers": []
                }
            },
            "attributes": {
                "objectType": "Customer"
            }
        }, {
            "id": "bfbd6ef0-311f-47ec-bbd7-0fcb7846661b",
            "companyProfile": {
                "tenantId": "bfbd6ef0-311f-47ec-bbd7-0fcb7846661b",
                "domain": "contosocorpdemo.onmicrosoft.com",
                "companyName": "Contoso",
                "links": {
                    "self": {
                        "uri": "/customers/bfbd6ef0-311f-47ec-bbd7-0fcb7846661b/profiles/company",
                        "method": "GET",
                        "headers": []
                    }
                },
                "attributes": {
                    "objectType": "CustomerCompanyProfile"
                }
            },
            "relationshipToPartner": "reseller",
            "links": {
                "self": {
                    "uri": "/customers/bfbd6ef0-311f-47ec-bbd7-0fcb7846661b",
                    "method": "GET",
                    "headers": []
                }
            },
            "attributes": {
                "objectType": "Customer"
            }
        }
    ],
    "links": {
        "self": {
            "uri": "/customers?size=0&filter=%7B%22Field%22%3A%22Domain%22%2C%22Value%22%3A%22cont%22%2C%22Operator%22%3A%22starts_with%22%7D",
            "method": "GET",
            "headers": []
        }
    },
    "attributes": {
        "objectType": "Collection"
    }
}