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.
|
query |
integer int32 |
||
seek
|
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 |
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
Microsoft.Partner.Core.Collections.Link
Nome | Tipo | Descrizione |
---|---|---|
body |
string |
|
headers |
System. |
|
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 | ||
items | ||
links | ||
totalCount |
integer |
Microsoft.Partner.Core.Collections.ResourceLinks
Nome | Tipo | Descrizione |
---|---|---|
next | ||
previous | ||
self |
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 | ||
billingProfile |
Microsoft. |
|
commerceId |
string |
|
companyProfile |
Microsoft. |
|
customDomains |
string[] |
|
id |
string |
|
links | ||
relationshipToPartner |
enum:
|
|
userCredentials |
Microsoft. |
Microsoft.Partner.Service.Customers.Contracts.V1.CustomerBillingProfile
Nome | Tipo | Descrizione |
---|---|---|
attributes | ||
companyName |
string |
|
culture |
string |
|
defaultAddress | ||
string |
||
firstName |
string |
|
id |
string |
|
language |
string |
|
lastName |
string |
|
links |
Microsoft.Partner.Service.Customers.Contracts.V1.CustomerCompanyProfile
Nome | Tipo | Descrizione |
---|---|---|
address | ||
attributes | ||
companyName |
string |
|
domain |
string |
|
string |
||
links | ||
organizationRegistrationNumber |
string |
|
tenantId |
string |
Microsoft.Partner.Service.Customers.Contracts.V1.UserCredentials
Nome | Tipo | Descrizione |
---|---|---|
password | ||
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 |