Terminology
Read about the common setup of RESTFul apis
URL Format
All the Web Service methods use a common convention in their URLs. The URLs consist of parts for customer alias, API key and method name. E.g.:
https://recruiter-api.hr-manager.net/restful.svc/v2/{CUSTOMER-ALIAS}/{API-KEY}/Positions/
When calling an API method, simply replace these parts with proper values.
Items
The node for items include the list of position data objects.
{ "Id": 100, "ThirdPartyPositionId": null, "Name": "", "Type": 1, "DepartmentId": 100, "DepartmentThirdPartyId": "", "ProjectThirdPartyId": "", "IsActive": true, "IsPublished": false, "ApplicationDueDateTimeUtc": "/Date(1524816000000)/", "PositionLeader": { "Id": 100, "ThirdPartyUserId": "", "Email": "john.doe@hrmts.cool", "Title": null, "FirstName": "John", "LastName": "Dow", "Details": null }, "Details": { "ShortDescription": "", "DefaultLanguageId": 0, "CreatedByUserId": 100, "LastUpdatedByUserId": 0, "CustomText1": "", "CustomText2": "", "CustomText3": "", "CustomText4": "", "CustomText5": "", "CustomText6": "", "CustomText7": "", "CustomText8": "", "CustomText9": "", "CustomText10": "", "CustomText11": "", "CustomText12": "", "CustomText13": "", "CustomText14": "", "CustomText15": "", "StartDateTimeUtc": "/Date(1525212000000)/", "CreatedDateTimeUtc": "/Date(1521636612000)/", "LastUpdatedDateTimeUtc": "/Date(1522838779000)/", "WorkflowId": 1, "Category": null, "ApplicationForm": { "Id": "10", "Name": "Default Application Form", "Alias": "Default", "Url": null }, "PositionAdministrator": null, "CustomList1": null, "CustomList2": null, "CustomList3": null, "CustomList4": null, "CustomList5": null, "CustomList6": null, "CustomList7": null, "CustomList8": null, "CustomList9": null, "CustomList10": null, "CustomList11": null, "CustomList12": null, "CustomList13": null, "CustomList14": null, "CustomList15": null, "ApplicationFormQuestionnaireList": [ { "ModuleType": 0, "Id": 100, "Title": "questionaire1", "QuestionList": [ { "Id": 3248, "Text": "Q1", "Type": 0, "AnswerOptionList": [ ], "AnswerList": null } ], "AverageScore": 0, "RawXml": null } ], "NoteList": [ { "Id": "100", "Text": "", "CreatedByUserId": 100, "CreatedDateTimeUtc": "/Date(1521636612000)/" } ], "ScreeningList": null, "ProcessQuestionnaireList": null, "AdvertisementList": [ { "Id": 100, "Description": "", "IntroductionText": "", "MediaList": [ { "Id": "5", "Type": 2, "IsPublished": false } ], "Content": null } ], "ParticipantList": null, "DocumentList": [], "PropertyBag": [] } }
Position Query String Parameters
Following are the query string parameters dedicated for positions
Position Id
Parameter | posid |
---|---|
Description | Send this parameter to filter the list with a single position. Retrieving a single position returns full details of the position. |
Value type | Integer |
Default value | none |
Sample | …/?posid=1 |
IsActive
Parameter | isactive |
---|---|
Description | Send this parameter to include active positions only. |
Value type | Boolean |
Default value | False |
Sample | .../?isactive=1 |
Include Questionnaire
Parameter | incquexml |
---|---|
Description | Send this parameter to include the questionnaire object with questions. |
Value type | Boolean |
Default value | False |
Sample | .../?incquexml=1 |
Include Document Contents
Parameter | incdoccont |
---|---|
Description | Send this parameter to include contents of the documents attached to the position. |
Value type | Boolean |
Default value | False |
Sample | ../?incdoccont=1 |
Include Advertisment Contents
Parameter | incadcont |
---|---|
Description | Send this parameter to include contents of the advertisements. |
Value type | Boolean |
Default value | False |
Sample | ../?incadcont=1 |