Раздел “Креативы”
Действие: Создание креатива
Метод: POST
URL: https://back.stage-ord.socialjet.pro/api/v1/creatives
Request:
| Ключ | Описание | Тип | Обязательность | Дефолтно | Связь |
| clientId | ID клиента | INT | Да | - | Client.id |
| agentId | ID юр. лица | INT | Да | - | Agent.id |
| campaignId | ID РК | INT | Нет | - | Campaign.id |
| campaignType | Тип РК | String | Да | - | E: Тип РК |
| name | Название креатива | String | Да | - | - |
| clientFileId | ID файла анкеты клиента | INT | Нет | - | File.id |
| creativeFileId | ID файла креатива | INT | Нет | - | File.id |
| creativeOrdMark | Маркировка в ОРД | String | Нет | NOT_PRESENT | - |
| initContractNumber | Номер изначального договора | String | Да | - | - |
| initContractDate | Дата договора | DateTime | Да | - | - |
| initContractType | Тип договора | String | Да | - | E: Тип договора |
| initDsNumber | Номер ДС к изначальному договору | String | Нет | - | - |
| initDsDate | Дата ДС к изначальному договору | DateTime | Нет | - | - |
| initSubject | Сведения о предмете ДС | String | Нет | - | - |
| initCustomer | Заказчик в изначальном договору | String | Да | - | - |
| initCustomerInn | ИНН заказчика | String | Да | - | - |
| initCustomerLegalStatus | Правовой статус заказчика | String | Да | - | E: Правовой статус |
| initExecutor | Исполнитель в изначальном договору | String | Да | - | - |
| initExecutorInn | ИНН исполнителя | String | Да | - | - |
| initExecutorLegalStatus | Правовой статус исполнителя | String | Да | - | E: Правовой статус |
| creativeType | Тип креатива | String | Да | - | E: Тип креатива |
| creativeSocial | Социальная реклама | Boolean | Нет | false | - |
| creativeKktu | ККТУ | String | Да | - | - |
| creativeObject | Описание объекта рекламы | String | Нет | - | - |
| creativeLocation | Расположение маркировки | String | Да | - | E: Расположение маркировки |
| comment | Комментарий | String | Нет | - | - |
| ordToken | Токен ОРД | String | Нет | - | - |
Response:
| Статус | Описание | Объект | Комментарий |
| 201 | Success | Creative | Объект креатива |
| 400 | Error | - | Ошибка |
| 500 | Error | - | Ошибка |
Действие: Обновление креатива
Метод: PUT
URL: https://back.stage-ord.socialjet.pro/api/v1/creatives/{ID}
Params:
| Ключ | Описание | Тип | Обязательность | Дефолтно | Связь |
| ID | ID креатива | INT | Да | - | Creative.id |
Request:
| Ключ | Описание | Тип | Обязательность | Дефолтно | Связь |
| clientId | ID клиента | INT | Нет | - | Client.id |
| agentId | ID юр. лица | INT | Нет | - | Agent.id |
| campaignId | ID РК | INT | Нет | - | Campaign.id |
| campaignType | Тип РК | String | Нет | - | E: Тип РК |
| name | Название креатива | String | Нет | - | - |
| clientFileId | ID файла анкеты клиента | INT | Нет | - | File.id |
| creativeFileId | ID файла креатива | INT | Нет | - | File.id |
| creativeOrdMark | Маркировка в ОРД | String | Нет | - | - |
| initContractNumber | Номер изначального договора | String | Нет | - | - |
| initContractDate | Дата договора | DateTime | Нет | - | - |
| initContractType | Тип договора | String | Нет | - | E: Тип договора |
| initDsNumber | Номер ДС к изначальному договору | String | Нет | - | - |
| initDsDate | Дата ДС к изначальному договору | DateTime | Нет | - | - |
| initSubject | Сведения о предмете ДС | String | Нет | - | - |
| initCustomer | Заказчик в изначальном договору | String | Нет | - | - |
| initCustomerInn | ИНН заказчика | String | Нет | - | - |
| initCustomerLegalStatus | Правовой статус заказчика | String | Нет | - | E: Правовой статус |
| initExecutor | Исполнитель в изначальном договору | String | Нет | - | - |
| initExecutorInn | ИНН исполнителя | String | Нет | - | - |
| initExecutorLegalStatus | Правовой статус исполнителя | String | Нет | - | E: Правовой статус |
| creativeType | Тип креатива | String | Нет | - | E: Тип креатива |
| creativeSocial | Социальная реклама | Boolean | Нет | - | - |
| creativeKktu | ККТУ | String | Нет | - | - |
| creativeObject | Описание объекта рекламы | String | Нет | - | - |
| creativeLocation | Расположение маркировки | String | Нет | - | E: Расположение маркировки |
| comment | Комментарий | String | Нет | - | - |
| ordToken | Токен ОРД | String | Нет | - | - |
Response:
| Статус | Описание | Объект | Комментарий |
| 200 | Success | Creative | Объект креатива |
| 400 | Error | - | Ошибка |
| 404 | Not Found | - | Отсутствует креатив |
| 500 | Error | - | Ошибка |
Действие: Удаление креатива
Метод: DELETE
URL: https://back.stage-ord.socialjet.pro/api/v1/creatives/{ID}
Params:
| Ключ | Описание | Тип | Обязательность | Дефолтно | Связь |
| ID | ID креатива | INT | Да | - | Creative.id |
Response:
| Статус | Описание | Объект | Комментарий |
| 20 | Success | - | Успех |
| 400 | Error | - | Ошибка |
| 500 | Error | - | Ошибка |
Действие: Получение креатива
Метод: GET
URL: https://back.stage-ord.socialjet.pro/api/v1/creatives/{ID}
Params:
| Ключ | Описание | Тип | Обязательность | Дефолтно | Связь |
| ID | ID креатива | INT | Да | - | Creative.id |
Response:
| Ключ | Описание | Тип | Обязательность | Дефолтно | Связь |
| id | ID креатива | INT | Да | AI | - |
| authorId | ID автора креатива | INT | Да | - | User.id |
| clientId | ID клиента | INT | Да | - | Client.id |
| agentId | ID юр. лица | INT | Да | - | Agent.id |
| campaignId | ID РК | INT | Да | - | Campaign.id |
| campaignType | Тип РК | String | Да | - | E: Тип РК |
| name | Название креатива | String | Да | - | - |
| clientFileId | ID файла анкеты клиента | INT | Нет | - | File.id |
| creativeFileId | ID файла креатива | INT | Да | - | File.id |
| creativeOrdMark | Маркировка в ОРД | String | Да | - | - |
| initContractNumber | Номер изначального договора | String | Да | - | - |
| initContractDate | Дата договора | DateTime | Да | - | - |
| initContractType | Тип договора | String | Да | - | E: Тип договора |
| initDsNumber | Номер ДС к изначальному договору | String | Нет | - | - |
| initDsDate | Дата ДС к изначальному договору | DateTime | Нет | - | - |
| initSubject | Сведения о предмете ДС | String | Нет | - | - |
| initCustomer | Заказчик в изначальном договору | String | Да | - | - |
| initCustomerInn | ИНН заказчика | String | Да | - | - |
| initCustomerLegalStatus | Правовой статус заказчика | String | Да | - | E: Правовой статус |
| initExecutor | Исполнитель в изначальном договору | String | Да | - | - |
| initExecutorInn | ИНН исполнителя | String | Да | - | - |
| initExecutorLegalStatus | Правовой статус исполнителя | String | Да | - | E: Правовой статус |
| creativeType | Тип креатива | String | Да | - | E: Тип креатива |
| creativeSocial | Социальная реклама | Boolean | Да | - | - |
| creativeKktu | ККТУ | String | Да | - | - |
| creativeObject | Описание объекта рекламы | String | Нет | - | - |
| creativeLocation | Расположение маркировки | String | Да | - | E: Расположение маркировки |
| comment | Комментарий | String | Нет | - | - |
| ordToken | Токен ОРД | String | Нет | - | - |
| createdAt | Дата добавления | DateTime | Да | - | - |
| author | Объект автора | <User> | Нет | - | User.id |
| client | Объект клиента | <Client> | Нет | - | Client.id |
| agent | Объект юр. лица | <Agent> | Нет | - | Agent.id |
| campaign | Объект РК | <Campaign> | Нет | - | Campaign.id |
| services | Список объектов услуг | <Service[]> | Нет | - | Service.id |
Enum: Тип РК
Метод: GET
URL: https://back.stage-ord.socialjet.pro/api/v1/dictionary/campaign-type
Метод: GET
URL: https://back.stage-ord.socialjet.pro/api/v1/dictionary/contract-type
Enum: Тип договора
Метод: GET
URL: https://back.stage-ord.socialjet.pro/api/v1/dictionary/legal-status
Enum: Правовой статус
Метод: GET
URL: https://back.stage-ord.socialjet.pro/api/v1/dictionary/creative-type
Enum: Тип креатива
Метод: GET
URL: https://back.stage-ord.socialjet.pro/api/v1/dictionary/marking-location
Enum: Расположение маркировки