Interface ITrvEmployee

The methods for the ITrvEmployee interface all use an XML-based format for input and output. To provide further detail, there are input and output samples for each method.

Method name: Inquiry

Short Description
Retrieve employee information.
Functionality
SAP POS processes the inquiry, retrieves the data, and outputs the employee information matching the inquiry. See sample XML input and output formats in the Syntax areas below.
Preconditions
- You must register rvEmployeeAPI.DLL
- At a minimum, the inquiry input must include the following information:
  - inquiryEmployeeNumber
  - inquiryEmployeeStoreNumber
  - Password of the employee who is the inquiry target
Result
HRESULT

Syntax Syntax

The file bstrXmlEmpInq is a sample XML-based employee inquiry. During processing, SAP POS uses inquiryEmployeeNumber to check authorization.

<EMPLOYEE_INQUIRY_REQUEST>
	<inquiryEmployeeNumber>1111</inquiryEmployeeNumber>
	<inquiryEmployeeStoreNumber>1</inquiryEmployeeStoreNumber>
	<password>111111b</password>
	<storeNumber>1</storeNumber>
	<employeeNumber>1111</employeeNumber>
	<firstName></firstName>
	<lastName></lastName>
</EMPLOYEE_INQUIRY_REQUEST>

End of the code.

Syntax Syntax

The file btrXmlEmpInqResult is a sample of the XML-based output generated for the employee inquiry.

<EMPLOYEE_INQUIRY_RESPONSE>
	<Employee_Inquiry_Response_Detail/>
	<address1/>
	<authorizationLevel>5</authorizationLevel>
	<cashierNumber>5555</cashierNumber>
	<city/>
	<clockedIn>0</clockedIn>
	<clockInDateTime>12-31-1969 06:00:00 PM</clockInDateTime>
	<clockInReason>0</clockInReason>
	<commissionRate>0</commissionRate>
	<employeeDiscount>30000</employeeDiscount>
	<employeeNumber>5555</employeeNumber>
	<employeeProfileID>0</employeeProfileID>
	<firstName>Leslie</firstName>
	<forcePreset>1</forcePreset>
	<hourlyPayRate>1</hourlyPayRate>
	<lastName>Radus</lastName>
	<password>OUJsa/+TdhCPZFiZpX1x4+3PTGg=</password>
	<phoneNumber1/>
	<priceLevel>0</priceLevel>
	<regionNumber>0</regionNumber>
	<salary>0</salary>
	<salesPersonID>5555</salesPersonID>
	<schedulingMode>0</schedulingMode>
	<socialInsuranceNumber>0</socialInsuranceNumber>
	<stateProviceCode/>
	<status>1</status>
	<storeNumber>1</storeNumber>
	<type>1</type>
	<zipCode/>
</EMPLOYEE_INQUIRY_RESPONSE>

End of the code.

Parameter Name	Parameter Type	Data Type
bstrXmlEmpInq	IN	BSTR
bstrXmlEmpInqResult	OUT	BSTR*

Method name: InquirySecurity

Short Description
Retrieve employee security information.
Functionality
SAP POS processes the inquiry, retrieves the data, and outputs the employee security information matching the inquiry. See sample XML input and output formats in the Syntax areas below.
Preconditions
You must register TrvEmployeeAPI.DLL.
Result
HRESULT

Syntax Syntax

The file bstrXmlEmpInqSecurity is a sample XML-based employee security inquiry. During processing, SAP POS uses inquiryEmployeeNumber to check authorization.

<EMPLOYEE_INQUIRY_SECURITY_REQUEST>
	<inquiryEmployeeNumber>1111</inquiryEmployeeNumber>
	<inquiryEmployeeStoreNumber>1</inquiryEmployeeStoreNumber>
	<password>111111a</password>
	<storeNumber>1</storeNumber>
	<employeeNumber>1111</employeeNumber>
	<firstName></firstName>
	<lastName></lastName>
</EMPLOYEE_INQUIRY_SECURITY_REQUEST>

End of the code.

Syntax Syntax

The file btrXmlEmpInqSecurityResult is a sample of the XML-based output generated for the employee security inquiry.

<EMPLOYEE_INQUIRY_SECURITY_RESPONSE>
	<authorizationLevel>5</authorizationLevel>
	<problemDescription>Employee Operation Succeed</problemDescription>
</EMPLOYEE_INQUIRY_SECURITY_RESPONSE>

End of the code.

Parameter Name	Parameter Type	Data Type
bstrXmlEmpInqSecurity	IN	BSTR
bstrXmlEmpInqSecurityResult	OUT	BSTR*

Method name: Update

Short Description
Update employee information.
Functionality
SAP POS authorizes the inquiry, updates the employee data, and outputs the results of the update processing. See sample input and output formats in the Syntax areas below.
Preconditions
You must register TrvEmployeeAPI.DLL.
Result
HRESULT

Syntax Syntax

The file bstrXmlEmpUpdate is a sample XML-based employee update request. During processing, SAP POS uses inquiryEmployeeNumber to check authorization.

