פעולות - couponType_listCoupons


פעולה זו מחזירה את כל הקופונים שנוצרו במערכת עבור סוג קופון המבוקש.


פרמטרים

פרמטר

סוג

תיאור

פרמטרי חובה

לפירוט

id

unsigned long long

מזהה סוג הקופון המבוקש


בקשה לדוגמא: https://www.tixwise.co.il/he/api.xml?USER=tix@tixwise.co.il&PASS=123456&TOKEN=tok&VERSION=1.0 &ACTION=couponType_listCoupons&id=8491


תגובת השרת

השרת מחזיר את כל הקופונים השייכים לסוג הקופון המבוקש, התגובה תחזור בתוך שדה ה- RESPONSE. במידה ונכשלה הפעולה, יוחזר ACK שלילי והסבר לכישלון ישלח בשדה RESPONSE. התגובה מוגדרת באמצעות הסכימה הבאה: couponType_listCoupons.xsd
להלן מבנה רשימת הקופונים:

פרמטר

סוג

תיאור

couponType_listCoupons

Collection

רשימת הקופונים השייכים לסוג זה, מכיל 0-n אלמנטים מסוג CouponItem


מבנה CouponItem

פרמטר

סוג

תיאור

id

unsigned long long

מזהה הקופון

code

string

קוד הקופון

is_delivered

bool

האם חולק הקופון

status

enum

סטטוס הקופון, האם עדיין פעיל



תגובת XML לדוגמא:

<?xml version="1.0" encoding="UTF-8"?>
<tixwise_response>
  <ACK>SUCESS</ACK>
  <VERSION>1.0</VERSION>
  <RESPONSE>
    <couponType_listCoupons>
      <CouponItem>
        <id>24</id>
        <coupon_type_id>1</coupon_type_id>
        <code>60810721</code>
        <status>COUPON_ACTIVE</status>
        <created_at>2010-12-30 12:56:48</created_at>
        <updated_at>2010-12-30 12:56:48</updated_at>
      </CouponItem>
      <CouponItem>
        <id>25</id>
        <coupon_type_id>1</coupon_type_id>
        <code>07344348</code>
        <is_delivered>1</is_delivered>
        <status>COUPON_ACTIVE</status>
        <created_at>2010-12-30 12:56:48</created_at>
        <updated_at>2010-12-30 12:56:48</updated_at>
      </CouponItem>
    </couponType_listCoupons>
  </RESPONSE>
</tixwise_response>