Voucher API

version v1           https://api.voucher.majales.cz.lynx.ocean.nen.cz/v1

/vouchers


POST https://api.voucher.majales.cz.lynx.ocean.nen.cz/v1/vouchers

Vytvoření voucheru

JSON Parameters

Parameter Type Required Description
project string Yes Projekt, ze kterého voucher vznikne (MAJALES || UTUBERING)
price integer Yes Hodnota voucheru
ticketType string Typ vstupenky (ETICKET || COD || PAPER), výchozí hodnota ETICKET
idOrder integer ID objednávky, ze které voucher pochází (neuvádí se pro ticketType=PAPER)
idOrderItem integer ID vstupenky, ze které voucher pochází (neuvádí se pro ticketType=PAPER)
idOrderPaperToVoucher integer ID objednávky vratky papírových vstupenek za voucher (povinné pro ticketType=PAPER)
paperTicketId string Číslo papírové vstupenky (povinné pro ticketType=COD a ticketType=PAPER)
refundName string Jméno toho, kdo vrátil papírovou vstupenku

Example:

{
  "project": "MAJALES",
  "price": 500,
  "idOrder": 20,
  "idOrderItem": 50
}

{
  "project": "MAJALES",
  "price": 500,
  "ticketType": "PAPER",
  "paperTicketId": "123456789",
  "refundName": "Jan Novák"
}

Response

201:

Property Type Description
number string Kód voucheru
project string Projekt, ze kterého voucher vznikl (MAJALES || UTUBERING)
price integer Hodnota voucheru
ticketType string Typ vstupenky (ETICKET || COD || PAPER)
idOrder integer ID objednávky, ze které voucher pochází
idOrderItem integer ID vstupenky, ze které voucher pochází
idOrderPaperToVoucher integer ID objednávky vratky papírových vstupenek za voucher (povinné pro ticketType=PAPER)
paperTicketId string Číslo papírové vstupenky (neuvádí se pro ticketType=ETICKET)
refundName string Jméno toho, kdo vrátil papírovou vstupenku

application/json

{
  "data": {
    "number": "ABDH568445",
    "project": "MAJALES",
    "price": 500,
    "ticketType": "ETICKET",
    "idOrder": 20,
    "idOrderItem": 50,
    "paperTicketId": null,
    "refundName": null
  },
  "success": true,
  "status": 201
}

 

404:

application/json

{
  "message": "Voucher already exists",
  "code": 1,
  "success": false,
  "status": 404
}

{
  "message": "Database error",
  "code": 2,
  "success": false,
  "status": 404
}

 

Other Endpoint Actions

DELETE
GET