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

Platí pro: partnerské Centrum | Partnerské centrum provozovaný společností 21Vianet | Partnerské centrum pro Microsoft Cloud Německo | Partnerské centrum pro Microsoft Cloud for US Government

Získá kolekci zákaznických prostředků, 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 poskytovatele nepřímých cloudových řešení (CSP).

Požadavky

  • Přihlašovací údaje popsané v partnerském centru ověřování. Tento scénář podporuje ověřování pomocí samostatné aplikace a přihlašovacích údajů uživatele a aplikace.

  • Filtr vytvořený uživatelem.

C#

Pro získání kolekce zákazníků, které odpovídají filtru, nejprve vytvořte instanci objektu SimpleFieldFilter , abyste vytvořili filtr. Budete muset předat řetězec, který obsahuje CustomerSearchField, a označit typ operace filtru jako FieldFilterOperation. StartsWith. To je jediná operace filtru pole podporovaná koncovým bodem zákazníků. Také budete muset zadat řetězec, podle kterého se má filtrovat.

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

Nakonec, pokud chcete spustit filtr a získat výsledek, nejdřív použijte IAggregatePartner. zákazníci , aby získali rozhraní pro zákaznické operace partnera. Pak zavolejte dotaz nebo metodu 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: aplikace testů konzoly. Project: třída microsoft Partner SDK samples: FilterCustomers. cs

Žádost REST

Syntaxe žádosti

Metoda Identifikátor URI žádosti
Čtěte {baseURL}/v1/Customers? size = {size} &Filter = {Filter} HTTP/1.1

Parametry identifikátoru URI

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

Název Typ Vyžadováno Popis
size int No Počet výsledků, které se mají zobrazit v jednom okamžiku. Tento parametr je volitelný.
filter filter Yes Filtr, který se má použít pro zákazníky Musí se jednat o kódovaný řetězec.

Syntaxe filtru

Parametr Filter je nutné vytvořit jako řadu párů klíč-hodnota oddělené čárkami. Každý klíč a hodnota musí být jednotlivě kotované a oddělené dvojtečkou. Celý filtr musí být kódovaný.

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:

Klíč Hodnota
Pole Pole, které se má filtrovat Platné hodnoty najdete v CustomerSearchField.
Hodnota Hodnota, podle které se má filtrovat Případ hodnoty je ignorován.
Operátor Operátor, který se má použít Jediná podporovaná hodnota pro tento scénář zákazníka je "začíná na _ ".

Hlavičky požadavku

Další informace najdete v tématu záhlaví REST partnerského centra.

Text požadavku

Žádné

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

V případě úspěchu tato metoda vrátí kolekci vyhovujících zákaznických prostředků v těle odpovědi.

Úspěšné odpovědi a chybové kódy

Každá odpověď je dodávána se stavovým kódem HTTP, který označuje úspěch nebo selhání a další informace o ladění. Použijte nástroj pro trasování sítě ke čtení tohoto kódu, typu chyby a dalších parametrů. Úplný seznam najdete v tématu kódy chyb REST partnerského centra.

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