Manage customer accounts - Get customers
Načte segment zákazníků partnera. Můžete také použít volitelné filtrování zákazníků. Zákazníci můžou filtrovat jenom podle řetězce, na kterém začíná název společnosti nebo název domény. Úplné vyhledávání se v současné době nepodporuje. Zákazníci je možné filtrovat pomocí operace filtru {Microsoft.Partner.Core.Query.Filters.FieldFilterOperation.StartsWith} a jako pole filtru zadat buď DisplayName (Název společnosti), nebo DefaultDomainName.
GET https://api.partnercenter.microsoft.com/v{version}/customers
GET https://api.partnercenter.microsoft.com/v{version}/customers?seekOperation={seekOperation}&size={size}&filter.operator={filter.operator}
Parametry identifikátoru URI
Name | V | Vyžadováno | Typ | Description |
---|---|---|---|---|
version
|
path | True |
string |
|
filter.
|
query |
integer int32 |
||
seek
|
query |
integer int32 |
Operace hledání. |
|
size
|
query |
integer int32 |
Maximální počet zákazníků, kteří se mají vrátit. |
Hlavička požadavku
Media Types: "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded"
Name | Vyžadováno | Typ | Description |
---|---|---|---|
Authorization | True |
string |
Autorizační nosný token |
ms-correlationid |
string |
Používá se pro interní sledování požadavků. Pokud není zadaný parametr ms-correlationid, server pro každý požadavek vygeneruje nový. |
|
ms-cv |
string |
Používá se pro interní sledování požadavků. Pokud není zadaný ms-cv, server pro každý požadavek vygeneruje nový. |
|
ms-requestid |
string |
Používá se k idempotenci požadavků. Pokud není zadaný identifikátor ms-requestid, server pro každý požadavek vygeneruje nový. |
Odpovědi
Name | Typ | Description |
---|---|---|
200 OK |
Požadavek byl úspěšný. Text odpovědi obsahuje seznam zákazníků, kteří odpovídají filtru. Pokud je odpověď stránkovaná podle velikosti stránky, zahrne se token pro pokračování. Tento token lze předat /customers?seek= k vyhledání výsledků zákazníků. Media Types: "application/json", "text/json" |
Definice
Microsoft.Partner.Core.Collections.Link
Name | Typ | Description |
---|---|---|
body |
string |
|
headers |
System. |
|
method |
string |
|
uri |
string |
Microsoft.Partner.Core.Collections.ResourceAttributes
Name | Typ | Description |
---|---|---|
etag |
string |
|
objectType |
string |
Microsoft.Partner.Core.Collections.ResourceCollection[Microsoft.Partner.Service.Customers.Contracts.V1.Customer]
Name | Typ | Description |
---|---|---|
attributes | ||
items | ||
links | ||
totalCount |
integer |
Microsoft.Partner.Core.Collections.ResourceLinks
Name | Typ | Description |
---|---|---|
next | ||
previous | ||
self |
Microsoft.Partner.Service.Customers.Contracts.V1.Address
Name | Typ | Description |
---|---|---|
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
Name | Typ | Description |
---|---|---|
allowDelegatedAccess |
boolean |
|
associatedPartnerId |
string |
|
attributes | ||
billingProfile |
Microsoft. |
|
commerceId |
string |
|
companyProfile |
Microsoft. |
|
customDomains |
string[] |
|
id |
string |
|
links | ||
relationshipToPartner |
enum:
|
|
userCredentials |
Microsoft. |
Microsoft.Partner.Service.Customers.Contracts.V1.CustomerBillingProfile
Name | Typ | Description |
---|---|---|
attributes | ||
companyName |
string |
|
culture |
string |
|
defaultAddress | ||
string |
||
firstName |
string |
|
id |
string |
|
language |
string |
|
lastName |
string |
|
links |
Microsoft.Partner.Service.Customers.Contracts.V1.CustomerCompanyProfile
Name | Typ | Description |
---|---|---|
address | ||
attributes | ||
companyName |
string |
|
domain |
string |
|
string |
||
links | ||
organizationRegistrationNumber |
string |
|
tenantId |
string |
Microsoft.Partner.Service.Customers.Contracts.V1.UserCredentials
Name | Typ | Description |
---|---|---|
password | ||
userName |
string |
System.Collections.Generic.KeyValuePair[System.String,System.String]
Name | Typ | Description |
---|---|---|
key |
string |
|
value |
string |
System.Security.SecureString
Name | Typ | Description |
---|---|---|
length |
integer |