Документация API JCat.Работа

Пакеты вакансий

Список пакетов объявлений тематики

Объявления могут быть сгруппированы в пакеты, каждый из которых имеет тариф, по которому осуществляется размещение.

GET /v1/packets/list/{theme}/{page}

Обязательные параметры:

ИмяТипОписаниеДопустимые значения
 theme stringТематика пакетовrealty
 page integerНомер страницы

Принимаемые параметры (GET-параметры):

ИмяТипОписаниеОбязательноеВозможно указание нескольких значенийДопустимые значения
sortstringПараметр, по которому нужно отсортировать выдачуНетНетid, createdAt, activatedAt
directionstringПорядок сортировкиНетНетdesc, asc
limitintegerКоличество пакетов в списке на одной страницеНетНет
statestringСтатус пакетов объявлений, которые приходят в ответеНетНетактивные - active, срок действия истёк - not_published, не оплачен - not_paid

 Результат запроса 

  • 200 OK - успешное выполнение
  • 404 Not Found - пакет объявлений не найден
  • 403 Forbidden - пакет объявлений недоступно данному пользователю

 Пример тела ответа 

{
    "data": {
        "items": [
            {
                "id": 12345,
                "number": "P12345",
                "title": "Недвижимость - 10",
                "createdAt": "2019-01-01T15:10:22+03:00",
                "activatedAt": "2019-01-01",
                "completedAt": "2020-01-19",
                "orders": {
                    "limit": 10,
                    "active": 0,
                    "archive": 2,
                    "total": 2
                },
                "state": {
                    "type": "active",
                    "title": "Активирован",
                    "left2end": 5,
                    "need2prolongate": false
                },
                "category": {
                    "id": 65,
                    "codeName": "realty",
                    "title": "Недвижимость",
                    "path": "Недвижимость",
                    "breadcrumbs": "65,292"
                },
                "tariff": {
                    "id": 152,
                    "title": "Базовый пакет",
                    "days": 30,
                    "premiums": {
                        "premium": 0,
                        "mblock": 0,
                        "total": 0
                    }
                },
                "region": {
                    "id": 83,
                    "title": "Чувашия"
                },
                "country": {
                    "id": null,
                    "title": null
                },
                "contacts": {
                    "personName": "",
                    "email": "",
                    "companyName": "",
                    "siteUrl": "",
                    "phones": {
                        "main": {
                            "number": "",
                            "additional": ""
                        },
                        "second": {
                            "number": "",
                            "additional": ""
                        }
                    }
                }
            }
        ],
        "total": 197,
        "pages": {
            "page": 1,
            "total": 20,
            "limit": 10
        }
    }
}

Перемещение объявления из пакета в пакет

POST v1/packets/move/{orderId}/{packetId}

Параметры запроса:

ИмяТипОписаниеПример значенияОбязательное
orderIdintegerИдентификатор объявления1000Да
packetIdintegerИдентификатор пакета100Да

Результат запроса:

  • 200 Ok - успешное выполнение
  • 400 Bad Request - в запросе отсутствуют данные или данное объявление нельзя перенести в указанный пакет
  • 403 Forbidden - доступ для данного пользователя запрещен

 Пример тела ответа 

{
    "data": {
        "message": "move_success",
        "value": {
            "order": 1000,
            "packet": "100",
            "tariff": "Базовый пакет"
        }
    }
}

 Пример тела ответа (невалидный запрос) 

{
    "data": {},
    "errors": [
        {
            "type": "validation",
            "code": "constraint",
            "text": "Регион объявления не подходит для размещения в указанном пакете",
            "value": "Москва"
        },
        {
            "type": "validation",
            "code": "constraint",
            "text": "Тематика объявления не подходит для размещения в указанном пакете",
            "field": "Аренда квартиры",
            "value": ""
        }
    ]
}