This API has recently been updated (08.06.2020) |
Read about the common setup of RESTFul apis |
Please read the API Usage Notice before implementing API consumption. This api will by default get 25 positions and have a max on 100, to change this or do paging please read the section about common parameters for RESTFul apis. |
The URL to Web Service method to retrieve one or more departments is the same as for recruiter and is as follows:
https://manager-api.hr-manager.net/restful.svc/{CUSTOMER-ALIAS}/{API-KEY}/departments/
When calling an API method, simply replace these parts with proper values.
Unless otherwise specified through a parameter, queries to the Department API will always default to Root.
The node for items include the list of position data objects.
{ "ExecutionTime": { "Minutes": "0", "Seconds": "0", "Milliseconds": "24" }, "Customer": { "Id": 100, "ThirdPartyCustomerId": "", "Name": "", "Alias": "", "ApiKey": "", "RootDepartment": { "Id": 100, "ThirdPartyId": "", "Name": "", "Details": null } }, "Counts": { "SearchCount": 2, "SkipCount": 0, "TakeCount": 2, "TotalCount": 100 }, "Sort": { "Field": "", "Direction": 0 }, "Items": [ { "Id": 100, "ThirdPartyId": "", "Name": "", "Details": { "InternalName": "", "IsRootDepartment": true, "IsVirtualRootDepartment": false, "IsSynchronized": false, "IsProjectCreationAllowed": true, "IsDeletable": false, "ContactPerson": "", "Address": "", "POBox": "", "Zip": "", "City": "", "County": "", "Country": "", "Phone": "", "PhoneFax": "", "Email": "", "WebSite": "", "ParentDepartmentCsv": "", "SynchronizationId": "", "ParentSynchronizationId": "", "CreatedDateTimeUtc": "/Date(1449826560000)/", "LastUpdatedDateTimeUtc": "/Date(1553765624000)/", "SubDepartments": { "Immediate": { "Count": 2, "Csv": "", "DepartmentList": [ { "Id": 100, "ThirdPartyId": "", "Name": "", "Details": null }, { "Id": 101, "ThirdPartyId": "", "Name": "", "Details": null }, ] }, "Recursive": { "Count": 100, "Csv": "", "DepartmentList": [] } }, "PropertyBag": [] } } ] } |
There are no special query string parameters for this method. See the common parameters for all Restful apis