Click here for an overview of Terminology. Read about the common setup of RESTFul apis |
Please read the API Usage Notice before implementing API consumption. |
https://manager-api.hr-manager.net/EmployeeDocument.svc
Methods:
Method | |
---|---|
| Retrieve list of meta-information for documents |
| Method used to do the Add Employee Documents |
| Method used to do the Delete Employee Documents |
| Method used to do the Update Employee Documents |
|
|
---|---|
AuthenticationToken | This token is used to validate the request so that only authorized users can perform the import. This is to provide the security to the API and restrict the unauthorized access. We can either user customer specific API Key or the Master Key to get access to the system. |
CustomerId | This is customer identification id to let system know where a particular employee should be imported |
ReferenceToken | This field is required for the Import Employee request, however we can pass any value for now in this field. |
EmployeeId | Id of the employee in the manager system for whom we need the list of documents. |
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://schemas.hr-manager.net/remoting/1.0/"> <soapenv:Header/> <soapenv:Body> <ns:GetEmployeeDocumentList> <ns:request> <ns:AuthenticationToken></ns:AuthenticationToken> <ns:CustomerId></ns:CustomerId> <ns:ReferenceToken></ns:ReferenceToken> <ns:EmployeeId></ns:EmployeeId> </ns:request> </ns:GetEmployeeDocumentList> </soapenv:Body> </soapenv:Envelope> |
|
|
---|---|
AuthenticationToken | This token is used to validate the request so that only authorized users can perform the import. This is to provide the security to the API and restrict the unauthorized access. We can either user customer specific API Key or the Master Key to get access to the system. |
CustomerId | This is customer identification id to let system know where a particular employee should be imported |
ReferenceToken | This field is required for the Import Employee request, however we can pass any value for now in this field. |
EmployeeDocuments | Minimum one Document should be sent when adding employee document using the API. |
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://schemas.hr-manager.net/remoting/1.0/" xmlns:hrm="http://schemas.datacontract.org/2004/07/HRMTS.TalentManager.Common.Models.Remoting.Employees"> <soapenv:Header/> <soapenv:Body> <ns:EmployeeDocumentAdd> <ns:request> <ns:AuthenticationToken></ns:AuthenticationToken> <ns:CustomerId></ns:CustomerId> <ns:ReferenceToken></ns:ReferenceToken> <ns:EmployeeDocuments> <hrm:EmployeeDocument> <hrm:Content></hrm:Content> <hrm:DocumentCategory></hrm:DocumentCategory> <hrm:FileName></hrm:FileName> <hrm:IsEmployeeVisible></hrm:IsEmployeeVisible> </hrm:EmployeeDocument> </ns:EmployeeDocuments> <ns:EmployeeId></ns:EmployeeId> </ns:request> </ns:EmployeeDocumentAdd> </soapenv:Body> </soapenv:Envelope> |
|
|
---|---|
AuthenticationToken | This token is used to validate the request so that only authorized users can perform the import. This is to provide the security to the API and restrict the unauthorized access. We can either user customer specific API Key or the Master Key to get access to the system. |
CustomerId | This is customer identification id to let system know where a particular employee should be imported |
ReferenceToken | This field is required for the Import Employee request, however we can pass any value for now in this field. |
EmployeeDocuments | Minimum one Document should be sent when deleting employee documents using the API. |
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://schemas.hr-manager.net/remoting/1.0/" xmlns:hrm="http://schemas.datacontract.org/2004/07/HRMTS.TalentManager.Common.Models.Remoting.Employees"> <soapenv:Header/> <soapenv:Body> <ns:EmployeeDocumentDelete> <ns:request> <ns:AuthenticationToken></ns:AuthenticationToken> <ns:CustomerId></ns:CustomerId> <ns:ReferenceToken></ns:ReferenceToken> <ns:EmployeeDocuments> <hrm:EmployeeDocumentDelete> <hrm:DocumentId></hrm:DocumentId> <hrm:EmployeeId></hrm:EmployeeId> <hrm:FileName></hrm:FileName> </hrm:EmployeeDocumentDelete> </ns:EmployeeDocuments> </ns:request> </ns:EmployeeDocumentDelete> </soapenv:Body> </soapenv:Envelope> |
|
|
---|---|
AuthenticationToken | This token is used to validate the request so that only authorized users can perform the import. This is to provide the security to the API and restrict the unauthorized access. We can either user customer specific API Key or the Master Key to get access to the system. |
CustomerId | This is customer identification id to let system know where a particular employee should be imported |
ReferenceToken | This field is required for the Import Employee request, however we can pass any value for now in this field. |
EmployeeDocuments | Minimum one Document should be sent when updating employee documents using the API. Following fields should be set for each document: |
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://schemas.hr-manager.net/remoting/1.0/" xmlns:hrm="http://schemas.datacontract.org/2004/07/HRMTS.TalentManager.Common.Models.Remoting.Employees"> <soapenv:Header/> <soapenv:Body> <ns:EmployeeDocumentUpdate> <ns:request> <ns:AuthenticationToken></ns:AuthenticationToken> <ns:CustomerId></ns:CustomerId> <ns:ReferenceToken></ns:ReferenceToken> <ns:EmployeeDocuments> <hrm:EmployeeDocument> <hrm:DocumentCategory></hrm:DocumentCategory> <hrm:DocumentId></hrm:DocumentId> <hrm:IsEmployeeVisible></hrm:IsEmployeeVisible> </hrm:EmployeeDocument> </ns:EmployeeDocuments> <ns:EmployeeId></ns:EmployeeId> </ns:request> </ns:EmployeeDocumentUpdate> </soapenv:Body> </soapenv:Envelope> |