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

Матеріал з SERVIO
Перейти до навігації Перейти до пошуку
(Створена сторінка: ==''' Функція виконує реєстрацію користувача в системі '''== Розділ містить методи, необхідні для реєстрації користувача в системі <br> {| cellspacing="3" cellpadding="0" style="width:100%; clear:both; margin:0.5em auto; background-color:#eaecf0; border:1px solid #c8ccd1;" |- ! style="background:#cdf; padding:0.5em; text-align:left; width:15%" id="file...)
 
Немає опису редагування
Рядок 38: Рядок 38:
<syntaxhighlight lang="json">
<syntaxhighlight lang="json">
{
{
  "PhoneNumber": "380931111113",
    "PhoneNumber": "0999999299",
  "Password": "MyPassword"
    "Password": "secretpassword",
  "LastName": "Jhone",
    "LastName": "Smith",
  "FirstName": "Snow",
    "FirstName": "John",
  "MiddleName": "Raven",
    "MiddleName": "Doe",
  "BirthDate": "1990-01-04",
    "BirthDate": "1990-01-01T00:00:00",
  "Code": null,
    "Code": "ABC123zxc",
  "CardCode": "111",
    "CardCode": "CARD456gfdg",
  "EMail": "johnsnow@gmail.com",
    "EMail": null,
  "CreateCard": true,
    "CreateCard": false,
  "Sex": null,
    "Sex": true,
  "Properties": [],
    "Properties": null,
  "AddressID": null,
    "AddressID": 0,
  "GetNews": true,
    "GetNews": true,
  "PlatfomID": null,
    "Children": [
  "UserPlatformId": null
        {
            "Firstname": "Child1",
            "Lastname": "Smith",
            "Patronymic": "Doe",
            "Birthday": "2010-05-15T00:00:00"
        },
        {
            "Firstname": "Child2",
            "Lastname": null,
            "Patronymic": null,
            "Birthday": null
        }
    ],
    "PlatformID": "PLATFORM123",
    "UserPlatfomID": "USERPLATFORM456"
}
}
</syntaxhighlight>
</syntaxhighlight>
Рядок 146: Рядок 160:
| ID
| ID
| ID користувача платформи
| ID користувача платформи
|-
|
| <span style="color:#ff0000">Children </span>
| <span style="color:#ff0000">Object[]</span>
| Інформація про дітей:
|-
|
||&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#ff0000">'''|'''</span> ID
| Int
| Ідентифікаційний номер дитини (якщо зазначено - запис оновлюється, інакше — створюється)
|-
|
||&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#ff0000">'''|'''</span> Firstname
| String
| Імя
|-
|
||&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#ff0000">'''|'''</span> Lastname
| String
| Фамілія
|-
|
||&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#ff0000">'''|'''</span> Patronymic
| String
| По батькові
|-
|
||&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#ff0000">'''|'''</span> Birthday 
| DateTime
| Дата народження (в форматі "2010-05-15T00:00:00" )
|-
|-



Версія за 12:10, 22 вересня 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 Номер телефону
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 ID ID користувача платформи
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 Ідентифікатор персони
* Позначення обов’язкового параметру
Додатковий опис вхідних параметрів