Постоянные клиенты

Поиск постоянных клиентов по номеру телефона

Поиск ведется по полям pepl_PhoneCell таблицы tp_People и clph_Phone таблицы tp_ClientPhones.

Тип

GET

Вызов

/get-client-by-phone

Параметры

phone: Номер телефона, заданный в произвольном формате. Сравниваются только цифры по полному соответствию.

Пример вызова

http://89.22.216.169:8090/get-client-by-phone?phone=+7(921)593-16-28

Формат возвращаемых данных

Список постоянных клиентов, каждый из которых содержит структуру постоянного клиента

Пример

[ 
    { 
        "clnt_ID": "670BF67D-5CA1-D949-A7A9-9BC79AA30EA3", 
        "clnt_clgr_ID": "91DDA629-F60C-7447-9B7F-714A5669318B", 
        "clnt_pepl_ID": "857950A1-0CD6-794F-8F51-74646C2487F8", 
        "clnt_Name": "Лучезарный Стив", 
        "clnt_isDisabled": false, 
        "clientPhones": [ 
            { 
                "clph_ID": "E9385982-4A2C-4E92-AA86-A6F30962E619", 
                "clph_clnt_ID": "670BF67D-5CA1-D949-A7A9-9BC79AA30EA3", 
                "clph_Phone": "+7(921)666-16-22"  
            } 
        ], 
        "clientIdentifiers": [ 
            { 
                "idnt_ID": "857950A1-0CD6-794F-8F51-74646C2487F8",
                "idnt_Name": "12345" 
            } 
        ], 
        "people": { 
            "pepl_ID": "857950A1-0CD6-794F-8F51-74646C2487F8", 
            "pepl_ppgr_ID": "19F8A776-CC8C-3F4B-B313-5FAFF308C001", 
            "pepl_FirstName": "Роман", 
            "pepl_SecondName": "Петров", 
            "pepl_EMail": "petrov@mail.ru",
            "notes": [ 
                { 
                    "note_ID": "2276EFC0-92F2-E549-A9DF-382306C835A7", 
                    "note_nttp_ID": "15A75D5C-C7AB-8347-8FAC-60BF9E9EAB4D", 
                    "note_Item_ID": "857950A1-0CD6-794F-8F51-74646C2487F8", 
                    "note_obj_ID": "857950A1-0CD6-794F-8F51-74646C2487F8", 
                    "note_tpsyso_ID": "BBBE0E82-FDBC-44EB-9544-1AA3FAB2F9A9", 
                    "note_Date": "2017-08-09T11:52:13", 
                    "note_Value": { 
                        "value": "w", 
                        "type": "string"  
                    } 
                }, 
                { 
                    "note_ID": "17C984D8-0F8F-2E43-83D8-60519622F378", 
                    "note_nttp_ID": "15A75D5C-C7AB-8347-8FAC-60BF9E9EAB4D", 
                    "note_Item_ID": "857950A1-0CD6-794F-8F51-74646C2487F8", 
                    "note_obj_ID": "857950A1-0CD6-794F-8F51-74646C2487F8", 
                    "note_tpsyso_ID": "BBBE0E82-FDBC-44EB-9544-1AA3FAB2F9A9", 
                    "note_Date": "2017-08-09T11:52:13", 
                    "note_Value": { 
                        "value": "q", 
                        "type": "string"  
                    } 
                } 
            ] 
        }, 
        "notes": [ 
            { 
                "note_ID": "8A7AE96D-9E76-1D4F-B1A9-BD64CCDB29A2", 
                "note_nttp_ID": "15A75D5C-C7AB-8347-8FAC-60BF9E9EAB4D", 
                "note_Item_ID": "670BF67D-5CA1-D949-A7A9-9BC79AA30EA3", 
                "note_obj_ID": "670BF67D-5CA1-D949-A7A9-9BC79AA30EA3", 
                "note_tpsyso_ID": "23BD8E43-AABC-4EB1-AA47-0DECF358F51F", 
                "note_Date": "2017-08-09T11:27:55", 
                "note_Value": { 
                    "value": "ф", 
                    "type": "string"  
                } 
            } 
        ] 
    } 
]

Привязка карты к постоянному клиенту

Тип

POST

Вызов

/bind-client-card

Параметры

client-id: GUID постоянного клиента (clnt_ID).
id: GUID идентификатора.
code: Код идентификатора.
type: Тип идентификатора.
card: Название карты (поле idnt_Name в таблице tp_Identifiers).

