Exigo API Web Service

GetRankQualifications

Returns rank qualification report card.

Input Properties

GetRankQualificationsRequest

PropertyData TypeNotes

CustomerIDInt32Unique numeric identifier for customer record.

RankID Int32

PeriodType Int32

PeriodIDInt32Optional. Will default to current period.

CultureCodeStringOptional. Return qualifications in a different language.

RankGroupIDInt32Optional. Will default to primary rank group.

CustomerKeyStringOptional. Unique alpha numeric identifier for customer record. Exeption will occur if CustomerID & CustomerKey are provided.

Output Properties

GetRankQualificationsResponse

PropertyData TypeNotes

CustomerIDInt32Unique numeric identifier for customerd record.

RankID Int32

RankDescriptionString

QualifiesBoolean

QualifiesOverrideBoolean

PayeeQualificationLegsQualificationResponse[][]

BackRankIDInt32

BackRankDescriptionString

NextRankIDInt32

NextRankDescriptionString

ScoreDecimal

CustomerKeyStringUnique alpha numeric identifier for customer record.

QualificationResponse

PropertyData TypeNotes

QualificationDescriptionString

RequiredString

ActualString

QualifiesBoolean

QualifiesOverrideBoolean

SupportingTableDataTable

CompletedDecimal

WeightDecimal

ScoreDecimal

Http Request

GET https://yourcompany-api.exigo.com/3.0/qualification?customerID=1
  &rankID=1
  &periodType=1
  &periodID=1
  &cultureCode=1
  &rankGroupID=1
  &customerKey=1
Authorization: Basic base64Encoded

Http Response

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

{
  "customerID": 1,
  "rankID": 1,
  "rankDescription": "",
  "qualifies": true,
  "qualifiesOverride": true,
  "payeeQualificationLegs": null,
  "backRankID": 1,
  "backRankDescription": "",
  "nextRankID": 1,
  "nextRankDescription": "",
  "score": null,
  "customerKey": "",
  "result": null
}

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: lifewave-api.exigo.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "https://api.exigo.com/GetRankQualifications"

<?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>
    <GetRankQualificationsRequest xmlns="http://api.exigo.com/">
      <CustomerID>int</CustomerID>
      <RankID>int</RankID>
      <PeriodType>int</PeriodType>
      <PeriodID>int</PeriodID>
      <CultureCode>string</CultureCode>
      <RankGroupID>int</RankGroupID>
      <CustomerKey>string</CustomerKey>
    </GetRankQualificationsRequest>
  </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>
    <GetRankQualificationsResult xmlns="http://api.exigo.com/">
      <CustomerID>int</CustomerID>
      <RankID>int</RankID>
      <RankDescription>string</RankDescription>
      <Qualifies>boolean</Qualifies>
      <QualifiesOverride>boolean</QualifiesOverride>
      <PayeeQualificationLegs>
        <ArrayOfQualificationResponse>
          <QualificationResponse>
            <QualificationDescription>string</QualificationDescription>
            <Required>string</Required>
            <Actual>string</Actual>
            <Qualifies>boolean</Qualifies>
            <QualifiesOverride>boolean</QualifiesOverride>
            <SupportingTable>xmlxml</SupportingTable>
            <Completed>decimal</Completed>
            <Weight>decimal</Weight>
            <Score>decimal</Score>
          </QualificationResponse>
        </ArrayOfQualificationResponse>
      </PayeeQualificationLegs>
      <BackRankID>int</BackRankID>
      <BackRankDescription>string</BackRankDescription>
      <NextRankID>int</NextRankID>
      <NextRankDescription>string</NextRankDescription>
      <Score>decimal</Score>
      <CustomerKey>string</CustomerKey>
    </GetRankQualificationsResult>
  </soap:Body>
</soap:Envelope>

C# Rest Client

Install Nuget package Exigo.Api.Client

try

{

//Create Api Client

var api = new ExigoApiClient("yourcmpany", "yourlogin", "yourpassword");

//Create Request

var req = new GetRankQualificationsRequest();

req.CustomerID = 1; //Unique numeric identifier for customer record.

req.RankID = 1;

req.PeriodType = 1;

req.PeriodID = 1; //Will default to current period.

req.CultureCode = "1"; //Return qualifications in a different language.

req.RankGroupID = 1; //Will default to primary rank group.

req.CustomerKey = "1"; //Unique alpha numeric identifier for customer record. Exeption will occur if CustomerID & CustomerKey are provided.

//Send Request to Server and Get Response

var res = await api.GetRankQualificationsAsync(req);

//Now examine the results:

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

Console.WriteLine("RankID: {0}", res.RankID);

Console.WriteLine("RankDescription: {0}", res.RankDescription);

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

Console.WriteLine("QualifiesOverride: {0}", res.QualifiesOverride);

foreach (var qualification[] in res.PayeeQualificationLegs)

{

Console.WriteLine("Length: {0}", qualification[].Length);

Console.WriteLine("LongLength: {0}", qualification[].LongLength);

Console.WriteLine("Rank: {0}", qualification[].Rank);

Console.WriteLine("SyncRoot: {0}", qualification[].SyncRoot);

Console.WriteLine("IsReadOnly: {0}", qualification[].IsReadOnly);

Console.WriteLine("IsFixedSize: {0}", qualification[].IsFixedSize);

Console.WriteLine("IsSynchronized: {0}", qualification[].IsSynchronized);

}

Console.WriteLine("BackRankID: {0}", res.BackRankID);

Console.WriteLine("BackRankDescription: {0}", res.BackRankDescription);

Console.WriteLine("NextRankID: {0}", res.NextRankID);

Console.WriteLine("NextRankDescription: {0}", res.NextRankDescription);

Console.WriteLine("Score: {0}", res.Score);

Console.WriteLine("CustomerKey: {0}", res.CustomerKey);

}

