Manage customer accounts - Get customers

Usługa:

Partner Center Rest

Wersja interfejsu API:

v1

Pobiera segment klientów partnera. Można również zastosować opcjonalne filtrowanie klientów. Klienci mogą być filtrowani tylko według ciągu, od którego zaczyna się nazwa firmy lub nazwa domeny. Wyszukiwanie pełne nie jest obecnie obsługiwane. Klienci mogą być filtrowani przy użyciu operacji filtru {Microsoft.Partner.Core.Query.Filters.FieldFilterOperation.StartsWith} i określając: DisplayName (nazwa firmy) lub DefaultDomainName jako pole filtru.

GET https://api.partnercenter.microsoft.com/v{version}/customers

Z parametrami opcjonalnymi:

GET https://api.partnercenter.microsoft.com/v{version}/customers?seekOperation={seekOperation}&size={size}&filter.operator={filter.operator}

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
version	path	True	string
filter.operator	query		integer int32
seekOperation	query		integer int32	Operacja wyszukiwania.
size	query		integer int32	Maksymalna liczba klientów do zwrócenia.

Nagłówek żądania

Media Types: "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded"

Nazwa	Wymagane	Typ	Opis
Authorization	True	string	Token elementu nośnego autoryzacji
ms-correlationid		string	Służy do śledzenia żądań wewnętrznie. Jeśli nie podano identyfikatora ms-correlationid, serwer wygeneruje nowy dla każdego żądania
ms-cv		string	Służy do śledzenia żądań wewnętrznie. Jeśli nie podano ms-cv, serwer wygeneruje nowy dla każdego żądania
ms-requestid		string	Służy do idempotentności żądań. Jeśli nie podano identyfikatora ms-requestid, serwer wygeneruje nowy dla każdego żądania

Odpowiedzi

Nazwa	Typ	Opis
200 OK	Microsoft.Partner.Core.Collections.ResourceCollection[Microsoft.Partner.Service.Customers.Contracts.V1.Customer]	Żądanie zakończyło się pomyślnie. Treść odpowiedzi zawiera listę klientów pasujących do filtru. Token kontynuacji jest dołączany, jeśli odpowiedź jest stronicowana według rozmiaru strony. Ten token można przekazać do /customers?seek= w celu wyszukiwania wyników klientów. Media Types: "application/json", "text/json"

Definicje

Nazwa	Opis
Microsoft.Partner.Core.Collections.Link
Microsoft.Partner.Core.Collections.ResourceAttributes
Microsoft.Partner.Core.Collections.ResourceCollection[Microsoft.Partner.Service.Customers.Contracts.V1.Customer]
Microsoft.Partner.Core.Collections.ResourceLinks
Microsoft.Partner.Service.Customers.Contracts.V1.Address
Microsoft.Partner.Service.Customers.Contracts.V1.Customer
Microsoft.Partner.Service.Customers.Contracts.V1.CustomerBillingProfile
Microsoft.Partner.Service.Customers.Contracts.V1.CustomerCompanyProfile
Microsoft.Partner.Service.Customers.Contracts.V1.UserCredentials
System.Collections.Generic.KeyValuePair[System.String,System.String]
System.Security.SecureString

Microsoft.Partner.Core.Collections.Link

Nazwa	Typ	Opis
body	string
headers	System.Collections.Generic.KeyValuePair[System.String,System.String][]
method	string
uri	string

Microsoft.Partner.Core.Collections.ResourceAttributes

Nazwa	Typ	Opis
etag	string
objectType	string

Microsoft.Partner.Core.Collections.ResourceCollection[Microsoft.Partner.Service.Customers.Contracts.V1.Customer]

Nazwa	Typ	Opis
attributes	Microsoft.Partner.Core.Collections.ResourceAttributes
items	Microsoft.Partner.Service.Customers.Contracts.V1.Customer[]
links	Microsoft.Partner.Core.Collections.ResourceLinks
totalCount	integer

Microsoft.Partner.Core.Collections.ResourceLinks

Nazwa	Typ	Opis
next	Microsoft.Partner.Core.Collections.Link
previous	Microsoft.Partner.Core.Collections.Link
self	Microsoft.Partner.Core.Collections.Link

Microsoft.Partner.Service.Customers.Contracts.V1.Address

Nazwa	Typ	Opis
addressLine1	string
addressLine2	string
addressLine3	string
city	string
country	string
district	string
emailAddress	string
firstName	string
id	string
lastName	string
middleName	string
phoneNumber	string
postalCode	string
region	string
state	string

Microsoft.Partner.Service.Customers.Contracts.V1.Customer

Nazwa	Typ	Opis
allowDelegatedAccess	boolean
associatedPartnerId	string
attributes	Microsoft.Partner.Core.Collections.ResourceAttributes
billingProfile	Microsoft.Partner.Service.Customers.Contracts.V1.CustomerBillingProfile
commerceId	string
companyProfile	Microsoft.Partner.Service.Customers.Contracts.V1.CustomerCompanyProfile
customDomains	string[]
id	string
links	Microsoft.Partner.Core.Collections.ResourceLinks
relationshipToPartner	enum: advisor microsoft_support none reseller syndication unknown
userCredentials	Microsoft.Partner.Service.Customers.Contracts.V1.UserCredentials

Microsoft.Partner.Service.Customers.Contracts.V1.CustomerBillingProfile

Nazwa	Typ	Opis
attributes	Microsoft.Partner.Core.Collections.ResourceAttributes
companyName	string
culture	string
defaultAddress	Microsoft.Partner.Service.Customers.Contracts.V1.Address
email	string
firstName	string
id	string
language	string
lastName	string
links	Microsoft.Partner.Core.Collections.ResourceLinks

Microsoft.Partner.Service.Customers.Contracts.V1.CustomerCompanyProfile

Nazwa	Typ	Opis
address	Microsoft.Partner.Service.Customers.Contracts.V1.Address
attributes	Microsoft.Partner.Core.Collections.ResourceAttributes
companyName	string
domain	string
email	string
links	Microsoft.Partner.Core.Collections.ResourceLinks
organizationRegistrationNumber	string
tenantId	string

Microsoft.Partner.Service.Customers.Contracts.V1.UserCredentials

Nazwa	Typ	Opis
password	System.Security.SecureString
userName	string

System.Collections.Generic.KeyValuePair[System.String,System.String]

Nazwa	Typ	Opis
key	string
value	string

System.Security.SecureString

Nazwa	Typ	Opis
length	integer