Manage customer accounts - Get customers

Service:

Partner Center Rest

API-versie:

v1

Hiermee haalt u een segment van de klanten van een partner op. Optioneel filteren van klanten kan ook worden toegepast. Klanten kunnen alleen worden gefilterd op een tekenreeks waarmee hun bedrijfsnaam of domeinnaam begint. Volledige zoekopdracht wordt momenteel niet ondersteund. Klanten kunnen worden gefilterd met behulp van een filterbewerking van {Microsoft.Partner.Core.Query.Filters.FieldFilterOperation.StartsWith}, en het opgeven van: DisplayName (bedrijfsnaam) of DefaultDomainName als filterveld.

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

Met optionele parameters:

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

URI-parameters

Name	In	Vereist	Type	Description
version	path	True	string
filter.operator	query		integer int32
seekOperation	query		integer int32	De zoekbewerking.
size	query		integer int32	Het maximum aantal klanten dat moet worden geretourneerd.

Aanvraagkoptekst

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

Name	Vereist	Type	Description
Authorization	True	string	Bearer-token voor autorisatie
ms-correlationid		string	Wordt intern gebruikt voor het bijhouden van aanvragen. Als er geen ms-correlationid is opgegeven, genereert de server een nieuwe voor elke aanvraag
ms-cv		string	Wordt intern gebruikt voor het bijhouden van aanvragen. Als er geen ms-cv is opgegeven, genereert de server een nieuwe voor elke aanvraag
ms-requestid		string	Wordt gebruikt voor idempotentie van aanvragen. Als er geen ms-requestid is opgegeven, genereert de server een nieuwe voor elke aanvraag

Antwoorden

Name	Type	Description
200 OK	Microsoft.Partner.Core.Collections.ResourceCollection[Microsoft.Partner.Service.Customers.Contracts.V1.Customer]	De aanvraag is geslaagd. De hoofdtekst van het antwoord bevat een lijst met klanten die overeenkomen met het filter. Er wordt een vervolgtoken opgenomen als het antwoord wordt gepaginad door het paginaformaat. Dit token kan worden doorgegeven aan /customers?seek= om klantresultaten te zoeken. Media Types: "application/json", "text/json"

Definities

Name	Description
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

Object

Name	Type	Description
body	string
headers	System.Collections.Generic.KeyValuePair[System.String,System.String][]
method	string
uri	string

Microsoft.Partner.Core.Collections.ResourceAttributes

Object

Name	Type	Description
etag	string
objectType	string

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

Object

Name	Type	Description
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

Object

Name	Type	Description
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

Object

Name	Type	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

Object

Name	Type	Description
allowDelegatedAccess	bool?
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

Object

Name	Type	Description
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

Object

Name	Type	Description
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

Object

Name	Type	Description
password	System.Security.SecureString
userName	string

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

Object

Name	Type	Description
key	string
value	string

System.Security.SecureString

Object

Name	Type	Description
length	integer