Retail Division API

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

API

Name Description
void Delete(LogonInfo, RecordIdentifier)

Delete a retail division.

Parameters:

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

Get a retail division.

Parameters:

  • logonInfo: Login information for the database
  • retailDivisionID: The ID of the retail division to get
void Save(LogonInfo, RetailDivision)

Save a retail division.

Parameters:

  • logonInfo: Login information for the database
  • retailDivision: The retail division to save
RetailDivisionSaveResult SaveList(LogonInfo, List<RetailDivision>)

Save multiple retail divisions.

Parameters:

  • logonInfo: Login information for the database
  • retailDivisions: The retail divisions to save

 

Business objects

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

Name Description
ID The ID of the retail division.
MasterID The unique identifier of the retail division.
Text The name the retail division.

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

Name Description
RetailDivisionErrorInfo A list of objects containing the retail divisions 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 divisions you must use the optimized update feature.

Updating a retail division


	RetailDivision division = wcfRetailDivisionService.Get(CreateLogonInfo(dataModel), "0000001");
	division.Text += "-Updated";

	((IOptimizedUpdate) division).CloneUpdateListToTransportList();
	wcfRetailDivisionService.Save(CreateLogonInfo(dataModel), division);

In the above example, firstly we get an existing retail division 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 division through the Integration Framework.

Deleting a retail division


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

See also