
פעולות - producer_listCouponTypes
פעולה זו מחזירה את רשימת סוגי הקופונים הפעילים של מארגן האירוע המפעיל את פעולת ה- API.
פרמטרים
אין פרמטרים נוספים פרט לפרמטרי החובה. לפירוט
בקשה לדוגמא:
https://www.tixwise.co.il/he/api.xml?USER=tix@tixwise.co.il&PASS=123456&TOKEN=tok&VERSION=1.0
&ACTION=producer_listCouponTypes
תגובת השרת
השרת מחזיר את רשימת סוגי הקופונים, התגובה תחזור בתוך שדה ה- RESPONSE. במידה ונכשלה הפעולה, יוחזר ACK שלילי והסבר לכישלון ישלח בשדה RESPONSE.
התגובה מוגדרת באמצעות הסכימה הבאה: producer_listCouponTypes.xsd
להלן מבנה רשימת הקופונים:
פרמטר |
סוג |
תיאור |
producer_listCouponTypes |
Collection |
רשימת סוגי הקופונים השייכים למארגן זה, מכיל 0-n אלמנטים מסוג CouponTypeItem |
מבנה CouponTypeItem
פרמטר |
סוג |
תיאור |
id |
unsigned long long |
מזהה סוג הקופון |
amount |
int |
כמות השימושים לכל קופון מסוג זה |
discount_type |
enum |
סוג ההנחה, כיום האפשרות היחידה היא COUPON_ABSOLUTE |
discount_value |
string |
סכום ההנחה |
description |
string |
תיאור סוג הקופון |
expiration_date |
Date (YYYY-MM-DD) |
תוקף סוג זה |
min_order_price |
float |
סכום עסקה מינימאלי לשימוש בסוג קופון זה |
תגובת XML לדוגמא:
<?xml version="1.0" encoding="UTF-8"?> <tixwise_response> <ACK>SUCESS</ACK> <VERSION>1.0</VERSION> <RESPONSE> <producer_listCouponTypes> <CouponTypeItem> <id>1</id> <producer_id>10001</producer_id> <amount>10</amount> <discount_type>COUPON_ABSOLUTE</discount_type> <discount_value>10</discount_value> <description>10 NIS discount coupon </description> <expiration_date>2010-11-16</expiration_date> <min_order_price>90.00</min_order_price> <is_global>1</is_global> <status>COUPON_TYPE_ACTIVE</status> <created_at>2010-12-26 12:54:59</created_at> <updated_at>2010-12-26 12:54:59</updated_at> </CouponTypeItem> </producer_listCouponTypes> </RESPONSE> </tixwise_response>