RegisterClient: відмінності між версіями

Матеріал з SERVIO
Перейти до навігації Перейти до пошуку
Немає опису редагування
Немає опису редагування
 
(Не показано одну проміжну версію цього користувача)
Рядок 84: Рядок 84:
| PhoneNumber
| PhoneNumber
| String  
| String  
| Номер телефону
| Номер телефону (використовувати формат 380998887766)
|-
|-
|  
|  
Рядок 114: Рядок 114:
| Code
| Code
| String  
| String  
| Код персони
| Код персони, якщо цей параметр вказується то буде оновлено дані персони ІД якої було вказано
|-
|-
|  
|  

Поточна версія на 08:08, 28 грудня 2023

Функція виконує реєстрацію користувача в системі

Розділ містить методи, необхідні для реєстрації користувача в системі


Опис Реєстрація користувача.
Метод POST
URL /POSExternal/RegisterClient



Request Headers
KEY VALUE
Content-Type application/json
AccessToken



Body raw (json)
{
    "PhoneNumber": "0999999299",
    "Password": "secretpassword",
    "LastName": "Smith",
    "FirstName": "John",
    "MiddleName": "Doe",
    "BirthDate": "1990-01-01T00:00:00",
    "Code": "ABC123zxc",
    "CardCode": "CARD456gfdg",
    "EMail": null,
    "CreateCard": false,
    "Sex": true,
    "Properties": null,
    "AddressID": 0,
    "GetNews": true,
    "Children": [
        {
            "Firstname": "Child1",
            "Lastname": "Smith",
            "Patronymic": "Doe",
            "Birthday": "2010-05-15T00:00:00"
        },
        {
            "Firstname": "Child2",
            "Lastname": null,
            "Patronymic": null,
            "Birthday": null
        }
    ],
    "PlatformID": "PLATFORM123",
    "UserPlatfomID": "USERPLATFORM456"
}



Типи даних Body
* Параметр Тип Опис
*
PhoneNumber String Номер телефону (використовувати формат 380998887766)
Password String Пароль
*
LastName String Прізвище клієнта
*
FirstName String Ім'я клієнта
*
MiddleName String По-батькові клієнта
BirthDate Date Дата народження
Code String Код персони, якщо цей параметр вказується то буде оновлено дані персони ІД якої було вказано
CardCode String Код карти
Email String Адреса електронної пошти
CreateCard Bool Признак створення карти під час реєстрації користувача (по замовчуванню - true Створювати)
Sex Bool Стать
Properties Int [] Масив ID характеристик страв
AddressID Int ID адреси
GetNews Bool Розсилати розсилку новин
PlatformID Int ID платформи
UserPlatformID Int ID користувача платформи
NumberOfChildren Int Кількість дітей
Children Object [] Інформація про дітей:
     | ID Int Ідентифікаційний номер дитини (якщо зазначено - запис оновлюється, інакше — створюється)
     | Firstname String Імя
     | Lastname String Фамілія
     | Patronymic String По батькові
     | Birthday DateTime Дата народження (в форматі "2010-05-15T00:00:00" )
* Позначення обов’язкового параметру
Додатковий опис вихідних параметрів



Response (json)
{
    "Error": "",
    "Success": true,
    "AddressID": null,
    "BirthDate": "1990-01-04 00:00:00",
    "CardCode": null,
    "EMail": null,
    "FirstName": "Snow",
    "LastName": "Jhone",
    "MiddleName": "Raven",
    "PlatformID": null,
    "Sex": false,
    "UserPlatfomID": null,
    "Code": "PERSON166714114529777",
    "PersonID": 23427
}



Типи даних Response
Параметр Тип Опис
Error String Опис помилки, що виникла
Success Bool Успіх виконання запиту
PersonID Int Ідентифікатор персони
* Позначення обов’язкового параметру
Додатковий опис вхідних параметрів