Группа /receivers/ — операции со справочником получателей

Комментарии

• Пользователи личного кабинета могут сохранить реквизиты своих контрагентов в справочник получателей. В дальнейшем, при заполнении сетевой заявки на забор и заявок на предварительное оформление можно будет не указывать все реквизиты для получателя по каждому грузу, а указать код получателя из справочника получателей.

Метод /receivers/add/ — добавление получателя в справочник

Доступ

• Зарегистрированные пользователи

Комментарии

• В поле code (код получателя) нужно сгенерировать GUID и передать его в строковом виде.
• Поля code, title, city, phone обязательны для заполнения.

Формат запроса

{
	"code": "c7d93049-6222-4a9f-b27a-6dc7483ed417", // Код получателя [String]
	"title": "ООО \"Вектор\"", // Наименование получателя [String]
	"city": "Барнаул", // Филиал получателя [String]
	"phone": "131426", // Телефон получателя [String]
	"inn": "500100732259", // ИНН получателя [String]
	"address": "", // Адрес получателя [String]
	"person": "Петров Петр Васильевич" // Контактное лицо [String]
}

Формат ответа

{
   "success": true,
   "status": "Получатель успешно добавлен"
}

Если получателя не удастся добавить, ответ будет содержать сообщения об ошибках в стандартной форме.

Метод /receivers/list/ — просмотр списка получателей

Доступ

• Зарегистрированные пользователи

Формат запроса

{
    // пустой объект
}

Формат ответа

{
    "receivers": [ // Список получателей [Array]
        {
            "code": "99441e15-8f8a-47b7-ab3c-41d38d0705c3", // Код получателя [String]
            "title": "ЧП \"Бенцион Крик и сыновья\"", // Наименование получателя [String]
            "city": "Барнаул", // Филиал получателя [String]
            "phone": "19170519", // Телефон получателя [String]
            "inn": null, // ИНН получателя [String]
            "address": "ул. Бабеля, 13", // Адрес получателя [String]
            "person": "Крик Бенцион Менделевич" // Контактное лицо [String]
        },
        {
            "code": "c7d93049-6222-4a9f-b27a-6dc7483ed417",
            "title": "ООО \"Вектор\"",
            "city": "Барнаул",
            "address": null,
            "person": "Петров Петр Васильевич",
            "phone": "131426",
            "inn": "500100732259"
        }
        ...
    ]
}

Метод /receivers/delete/ — удаление получателя из справочника

Доступ

• Зарегистрированные пользователи

Формат запроса

{
	"code": "c7d93049-6222-4a9f-b27a-6dc7483ed417" // Код удаляемого получателя [String]
}

Формат ответа

{
   "success": true,
   "status": "Получатель успешно удален"
}

Метод /receivers/update/ — обновление получателя в справочнике

Доступ

• Зарегистрированные пользователи

Комментарии

• Обязательно указывать в запросе код получателя в поле code
• Остальные поля необязательны, следует указывать только значения полей, которые нужно изменить
• Значения необязательных полей inn, address, person можно очистить с помощью запроса, для этого надо установить соответствующий признак очистки поля (один из: clearInn, clearAddress, clearPerson). При этом недопустимо в одном запросе указывать и новое значение, и признак очистки для одного и того же поля.

Формат запроса

{
    "code": "c7d93049-6222-4a9f-b27a-6dc7483ed417", // Код изменяемого получателя [String]

    "title": "ООО \"Вектор\"", // Наименование получателя [String]
    "city": "Барнаул", // Филиал получателя [String]
    "phone": "131426", // Телефон получателя [String]
    "inn": "500100732259", // ИНН получателя [String]
    "address": "ул. Ленона 5/13", // Адрес получателя [String]
    "person": "Петров Петр Васильевич", // Контактное лицо [String]
	
    // Признак очистки ИНН получателя, необязательное [Boolean]
    "clearInn": true, // не следует устанавливать этот признак в запросе с заполненным значением поля inn
	
    // Признак очистки контактного лица, необязательное [Boolean]
    "clearPerson": true, // не следует устанавливать этот признак в запросе с заполненным значением поля person
    
    // Признак очистки адреса получателя, необязательное [Boolean]
    "clearAddress": true // не следует устанавливать этот признак в запросе с заполненным значением поля address
}

Формат ответа

{
   "success": true,
   "status": "Получатель успешно изменен"
}