Обязательно должны быть переданы: client-id, а также либо id идентификатора, либо code и type идентификатора (type может быть поднят из устройства, если заполнен), либо card (имя).

Пример вызова

http://89.22.216.169:8090/bind-client-card?client-id=9ACC7A33-B5EC-485F-A516-E3588FB8EC61&card=12345

Формат возвращаемых данных

HttpStatus 200, если успешно, иначе одна из ошибок:

Карта не найдена в принципе:

{ 
  "message": "[Microsoft][ODBC SQL Server Driver][SQL Server]Карта не валидна", 
  "errorType": "database", 
  "errorCode": 130040 
}

Карта в корзине удалений:

{ 
  "message": "[Microsoft][ODBC SQL Server Driver][SQL Server]Карта 12345 в корзине удалений", 
  "errorType": "database", 
  "errorCode": 130041 
}

Карта продублирована:

{
  "message": "[Microsoft][ODBC SQL Server Driver][SQL Server]Обнаружено дублирование карты 12345", 
  "errorType": "database", 
  "errorCode": 130042 
}

Карта привязана к:

другому клиенту:

{
  "message": "[Microsoft][ODBC SQL Server Driver][SQL Server]Карта 12345 привязана к другому клиенту", 
  "errorType": "database", 
  "errorCode": 130043 
}

переданному клиенту:

{ 
  "message": "[Microsoft][ODBC SQL Server Driver][SQL Server]Карта 12345 уже привязана к данному клиенту", 
  "errorType": "database", 
  "errorCode": 130044 
}

сотруднику:

{ 
  "message": "[Microsoft][ODBC SQL Server Driver][SQL Server]Карта 12345 привязана к сотруднику", 
  "errorType": "database", 
  "errorCode": 130045 
}

Редактирование постоянного клиента

Тип

PUT

Вызов

/update-client

Формат возвращаемых данных

Ничего не возвращает

Параметры

В секции BODY запроса содержимое редактирования постоянного клиента в иерархическом виде (в секции HEADER необходимо указать "Content-Type: application/json").

Пример вызова

curl \
  -X PUT \
  -H "Content-Type: application/json" \
  -d @client_in.json \  
  --url "http://89.22.216.169:8090/update-client"

: client_in.json - имя файла с редактируемыми полями из содержимого постоянного клиента.

Пример редактирования постоянного клиента

Редактируемый постоянный клиент на входе

{    
"clnt_ID": "E7F9298A-613D-6241-BA4B-0AA0A1134B6E", 
    "people": { 
    "pepl_ID": "857950A1-0CD6-794F-8F51-74646C2487F8", 
        "pepl_FirstName": "Рулон", 
        "pepl_SecondName": "Обоев", 
        "pepl_EMail": "oboev@yandex.ru", 
        "pepl_PhoneCell": "+7(921)593-16-58"  
    }, 
    "clientPhones": [ 
    { 
    "clph_ID": "A886CB42-5598-8543-888B-5B37EA0A12B7", 
      "clph_Phone": "+7(921)593-16-58"  
    } 
    ], 
    "addresses": [ 
    { 
    "addr_ID": "0B944627-F3CA-F741-B545-D5B98B8F4710", 
    "addr_XML": "Санкт-ПетербургЛенина102121224комментарий" 
    } 
  ] 
}

Соглашения

Для редактирования нужного клиента обязателен clnt_ID существующего в базе клиента, если такого ID нет, или clnt_ID вообще не был введен, то будет возвращена ошибка.

{ 
    "timestamp": 1510317018403, 
    "status": 500, 
    "error": "Internal Server Error", 
    "exception": "com.tillypad.lib.client.SQLException", 
    "message": "[Microsoft][ODBC SQL Server Driver][SQL Server]Значение параметра clnt_ID не заполнено или не найдено",
    "path": "/update-client", 
    "errorcode": 135531 
}

Для редактирования клиента достаточно отправить только редактируемые поля, а для редактирования его параметров People, ClientPhones, Addresses нужны их ID (ведь телефонов и адресов может быть несколько, а People - это редактирование персональных данных, привязанных к клиенту).

"clientPhones": [
    {
    "clph_ID": "A886CB42-5598-8543-888B-5B37EA0A12B7",
        "clph_Phone": "+7(921)593-16-58" 
    }
    ],
