Exigo Web Services API v3.4.225

AddPartyGuests

Adds one or more guests to a party.

Input Properties

AddPartyGuestsRequest
PropertyData TypeNotes
PartyIDInt32The unique identifier of the party.
GuestIDsInt32[]The unique identifiers of the guests you want to add to the party.

Output Properties

AddPartyGuestsResponse
PropertyData TypeNotes

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/AddPartyGuests"

<?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> <AddPartyGuestsRequest xmlns="http://api.exigo.com/"> <PartyID>int</PartyID> <GuestIDs> <int>int</int> </GuestIDs> </AddPartyGuestsRequest> </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> <AddPartyGuestsResult xmlns="http://api.exigo.com/" /> </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

    AddPartyGuestsRequest req = new AddPartyGuestsRequest();

 

    req.PartyID = 1;                //The unique identifier of the party

 

    //Add GuestIDs

    List<Int32> guestids = new List<Int32>();

    guestids.Add(1);

    guestids.Add(2);

 

    //Now attach the list to the request

    req.GuestIDs = guestids.ToArray();

 

    //Send Request to Server and Get Response

    AddPartyGuestsResponse res = api.AddPartyGuests(req);

 

    //Now examine the results:

}

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

 

    req.PartyID = 1

 

    'Add GuestIDs

    Dim guestids As New List(Of Int32)()

    guestids.Add(1)

    guestids.Add(2)

 

    'Now attach the list to the request

    req.GuestIDs = guestids.ToArray()

 

    'Send Request to Server and Get Response

    Dim res As AddPartyGuestsResponse = api.AddPartyGuests(req)

 

    'Now examine the results:

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;

 

    //Add GuestIDs

 

 

 

    //Now attach the list to the request

    req.GuestIDs = array(guestID1,guestID2);

 

    //Send Request to Server and Get Response

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

    AddPartyGuestsRequest req = new AddPartyGuestsRequest();

 

    req.setPartyID(1);

 

    //Add GuestIDs

    ArrayOfSystem.Int32 guestids = new ArrayOfSystem.Int32();

 

    Int32 guestID1 = new Int32();

    guestids.Add(guestID1);

 

    Int32 guestID2 = new Int32();

    guestids.Add(guestID2);

 

    //Now attach the list to the request

    req.setGuestIDs(guestids);

 

    //Send Request to Server and Get Response

    AddPartyGuestsResponse res = api.getExigoApiSoap().addPartyGuests(req, auth);

 

    //Now examine the results:

}

catch (Exception ex)

{

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

}

CSV

This method does not support csv output.