Описание

Веб-сервис предназначен для создания категорий многоразовых купонов и генерации экземпляров для них.

Сервис предоставляет 2 метода:

createCouponsCategory - создание категории серийных/многоразовых купонов;
generateCoupons - создание экземпляров купонов.

Методы веб-сервиса для генерации купонов

Создание категории купонов
Метод	createCouponsCategory
URL	http://IP-адрес_сервера:8090/SET-Cards-Coupons/SET/SerialCouponsWS
WSDL	http://IP-адрес_сервера:8090/SET-Cards-Coupons/SET/SerialCouponsWS?wsdl
Комментарий	Создание категории многоразовых купонов.

Входные параметры

Наименование		Тип данных	Описание	Обязательное
name		String	Название категории	Да
nameForClient		String	Название для клиента	Нет
position		Комплексный	Область действия купона: RECEIPT - на весь чек (по умолчанию); POSITION - на все количество в позиции; ITEM - на одну единицу в позиции.	Нет
description		String	Описание	Нет
duration		Комплексный	Период действия	Нет
	dateFrom	Datetime	Дата начала действия	Нет
	dateTo	Datetime	Дата окончания действия	Нет
needShowMessage		Boolean	Отображать сообщение для кассира о результатах применения купона. По умолчанию признак выключен.	Нет
showCouponMessages		Boolean	Уведомление кассиру о необходимости забрать купон. По умолчанию признак выключен.	Нет
multiUse		Boolean	Многократное применение купона в одном чеке. По умолчанию признак выключен.	Нет

Выходные параметры

Наименование	Тип данных	Описание	Обязательное
guid	Long	Идентификатор созданной категории купонов	Да

Пример запроса:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:web="http://serial.web.coupons.cards.crystals.ru/">
    <soapenv:Header/>
    <soapenv:Body>
        <web:createCouponsCategory>
            <couponInfo>
                <name>Тестовая категория</name>
                <nameForClient>Тестовая категория</nameForClient>
                <position>POSITION</position>
                <description>Описание категории</description>
                <duration>
                    <dateFrom>2024-02-20T23:59:00.000</dateFrom>
                    <dateTo>2050-02-20T23:59:00.000</dateTo>
                </duration>
                <needShowMessage>true</needShowMessage>
                <showCouponMessages>true</showCouponMessages>
                <multiUse>false</multiUse>
            </couponInfo>
        </web:createCouponsCategory>
    </soapenv:Body>
</soapenv:Envelope>

Пример ответа:

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
    <soap:Body>
        <ns2:createCouponsCategoryResponse xmlns:ns2="http://serial.web.coupons.cards.crystals.ru/">
            <guid>133</guid>
        </ns2:createCouponsCategoryResponse>
    </soap:Body>
</soap:Envelope>

Создание экземпляров купонов
Метод	generateCoupons
URL	http://IP-адрес_сервера:8090/SET-Cards-Coupons/SET/SerialCouponsWS
WSDL	http://IP-адрес_сервера:8090/SET-Cards-Coupons/SET/SerialCouponsWS?wsdl
Комментарий	Создание экземпляров многоразовых купонов.

Входные параметры

Наименование	Тип данных	Описание	Обязательное
categoryCouponsGuid	Long	Идентификатор категории многоразовых купонов	Да
startField	String	Начало диапазона купонов	Да
countField	Long	Количество купонов. Если `promoCode = true`, то значение параметра должно быть равно "1".	Да
promoCode	Boolean	Признак промокода. По умолчанию признак выключен.	Нет

Выходные параметры

Наименование	Тип данных	Описание	Обязательное
startField	String	Начало диапазона купонов	Нет
finishField	String	Конец диапазона купонов	Нет
countField	Long	Количество купонов	Нет

Пример запроса:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:web="http://serial.web.coupons.cards.crystals.ru/">
    <soapenv:Header/>
    <soapenv:Body>
        <web:generateCoupons>
            <couponsInfo>
                <categoryCouponsGuid>129</categoryCouponsGuid>
                <startField>МОЙ_ПРОМОКОД</startField>
                <countField>1</countField>
                <promoCode>true</promoCode>
            </couponsInfo>
        </web:generateCoupons>
    </soapenv:Body>
</soapenv:Envelope>

Пример ответа:

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
    <soap:Body>
        <ns2:generateCouponsResponse xmlns:ns2="http://serial.web.coupons.cards.crystals.ru/">
            <generateCouponsResponse>
                <startField>МОЙ_ПРОМОКОД</startField>
                <finishField>МОЙ_ПРОМОКОД</finishField>
                <countField>1</countField>
            </generateCouponsResponse>
        </ns2:generateCouponsResponse>
    </soap:Body>
</soap:Envelope>

Пример ответа в случае ошибки:

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
    <soap:Body>
        <soap:Fault>
            <faultcode>soap:Server</faultcode>
            <faultstring>Диапазон существует.</faultstring>
            <detail>
                <ns1:SerialCouponsException xmlns:ns1="http://serial.web.coupons.cards.crystals.ru/"/>
            </detail>
        </soap:Fault>
    </soap:Body>
</soap:Envelope>

Интеграция

Веб-сервис по генерации многоразовых купонов

Описание

Методы веб-сервиса для генерации купонов

Создание категории купонов

Создание экземпляров купонов