"addresses": [
    {
    "addr_ID": "0B944627-F3CA-F741-B545-D5B98B8F4710",
    "addr_XML": "<Address><Village Caption="Населенный пункт" Key="True">Санкт-Петербург</Village><Street Caption="Улица" Key="True">Ленина</Street><House Caption="Дом" Key="True">10</House><Building Caption="Корпус" Key="True">2</Building><Apartment Caption="Квартира" Key="True">12</Apartment><Entrance Caption="Подъезд">1</Entrance><Floor Caption="Этаж">2</Floor><Intercom Caption="Домофон">24</Intercom><Comment Caption="Комментарий">комментарий</Comment></Address>" 

    }
    ]

Для добавления нового телефона - добавить только новый телефон (clph_Phone).

Предупреждение

Телефон добавить можно, а привязать адрес (addr_XML) – нет.

В текущей реализации API добавление адреса не реализовано. Можно только изменять существующий адрес.

Формирование постоянного клиента

Тип

POST

Вызов

/post-client

Формат возвращаемых данных

{ 
  "clnt_ID": "670BF67D-5CA1-D949-A7A9-9BC79AA30EA3" 
}

Параметры

В секции BODY запроса содержимое постоянного клиента в иерархическом виде. В секции HEADER необходимо указать "Content-Type: application/json".

Пример вызова

curl \
  -H "Content-Type: application/json"  \
  -d @client_in.json \  
  -o out.json \  
  --url "http://89.22.216.169:8090/post-client"

: client_in.json - имя файла с содержимым постоянного клиента,
: out.json - имя файла с идентификатором созданного постоянного клиента

Пример формирования постоянного клиента

Постоянный клиент на входе

{ 
    "clnt_clgr_ID": "91DDA629-F60C-7447-9B7F-714A5669318B", 
    "clnt_pepl_ID": "857950A1-0CD6-794F-8F51-74646C2487F8", 
    "clnt_Name": "Рулон Обоев", 
    "clnt_isDisabled": false, 
    "clientPhones": [ 
        { 
          "clph_Phone": "+7(921)666-16-22"  
        } 
    ], 
    "people": { 
        "pepl_FirstName": "Рулон", 
        "pepl_SecondName": "Обоев", 
        "pepl_EMail": "oboev@mail.ru", 
        "pepl_PhoneCell": "+7(921)666-16-22"  
    } 
}

Ответ

{ 
    "clnt_ID": "E90648DF-5F4A-1A4F-990A-E4BF2B09FA2E"  
}

Соглашения

Если введенный clnt_ID уже существует в базе, то отправка запроса вернет ошибку.

{ 
    "timestamp": 1510309971248, 
    "status": 500, 
    "error": "Internal Server Error", 
    "exception": "com.tillypad.lib.client.SQLException", 
    "message": "[Microsoft][ODBC SQL Server Driver][SQL Server]Постоянный клиент с таким clnt_ID уже существует", 
    "path": "/post-client", 
    "errorcode": 135533 
}

Структура постоянного клиента

{ 
  поля таблицы tp_Clients, 
  "clientPhones": {поля таблицы tp_ClientPhones}, --опционально 
  "People": { 
    поля таблицы tp_People, 
   "notes": [{поля таблицы tp_Notes},{ },] -- опционально 
  } --опционально 
}

Постоянные клиенты (tp_Clients)

Таблица tp_Clients.

Поле	Обязательное	Заполняется на сервере	Заполняется на клиенте
clnt_ID	✔	✔
clnt_clgr_ID	✔		✔
clnt_firm_ID			✔
clnt_lggr_ID			✔
clnt_sprv_ID			✔
clnt_Name	✔		✔
clnt_Description			✔
clnt_IsDisabled	✔		✔

Номера телефонов постоянных клиентов (tp_ClientPhones)

Таблица tp_ClientPhones.

Поле	Обязательное	Заполняется на сервере	Заполняется на клиенте
clph_ID	✔	✔
clph_clnt_ID	✔	✔
clph_Phone	✔		✔

Персональные данные (tp_People)

Таблица tp_People.