<CUSTOMER_UPDATE_REQUEST>
	<Customer_Update_Request_Header>
		<inquiryEmployeeNumber>1111</inquiryEmployeeNumber>
		<inquiryEmployeeStoreNumber>1</inquiryEmployeeStoreNumber>
	</Customer_Update_Request_Header>
		<Employee_Update_Request_Detail>
		<customerNumber>10987654321</customerNumber>
		<address1></address1>
		<authorizationLevel></authorizationLevel>
		<cashierNumber></cashierNumber>
		<city></city>
		<clockedIn></clockedIn>
		<clockInDateTime></clockInDateTime>
		<clockInReason></clockInReason>
		<commissionRate></commissionRate>
		<employeeDiscount></employeeDiscount>
		<employeeProfileID></employeeProfileID>
		<firstName>John</firstName>
		<forcePreset></forcePreset>
		<hourlyPayRate></hourlyPayRate>
		<lastName>Smith</lastName>
		<password></password>
		<phoneNumber1></phoneNumber1>
		<priceLevel></priceLevel>
		<regionNumber></regionNumber>
		<salary></salary>
		<salesPersonID></salesPersonID>
		<schedulingMode></schedulingMode>
		<shortName></shortName>
		<socialInsuranceNumber></socialInsuranceNumber>
		<stateProvinceCode></stateProvinceCode>
		<status></status>
		<storeNumber></storeNumber>
		<type></type>
		<zipCode></zipCode>
	</Employee_Update_Request_Detail>
</EMPLOYEE_UPDATE_REQUEST>

End of the code.

Syntax Syntax

The file btrXmlEmpInqUpdate is a sample of the XML-based output generated to show the results of the employee update processing.

<CUSTOMER_UPDATE_RESPONSE>
	<Customer_Update_Response_Header/>
		<inquiryEmployeeNumber>1111</inquiryEmployeeNumber>
	<Customer_Update_Response_Detail/>
		<customerNumber>10987654321</customerNumber>
</CUSTOMER_UPDATE_RESPONSE>

End of the code.

Parameter Name	Parameter Type	Data Type
bstrXmlEmpUpdate	IN	BSTR
bstrXmlEmpUpdateResult	OUT	BSTR*

Method name: Delete

Short Description
Delete employee.
Functionality
SAP POS authorizes the inquiry, deletes the employee, and outputs the results of the delete processing. See sample input and output formats in the Syntax areas below.
Preconditions
You must register TrvEmployeeAPI.DLL.
Result
HRESULT

Syntax Syntax

The file bstrXmlEmpDelete is a sample XML-based employee delete request. During processing, SAP POS uses inquiryEmployeeNumber to check authorization.

<EMPLOYEE_DELETE_REQUEST>
	<Employee_Delete_Request_Header>
		<inquiryEmployeeNumber>1111</inquiryEmployeeNumber>
		<inquiryEmployeeStoreNumber>1</inquiryEmployeeStoreNumber>
	</Employee_Delete_Request_Header>
	<Employee_Delete_Request_Detail>
		<storeNumber></storeNumber>
		<employeeNumber>8877</employeeNumber>
		<firstName></firstName>
		<lastName></lastName>
	</Employee_Delete_Request_Detail>
</EMPLOYEE_DELETE_REQUEST>

End of the code.

Syntax Syntax

The file btrXmlEmpDeleteResult is a sample of the XML-based output generated to show the results of the employee delete processing.

<EMPLOYEE_DELETE_RESPONSE>
	<Employee_Delete_Response_Header/>
		<inquiryEmployeeNumber>1111</inquiryEmployeeNumber>
		<inquiryEmployeeStoreNumber>1</inquiryEmployeeStoreNumber>
	<Employee_Delete_Response_Detail/>
		<storeNumber>0</storeNumber>
		<employeeNumber>8877</employeeNumber>
</EMPLOYEE_DELETE_RESPONSE>

End of the code.

Parameter Name	Parameter Type	Data Type
bstrXmlEmpDelete	IN	BSTR
bstrXmlEmpDeleteResult	OUT	BSTR*

Method name: Initialize

Short Description
Initialize employee information.
Functionality
SAP POS initializes the employee information and outputs the results of the initialize processing. See sample input and output formats in the Syntax areas below.
Preconditions
You must register TrvEmployeeAPI.DLL.
Result
HRESULT

Syntax Syntax

The file bstrXmlEmpInit is a sample XML-based initialize request.

<EMPLOYEE_INIT_REQUEST>
	<serverName>127.0.0.1</serverName>
	<storeNumber>1</storeNumber>
	<registerNumber>1</registerNumber>
	<timeOut>20</timeOut>
</EMPLOYEE_INIT_REQUEST>

End of the code.

Syntax Syntax

The file btrXmlEmpInitResult is a sample of the XML-based output generated to show the initialization results.

<EMPLOYEE_INIT_RESPONSE>
	<problemDescription>Employee Operation Succeed</problemDescription>
</EMPLOYEE_INIT_RESPONSE>

End of the code.

Parameter Name	Parameter Type	Data Type
bstrXmlEmpInit	IN	BSTR
bstrXmlEmpInitResult	OUT	BSTR*