Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Method

GetEmployeeDocumentList

Retrieve list of meta-information for documents

EmployeeDocumentAdd

Method used to do the Add Employee Documents

EmployeeDocumentDelete

Method used to do the Delete Employee Documents

EmployeeDocumentUpdate

Method used to do the Update Employee Documents

GetEmployeeDocumentList

Minimum fields required in order to

...

get a list

 

 

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.

...

Code Block
<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>

 

EmployeeDocumentAdd

Minimum fields required in order to

...

add

 

 

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.

Following fields should be set for each document:
-Contents
-DocumentCategory
-FileName and
-IsEmployeeVisible

...