Поле	Обязательное	Заполняется на сервере	Заполняется на клиенте
pepl_ID	✔	✔
pepl_ppgr_ID	✔		✔
pepl_sex_ID			✔
pepl_lggr_ID			✔
pepl_FirstName			✔
pepl_SecondName			✔
pepl_Patronymic			✔
pepl_Document			✔
pepl_WorkPlace			✔
pepl_Position			✔
pepl_PhoneWork			✔
pepl_PhoneHome			✔
pepl_PhoneCell			✔
pepl_EMail			✔
pepl_INN			✔
pepl_Comment			✔
pepl_FirstName			✔
pepl_SecondName			✔
pepl_Patronymic			✔
pepl_Document			✔

Адреса (tp_Addresses)

Таблица tp_Addresses.

Поле	Обязательное	Заполняется на сервере	Заполняется на клиенте
addr_ID	✔	✔
addr_obj_ID	✔	✔	✔
addr_tpsyso_Phone	✔	✔	✔
addr_XML			✔

Заметки (tp_Notes)

Структура заметки

Пример

{ 
  "clnt_ID": "670BF67D-5CA1-D949-A7A9-9BC79AA30EA3", 
  "clnt_clgr_ID": "91DDA629-F60C-7447-9B7F-714A5669318B", 
  "clnt_pepl_ID": "857950A1-0CD6-794F-8F51-74646C2487F8", 
  "clnt_Name": "Лучезарный Стив", 
  "clnt_isDisabled": false, 
  "clientPhones": [ 
    { 
      "clph_ID": "E9385982-4A2C-4E92-AA86-A6F30962E619", 
      "clph_clnt_ID": "670BF67D-5CA1-D949-A7A9-9BC79AA30EA3", 
      "clph_Phone": "+7(921)666-16-22"  
    } 
  ], 
  "people": { 
    "pepl_ID": "857950A1-0CD6-794F-8F51-74646C2487F8", 
    "pepl_ppgr_ID": "19F8A776-CC8C-3F4B-B313-5FAFF308C001", 
    "pepl_FirstName": "Роман", 
    "pepl_SecondName": "Петров", 
    "pepl_EMail": "petrov@mail.ru", 
    "notes": [ 
      { 
        "note_ID": "2276EFC0-92F2-E549-A9DF-382306C835A7", 
        "note_nttp_ID": "15A75D5C-C7AB-8347-8FAC-60BF9E9EAB4D", 
        "note_Item_ID": "857950A1-0CD6-794F-8F51-74646C2487F8", 
        "note_obj_ID": "857950A1-0CD6-794F-8F51-74646C2487F8", 
        "note_tpsyso_ID": "BBBE0E82-FDBC-44EB-9544-1AA3FAB2F9A9",
        "note_Date": "2017-08-09T11:52:13",
        "note_Value": { 
          "value": "w", 
          "type": "string"  
        } 
      }, 
      { 
        "note_ID": "17C984D8-0F8F-2E43-83D8-60519622F378", 
        "note_nttp_ID": "15A75D5C-C7AB-8347-8FAC-60BF9E9EAB4D", 
        "note_Item_ID": "857950A1-0CD6-794F-8F51-74646C2487F8", 
        "note_obj_ID": "857950A1-0CD6-794F-8F51-74646C2487F8", 
        "note tpsyso ID": "BBBE0E82-FDBC-44EB-9544-1AA3FAB2F9A9",
        "note_Date": "2017-08-09T11:52:13",
        "note_Value": { 
          "value": "q", 
          "type": "string"  
        } 
      } 
    ] 
  }, 
  "notes": [ 
    { 
      "note_ID": "8A7AE96D-9E76-1D4F-B1A9-BD64CCDB29A2", 
      "note_nttp_ID": "15A75D5C-C7AB-8347-8FAC-60BF9E9EAB4D", 
      "note_Item_ID": "670BF67D-5CA1-D949-A7A9-9BC79AA30EA3", 
      "note_obj_ID": "670BF67D-5CA1-D949-A7A9-9BC79AA30EA3", 
      "note_tpsyso_ID": "23BD8E43-AABC-4EB1-AA47-0DECF358F51F", 
      "note_Date": "2017-08-09T11:27:55", 
      "note_Value": { 
        "value": "ф", 
        "type": "string"  
      } 
    } 
  ] 
}

Запрос данных постоянного клиента

Тип

GET

Вызов

/get-client

Параметры

client-id: Идентификатор постоянного клиента.

Пример вызова

http://89.22.216.169:8090/get-client?client-id=670BF67D-5CA1-D949-A7A9-9BC79AA30EA3

