Tm Document API



 

Please read the API Usage Notice before implementing API consumption.

URL

https://manager-api.hr-manager.net/EmployeeDocument.svc

Methods:

Method

 

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

A unique value (i.e a GUID). This field is required, The value can be any unique string.

EmployeeId

Id of the employee in the manager system for whom we need the list of documents.

 

 


Basic request structure:

1 2 3 4 5 6 7 8 9 10 11 12 13 <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>

 

Response structure:

 

 

 

 

ReferenceToken

It is the same token value which was sent in request.

SystemLanguageType

Language specified in the request. Default will be English.

TransactionStatus

It contains the details of the customer specified in the request and validated through Authentication Token. It also holds the status of the Request sent e.g. Success or Failure.

DocumentList

It can have 0 or more occurrence of employee documents specified in the request.

Document

It contains the details of the document identified by the Id field. Contents of the documents are not included in the response. Actual file can be downloaded using DownloadUrl provided in the Document details.

 

 

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 <s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body> <GetEmployeeDocumentListResponse xmlns="http://schemas.hr-manager.net/remoting/1.0/"> <GetEmployeeDocumentListResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <ReferenceToken></ReferenceToken> <SystemLanguageType></SystemLanguageType> <TransactionStatus> <Customer> <Details i:nil="true"/> <Id></Id> <Name></Name> </Customer> <DebugOverview i:nil="true"/> <StatusDescription></StatusDescription> <StatusType></StatusType> </TransactionStatus> <DocumentList xmlns:a="http://schemas.hr-manager.net/restful/2.0/"> <a:Document> <a:Id></a:Id> <a:Name></a:Name> <a:Extension></a:Extension> <a:ByteCount></a:ByteCount> <a:DownloadUrl></a:DownloadUrl> <a:Bytes i:nil="true"/> <a:Type></a:Type> <a:StorageId/> </a:Document> </DocumentList> <EmployeeDocumentStatusType></EmployeeDocumentStatusType> </GetEmployeeDocumentListResult> </GetEmployeeDocumentListResponse> </s:Body> </s: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

A unique value (i.e a GUID). This field is required, The value can be any unique string.

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


Basic request structure:

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 <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>

 

Response structure:

 

 

 

 

ReferenceToken

It is the same token value which was sent in request.

SystemLanguageType

Language specified in the request. Default will be English.

TransactionStatus

It contains the details of the customer specified in the request and validated through Authentication Token.
It also holds the status of the Request sent e.g. Success, Failure or CompletedWithErrors.

EmployeeDocumentStatusList

It can have 1 or more occurrence of Document status specified in the request.

EmployeeDocumentStatus

It contains the details of the document status like System generated ID of the document,
status whether document has been imported or not, any error message while importing the document
i.e
File Name is missing,
Extension is Missing or Extension not allowed.

 

 

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 <s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body> <EmployeeDocumentAddResponse xmlns="http://schemas.hr-manager.net/remoting/1.0/"> <EmployeeDocumentAddResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <ReferenceToken></ReferenceToken> <SystemLanguageType></SystemLanguageType> <TransactionStatus> <Customer> <Details i:nil="true"/> <Id></Id> <Name></Name> </Customer> <DebugOverview i:nil="true"/> <StatusDescription></StatusDescription> <StatusType></StatusType> </TransactionStatus> <EmployeeDocumentStatus xmlns:a="http://schemas.datacontract.org/2004/07/HRMTS.TalentManager.Common.Models.Remoting.Employees"> <a:EmployeeDocumentStatus> <a:DocumentCategoryId></a:DocumentCategoryId> <a:DocumentStatus></a:DocumentStatus> <a:DocumentStatusErrorMessage i:nil="true"/> <a:EmployeeId></a:EmployeeId> <a:FileName></a:FileName> <a:Id></a:Id> </a:EmployeeDocumentStatus> </EmployeeDocumentStatus> </EmployeeDocumentAddResult> </EmployeeDocumentAddResponse> </s:Body> </s:Envelope>

 

EmployeeDocumentDelete

Minimum fields required

 

 

 

 

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

A unique value (i.e a GUID). This field is required, The value can be any unique string.

EmployeeDocuments

Minimum one Document should be sent when deleting employee documents using the API.

