Condividi tramite


Manage customer accounts - Get customers

Recupera un segmento dei clienti di un partner. È anche possibile applicare filtri facoltativi per i clienti. I clienti possono essere filtrati solo in base a una stringa con cui inizia il nome della società o il nome di dominio. La ricerca completa non è attualmente supportata. I clienti possono essere filtrati usando un'operazione di filtro {Microsoft.Partner.Core.Query.Filters.FieldFilterOperation.StartsWith} e specificando: DisplayName (Nome società) o DefaultDomainName come campo filtro.

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}

Parametri dell'URI

Nome In Necessario Tipo Descrizione
version
path True

string

filter.operator
query

integer

int32
seekOperation
query

integer

int32

Operazione di ricerca.

size
query

integer

int32

Numero massimo di clienti da restituire.

Intestazione della richiesta

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

Nome Necessario Tipo Descrizione
Authorization True

string

Token di connessione dell'autorizzazione

ms-correlationid

string

Usato per tenere traccia delle richieste internamente. Se non viene specificato un ms-correlationid, il server genererà un nuovo elemento per ogni richiesta

ms-cv

string

Usato per tenere traccia delle richieste internamente. Se non viene specificata una ms-cv, il server genererà un nuovo per ogni richiesta

ms-requestid

string

Usato per l'idempotenza delle richieste. Se non viene specificato un ms-requestid, il server genererà un nuovo per ogni richiesta

Risposte

Nome Tipo Descrizione
200 OK

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

La richiesta ha avuto esito positivo. Il corpo della risposta contiene un elenco di clienti che corrispondono al filtro. Se la risposta viene inserita in pagine in base alle dimensioni della pagina, viene incluso un token di continuazione. Questo token può essere passato a /customers?seek= per cercare i risultati dei clienti.

Media Types: "application/json", "text/json"

Definizioni

Nome Descrizione
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
Nome Tipo Descrizione
body

string

headers

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

method

string

uri

string

Microsoft.Partner.Core.Collections.ResourceAttributes

Nome Tipo Descrizione
etag

string

objectType

string

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

Nome Tipo Descrizione
attributes

Microsoft.Partner.Core.Collections.ResourceAttributes

items

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

links

Microsoft.Partner.Core.Collections.ResourceLinks

totalCount

integer

Nome Tipo Descrizione
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

Nome Tipo Descrizione
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

Nome Tipo Descrizione
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

Nome Tipo Descrizione
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

Nome Tipo Descrizione
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

Nome Tipo Descrizione
password

System.Security.SecureString

userName

string

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

Nome Tipo Descrizione
key

string

value

string

System.Security.SecureString

Nome Tipo Descrizione
length

integer