Exigo Web Services API v2022.12.19.1

UpdateParty

Updates selected Party instance

Input Properties

UpdatePartyRequest
PropertyData TypeNotes
PartyIDInt32
PartyTypeInt32Optional. PartyTy.
PartyStatusTypeInt32Optional. PartyStatusTy.
HostIDInt32Optional. HostID.
DistributorIDInt32Optional. DistributorID.
StartDateDateTimeOptional. StartDate.
CloseDateDateTimeOptional. Close Date.
DescriptionStringOptional. Description.
EventStartDateTimeOptional. Event Start date.
EventEndDateTimeOptional. Event End date.
LanguageIDInt32Optional. Language ID.
InformationStringOptional. Information.
AddressPartyAddressOptional. Information.
BookingPartyIDInt32Optional. BookingPartyID.
Field1StringOptional. Field1.
Field2StringOptional. Field2.
Field3StringOptional. Field3.
Field4StringOptional. Field4.
Field5StringOptional. Field5.

Output Properties

UpdatePartyResponse
PropertyData TypeNotes

Http Request

PUT https://yourcompany-api.exigo.com/3.0/party HTTP/1.1
Content-Type: application/json
Authorization: Basic base64Encoded(yourlogin@yourcompany:yourpassword)

{ "partyID": 1, "partyType": 1, "partyStatusType": 1, "hostID": 1, "distributorID": 1, "startDate": "2024-11-02T00:00:00-05:00", "closeDate": "2024-11-02T00:00:00-05:00", "description": "1", "eventStart": "2024-11-02T00:00:00-05:00", "eventEnd": "2024-11-02T00:00:00-05:00", "languageID": 1, "information": "1", "bookingPartyID": 1, "field1": "1", "field2": "1", "field3": "1", "field4": "1", "field5": "1" }

Http Response

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

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

<?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> <UpdatePartyRequest xmlns="http://api.exigo.com/"> <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> </UpdatePartyRequest> </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> <UpdatePartyResult xmlns="http://api.exigo.com/" /> </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 UpdatePartyRequest();

 

    req.PartyID = 1;

    req.PartyType = 1;              //PartyTy

    req.PartyStatusType = 1;        //PartyStatusTy

    req.HostID = 1;                 //HostID

    req.DistributorID = 1;          //DistributorID

    req.StartDate = DateTime.Today;              //StartDate

    req.CloseDate = DateTime.Today;              //Close Date

    req.Description = "1";          //Description

    req.EventStart = DateTime.Today;             //Event Start date

    req.EventEnd = DateTime.Today;               //Event End date

    req.LanguageID = 1;             //Language ID

    req.Information = "1";          //Information

    req.BookingPartyID = 1;         //BookingPartyID

    req.Field1 = "1";               //Field1

    req.Field2 = "1";               //Field2

    req.Field3 = "1";               //Field3

    req.Field4 = "1";               //Field4

    req.Field5 = "1";               //Field5

 

    //Send Request to Server and Get Response

    var res = await api.UpdatePartyAsync(req);

 

    //Now examine the results:

}

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

    UpdatePartyRequest req = new UpdatePartyRequest();

 

    req.PartyID = 1;

    req.PartyType = 1;              //PartyTy

    req.PartyStatusType = 1;        //PartyStatusTy

    req.HostID = 1;                 //HostID

    req.DistributorID = 1;          //DistributorID

    req.StartDate = DateTime.Today;              //StartDate

    req.CloseDate = DateTime.Today;              //Close Date

    req.Description = "1";          //Description

    req.EventStart = DateTime.Today;             //Event Start date

    req.EventEnd = DateTime.Today;               //Event End date

    req.LanguageID = 1;             //Language ID

    req.Information = "1";          //Information

    req.BookingPartyID = 1;         //BookingPartyID

    req.Field1 = "1";               //Field1

    req.Field2 = "1";               //Field2

    req.Field3 = "1";               //Field3

    req.Field4 = "1";               //Field4

    req.Field5 = "1";               //Field5

 

    //Send Request to Server and Get Response

    UpdatePartyResponse res = api.UpdateParty(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 UpdatePartyRequest()

 

    req.PartyID = 1

    req.PartyType = 1

    req.PartyStatusType = 1

    req.HostID = 1

    req.DistributorID = 1

    req.StartDate = DateTime.Today

    req.CloseDate = DateTime.Today

    req.Description = "1"

    req.EventStart = DateTime.Today

    req.EventEnd = DateTime.Today

    req.LanguageID = 1

    req.Information = "1"

    req.BookingPartyID = 1

    req.Field1 = "1"

    req.Field2 = "1"

    req.Field3 = "1"

    req.Field4 = "1"

    req.Field5 = "1"

 

    'Send Request to Server and Get Response

    Dim res As UpdatePartyResponse = api.UpdateParty(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;

    $req->PartyType = 1;

    $req->PartyStatusType = 1;

    $req->HostID = 1;

    $req->DistributorID = 1;

    $req->StartDate = 1;

    $req->CloseDate = 1;

    $req->Description = "1";

    $req->EventStart = 1;

    $req->EventEnd = 1;

    $req->LanguageID = 1;

    $req->Information = "1";

    $req->BookingPartyID = 1;

    $req->Field1 = "1";

    $req->Field2 = "1";

    $req->Field3 = "1";

    $req->Field4 = "1";

    $req->Field5 = "1";

 

    //Send Request to Server and Get Response

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

    UpdatePartyRequest req = new UpdatePartyRequest();

 

    req.setPartyID(1);

    req.setPartyType(1);

    req.setPartyStatusType(1);

    req.setHostID(1);

    req.setDistributorID(1);

    req.setStartDate(1);

    req.setCloseDate(1);

    req.setDescription("1");

    req.setEventStart(1);

    req.setEventEnd(1);

    req.setLanguageID(1);

    req.setInformation("1");

    req.setBookingPartyID(1);

    req.setField1("1");

    req.setField2("1");

    req.setField3("1");

    req.setField4("1");

    req.setField5("1");

 

    //Send Request to Server and Get Response

    UpdatePartyResponse res = api.getExigoApiSoap().updateParty(req, auth);

 

    //Now examine the results:

}

catch (Exception ex)

{

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

}

CSV

This method does not support csv output.