Zkopírováno

/v1/Voucher/GetList

Načte seznam všech voucherů, které jsou definovány v systému. Pokud obchodník vouchery nepoužívá vrací vždy prázdnou kolekci.

Nutná oprávnění

Voucher_r

Požadavek

ObjectStateModifiedAfterListRequest
Název Popis Typ Další informace
ModifiedAfter

Datum, které určuje, že se mají vrátit jen záznamy upravené po tomto datu.

 unix time stamp

Nepovinné pole

OnlyPublic

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

 boolean
TimeStamp

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

 unix time stamp

Příklad požadavku

application/json

Ukázka 
{
  "ModifiedAfter": 1766617200,
  "OnlyPublic": true,
  "TimeStamp": 1769347013
}

Odpověď

Popis odpovědi

Načte seznam všech voucherů, které jsou definovány v systému. Pokud obchodník vouchery nepoužívá vrací vždy prázdnou kolekci.

ListResponseOfVoucherApiModel
Název Popis Typ Další informace
Items

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

 VoucherApiModel[]
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": [
    {
      "Name": "Poukaz",
      "Description": "Popisek",
      "PriceWithVat": 500.0,
      "VatRateNullable": 0.21,
      "ExpirationType": "AfterTime",
      "ExpirationDate": null,
      "ExpirationDuration": {
        "Unit": "Years",
        "Count": 1
      },
      "Type": "BookingService",
      "Items": [
        {
          "BookingServiceId": 112325,
          "PassId": null
        }
      ],
      "PercentageAmount": null,
      "CreditAmount": null,
      "State": "Public",
      "Id": 14589123
    }
  ],
  "IsError": false,
  "ErrorParameter": null,
  "ErrorMessage": null,
  "ErrorParameters": [],
  "ErrorMessages": []
}