רשימת לקוחות

company (המכונה לקוח) מייצג ארגון ייחודי עם חשבון דרך הארגון. בשיטה הזו רשומים לקוחות שמשויכים לחשבון המפיץ שלכם.

חתימת שיטה

public ListCustomersResponse listCustomers(ListCustomersRequest request)  throws CommonException;

בקשה של רשימת לקוחות

שם הנכס ערך נדרש תיאור
pageSize int לא גודל הדף, עד 100. אם הגודל הוא 100 או null, ייעשה שימוש ב-100.
pageToken string לא אסימון הדף. אם הדף ריק, המערכת מחזירה את הדף הראשון.
vendorParams map לא שדות נוספים, צמד מפתח/ערך שצוין על ידי הספק.

תשובה – רשימת לקוחות

שם הנכס ערך תיאור
customers רשימה של object(Company) רשימת הלקוחות המשויכים למפיץ.
totalCount int המספר הכולל של מכשירים התואמים לבקשה.
nextPageToken strong האסימון של הדף הבא. ריק עבור הדף האחרון.
vendorParams map שדות נוספים, צמד מפתח/ערך שצוין על ידי הספק.

התנהגות השגיאה

אם מתרחשת שגיאה, בספרייה כתוב CommonException שמכיל את אחד מקודי השגיאה הבאים:

קוד שגיאה
INTERNAL_SERVER_ERROR
INVALID_PAGE_TOKEN