Exigo Web Services API v2025.5.13.5

 Search

GetParties

Gets Parties list

Input Properties

GetPartiesRequest
PropertyData TypeNotes
PartyIDInt32Optional.
HostIDInt32Optional.
DistributorIDInt32Optional.
PartyStatusType Int32Optional. Party Status.
BookingPartyIDInt32Optional. BookingPartyID.
Field1StringOptional. Field1.
Field2StringOptional. Field2.
Field3StringOptional. Field3.
Field4StringOptional. Field4.
Field5StringOptional. Field5.
PartyExternalIDGuidOptional. PartyExternalID.

Output Properties

GetPartiesResponse
PropertyData TypeNotes
PartiesPartyResponse[]
PartyResponse
PropertyData TypeNotes
PartyIDInt32
PartyType Int32Party type.
PartyStatusType Int32Party Status.
HostIDInt32
DistributorIDInt32
StartDateDateTime
CloseDateDateTime
DescriptionString
EventStartDateTime
EventEndDateTime
LanguageID Int32Customize the web experience by setting this.
InformationString
AddressPartyAddress
BookingPartyIDInt32
Field1 String
Field2 String
Field3 String
Field4 String
Field5 String
PartyShoppingUrlString
PartyExternalIDGuid
TimeZoneIDString
VirtualMeetingLinkString

Http Request

GET https://yourcompany-api.exigo.com/3.0/party?partyID=1
  &hostID=1
  &distributorID=1
  &partyStatusType=1
  &bookingPartyID=1
  &field1=1
  &field2=1
  &field3=1
  &field4=1
  &field5=1
  &partyExternalID=1
Authorization: Basic base64Encoded

Http Response

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


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

