Retail Department API

This topic describes the retail department APIs for the Integration Framework.

API

Name Description
void Delete(LogonInfo, RecordIdentifier)

Delete a retail department.

Parameters:

  • logonInfo: Login information for the database
  • retailDepartmentID: The ID of the retail department to delete
void Get(LogonInfo, RecordIdentifier)

Get a retail department.

Parameters:

  • logonInfo: Login information for the database
  • retailDepartmentID: The ID of the retail department to get
void Save(LogonInfo, RetailDepartment)

Save a retail department.

Parameters:

  • logonInfo: Login information for the database
  • retailDepartment: The retail department to save

If the retail department has a division that does not already exist in LS One database, then the department is saved with no associated division.
RetailDepartmentsSaveResult SaveList(LogonInfo, List<RetailDepartment>)

Save multiple retail departments.

Parameters:

  • logonInfo: Login information for the database
  • retailDepartments: The retail departments to save

 

Business objects

The following business objects are used by the retail department API.

Name Description
ID The ID of the retail department.
MasterID The unique identifier of the retail department.
NameAlias The name alias of the retail department.
RetailDivisionID The ID of the retail division to which the departments belongs to.
RetailDivisionMasterID The unique identifier of the retail division.
Text The name the retail department.

For a retail department object to be valid the ID and Text properties must be set.

Name Description
RetailDepartmentErrorInfo A list of objects containing the retail departments that failed the saving process along with the error message.
EndTime The time at which the saving process finished.
StartTime The time at which the saving process started.
Success True if the saving process finished successfully.

 

Examples

To update retail departments you must use the optimized update feature.

Updating a retail department


	RetailDepartment department = wcfRetailDepartmentService.Get(CreateLogonInfo(dataModel), "0000001");
	department.Text += "-Updated";
	department.DivisionID = "0000003";

	((IOptimizedUpdate) department).CloneUpdateListToTransportList();
	wcfRetailDepartmentService.Save(CreateLogonInfo(dataModel), department);

In the above example, firstly we get an existing retail department through the Integration Framework, update it, then we clone the update list using the optimized update functionality. After we update all properties accordingly we save the retail department through the Integration Framework.

Deleting a retail department


	wcfRetailDepartmentService.Delete(CreateLogonInfo(dataModel), "0000001");

See also