Manage customer accounts - Get customers
Ruft ein Segment der Kunden eines Partners ab. Optionale Filterung von Kunden kann auch angewendet werden. Kunden können nur nach einer Zeichenfolge gefiltert werden, mit der ihr Firmenname oder Domänenname beginnt. Die vollständige Suche wird derzeit nicht unterstützt. Kunden können mithilfe eines {Microsoft.Partner.Core.Query.Filters.FieldFilterOperation.StartsWith}-Filtervorgangs gefiltert werden und entweder: DisplayName (Firmenname) oder DefaultDomainName als Filterfeld angeben.
GET https://api.partnercenter.microsoft.com/v{version}/customersGET https://api.partnercenter.microsoft.com/v{version}/customers?seekOperation={seekOperation}&size={size}&filter.operator={filter.operator}URI-Parameter
| Name | In | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
version
|
path | True |
string |
|
|
filter.
|
query |
integer int32 |
||
|
seek
|
query |
integer int32 |
Der Suchvorgang. |
|
|
size
|
query |
integer int32 |
Die maximale Anzahl von Kunden, die zurückgegeben werden sollen. |
Anforderungsheader
Media Types: "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded"
| Name | Erforderlich | Typ | Beschreibung |
|---|---|---|---|
| Authorization | True |
string |
Autorisierungs-Bearertoken |
| ms-correlationid |
string |
Wird intern zum Nachverfolgen von Anforderungen verwendet. Wenn keine ms-correlationid angegeben wird, generiert der Server für jede Anforderung eine neue. |
|
| ms-cv |
string |
Wird intern zum Nachverfolgen von Anforderungen verwendet. Wenn kein ms-cv bereitgestellt wird, generiert der Server für jede Anforderung eine neue. |
|
| ms-requestid |
string |
Wird für die Idempotenz von Anforderungen verwendet. Wenn keine ms-requestid angegeben wird, generiert der Server für jede Anforderung eine neue anforderung. |
Antworten
| Name | Typ | Beschreibung |
|---|---|---|
| 200 OK |
Die Anforderung war erfolgreich. Der Antworttext enthält eine Liste der Kunden, die dem Filter entsprechen. Ein Fortsetzungstoken ist enthalten, wenn die Antwort von der Seitengröße ausgelagert wird. Dieses Token kann an /customers?seek= übergeben werden, um Kundenergebnisse zu suchen. Media Types: "application/json", "text/json" |
Definitionen
Microsoft.Partner.Core.Collections.Link
| Name | Typ | Beschreibung |
|---|---|---|
| body |
string |
|
| headers |
System. |
|
| method |
string |
|
| uri |
string |
Microsoft.Partner.Core.Collections.ResourceAttributes
| Name | Typ | Beschreibung |
|---|---|---|
| etag |
string |
|
| objectType |
string |
Microsoft.Partner.Core.Collections.ResourceCollection[Microsoft.Partner.Service.Customers.Contracts.V1.Customer]
| Name | Typ | Beschreibung |
|---|---|---|
| attributes | ||
| items | ||
| links | ||
| totalCount |
integer |
Microsoft.Partner.Core.Collections.ResourceLinks
| Name | Typ | Beschreibung |
|---|---|---|
| next | ||
| previous | ||
| self |
Microsoft.Partner.Service.Customers.Contracts.V1.Address
| Name | Typ | Beschreibung |
|---|---|---|
| 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 | Beschreibung |
|---|---|---|
| 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 | Beschreibung |
|---|---|---|
| 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 | Beschreibung |
|---|---|---|
| address | ||
| attributes | ||
| companyName |
string |
|
| domain |
string |
|
|
string |
||
| links | ||
| organizationRegistrationNumber |
string |
|
| tenantId |
string |
Microsoft.Partner.Service.Customers.Contracts.V1.UserCredentials
| Name | Typ | Beschreibung |
|---|---|---|
| password | ||
| userName |
string |
System.Collections.Generic.KeyValuePair[System.String,System.String]
| Name | Typ | Beschreibung |
|---|---|---|
| key |
string |
|
| value |
string |
System.Security.SecureString
| Name | Typ | Beschreibung |
|---|---|---|
| length |
integer |