Získání seznamu zákazníků filtrovaných podle vyhledávacího pole

Článek
01/10/2024

Platí pro: Partnerské centrum | Partnerské centrum provozované společností 21Vianet | Partnerské centrum pro Microsoft Cloud pro státní správu USA

Získá kolekci prostředků zákazníků , které odpovídají filtru. Volitelně můžete nastavit velikost stránky. Můžete filtrovat podle názvu společnosti, domény, nepřímého prodejce nebo nepřímého poskytovatele cloudových řešení (CSP).

Požadavky

Přihlašovací údaje popsané v ověřování v Partnerském centru Tento scénář podporuje ověřování pomocí samostatných přihlašovacích údajů aplikace i aplikace a uživatele.
Filtr vytvořený uživatelem.

C#

Pokud chcete získat kolekci zákazníků, kteří odpovídají filtru, vytvořte nejprve instanci objektu SimpleFieldFilter a vytvořte filtr. Budete muset předat řetězec, který obsahuje Pole CustomerSearchField, a označit typ operace filtru jako FieldFilterOperation.StartsWith. To je jediná operace filtru polí podporovaná koncovým bodem zákazníka. Budete také muset zadat řetězec, podle který chcete filtrovat.

Dále vytvořte instanci objektu iQuery, který se má předat dotazu voláním BuildSimpleQuery metody a předáním filtru. BuildSimplyQuery je pouze jedním z typů dotazů podporovaných třídou QueryFactory .

Nakonec k provedení filtru a získání výsledku nejprve použijte IAggregatePartner.Customers k získání rozhraní pro operace zákazníka partnera. Potom volejte metodu Query nebo QueryAsync.

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);

Ukázka: Konzolová testovací aplikace Projekt: Ukázky sady SDK v Partnerském centru – třída: FilterCustomers.cs

Požadavek REST

Syntaxe požadavku

metoda	Identifikátor URI žádosti
GET	{baseURL}/v1/customers?size={size}&filter={filter} HTTP/1.1

Parametry identifikátoru URI

Použijte následující parametry dotazu.

Name	Type	Požadováno	Popis
size	int	No	Počet výsledků, které se mají zobrazit najednou. Tento parametr je volitelný.
filter	filter	Ano	Filtr, který se má použít pro zákazníky. Musí se jednat o kódovaný řetězec.

Syntaxe filtru

Parametr filtru musíte vytvořit jako řadu párů klíč-hodnota oddělených čárkami. Každý klíč a hodnota musí být jednotlivě uvozovány a odděleny dvojtečku. Celý filtr musí být kódován.

Nekódovaný příklad vypadá takto:

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

Následující tabulka popisuje požadované páry klíč-hodnota:

Key	Hodnota
Pole	Pole, které chcete filtrovat. Platné hodnoty lze najít v CustomerSearchField.
Hodnota	Hodnota, podle které chcete filtrovat. Velká a malá písmena hodnoty se ignorují.
Operátor	Operátor, který se má použít. Jediná podporovaná hodnota pro tento scénář zákazníka je "starts_with".

Záhlaví žádosti

Další informace najdete v tématu Hlavičky REST Partnerského centra.

Text požadavku

Nezaokrouhlovat.

Příklad požadavku

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

Odpověď REST

Pokud je tato metoda úspěšná, vrátí v textu odpovědi kolekci odpovídajících prostředků zákazníka .

Kódy úspěšnosti a chyb odpovědi

Každá odpověď obsahuje stavový kód HTTP, který označuje úspěch nebo selhání a další informace o ladění. Ke čtení tohoto kódu, typu chyby a dalších parametrů použijte nástroj pro trasování sítě. Úplný seznam najdete v tématu Kódy chyb REST v Partnerském centru.

Příklad odpovědi

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"
    }
}

Sdílet prostřednictvím