Following fields should be set for each document:
-DocumentId - DocumentId used in TMAN System.
-EmployeeId - EmployeeId of the employee in -TMAN System.
-FileName - FileName of the document to be deleted. If the file name does not match document won't be deleted.


Basic request structure:

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 <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>

 

Response structure:

 

 

 

 

ReferenceToken

It is the same token value which was sent in request.

SystemLanguageType

Language specified in the request. Default will be English.

TransactionStatus

It contains the details of the customer specified in the request and validated through Authentication Token.
It also holds the status of the Request sent e.g. Success, Failure or CompletedWithErrors.

EmployeeDocumentStatusList

It can have 1 or more occurrence of Document status specified in the request.

EmployeeDocumentStatus

It contains the details of the document status whether document has been deleted or not,
any error message while deleting the document e.g. FileNameOrEmployeeIdDoesNotMatch.

 

 

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 <s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body> <EmployeeDocumentDeleteResponse xmlns="http://schemas.hr-manager.net/remoting/1.0/"> <EmployeeDocumentDeleteResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <ReferenceToken></ReferenceToken> <SystemLanguageType></SystemLanguageType> <TransactionStatus> <Customer> <Details i:nil="true"/> <Id></Id> <Name></Name> </Customer> <DebugOverview i:nil="true"/> <StatusDescription></StatusDescription> <StatusType></StatusType> </TransactionStatus> <EmployeeDocumentStatus xmlns:a="http://schemas.datacontract.org/2004/07/HRMTS.TalentManager.Common.Models.Remoting.Employees"> <a:EmployeeDocumentStatus> <a:DocumentCategoryId></a:DocumentCategoryId> <a:DocumentStatus></a:DocumentStatus> <a:DocumentStatusErrorMessage i:nil="true"/> <a:EmployeeId></a:EmployeeId> <a:FileName></a:FileName> <a:Id></a:Id> </a:EmployeeDocumentStatus> </EmployeeDocumentStatus> </EmployeeDocumentDeleteResult> </EmployeeDocumentDeleteResponse> </s:Body> </s:Envelope>

  

EmployeeDocumentUpdate

Minimum fields required in order to update.

 

 

 

 

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

A unique value (i.e a GUID). This field is required, The value can be any unique string.

EmployeeDocuments

Minimum one Document should be sent when updating employee documents using the API. Following fields should be set for each document:
-DocumentId
-DocumentCategory
-IsEmployeeVisible


Basic request structure:

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 <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>

 

Response structure:

 

 

 

 

ReferenceToken

It is the same token value which was sent in request.

SystemLanguageType

Language specified in the request. Default will be English

TransactionStatus

It contains the details of the customer specified in the request and validated through Authentication Token.
It also holds the status of the Request sent e.g. Success, Failure or CompletedWithErrors.

EmployeeDocumentStatusList

It can have 1 or more occurrence of Document status specified in the request.

EmployeeDocumentStatus

It contains the details of the document status whether document has been updated or not any error message while updating the document.

 

 

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 <s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body> <EmployeeDocumentUpdateResponse xmlns="http://schemas.hr-manager.net/remoting/1.0/"> <EmployeeDocumentUpdateResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <ReferenceToken></ReferenceToken> <SystemLanguageType></SystemLanguageType> <TransactionStatus> <Customer> <Details i:nil="true"/> <Id></Id> <Name></Name> </Customer> <DebugOverview i:nil="true"/> <StatusDescription></StatusDescription> <StatusType></StatusType> </TransactionStatus> <EmployeeDocumentStatus xmlns:a="http://schemas.datacontract.org/2004/07/HRMTS.TalentManager.Common.Models.Remoting.Employees"> <a:EmployeeDocumentStatus> <a:DocumentCategoryId></a:DocumentCategoryId> <a:DocumentStatus></a:DocumentStatus> <a:DocumentStatusErrorMessage i:nil="true"/> <a:EmployeeId></a:EmployeeId> <a:FileName i:nil="true"/> <a:Id></a:Id> </a:EmployeeDocumentStatus> </EmployeeDocumentStatus> </EmployeeDocumentUpdateResult> </EmployeeDocumentUpdateResponse> </s:Body> </s:Envelope>