Zkopírováno

/v1/Segment/GetList

Načte seznam všech zaměření od právě přihlášeného obchodníka.

Nutná oprávnění

Segment_r

Požadavek

PagedObjectStateListRequest
Název Popis Typ Další informace
OnlyPublic

Označuje, zda-li se mají získat pouze veřejné (tj. jsou viditelné zákazníky) objekty.

 boolean
Page

Číslo stránky (od 1) pro stránkování výsledků.

 integer

Povinný údaj

PageSize

Počet záznamů na stránku (1 až 100) pro stránkování výsledků.

 integer

Povinný údaj

TimeStamp

Datum a čas prováděného dotazu

 unix time stamp

Příklad požadavku

application/json

Ukázka 
{
  "OnlyPublic": true,
  "Page": 1,
  "PageSize": 20,
  "TimeStamp": 1793189633
}

Odpověď

Popis odpovědi

Načte seznam všech zaměření od právě přihlášeného obchodníka.

ListResponseOfSegmentApiModel
Název Popis Typ Další informace
Items

Navrácená kolekce objektů vyhovující dotazu.

 SegmentApiModel[]
ErrorMessage

Chybová hláška doplňující chybu (např. pro debug).

 string
ErrorMessages

Pole chybových hlášek. Pokud vznikla jen 1 chyba, tak je tu jen 1 chybová hláška.

 string[]
ErrorParameter

Případný chybně zadaný parametr v požadavku.

 string
ErrorParameters

Pole chybně zadaných parametrů. Pokud je chybný jen 1 parametr, tak je tu jen 1.

 string[]
IsError

Indikuje, zda vznikla chyba.

 boolean

Příklad odpovědi

application/json

Ukázka 
{
  "Items": [
    {
      "SegmentType": "OneToOne",
      "InternalName": "Massages",
      "LocalizedName": "Masáže",
      "CustomizedName": null,
      "State": "Public",
      "Id": 1011
    }
  ],
  "IsError": false,
  "ErrorParameter": null,
  "ErrorMessage": null,
  "ErrorParameters": [],
  "ErrorMessages": []
}