catch (Exception ex)

{

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

}

C# Soap Client

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

GetRankQualificationsRequest req = new GetRankQualificationsRequest();

req.CustomerID = 1; //Unique numeric identifier for customer record.

req.RankID = 1;

req.PeriodType = 1;

req.PeriodID = 1; //Will default to current period.

req.CultureCode = "1"; //Return qualifications in a different language.

req.RankGroupID = 1; //Will default to primary rank group.

req.CustomerKey = "1"; //Unique alpha numeric identifier for customer record. Exeption will occur if CustomerID & CustomerKey are provided.

//Send Request to Server and Get Response

GetRankQualificationsResponse res = api.GetRankQualifications(req);

//Now examine the results:

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

Console.WriteLine("RankID: {0}", res.RankID);

Console.WriteLine("RankDescription: {0}", res.RankDescription);

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

Console.WriteLine("QualifiesOverride: {0}", res.QualifiesOverride);

foreach (QualificationResponse[] qualification[] in res.PayeeQualificationLegs)

{

Console.WriteLine("Length: {0}", qualification[].Length);

Console.WriteLine("LongLength: {0}", qualification[].LongLength);

Console.WriteLine("Rank: {0}", qualification[].Rank);

Console.WriteLine("SyncRoot: {0}", qualification[].SyncRoot);

Console.WriteLine("IsReadOnly: {0}", qualification[].IsReadOnly);

Console.WriteLine("IsFixedSize: {0}", qualification[].IsFixedSize);

Console.WriteLine("IsSynchronized: {0}", qualification[].IsSynchronized);

}

Console.WriteLine("BackRankID: {0}", res.BackRankID);

Console.WriteLine("BackRankDescription: {0}", res.BackRankDescription);

Console.WriteLine("NextRankID: {0}", res.NextRankID);

Console.WriteLine("NextRankDescription: {0}", res.NextRankDescription);

Console.WriteLine("Score: {0}", res.Score);

Console.WriteLine("CustomerKey: {0}", res.CustomerKey);

}

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 GetRankQualificationsRequest()

req.CustomerID = 1

req.RankID = 1

req.PeriodType = 1

req.PeriodID = 1

req.CultureCode = "1"

req.RankGroupID = 1

req.CustomerKey = "1"

'Send Request to Server and Get Response

Dim res As GetRankQualificationsResponse = api.GetRankQualifications(req)

'Now examine the results:

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

Console.WriteLine("RankID: {0}", res.RankID)

Console.WriteLine("RankDescription: {0}", res.RankDescription)

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

Console.WriteLine("QualifiesOverride: {0}", res.QualifiesOverride)

For Each qualification[] As QualificationResponse[] In res.PayeeQualificationLegs

Console.WriteLine("Length: {0}", qualification[].Length)

Console.WriteLine("LongLength: {0}", qualification[].LongLength)

Console.WriteLine("Rank: {0}", qualification[].Rank)

Console.WriteLine("SyncRoot: {0}", qualification[].SyncRoot)

Console.WriteLine("IsReadOnly: {0}", qualification[].IsReadOnly)

Console.WriteLine("IsFixedSize: {0}", qualification[].IsFixedSize)

Console.WriteLine("IsSynchronized: {0}", qualification[].IsSynchronized)

Console.WriteLine("BackRankID: {0}", res.BackRankID)

Console.WriteLine("BackRankDescription: {0}", res.BackRankDescription)

Console.WriteLine("NextRankID: {0}", res.NextRankID)

Console.WriteLine("NextRankDescription: {0}", res.NextRankDescription)

Console.WriteLine("Score: {0}", res.Score)

Console.WriteLine("CustomerKey: {0}", res.CustomerKey)

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->RankID = 1;

$req->PeriodType = 1;

$req->PeriodID = 1;

$req->CultureCode = "1";

$req->RankGroupID = 1;

$req->CustomerKey = "1";

//Send Request to Server and Get Response

$res = $api.GetRankQualifications($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

GetRankQualificationsRequest req = new GetRankQualificationsRequest();

req.setCustomerID(1);

req.setRankID(1);

req.setPeriodType(1);

req.setPeriodID(1);

req.setCultureCode("1");

req.setRankGroupID(1);

req.setCustomerKey("1");

//Send Request to Server and Get Response

GetRankQualificationsResponse res = api.getExigoApiSoap().getRankQualifications(req, auth);

//Now examine the results:

}

catch (Exception ex)

{

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

}

CSV

This method supports CSV output.

HTTP Get Request:

https://lifewave-api.exigo.com/3.0/csv/?method=GetRankQualifications
&ApiLoginName=String
&ApiPassword=String
&ApiCompany=String
&CustomerID=Int32
&RankID=Int32
&PeriodType=Int32
&PeriodID=Nullable`1
&CultureCode=String
&RankGroupID=Nullable`1
&CustomerKey=String

Response Fields

CustomerID,RankID,RankDescription,Qualifies,QualifiesOverride,Length,LongLength,Rank,SyncRoot,IsReadOnly,IsFixedSize,IsSynchronized,BackRankID,BackRankDescription,NextRankID,NextRankDescription,Score,CustomerKey
Int32,Int32,String,Boolean,Nullable`1,Int32,Int64,Int32,Object,Boolean,Boolean,Boolean,Nullable`1,String,Nullable`1,String,Decimal,String

Exigo Web Services API v2022.12.19.1

GetRankQualifications

Input Properties

GetRankQualificationsRequest

Output Properties

GetRankQualificationsResponse

QualificationResponse

Soap Response

C# Soap Client

VB.Net

PHP

Java

CSV