Advert Status API

This API call is used to fetch the status of an advert posted on different job boards so that users will know whether the advert is delivered successfully to all the job boards or not.

This call is usually used when the ATS/CRM system is fetching the status details on user action. As notify on delivery and advert status works in the same way, you can use one or both methods as per business requirements.

Request

POST https://beanwidget.adcourier.com/distro/advert_status

Content Type: application/json
Body:
Example Request
{
    "authentication": {
        "api_key": "123456789",
        "time": "1395834265000",
        "signature": "s6f74hd756heg6sgr6gfts64g6sgdf5462yehdg5fbrys7rjek9ksjurhdytchs65"
    },
    "identification": {
        "client_id": "testclient",
        "adc_username": "testuser@testing.testoffice.testclient"
    },
    "transaction": {
        "filters": {
            "job_reference": "TSTJ234"
        }
    }
}
Example Response (200 OK)
{
    "data": [
        {
            "adc_username": "testuser@testing.testoffice.testclient",
            "channels": [
                {
                    "advert_url": "http://broadbean_demo_board.broadbantech.com/jobs/view/0022",
                    "name": "Broadbean Demo Board",
                    "posted_time": "2024-02-29T09:08:50Z",
                    "removal_time": "2024-03-07T09:08:50Z",
                    "response_count": "1",
                    "status": "Delivered"
                }
            ],
            "vacancy_details": {
                "advert_id": "631306",
                "created_time": "2024-02-29T09:08:47Z",
                "industry": "Accountancy",
                "job_description": "test description",
                "job_reference": "12345abc",
                "job_title": "Finance Manager v3",
                "salary": {
                    "benefits": "benefits",
                    "currency": "EUR",
                    "from": "60000",
                    "period": "annum",
                    "to": "100000"
                },
                "skills": ""
            }
        },
        {
            "adc_username": "testuser@testing.testoffice.testclient",
            "channels": [
                {
                    "advert_url": "http://broadbean_demo_board.brodbeantech.com/jobs/view/0211",
                    "name": "Broadbean Demo Board",
                    "posted_time": "2024-02-29T09:07:51Z",
                    "removal_time": "2024-03-07T09:07:51Z",
                    "response_count": "0",
                    "status": "Delivered"
                },
                {
                    "advert_url": "http://www.jobscbi.net/jobs/view/30397",
                    "name": "Jobs Cabinet (Test Board)",
                    "posted_time": "2024-02-29T09:07:50Z",
                    "removal_time": "2024-03-07T09:07:50Z",
                    "response_count": "0",
                    "status": "Delivered"
                }
            ],
            "vacancy_details": {
                "advert_id": "631305",
                "created_time": "2024-02-29T09:07:31Z",
                "industry": "Accountancy",
                "job_description": "test description",
                "job_reference": "12345abc",
                "job_title": "Finance Manager v2",
                "salary": {
                    "benefits": "benefits",
                    "currency": "EUR",
                    "from": "60000",
                    "period": "annum",
                    "to": "100000"
                },
                "skills": ""
            }
        }
    ],
    "message": "AdvertCheck request successful",
    "response_id": "3AF21F04-DA53-11EE-9A75-9EAC79142E14",
    "response_time": "2024-03-04T18:15:50Z",
    "success": 1
}

Request Fields


Response Fields

Return to top