Az ügyfelek listájának lekérése keresési mező alapján szűrve
A következőre vonatkozik: Partnerközpont | A 21Vianet által üzemeltetett Partnerközpont | Partnerközpont a Microsoft Cloud for US Government számára
Lekéri a szűrőnek megfelelő ügyfélerőforrások gyűjteményét. Igény szerint beállíthatja az oldalméretet. Szűrhet cégnév, tartomány, közvetett viszonteladó vagy közvetett felhőszolgáltató (CSP) alapján.
Előfeltételek
Hitelesítő adatok a Partnerközpont hitelesítésében leírtak szerint. Ez a forgatókönyv támogatja az önálló alkalmazással és az App+Felhasználói hitelesítő adatokkal való hitelesítést is.
Felhasználó által létrehozott szűrő.
C#
Ha egy szűrőnek megfelelő ügyfélgyűjteményt szeretne lekérni, először példányosítson egy SimpleFieldFilter objektumot a szűrő létrehozásához. Át kell adnia egy sztringet, amely tartalmazza a CustomerSearchFieldet, és a szűrőművelet típusát FieldFilterOperation.StartsWith néven kell megadnia. Ez az egyetlen mezőszűrő művelet, amelyet az ügyfelek végpontja támogat. Meg kell adnia a szűréshez szükséges sztringet is.
Ezután hozzon létre egy iQuery objektumot, amely a BuildSimpleQuery metódus meghívásával és a szűrő átadásával továbbítja a lekérdezésnek. A BuildSimplyQuery csak egyike a QueryFactory osztály által támogatott lekérdezéstípusoknak.
Végül a szűrő végrehajtásához és az eredmény lekéréséhez először használja az IAggregatePartner.Customers szolgáltatást a partner ügyfélműveleteinek felületének lekéréséhez. Ezután hívja meg a Query vagy QueryAsync metódust.
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);
Példa: Konzoltesztelő alkalmazás. Projekt: Partnerközpont SDK-minták osztálya: FilterCustomers.cs
REST-kérés
Kérés szintaxisa
| Metódus | Kérés URI-ja |
|---|---|
| GET | {baseURL}/v1/customers?size={size}&filter={filter} HTTP/1.1 |
URI-paraméterek
Használja a következő lekérdezési paramétereket.
| Name | Type | Kötelező | Leírás |
|---|---|---|---|
| Méret | egész | Nem | Az egyszerre megjelenítendő eredmények száma. Ez a paraméter nem kötelező. |
| szűrő | szűrő | Igen | Az ügyfelekre alkalmazandó szűrő. Ennek kódolt sztringnek kell lennie. |
Szűrőszintaxis
A szűrőparamétert vesszővel elválasztott, kulcs-érték párok sorozataként kell összeállítania. Minden kulcsot és értéket külön-külön kell idézni, és kettősponttal kell elválasztani. A teljes szűrőt kódolni kell.
Egy kódolatlan példa a következőképpen néz ki:
?filter{"Field":"CompanyName","Value":"cont","Operator":"starts_with"}
Az alábbi táblázat a szükséges kulcs-érték párokat ismerteti:
Kérésfejlécek
További információ: Partnerközpont – REST fejlécek.
Kérés törzse
Nincs.
Példa kérése
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: aaaa0000-bb11-2222-33cc-444444dddddd
X-Locale: en-US
Host: api.partnercenter.microsoft.com
Connection: Keep-Alive
REST-válasz
Ha sikeres, ez a metódus egy egyező ügyfélerőforrás-gyűjteményt ad vissza a válasz törzsében.
Válasz sikeresség és hibakódok
Minden válaszhoz tartozik egy HTTP-állapotkód, amely jelzi a sikert vagy a hibát, valamint további hibakeresési információkat. A kód, a hibatípus és a további paraméterek olvasásához használjon hálózati nyomkövetési eszközt. A teljes listát a Partnerközpont REST-hibakódjaiban találja.
Példa válaszra
HTTP/1.1 200 OK
Content-Length: 1839
Content-Type: application/json; charset=utf-8
MS-CorrelationId: aaaa0000-bb11-2222-33cc-444444dddddd
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": "aaaabbbb-0000-cccc-1111-dddd2222eeee",
"companyProfile": {
"tenantId": "aaaabbbb-0000-cccc-1111-dddd2222eeee",
"domain": "contoso190.onmicrosoft.com",
"companyName": "Contoso190",
"links": {
"self": {
"uri": "/customers/aaaabbbb-0000-cccc-1111-dddd2222eeee/profiles/company",
"method": "GET",
"headers": []
}
},
"attributes": {
"objectType": "CustomerCompanyProfile"
}
},
"relationshipToPartner": "reseller",
"links": {
"self": {
"uri": "/customers/aaaabbbb-0000-cccc-1111-dddd2222eeee",
"method": "GET",
"headers": []
}
},
"attributes": {
"objectType": "Customer"
}
}, {
"id": "bbbbcccc-1111-dddd-2222-eeee3333ffff",
"companyProfile": {
"tenantId": "bbbbcccc-1111-dddd-2222-eeee3333ffff",
"domain": "ContosoCorpCo.onmicrosoft.com",
"companyName": "Contoso",
"links": {
"self": {
"uri": "/customers/bbbbcccc-1111-dddd-2222-eeee3333ffff/profiles/company",
"method": "GET",
"headers": []
}
},
"attributes": {
"objectType": "CustomerCompanyProfile"
}
},
"relationshipToPartner": "reseller",
"links": {
"self": {
"uri": "/customers/bbbbcccc-1111-dddd-2222-eeee3333ffff",
"method": "GET",
"headers": []
}
},
"attributes": {
"objectType": "Customer"
}
}, {
"id": "ccccdddd-2222-eeee-3333-ffff4444aaaa",
"companyProfile": {
"tenantId": "ccccdddd-2222-eeee-3333-ffff4444aaaa",
"domain": "contosocorpdemo.onmicrosoft.com",
"companyName": "Contoso",
"links": {
"self": {
"uri": "/customers/ccccdddd-2222-eeee-3333-ffff4444aaaa/profiles/company",
"method": "GET",
"headers": []
}
},
"attributes": {
"objectType": "CustomerCompanyProfile"
}
},
"relationshipToPartner": "reseller",
"links": {
"self": {
"uri": "/customers/ccccdddd-2222-eeee-3333-ffff4444aaaa",
"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"
}
}