Формат возвращаемых данных

Список постоянных клиентов, каждый из которых содержит структуру постоянного клиента.

Пример

[ 
    { 
        "clnt_ID": "670BF67D-5CA1-D949-A7A9-9BC79AA30EA3", 
        "clnt_clgr_ID": "91DDA629-F60C-7447-9B7F-714A5669318B", 
        "clnt_pepl_ID": "857950A1-0CD6-794F-8F51-74646C2487F8", 
        "clnt_Name": "Лучезарный Стив", 
        "clnt_isDisabled": false, 
        "clientPhones": [ 
            { 
                "clph_ID": "E9385982-4A2C-4E92-AA86-A6F30962E619", 
                "clph_clnt_ID": "670BF67D-5CA1-D949-A7A9-9BC79AA30EA3", 
                "clph_Phone": "+7(921)666-16-22"  
            } 
        ], 
        "clientIdentifiers": [ 
            { 
                "idnt_ID": "857950A1-0CD6-794F-8F51-74646C2487F8", 
                "idnt_Name": "12345" 
            } 
        ], 
        "people": { 
            "pepl_ID": "857950A1-0CD6-794F-8F51-74646C2487F8", 
            "pepl_ppgr_ID": "19F8A776-CC8C-3F4B-B313-5FAFF308C001", 
            "pepl_FirstName": "Роман", 
            "pepl_SecondName": "Петров", 
            "pepl_EMail": "petrov@mail.ru",
            "notes": [ 
                { 
                    "note_ID": "2276EFC0-92F2-E549-A9DF-382306C835A7", 
                    "note_nttp_ID": "15A75D5C-C7AB-8347-8FAC-60BF9E9EAB4D", 
                    "note_Item_ID": "857950A1-0CD6-794F-8F51-74646C2487F8", 
                    "note_obj_ID": "857950A1-0CD6-794F-8F51-74646C2487F8", 
                    "note_tpsyso_ID": "BBBE0E82-FDBC-44EB-9544-1AA3FAB2F9A9", 
                    "note_Date": "2017-08-09T11:52:13", 
                    "note_Value": { 
                        "value": "w", 
                        "type": "string"  
                    } 
                }, 
                { 
                    "note_ID": "17C984D8-0F8F-2E43-83D8-60519622F378", 
                    "note_nttp_ID": "15A75D5C-C7AB-8347-8FAC-60BF9E9EAB4D", 
                    "note_Item_ID": "857950A1-0CD6-794F-8F51-74646C2487F8", 
                    "note_obj_ID": "857950A1-0CD6-794F-8F51-74646C2487F8", 
                    "note_tpsyso_ID": "BBBE0E82-FDBC-44EB-9544-1AA3FAB2F9A9", 
                    "note_Date": "2017-08-09T11:52:13", 
                    "note_Value": { 
                        "value": "q", 
                        "type": "string"  
                    } 
                } 
            ] 
        }, 
        "notes": [ 
            { 
                "note_ID": "8A7AE96D-9E76-1D4F-B1A9-BD64CCDB29A2", 
                "note_nttp_ID": "15A75D5C-C7AB-8347-8FAC-60BF9E9EAB4D", 
                "note_Item_ID": "670BF67D-5CA1-D949-A7A9-9BC79AA30EA3", 
                "note_obj_ID": "670BF67D-5CA1-D949-A7A9-9BC79AA30EA3", 
                "note_tpsyso_ID": "23BD8E43-AABC-4EB1-AA47-0DECF358F51F", 
                "note_Date": "2017-08-09T11:27:55", 
                "note_Value": { 
                    "value": "ф", 
                    "type": "string"  
                } 
            } 
        ] 
    } 
]

Запрос предыдущих заказов постоянного клиента

Тип

GET

Вызов

/get-guests

Параметры

client-id: Идентификатор постоянного клиента.
last-days: Количество последних дней. Необязательный параметр.

Пример вызова

http://89.22.216.169:8090/get-guests?client-id=E1D526BE-56F4-4C40-A169-2FEFD9D7679C

Формат возвращаемых данных

Список гостевых счетов, каждый из которых содержит структуру гостевого счета.

