Api/CampaignDocList/GetCampaignDocList
The GetCampaignDocList API request provides a way to retrieve a list of the “published” documents linked to an Interview Coordinator campaign record.
One of the features of our Interview Coordinator Applicant Tracking Software (ATS) is the ability to associate one or more documents with a recruitment campaign record. There can be a wide variety of reasons to link documents to a Campaign record – for example, a detailed description of the vacancy to be filled or a recruitment agency terms and conditions document or perhaps even a candidate survey document.
The designated Hiring Manager for an Interview Coordinator campaign can choose to “publish” one or more of these linked documents and, when flagged as published, the documents can be downloaded by candidates or other interested parties.
Linking and publishing document to an Interview Coordinator campaign means that the documents can be used as an integral part of the job advert which describes the vacancy. They can also be used as part of the candidate application process. For example, a candidate could be asked to download and complete a form, and then upload the completed form as part of the application process for a specific vacancy.
Here is an example GetCampaignDocsList request using JSON format :
V2.api.interviewcoordinator
POST /api/uploaddocuments/GetCampaignDocList
{“CampaignID”: “457”}
In response to the receipt of correctly formatted GetCampaignDocsList request, the API server will respond with an http 200 OK response and a series of response parameters. Here is an example response where 3 campaign documents have been “published” by the campaign Hiring Manager:
{“Status”: “success”,”Content”: {“NumberOfDocs”: “3”,”list”: [{“DocumentID”: “http://app.interviewcoordinator.com//Uploads/DocumentAttachments/457//f66f5513-6ceb-49e7-8a7f-77035f2da1ed.pdf“,”Description”: “Job description PDF file attachment”,”Type”: “pdf”,”DisplayOrder”: “1”},{“DocumentID”: “http://app.interviewcoordinator.com//Uploads/DocumentAttachments/457//825df63f-d963-498c-b8f5-2afa78e417e9.xml“,”Description”: “Candidate-Survey PDF file attachement”,”Type”: “pdf”,”DisplayOrder”: “2”},{“DocumentID”: “http://app.interviewcoordinator.com//Uploads/DocumentAttachments/457//1f29077d-20b7-4ec8-b4f3-fb56f488fc06.dwg“,”Description”: “Company Overview PDF file attachment”,”Type”: “pdf”,”DisplayOrder”: “3”}]},”Errors”: null}
Clicking any of the published document URL’s will download the document to the local device.