Exigo Web Services API v3.4.272

GetQualificationOverrides

Returns Customer Overrides

Input Properties

GetQualificationOverridesRequest
PropertyData TypeNotes
CustomerIDInt32Optional. Optional.
OverrideIDInt32Optional.
BatchSizeInt32Optional. Defaults to 1000 at a time.

Output Properties

GetQualitificationOverridesResponse
PropertyData TypeNotes
QualificationOverridesGetQualificationOverrideResponse[]
GetQualificationOverrideResponse
PropertyData TypeNotes
CustomerIDInt32Unique identifier for a customer entity.
OverrideIDInt32
QualifiesBoolean
PeriodType Int32
StartPeriodIDInt32
EndPeriodIDInt32
ModifiedDateDateTime
ModifiedByString
AmountDecimal

SOAP Request

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /3.0/ExigoApi.asmx HTTP/1.1
Host: api.exigo.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://api.exigo.com/GetQualificationOverrides"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope 
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Header> <ApiAuthentication xmlns="http://api.exigo.com/"> <LoginName>string</LoginName> <Password>string</Password> <Company>string</Company> <Identity>string</Identity> <RequestTimeUtc>dateTime</RequestTimeUtc> <Signature>string</Signature> </ApiAuthentication> </soap:Header> <soap:Body> <GetQualificationOverridesRequest xmlns="http://api.exigo.com/"> <CustomerID>int</CustomerID> <OverrideID>int</OverrideID> <BatchSize>int</BatchSize> </GetQualificationOverridesRequest> </soap:Body> </soap:Envelope>

SOAP Response

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope 
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <GetQualificationOverridesResult xmlns="http://api.exigo.com/"> <QualificationOverrides> <GetQualificationOverrideResponse> <CustomerID>int</CustomerID> <OverrideID>int</OverrideID> <Qualifies>boolean</Qualifies> <PeriodType>int</PeriodType> <StartPeriodID>int</StartPeriodID> <EndPeriodID>int</EndPeriodID> <ModifiedDate>dateTime</ModifiedDate> <ModifiedBy>string</ModifiedBy> <Amount>decimal</Amount> </GetQualificationOverrideResponse> </QualificationOverrides> </GetQualificationOverridesResult> </soap:Body> </soap:Envelope>

C#

try

{

    //Create Main API Context Object

    ExigoApi api = new ExigoApi();

 

    //Create Authentication Header

    ApiAuthentication auth = new ApiAuthentication();

    auth.LoginName = "yourLoginName";

    auth.Password = "yourPassword";

    auth.Company = "yourCompany";

    api.ApiAuthenticationValue = auth;

 

    //Create Request

    GetQualificationOverridesRequest req = new GetQualificationOverridesRequest();

 

    req.CustomerID = 1;             //Optional

    req.OverrideID = 1;

    req.BatchSize = 1;              //Defaults to 1000 at a time

 

    //Send Request to Server and Get Response

    GetQualitificationOverridesResponse res = api.GetQualificationOverrides(req);

 

    //Now examine the results:

 

    foreach (GetQualificationOverrideResponse getQualificationOverride in res.QualificationOverrides)

    {

        Console.WriteLine("CustomerID: {0}", getQualificationOverride.CustomerID);

        Console.WriteLine("OverrideID: {0}", getQualificationOverride.OverrideID);

        Console.WriteLine("Qualifies: {0}", getQualificationOverride.Qualifies);

        Console.WriteLine("PeriodType: {0}", getQualificationOverride.PeriodType);

        Console.WriteLine("StartPeriodID: {0}", getQualificationOverride.StartPeriodID);

        Console.WriteLine("EndPeriodID: {0}", getQualificationOverride.EndPeriodID);

        Console.WriteLine("ModifiedDate: {0}", getQualificationOverride.ModifiedDate);

        Console.WriteLine("ModifiedBy: {0}", getQualificationOverride.ModifiedBy);

        Console.WriteLine("Amount: {0}", getQualificationOverride.Amount);

    }

}