<?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>
    <GetPartiesRequest xmlns="http://api.exigo.com/">
      <PartyID>int</PartyID>
      <HostID>int</HostID>
      <DistributorID>int</DistributorID>
      <PartyStatusType>int</PartyStatusType>
      <BookingPartyID>int</BookingPartyID>
      <Field1>string</Field1>
      <Field2>string</Field2>
      <Field3>string</Field3>
      <Field4>string</Field4>
      <Field5>string</Field5>
      <PartyExternalID>guid</PartyExternalID>
    </GetPartiesRequest>
  </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>
    <GetPartiesResult xmlns="http://api.exigo.com/">
      <Parties>
        <PartyResponse>
          <PartyID>int</PartyID>
          <PartyType>int</PartyType>
          <PartyStatusType>int</PartyStatusType>
          <HostID>int</HostID>
          <DistributorID>int</DistributorID>
          <StartDate>dateTime</StartDate>
          <CloseDate>dateTime</CloseDate>
          <Description>string</Description>
          <EventStart>dateTime</EventStart>
          <EventEnd>dateTime</EventEnd>
          <LanguageID>int</LanguageID>
          <Information>string</Information>
          <Address>
            <Address1>string</Address1>
            <Address2>string</Address2>
            <City>string</City>
            <State>string</State>
            <Zip>string</Zip>
            <Country>string</Country>
          </Address>
          <BookingPartyID>int</BookingPartyID>
          <Field1>string</Field1>
          <Field2>string</Field2>
          <Field3>string</Field3>
          <Field4>string</Field4>
          <Field5>string</Field5>
          <PartyShoppingUrl>string</PartyShoppingUrl>
          <PartyExternalID>guid</PartyExternalID>
          <TimeZoneID>string</TimeZoneID>
          <VirtualMeetingLink>string</VirtualMeetingLink>
        </PartyResponse>
      </Parties>
    </GetPartiesResult>
  </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 GetPartiesRequest();

 

    req.PartyID = 1;

    req.HostID = 1;

    req.DistributorID = 1;

    req.PartyStatusType = 1;        //Party Status

    req.BookingPartyID = 1;         //BookingPartyID

    req.Field1 = "1";               //Field1

    req.Field2 = "1";               //Field2

    req.Field3 = "1";               //Field3

    req.Field4 = "1";               //Field4

    req.Field5 = "1";               //Field5

    req.PartyExternalID = 1;        //PartyExternalID

 

    //Send Request to Server and Get Response

    var res = await api.GetPartiesAsync(req);

 

    //Now examine the results:

 

    foreach (var party in res.Parties)

    {

        Console.WriteLine("PartyID: {0}", party.PartyID);

        Console.WriteLine("PartyType: {0}", party.PartyType);

        Console.WriteLine("PartyStatusType: {0}", party.PartyStatusType);

        Console.WriteLine("HostID: {0}", party.HostID);

        Console.WriteLine("DistributorID: {0}", party.DistributorID);

        Console.WriteLine("StartDate: {0}", party.StartDate);

        Console.WriteLine("CloseDate: {0}", party.CloseDate);

        Console.WriteLine("Description: {0}", party.Description);

        Console.WriteLine("EventStart: {0}", party.EventStart);

        Console.WriteLine("EventEnd: {0}", party.EventEnd);

        Console.WriteLine("Information: {0}", party.Information);

        Console.WriteLine("Address: {0}", party.Address);

        Console.WriteLine("BookingPartyID: {0}", party.BookingPartyID);

        Console.WriteLine("PartyShoppingUrl: {0}", party.PartyShoppingUrl);

        Console.WriteLine("PartyExternalID: {0}", party.PartyExternalID);

        Console.WriteLine("TimeZoneID: {0}", party.TimeZoneID);

        Console.WriteLine("VirtualMeetingLink: {0}", party.VirtualMeetingLink);

    }

}

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

    GetPartiesRequest req = new GetPartiesRequest();

 

    req.PartyID = 1;

    req.HostID = 1;

    req.DistributorID = 1;

    req.PartyStatusType = 1;        //Party Status

    req.BookingPartyID = 1;         //BookingPartyID

    req.Field1 = "1";               //Field1

    req.Field2 = "1";               //Field2

    req.Field3 = "1";               //Field3

    req.Field4 = "1";               //Field4

    req.Field5 = "1";               //Field5

    req.PartyExternalID = 1;        //PartyExternalID

 

    //Send Request to Server and Get Response

    GetPartiesResponse res = api.GetParties(req);

 

    //Now examine the results:

 

    foreach (PartyResponse party in res.Parties)

    {

        Console.WriteLine("PartyID: {0}", party.PartyID);

        Console.WriteLine("PartyType: {0}", party.PartyType);

        Console.WriteLine("PartyStatusType: {0}", party.PartyStatusType);

        Console.WriteLine("HostID: {0}", party.HostID);

        Console.WriteLine("DistributorID: {0}", party.DistributorID);

        Console.WriteLine("StartDate: {0}", party.StartDate);

        Console.WriteLine("CloseDate: {0}", party.CloseDate);

        Console.WriteLine("Description: {0}", party.Description);

        Console.WriteLine("EventStart: {0}", party.EventStart);

        Console.WriteLine("EventEnd: {0}", party.EventEnd);

        Console.WriteLine("Information: {0}", party.Information);

        Console.WriteLine("Address: {0}", party.Address);

        Console.WriteLine("BookingPartyID: {0}", party.BookingPartyID);

        Console.WriteLine("PartyShoppingUrl: {0}", party.PartyShoppingUrl);

        Console.WriteLine("PartyExternalID: {0}", party.PartyExternalID);

        Console.WriteLine("TimeZoneID: {0}", party.TimeZoneID);

        Console.WriteLine("VirtualMeetingLink: {0}", party.VirtualMeetingLink);

    }

}

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

 

    req.PartyID = 1

    req.HostID = 1

    req.DistributorID = 1

    req.PartyStatusType = 1

    req.BookingPartyID = 1

    req.Field1 = "1"

    req.Field2 = "1"

    req.Field3 = "1"

    req.Field4 = "1"

    req.Field5 = "1"

    req.PartyExternalID = 1

 

    'Send Request to Server and Get Response

    Dim res As GetPartiesResponse = api.GetParties(req)

 

    'Now examine the results:

 

    For Each party As PartyResponse In res.Parties

        Console.WriteLine("PartyID: {0}", party.PartyID)

        Console.WriteLine("PartyType: {0}", party.PartyType)

        Console.WriteLine("PartyStatusType: {0}", party.PartyStatusType)

        Console.WriteLine("HostID: {0}", party.HostID)

        Console.WriteLine("DistributorID: {0}", party.DistributorID)

        Console.WriteLine("StartDate: {0}", party.StartDate)

        Console.WriteLine("CloseDate: {0}", party.CloseDate)

        Console.WriteLine("Description: {0}", party.Description)

        Console.WriteLine("EventStart: {0}", party.EventStart)

        Console.WriteLine("EventEnd: {0}", party.EventEnd)

        Console.WriteLine("Information: {0}", party.Information)

        Console.WriteLine("Address: {0}", party.Address)

        Console.WriteLine("BookingPartyID: {0}", party.BookingPartyID)

        Console.WriteLine("PartyShoppingUrl: {0}", party.PartyShoppingUrl)

        Console.WriteLine("PartyExternalID: {0}", party.PartyExternalID)

        Console.WriteLine("TimeZoneID: {0}", party.TimeZoneID)

        Console.WriteLine("VirtualMeetingLink: {0}", party.VirtualMeetingLink)

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

    $req->HostID = 1;

    $req->DistributorID = 1;

    $req->PartyStatusType = 1;

    $req->BookingPartyID = 1;

    $req->Field1 = "1";

    $req->Field2 = "1";

    $req->Field3 = "1";

    $req->Field4 = "1";

    $req->Field5 = "1";

    $req->PartyExternalID = 1;

 

    //Send Request to Server and Get Response

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

    GetPartiesRequest req = new GetPartiesRequest();

 

    req.setPartyID(1);

    req.setHostID(1);

    req.setDistributorID(1);

    req.setPartyStatusType(1);

    req.setBookingPartyID(1);

    req.setField1("1");

    req.setField2("1");

    req.setField3("1");

    req.setField4("1");

    req.setField5("1");

    req.setPartyExternalID(1);

 

    //Send Request to Server and Get Response

    GetPartiesResponse res = api.getExigoApiSoap().getParties(req, auth);

 

    //Now examine the results:

}

catch (Exception ex)

{

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

}

CSV

This method does not support csv output.