Команда addCard создает карту. Атрибуты карты задаются обязательным параметром card.
Свойства параметра card.
| | | Примечания |
|---|
idcard | строковый(100) | Идентификационный код карты | Обязательно для заполнения |
idcardgroup | числовой(11) | Идентификационный код группы карт |
|
idclient | строковый(100) | Идентификационный код клиента |
|
number | строковый(200) | Номер карты |
|
validitydatebeg | дата | Начало периода валидности |
|
validitydateend | дата | Окончание периода валидности |
|
cardSum | вещественный(20,2) | Сумма на карте |
|
blocked | числовой(11) | Состояние карты (заблокирована или нет) |
|
lastknownbonusbalance | вещественный(15,2) | Последний известный баланс бонусов на карте |
|
lastknownbonusbalancedate | дата | Дата получения последнего известного баланса бонусов на карте |
|
multiplicator | вещественный(15,2) | Мультипликатор – коэффициент карты (может использоваться в качестве множителя для скидок) |
|
multiplicatorbeg | дата | Дата начала действия мультипликатора |
|
multiplicatorend | дата | Дата окончания действия мультипликатора |
|
multiplicatorcurrent | вещественный(15,2) | Текущий мультипликатор или мультипликатор по умолчанию |
|
discountpercent | вещественный(5,2) | Процент скидки |
|
| pincode | строковый(100) | Пин-код |
|
| purchases | числовой(11) | Количество покупок |
|
| cardstatus | числовой(11) | Статус карты. Может принимать значения: - 0 – EARN_ONLY (анонимная, доступно только начисление),
- 1 – EARN_PAY (активная, доступно начисление и списание),
- 2 – NO_OPERATION (заблокирована, выполнение любых операций запрещено),
- 3 – PAY_ONLY (новый статус, возможна только оплата).
|
|
| shopcode | строковый(255) | Код магазина |
|
| options | объект | Опции карты |
|
Свойства объекта options
Свойство | Тип данных | Описание |
|---|
disablerefundbonuses | числовой(1) | Запрет возврата бонусных баллов: - false – разрешен возврат бонусных баллов,
- true – запрещен возврат бонусных баллов.
|
| Code Block |
|---|
|
{
"command": "addCard",
"card": {
"idcard": "4",
"idcardgroup": 9,
"idclient": "35",
"number": "2371165454",
"validitydatebeg": "2011-05-20",
"validitydateend": "2011-09-20",
"cardSum": 587.20,
"blocked": false,
"lastknownbonusbalance": 87.20,
"lastknownbonusbalancedate": "2011-09-20T00:00:00.00",
"multiplicator": 1.4,
"multiplicatorbeg": "2011-09-01T00:00:00.00",
"multiplicatorend": "2011-09-30T00:00:00.00",
"multiplicatorcurrent": 1,
"discountpercent": 10,
"shopcode": "13",
"options": {
"disablerefundbonuses": true
}
}
} |
Команда clearCard
Команда clearCard очищает справочник карт.
| Code Block |
|---|
|
{
"command": "clearCard"
} |
Команда deleteCard
Команда deleteCard удаляет из справочника карт запись о карте.
Параметр: идентификационный номер карты.
| Code Block |
|---|
|
{
"command": "deleteCard",
"idcard": 12
} |
Команда updateCard
Команда updateCard обновляет данные об уже существующей карте. Атрибуты карты задаются обязательным параметром card. При обновлении может использоваться как idcard, так и number, в остальном следует указывать только изменяемые атрибуты.
Свойства параметра card.
| | |
|---|
idcard | строковый(100) | Идентификационный код карты |
idcardgroup | числовой(11) | Идентификационный код группы карт |
idclient | строковый(100) | Идентификационный код клиента |
number | строковый(200) | Номер карты |
validitydatebeg | дата | Начало периода валидности |
validitydateend | дата | Окончание периода валидности |
cardSum | вещественный(20,2) | Сумма на карте |
blocked | числовой(11) | Состояние карты(заблокирована или нет) |
lastknownbonusbalance | вещественный(15,2) | Последний известный баланс бонусов на карте |
lastknownbonusbalancedate | дата | Дата получения последнего известного баланса бонусов на карте |
multiplicator | вещественный(15,2) | Мультипликатор – коэффициент карты (может использоваться в качестве множителя для скидок) |
multiplicatorbeg | дата | Дата начала действия мультипликатора |
multiplicatorend | дата | Дата окончания действия мультипликатора |
multiplicatorcurrent | вещественный(15,2) | Текущий мультипликатор или мультипликатор по умолчанию |
discountpercent | вещественный(5,2) | Процент скидки |
| pincode | строковый(100) | Пин-код |
| purchases | числовой(11) | Количество покупок |
| cardstatus | числовой(11) | Статус карты. Может принимать значения: - 0 – EARN_ONLY (анонимная, доступно только начисление),
- 1 – EARN_PAY (активная, доступно начисление и списание),
- 2 – NO_OPERATION (заблокирована, выполнение любых операций запрещено),
- 3 – PAY_ONLY (новый статус, возможна только оплата).
|
| shopcode | строковый(255) | Код магазина |
| options | объект | Опции карты |
Свойства объекта options
Свойство | Тип данных | Описание |
|---|
disablerefundbonuses | числовой(1) | Запрет возврата бонусных баллов: - false – разрешен возврат бонусных баллов,
- true – запрещен возврат бонусных баллов.
|
| Code Block |
|---|
|
{
"command": "updateCard",
"card": {
"idcard": "4",
"idcardgroup": 9,
"idclient": "35",
"number": "2371165454",
"validitydatebeg": "2011-05-20",
"validitydateend": "2011-09-20",
"cardSum": 587.20,
"blocked": false,
"lastknownbonusbalance": 87.20,
"lastknownbonusbalancedate": "2011-09-20T00:00:00.00",
"multiplicator": 1.4,
"multiplicatorbeg": "2011-09-01T00:00:00.00",
"multiplicatorend": "2011-09-30T00:00:00.00",
"multiplicatorcurrent": 1,
"discountpercent": 15,
"shopcode": "33",
"options": {
"disablerefundbonuses": true
}
}
} |