Mendapatkan daftar pelanggan yang difilter menurut bidang pencarian

Artikel
01/10/2024

Berlaku untuk: Pusat Mitra | Pusat Mitra yang dioperasikan oleh 21Vianet | Pusat Mitra untuk Microsoft Cloud untuk Pemerintah AS

Mendapatkan kumpulan sumber daya Pelanggan yang cocok dengan filter. Anda dapat secara opsional mengatur ukuran halaman. Anda dapat memfilter menurut nama perusahaan, domain, penjual tidak langsung, atau penyedia solusi cloud tidak langsung (CSP).

Prasyarat

Kredensial seperti yang dijelaskan dalam autentikasi Pusat Mitra. Skenario ini mendukung autentikasi dengan kredensial Aplikasi mandiri dan Aplikasi+Pengguna.
Filter yang dibangun pengguna.

C#

Untuk mendapatkan koleksi pelanggan yang cocok dengan filter, pertama-tama buat objek SimpleFieldFilter untuk membuat filter. Anda harus meneruskan string yang berisi CustomerSearchField, dan menunjukkan jenis operasi filter sebagai FieldFilterOperation.StartsWith. Itulah satu-satunya operasi filter bidang yang didukung oleh titik akhir pelanggan. Anda juga harus menyediakan string untuk difilter.

Selanjutnya, buat instans objek iQuery untuk diteruskan ke kueri dengan memanggil metode BuildSimpleQuery dan meneruskannya filter. BuildSimplyQuery hanyalah salah satu jenis kueri yang didukung oleh kelas QueryFactory.

Terakhir, untuk menjalankan filter dan mendapatkan hasilnya, pertama-tama gunakan IAggregatePartner.Customers untuk mendapatkan antarmuka ke operasi pelanggan mitra. Kemudian panggil metode Query atau 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);

Sampel: Aplikasi pengujian konsol. Proyek: Kelas Sampel SDK Pusat Mitra: FilterCustomers.cs

Permintaan REST

Minta sintaks

Metode	URI Permintaan
DAPATKAN	{baseURL}/v1/customers?size={size}&filter={filter} HTTP/1.1

Parameter URI

Gunakan parameter kueri berikut.

Nama	Jenis	Wajib	Deskripsi
size	int	No	Jumlah hasil yang akan ditampilkan pada satu waktu. Parameter ini bersifat opsional.
filter	filter	Ya	Filter untuk diterapkan kepada pelanggan. Ini harus berupa string yang dikodekan.

Sintaks Filter

Anda harus menyusun parameter filter sebagai serangkaian pasangan nilai kunci yang dipisahkan koma. Setiap kunci dan nilai harus dikutip secara individual dan dipisahkan oleh titik dua. Seluruh filter harus dikodekan.

Contoh yang tidak dikodekan terlihat seperti ini:

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

Tabel berikut ini menjelaskan pasangan kunci-nilai yang diperlukan:

Tombol	Nilai
Bidang	Bidang yang akan difilter. Nilai yang valid dapat ditemukan di CustomerSearchField.
Value	Nilai yang akan difilter. Kasus nilai diabaikan.
Operator	Operator yang akan diterapkan. Satu-satunya nilai yang didukung untuk skenario pelanggan ini adalah "starts_with".

Header permintaan

Untuk informasi selengkapnya, lihat Header REST Pusat Mitra.

Isi permintaan

Tidak ada.

Contoh permintaan

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

Respons REST

Jika berhasil, metode ini mengembalikan kumpulan sumber daya Pelanggan yang cocok dalam isi respons.

Kode kesalahan dan keberhasilan respons

Setiap respons dilengkapi dengan kode status HTTP yang menunjukkan keberhasilan atau kegagalan dan informasi penelusuran kesalahan tambahan. Gunakan alat pelacakan jaringan untuk membaca kode ini, jenis kesalahan, dan parameter tambahan. Untuk daftar lengkapnya, lihat Kode kesalahan REST Pusat Mitra.

Contoh tanggapan

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

Bagikan melalui