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
Method: POST
Endpoint:
https://beanwidget.adcourier.com/distro/advert_status
Content Type: application/json
Body:
Request Fields
| Level | Field | Type | Mandatory | Example Values | Notes |
|---|---|---|---|---|---|
| 1 | authentication | object | Y | ||
| 1.1 | api_key | string | Y | Unique API key for each client, supplied by Veritone Hire | |
| 1.2 | time | string | Y | epoch value (as string) | |
| 1.3 | signature | string | Y | SHA256/HMAC message digest encoded with shared secret key | |
| 2 | identification | object | Y | ||
| 2.1 | client_id | string | Y | AdCourier client id | |
| 2.2 | adc_username | string | Y | AdCourier (ADC) username | |
| 3 | transaction | object | |||
| 3.1 | filters | object | Y | The filters object must contain either: a job_reference string; or a custom_fields array with at least one element. | |
| 3.1.1 | job_reference | string | Y (if custom field is not used) | ||
| 3.1.2 | custom_fields | array list | N | ||
| 3.1.2.1 | name | string | Y | ATS_Job_Id | |
| 3.1.2.2 | value | string | Y | A12345 |
Response Fields
| Level | Field | Type | Mandatory | Example Values | Notes |
|---|---|---|---|---|---|
| 1 | data | array list | Y | ||
| 1.1 | adc_username | string | Y | ||
| 1.2 | channels | array list | Y | ||
| 1.2.1 | advert_url | string | Y | ||
| 1.2.2 | name | string | Y | ||
| 1.2.3 | posted_time | DateTime | Y | ||
| 1.2.4 | removal_time | DateTime | N | ||
| 1.2.5 | response_count | string | Y | ||
| 1.2.6 | status | string | Y | ||
| 1.3 | vaccancy_details | object | Y | ||
| 1.3.1 | advert_id | string | Y | ||
| 1.3.2 | created_time | DateTime | Y | ||
| 1.3.3 | industry | string | N | ||
| 1.3.4 | job_description | string | Y | ||
| 1.3.5 | job_reference | string | Y | ||
| 1.3.6 | job_title | string | N | ||
| 1.3.7 | salary | object | N | ||
| 1.3.7.1 | benefits | string | Y | ||
| 1.3.7.2 | currency | string | Y | ||
| 1.3.7.3 | from | string | Y | ||
| 1.3.7.4 | period | string | Y | ||
| 1.3.7.5 | to | string | Y | ||
| 1.3.8 | skills | string | N | ||
| 2 | message | string | Y | ||
| 3 | response_id | string | |||
| 4 | response_time | DateTime | |||
| 5 | success | string | Y | ||
| 6 | Error | string |