Manage customer accounts - Get customers
Lekéri a partner ügyfeleinek egy szegmensét. Az ügyfelek választható szűrése is alkalmazható. Az ügyfelek csak olyan sztring alapján szűrhetők, amellyel a vállalat vagy a tartománynév kezdődik. A teljes keresés jelenleg nem támogatott. Az ügyfelek {Microsoft használatával szűrhetők. Partner.Core.Query.Filters.FieldFilterOperation.StartsWith} szűrőművelet, és a következőt adja meg: DisplayName (Cégnév) vagy DefaultDomainName szűrőmezőként.
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}
URI-paraméterek
Name | In | Kötelező | Típus | Description |
---|---|---|---|---|
version
|
path | True |
string |
|
filter.
|
query |
integer int32 |
||
seek
|
query |
integer int32 |
A keresési művelet. |
|
size
|
query |
integer int32 |
A visszaadni kívánt ügyfelek maximális száma. |
Kérelem fejléce
Media Types: "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded"
Name | Kötelező | Típus | Description |
---|---|---|---|
Authorization | True |
string |
Engedélyezési tulajdonos jogkivonata |
ms-correlationid |
string |
A kérések belső nyomon követésére szolgál. Ha nincs megadva ms-correlationid, a kiszolgáló minden kéréshez létrehoz egy újat |
|
ms-cv |
string |
A kérések belső nyomon követésére szolgál. Ha nincs megadva ms-cv, a kiszolgáló minden kéréshez létrehoz egy újat |
|
ms-requestid |
string |
A kérések idempotensségéhez használatos. Ha nincs megadva ms-requestid, a kiszolgáló minden kéréshez létrehoz egy újat |
Válaszok
Name | Típus | Description |
---|---|---|
200 OK |
A kérés sikeres volt. A válasz törzse a szűrőnek megfelelő ügyfelek listáját tartalmazza. A rendszer egy folytatási jogkivonatot is tartalmaz, ha a válasz oldalmérete alapján lapozott. Ez a jogkivonat átadható a /customers?seek= címre az ügyfelek eredményeinek kereséséhez. Media Types: "application/json", "text/json" |
Definíciók
Microsoft.Partner.Core.Collections.Link
Name | Típus | Description |
---|---|---|
body |
string |
|
headers |
System. |
|
method |
string |
|
uri |
string |
Microsoft.Partner.Core.Collections.ResourceAttributes
Name | Típus | Description |
---|---|---|
etag |
string |
|
objectType |
string |
Microsoft.Partner.Core.Collections.ResourceCollection[Microsoft.Partner.Service.Customers.Contracts.V1.Customer]
Name | Típus | Description |
---|---|---|
attributes | ||
items | ||
links | ||
totalCount |
integer |
Microsoft.Partner.Core.Collections.ResourceLinks
Name | Típus | Description |
---|---|---|
next | ||
previous | ||
self |
Microsoft.Partner.Service.Customers.Contracts.V1.Address
Name | Típus | 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 | Típus | 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 | Típus | 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 | Típus | Description |
---|---|---|
address | ||
attributes | ||
companyName |
string |
|
domain |
string |
|
string |
||
links | ||
organizationRegistrationNumber |
string |
|
tenantId |
string |
Microsoft.Partner.Service.Customers.Contracts.V1.UserCredentials
Name | Típus | Description |
---|---|---|
password | ||
userName |
string |
System.Collections.Generic.KeyValuePair[System.String,System.String]
Name | Típus | Description |
---|---|---|
key |
string |
|
value |
string |
System.Security.SecureString
Name | Típus | Description |
---|---|---|
length |
integer |