Manage MSL Calling Sequence

<< Click to Display Table of Contents >>

Navigation:  General Functions > Configuring the MIE (Programmer's Guide) > Calling Web Services > Calling Sequence >

Manage MSL Calling Sequence

The ManageMSL web method has its own calling and return structures as defined below:

MSLCall contains the following elements:

Element

Required/Optional

Definition

CallingProgram

Optional

The name of your program that is calling the web service.

CallingVersion

Optional

The version of your program that is calling the web service.

Password

Required

Password for access to the MIE.  Must be sent having first been passed through ESI's CRYPT function (available as one of the functions within MIEWebServices.dll)

UserID

Required

UserID for access to the MIE.

ds

Required

A dataset of type dsMSL.  It contains one or more rows of MSL data to be applied to the target customer's MSL.

bAllowPartial

Required

True if partial results are permitted - meaning that each row sent will be attempted to be applied by the method regardless of any errors that may have been encountered with other rows.

False if all rows must succeed or the entire transaction fails and is rolled back.

 

Once you have called the web service, it will return a structure (also defined within the web service, called MSLReturn).  

 

MSLReturn contains the following elements:

Element

Definition

ErrorCount

Number of errors encountered by the method just called.

ErrorMesssage

Textual explanation of any errors encountered.

IssueCount

Number of issues encountered by the method just called.

IssueMessage

Textual explanation of any issues encountered.

WebServiceVersion

The version of the MIE Web Service that responded to the call.

ds

A dataset of type dsMSL.  The dataset contains one table that contains all of the rows that were sent.  For each row, the column mslNo is filled in (for rows that were to be added, this is the value that was assigned by the MIE) as well as the column RowResult.