Responses API

This endpoint provides the link for Veritone Hire NMR (New Manage Responses) screen that will show responses received for advert matching the details given inside the filter object of the API request. Users can use this screen to check the responses, flag candidates and forward CV etc.

Request

POST https://beanwidget.adcourier.com/candidates/responses

Content Type: application/json
Body:
Example Request 
{
    "authentication": {
        "api_key": "123456789",
        "signature": "s6f74hd756heg6sgr6gfts64g6sgdf5462yehdg5fbrys7rjek9ksjurhdytchs65",
        "time": "1395834265000"
    },
    "identification": {
        "client_id": "testclient",
        "adc_username": "testuser@testing.testoffice.testclient"
    },
    "transaction": {
        "options": {
            "behaviour_if_not_advert_owner": "view"
        },
        "config": {
            "stylesheet": "https://www.testsite.com/custabc12311om.css"
        },
        "filters": {
            "custom_fields": [
                {
                    "name": "ATS_Job_Id",
                    "value": "12345"
                }
            ],
            "jobref": "abc12311"
        }
    }
}
Example Response (200 OK) 
{
    "success": 1,
    "url": "https://api-search.adcourier.com/search/r2KLLkDBF6cfH6ghf4pB8GCqhDY/?STOK=eyJwMnMiOiJAyYyI6NTAwMH0.ZV90"
}

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 options object N The default is none and don’t need to add unless required.
3.1.1 behaviour_if_not_advert_owner string Y "none"|"view"|"act" "“none” - No visibility of other peoples’ adverts (will go to Broadcast Step 1 to post a new advert).
“view” / “act” - same behaviour - if the advert is owned by another user they will be logged into NMR (new manage responses) as the original advert owner and should see the responses"
3.2 filters object Y The filters object must contain either: a job_reference string; or a custom_fields array with at least one element.
3.2.1 job_reference string Y (if custom field is not used)
3.2.2 custom_fields array list N
3.2.2.1 name string Y ATS_Job_Id
3.2.2.2 value string Y A12345
3.3 config object N
3.3.1 stylesheet string Y Custom CSS file link.

Response Fields

Level Field Type Mandatory Example Values Notes
1 success boolean Y 1 or 0
2 url string Y (In case of success) iFrame Url for new managed response screen.
3 error string Y (In case of error) Error message
Return to top