Home > Factory Productivity and Scheduling > Advanced Topics > Import Export Data > Empower API > Using The API To Retrieve Data > Product and Processes
Product and Processes
Product and Process details can be retrieved through the API using the following function calls
1. GetProductDetails(ProductName As String)
This function takes a single argument of data type String and returns the Product Data if it exists.
The following data types are used
NewProductData
ProductName As String
ProductCode As String
Status As String
ProductGroup As String
ProductDescription As String
ProcessList As List(Of ProductProcess)
ProductProcess
ProcessName As String
ProcessData As NewProcessData
BudgetTime As String
NewProcessData
ProcessName As String
ProcessDescription As String
ProcessGroupName As String
As a result the request body should be based on the following
<soapenv:Body>
<web:GetProductDetails>
<web:ProductName>PRODUCT NAME</web:ProductName>
</web:GetProductDetails>
</soapenv:Body>
Response XML Format,
<soap:Body>
<GetProductDetailsResponse xmlns="http://empowersoftware.co.nz/WebService">
<GetProductDetailsResult>
<ProductName>PRODUCT NAME</ProductName>
<ProductCode>PRODUCT CODE</ProductCode>
<Status>STATUS</Status>
<ProductGroup>PRODUCT GROUP</ProductGroup>
<ProductDescription>PRODUCT DESCRIPTION</ProductDescription>
<ProcessList>
<!--Zero or more repetitions:-->
<ProductProcess>
<ProcessName>PROCESS NAME</ProcessName>
<ProcessData>
<ProcessName>PROCESS NAME</ProcessName>
<ProcessDescription>PROCESS DESCRIPTION</ProcessDescription>
<ProcessGroupName>PROCESS GROUP</ProcessGroupName>
</ProcessData>
<BudgetTime>PROCESS BUDGET</BudgetTime>
</ProductProcess>
</ProcessList>
</GetProductDetailsResult>
</GetProductDetailsResponse>
</soap:Body>
2. GetProductDetailsForProductCode(ProductCode As String)
This function takes a single argument of data type String and returns the Product Data if it exists.
As a result the request body should be based on the following
<soapenv:Body>
<web:GetProductDetails>
<web:ProductCode>PRODUCT CODE</web:ProductName>
</web:GetProductDetails>
</soapenv:Body>
Each of the above function calls returns the same data set as follows:
Response XML Format,
<soap:Body>
<GetProductDetailsResponse xmlns="http://empowersoftware.co.nz/WebService">
<GetProductDetailsResult>
<ProductName>PRODUCT NAME</ProductName>
<ProductCode>PRODUCT CODE</ProductCode>
<Status>STATUS</Status>
<ProductGroup>PRODUCT GROUP</ProductGroup>
<ProductDescription>PRODUCT DESCRIPTION</ProductDescription>
<ProcessList>
<!--Zero or more repetitions:-->
<ProductProcess>
<ProcessName>PROCESS NAME</ProcessName>
<ProcessData>
<ProcessName>PROCESS NAME</ProcessName>
<ProcessDescription>PROCESS DESCRIPTION</ProcessDescription>
<ProcessGroupName>PROCESS GROUP</ProcessGroupName>
</ProcessData>
<BudgetTime>PROCESS BUDGET</BudgetTime>
</ProductProcess>
</ProcessList>
</GetProductDetailsResult>
</GetProductDetailsResponse>
</soap:Body>
The following data types are used
NewProductData
ProductName As String
ProductCode As String
Status As String
ProductGroup As String
ProductDescription As String
ProcessList As List(Of ProductProcess)
ProductProcess
ProcessName As String
ProcessData As NewProcessData
BudgetTime As String
NewProcessData
ProcessName As String
ProcessDescription As String
ProcessGroupName As String
For more information see
Example Code
WDSL Schema
See also
Products
See also
|