[
  {
    "gest_ID": "2FCC70CA-64E5-D348-AE54-D5E3A27AC0AC",
    "gest_dvsn_ID": "BF084ED2-5EED-0344-A1EF-845A1E5B47EC",
    "gest_clnt_ID": "E1D526BE-56F4-4C40-A169-2FEFD9D7679C",
    "gest_usr_ID": "D0ECCA5E-B2B7-4F46-9BC2-5BF81FC5908E",
    "gest_dev_ID": "9B42C422-C780-F948-8A65-29E71C73AA0E",
    "gest_gsst_ID": 1,
    "gest_DateOpen": "2017-06-30T14:55:59",
    "gest_DateClose": "2017-06-30T14:55:59",
    "gest_Name": "007",
    "gest_ClientName": "Коля",
    "gest_ClientPhone": "+7(900)000-00-02",
    "gest_ClientAddress": " г.Москва Митинская ул 40 1", 
    "gest_Count": 1, 
    "guestDeliveries": 
    { 
        "gsdlv_gest_ID": "2FCC70CA-64E5-D348-AE54-D5E3A27AC0AC", 
        "gsdlv_usr_ID_Courier": "D59CAE1F-8DC1-6146-A907-70998F83642C", 
        "gsdlv_dlvrst_ID": 1, 
        "gsdlv_dlvrmt_ID": 1, 
        "gsdlv_cncpt_ID": "8550E05D-83D5-C049-A8CF-772A51995F71", 
        "gsdlv_Date": "2017-06-30T14:08:47", 
        "gsdlv_DateDelivered": "2017-06-30T15:35:15", 
        "gsdlv_IsAutoStart": true, 
        "gsdlv_CookingTime": 1800, 
        "gsdlv_DeliveryTime": 900, 
        "gsdlv_SendSooner": true, 
        "gsdlv_NeedConfirmation": false, 
        "gsdlv_GeoRegionID": "1", 
        "gsdlv_GeoCoordinates": "55.847796, 37.360052" 
     }, 
     "orders": [ 
     { 
         "ordr_ID": "7C113057-C57E-054A-AE29-30FEE179ABC1", 
         "ordr_gest_ID": "2FCC70CA-64E5-D348-AE54-D5E3A27AC0AC", 
         "ordr_usr_ID": "D0ECCA5E-B2B7-4F46-9BC2-5BF81FC5908E", 
         "ordr_usr_ID_Operator": "D0ECCA5E-B2B7-4F46-9BC2-5BF81FC5908E", 
         "ordr_dev_ID": "2B492714-9036-5C45-99C0-F40680A1378A", 
         "ordr_dvsn_ID": "BF084ED2-5EED-0344-A1EF-845A1E5B47EC", 
         "ordr_arch_ID": "33F28A03-0D55-334C-8C8B-44EDA012BA86", 
         "ordr_orst_ID": 1, "ordr_Date": "2017-06-30T14:09:48", 
         "ordr_Name": "004", 
         "orderItems": [ 
         { 
            "orit_ID": "FB76046A-A439-604D-A7AB-22FFDE54F96F", 
            "orit_ordr_ID": "7C113057-C57E-054A-AE29-30FEE179ABC1", 
            "orit_mitm_ID": "37BA7F79-1173-4445-8BC9-2D1E61C06E50", 
            "orit_mvtp_ID": "2FD4FA63-12A1-4FAD-B215-607460886D82", 
            "orit_slgr_ID": "8E249A40-1ACE-E84F-BD74-C4A7F1D1AE6A", 
            "orit_pcit_ID": "1C9C6636-06BD-4064-AD68-4E5F915514BA", 
            "orit_Volume": 1, 
            "orit_Count": 1, 
            "orit_Price": 250, 
            "orit_PriceDiscount": 0, 
            "orit_PriceMargin": 0, 
            "orit_VAT": 0, 
            "orit_PriceVat": 0, 
            "orit_Order": 4, 
            "orit_IsUnspentCredit": false 
         }, 
         { 
            "orit_ID": "5A575374-2C72-C64C-A4D5-A1B8E216CB4C", 
            "orit_ordr_ID": "7C113057-C57E-054A-AE29-30FEE179ABC1", 
            "orit_mitm_ID": "E11B2401-2E49-CF4C-B850-81D0D3D0899E", 
            "orit_mvtp_ID": "2FD4FA63-12A1-4FAD-B215-607460886D82", 
            "orit_slgr_ID": "8E249A40-1ACE-E84F-BD74-C4A7F1D1AE6A", 
            "orit_pcit_ID": "F0C79247-1402-4623-8C89-A0CFF10778E6", 
            "orit_Volume": 1, 
            "orit_Count": 1, 
            "orit_Price": 110, 
            "orit_PriceDiscount": 0, 
            "orit_PriceMargin": 0, 
            "orit_VAT": 0, 
            "orit_PriceVat": 0, 
            "orit_Order": 3, 
            "orit_IsUnspentCredit": false 
          }, 
          { 
            "orit_ID": "665A6166-17C8-3040-BB58-EF1366FBC0C1", 
            "orit_ordr_ID": "7C113057-C57E-054A-AE29-30FEE179ABC1", 
            "orit_mitm_ID": "80EA8444-C250-FB4C-8688-4AB5AB73F8B8", 
            "orit_mvtp_ID": "2FD4FA63-12A1-4FAD-B215-607460886D82", 
            "orit_slgr_ID": "8E249A40-1ACE-E84F-BD74-C4A7F1D1AE6A", 
            "orit_pcit_ID": "1F587A91-D559-47C7-AF93-C709D88D07C4", 
            "orit_Volume": 1, 
            "orit_Count": 1, 
            "orit_Price": 250, 
            "orit_PriceDiscount": 0, 
            "orit_PriceMargin": 0, 
            "orit_VAT": 0, 
            "orit_PriceVat": 0, 
            "orit_Order": 2, 
            "orit_IsUnspentCredit": false 
          }
 ] } ] }, ... ]

