FetchEmailReach Configuration
There are two reasons for examining the EmailReach test configuration:
- To allow the user to confirm that this is the correct test configuration
- To provide the information needed to build a test report
You cannot modify the test configuration through the web service; this must be done through the web site.
The function call is straight-forward; you send the request with your authentication token and you get the list of configured tests. No special return codes have been assigned to this function because it should never fail (this would only happen if the entire service has failed).
EmailReachConfigInfo FetchEmailReachConfiguration(string authToken)
The data structure that it returns contains the return code for the request (which should always be “OK”), and an array of “Test” objects, with one object for each configured test.
In C#: the returned structured may be declared like this:
struct EmailReachConfigInfo
{
Test[] tests;
ReturnCode codes;
}
The WSDL declaration is:
<s:complexType name="EmailReachConfigInfo">
<s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="tests" type="tns:ArrayOfTest" />
<s:element minOccurs="1" maxOccurs="1" name="codes" type="tns:ReturnCode" />
</s:sequence>
</s:complexType>
Each “Test” object provides four values: a unique ID, the test name, the current version and a description. The ID is provided so that you can associate this information with the results of each test.
In C#:
struct Test
{
int id;
string name;
string version;
string description;
}
The WSDL declaration is:
<s:complexType name="Test">
<s:sequence>
<s:element minOccurs="1" maxOccurs="1" name="id" type="s:int" />
<s:element minOccurs="0" maxOccurs="1" name="name" type="s:string" />
<s:element minOccurs="0" maxOccurs="1" name="version" type="s:string" />
<s:element minOccurs="0" maxOccurs="1" name="description" type="s:string" />
</s:sequence>
</s:complexType>
|