catch (Exception ex)

{

    Console.WriteLine("Error: " + ex.Message);

}

VB.Net

Try

    'Create Main API Context Object

    Dim api as new ExigoApi()

 

    'Create Authentication Header

    Dim auth as new ApiAuthentication()

    auth.LoginName = "yourLoginName"

    auth.Password = "yourPassword"

    auth.Company = "yourCompany"

    api.ApiAuthenticationValue = auth

 

    'Create Request

    Dim req as new GetQualificationOverridesRequest()

 

    req.CustomerID = 1

    req.OverrideID = 1

    req.BatchSize = 1

 

    'Send Request to Server and Get Response

    Dim res As GetQualitificationOverridesResponse = api.GetQualificationOverrides(req)

 

    'Now examine the results:

 

    For Each getQualificationOverride As GetQualificationOverrideResponse In res.QualificationOverrides

        Console.WriteLine("CustomerID: {0}", getQualificationOverride.CustomerID)

        Console.WriteLine("OverrideID: {0}", getQualificationOverride.OverrideID)

        Console.WriteLine("Qualifies: {0}", getQualificationOverride.Qualifies)

        Console.WriteLine("PeriodType: {0}", getQualificationOverride.PeriodType)

        Console.WriteLine("StartPeriodID: {0}", getQualificationOverride.StartPeriodID)

        Console.WriteLine("EndPeriodID: {0}", getQualificationOverride.EndPeriodID)

        Console.WriteLine("ModifiedDate: {0}", getQualificationOverride.ModifiedDate)

        Console.WriteLine("ModifiedBy: {0}", getQualificationOverride.ModifiedBy)

        Console.WriteLine("Amount: {0}", getQualificationOverride.Amount)

    Next

Catch ex As Exception

    Console.WriteLine("Error: " & ex.Message)

End Try

PHP

Note: PHP is not officially supported.

<?php

try

{

    //Setup the SoapClient and Authentication

    $api = new SoapClient("http://api.exigo.com/3.0/ExigoApi.asmx?WSDL");

    $ns = "http://api.exigo.com/";

    $auth = array()

    $auth["LoginName"] = new SoapVar("yourLoginName",XSD_STRING,null,null,null,$ns);

    $auth["Password"] = new SoapVar("yourPassword",XSD_STRING,null,null,null,$ns);

    $auth["Company"] = new SoapVar("yourCompany",XSD_STRING,null,null,null,$ns);

    $headerBody = new SoapVar($auth, SOAP_ENC_OBJECT);

    $header = new SoapHeader($ns, 'ApiAuthentication', $headerBody);

    $api->__setSoapHeaders(array($header));

 

    //Create Request

 

    $req->CustomerID = 1;

    $req->OverrideID = 1;

    $req->BatchSize = 1;

 

    //Send Request to Server and Get Response

    $res = $api.GetQualificationOverrides($req);

 

    //Now examine the results:

}

catch (SoapFault $ex)

{

    echo "Error: ", $ex->getMessage();

}

?>

Java

Note: Java is not officially supported.

try

{

    //Create Main API Context Object

    ExigoApi api = new ExigoApi();

 

    //Create Authentication Header

    ApiAuthentication auth = new ApiAuthentication();

    auth.setLoginName("yourLoginName");

    auth.setPassword("yourPassword");

    auth.setCompany("yourCompany");

    api.setApiAuthenticationValue(auth);

 

    //Create Request

    GetQualificationOverridesRequest req = new GetQualificationOverridesRequest();

 

    req.setCustomerID(1);

    req.setOverrideID(1);

    req.setBatchSize(1);

 

    //Send Request to Server and Get Response

    GetQualitificationOverridesResponse res = api.getExigoApiSoap().getQualificationOverrides(req, auth);

 

    //Now examine the results:

}

catch (Exception ex)

{

    System.out.println("Error: " + ex.getMessage());

}

CSV

This method does not support csv output.