Запрос списка адресов постоянного клиента

Тип

GET

Вызов

/get-client-addresses

Параметры

client-id: Идентификатор постоянного клиента.

Пример вызова

http://89.22.216.169:8090/get-client-addresses?client-id=001492F8-8ECE-EE47-AFD0-0050AC2C1273

Формат возвращаемых данных

[ 
  { 
    "addr_XML": " 
г.Москва Митинская ул 2 1 1 " },
... ]

Запрос списка групп постоянных клиентов

Тип

GET

Вызов

/get-client-groups

Параметры

Без параметров.

Пример вызова

http://89.22.216.169:8090/get-client-groups

Формат возвращаемых данных

[ 
    { 
        "clgr_ID": "688B4CD9-1D83-B744-BD50-12B90C5E8368", 
        "clgr_Name": "Новые клиенты доставки", 
        "clgr_IsDisabled": false 
    }, 
    { 
        "clgr_ID": "0F07B907-E2C3-6E4A-B035-13B4D06B2FFC", 
        "clgr_Name": "dp_spb", 
        "clgr_IsDisabled": false 
    }, 
   ... 
]

Группы постоянных клиентов (tp_ClientGroups)

Таблица tp_ClientGroups.

Запрос баллов постоянного клиента

Тип

GET

Вызов

/get-discount-point-operations

Параметры

client-id: Идентификатор постоянного клиента.
discount-point-type-id: Идентификатор типа баллов.

Пример вызова

http://localhost:8080/get-discount-point-operations?client-id=7F944ABD-0729-D948-A052-531D74B3482F

Формат возвращаемых данных:

[ 
  { 
    "cdpo_ID": "206B46A4-621E-794D-B290-0F6883C3B6E2", 
    "cdpo_clnt_ID": "7F944ABD-0729-D948-A052-531D74B3482F", 
    "cdpo_dspt_ID": "A976C6ED-C511-4755-B942-636645A6A1B0", 
    "cdpo_Date": "2014-06-16T15:15:21", 
    "cdpo_Name": "1", 
    "cdpo_Value": 100 
  }, 
  ... 
]

Операции по баллам постоянных клиентов (tp_ClientDiscountPointOperations)

Таблица tp_ClientDiscountPointOperations.

Запрос средств постоянного клиента

Тип

GET

Вызов

/get-purse-operations

Параметры

client-id: Идентификатор постоянного клиента.
purse-type-id: Идентификатор типа счетов. Необязательный параметр.

Пример вызова

http://89.22.216.169:8090/get-purse-operations?client-id=83089758-5EE7-164F-8C2F-2FE1C93CCBED

Формат возвращаемых данных

[ 
  { 
    "cpop_ID": "78898376-1867-3B47-B039-B9ED773101C3", 
    "cpop_clnt_ID": "83089758-5EE7-164F-8C2F-2FE1C93CCBED", 
    "cpop_cptp_ID": "0C1B4009-C3F9-584B-AF1B-F1F2C8171357", 
    "cpop_Date": "2017-07-10T11:22:37", 
    "cpop_Name": "1", 
    "cpop_Sum": 500 
  }, 
  ... 
]

Операции по счетам постоянных клиентов (tp_ClientDiscountPurseOperations)

Таблица tp_ClientDiscountPurseOperations.

Начисление/списание баллов постоянного клиента

Тип

POST

Вызов

/post-discount-point-operations

Формат возвращаемых данных

Ничего не возвращает.

Параметры

В секции BODY запроса список операций по баллам постоянных клиентов. В секции HEADER необходимо указать "Content-Type: application/json".

Пример вызова

curl \
  -H "Content-Type: application/json"  \ 
  -d @operations.json \   
  --url "http://89.22.216.169:8090/post-discount-point-operations"

: operations.json - имя файла со списком операций по баллам постоянных клиентов.

Пример перевода баллов между постоянными клиентами

[ 
  { 
    "cdpo_clnt_ID": "7F944ABD-0729-D948-A052-531D74B3482F", 
    "cdpo_dspt_ID": "A976C6ED-C511-4755-B942-636645A6A1B0", 
    "cdpo_Date": "2017-08-04T15:15:21", 
    "cdpo_Name": "1", 
    "cdpo_Value": -15 
  }, 
  { 
    "cdpo_clnt_ID": "65032E31-D623-C746-B234-04979C9825CE", 
    "cdpo_dspt_ID": "A976C6ED-C511-4755-B942-636645A6A1B0", 
    "cdpo_Date": "2017-08-04T15:15:21", 
    "cdpo_Name": "1", 
    "cdpo Value": 15
  } 
]

Операции по баллам постоянных клиентов (tp_ClientDiscountPointOperations)

Таблица tp_ClientDiscountPointOperations.

Поле	Обязательное	Заполняется на сервере	Заполняется на клиенте
cdpo_ID	✔	✔
cdpo_clnt_ID	✔		✔
cdpo_dspt_ID	✔		✔
cdpo_usr_ID			✔
cdpo_Date	✔		✔
cdpo_Name	✔		✔
cdpo_Description			✔
cdpo_Value	✔		✔

Начисление/списание средств постоянного клиента

Тип

POST

Вызов

/post-purse-operations

Формат возвращаемых данных

Ничего не возвращает.

Параметры

Пример вызова

curl \
  -H "Content-Type: application/json" \
  -d @operations.json \ 
  --url "http://89.22.216.169:8090/post-purse-operations"

: operations.json - имя файла со списком операций по счетам постоянных клиентов.

Пример перевода средств между постоянными клиентами

[ 
  { 
    "cpop_clnt_ID": "47CF2393-25B4-4CFA-A7F5-D611251573DF", 
    "cpop_cptp_ID": "3CD1F27B-7955-EC4C-AD58-A325538275B2", 
    "cpop_atop_ID": "EA2DBD33-1DE4-49B1-8FC8-D813FF331817", 
    "cpop_usr_ID": "67436E4B-B148-4138-B995-7E6C9448A70B", 
    "cpop_Date": "2017-08-04T14:43:10", 
    "cpop_Name": "5", 
    "cpop_Sum": -15 
  }, 
  { 
    "cpop_clnt_ID": "65032E31-D623-C746-B234-04979C9825CE", 
    "cpop_cptp_ID": "3CD1F27B-7955-EC4C-AD58-A325538275B2", 
    "cpop atop ID": "EA2DBD33-1DE4-49B1-8FC8-D813FF331817", 
    "cpop_usr_ID": "67436E4B-B148-4138-B995-7E6C9448A70B", 
    "cpop_Date": "2017-08-04T14:43:10", 
    "cpop_Name": "5", 
    "cpop_Sum": 15 
  } 
]

Операции по счетам постоянных клиентов (tp_ClientPurseOperations)

Таблица tp_ClientPurseOperations.

Поле	Обязательное	Заполняется на сервере	Заполняется на клиенте
cpop_ID	✔	✔
cpop_clnt_ID	✔		✔
cpop_atop_ID	✔		✔
cdpo_usr_ID			✔
cdpo_cpop_ID_Return			✔
cdpo_Date	✔		✔
cdpo_Name	✔		✔
cdpo_Description			✔
cdpo_Sum	✔		✔
cdpo_ExternalTransaction			✔