CiirusXMLAdditionalFunctions15025 Web Service

CiirusXMLAdditionalFunctions15025

Click here for a complete list of operations.

CRMAddLead

Adds a Guest Contact lead to the CiiRUS CRM.

This can be used to determine if an existing BookingID is a reservation that has been specified as PoolHeat requested by guest.

Pass the following parameters:

APIUsername (String) *Required
APIPassword (String) *Required
FirstName (String) *Required
-Blank string not accepted
LastName (String) *Required
-Blank string not accepted
Address1 (String) Optional
-If not specified (optional value) should be passed as a blank string
Address2 (String) Optional
-If not specified (optional value) should be passed as a blank string
City (String) Optional
-If not specified (optional value) should be passed as a blank string
County (String) Optional
-If not specified (optional value) should be passed as a blank string
State (String) Optional
-If not specified (optional value) should be passed as a blank string
Country (String) Optional
-If not specified (optional value) should be passed as a blank string
Zip (String) Optional
-If not specified (optional value) should be passed as a blank string
Telephone (String) Optional
-If not specified (optional value) should be passed as a blank string
CellPhone (String) Optional
-If not specified (optional value) should be passed as a blank string
EmailAddress (String) Optional/*Required
-Optional if the "SendEnquireyEmail" and "AddAsEnquirey" node values are false
-*Required if the "SendEnquireyEmail" OR "AddAsEnquirey" node values are True
Comments (String) Optional
-If not specified (optional value) should be passed as a blank string
CombinedAddress (String) Optional
-If not specified (optional value) should be passed as a blank string
PartnerName (String) Optional
-If not specified (optional value) should be passed as a blank string
NamesOfFamilyMembers (String) Optional
-If not specified (optional value) should be passed as a blank string
-Please pass multiple values as a CSV rather than as an Array
Hobbies (String) Optional
-If not specified (optional value) should be passed as a blank string
-Please pass multiple values as a CSV rather than as an Array
FavoriteTravelDestinations (String) Optional
-If not specified (optional value) should be passed as a blank string
-Please pass multiple values as a CSV rather than as an Array
SpecialRequirements (String) Optional
-If not specified (optional value) should be passed as a blank string
-Please pass multiple values as a CSV rather than as an Array
PetDetails (String) Optional
-If not specified (optional value) should be passed as a blank string
-Please pass multiple values as a CSV rather than as an Array
Occupation (String) Optional
-If not specified (optional value) should be passed as a blank string
TypicalPartySize (Integer) *Required
If no Typical party size is known pass 0 else pass the Typical Party Size for this Lead (this value is different to EnquiryPartySize)
Gender (String) Optional
-If not specified (optional value) should be passed as a blank string
-Accepted Values:
- male
- female
- m
- f
- 0
  -male
- 1
  -female
Note: This is a person's biological sex. This is not related to the gender to which they identify as being.
DateOfBirth (String, dd MMM yyyy) Optional
-If not specified (optional value) should be passed as a blank string
WeddingAnniversary (String, dd MMM yyyy) Optional
-If not specified (optional value) should be passed as a blank string
PortalActive (Boolean) *Required
-Sets if the Guest is allowed access to the guest portal
AddressTidied (Boolean) *Required
-True flags that the address passed to this function is verified as a valid address and is parsed into the component parts
Note: This is used when the address is split into the address component parts (in this case "CombinedAddress" is accepted, but not required)
-False flags that the address passed to this function has not been validated or an that the address has not been parsed into its component parts
Note: This is used when the "CombinedAddress" node is populated and not split into the address component parts
AllowMarketingEmails (Boolean) *Required
-Sets if the user is allowed to be remarketed to or if they do not wish to be contacted with marketing materials
AddAsEnquirey (Boolean) *Required
-Sets if a web Enquiry is added to the system
SendEnquireyEmail (Boolean) *Required
-Determines if CiiRUS sends the Enquiry template e-mail for a property to the guest as defined by the User defined by the node "AgentAccountUserID"
AgentAccountUserID (Integer) *Required
-This specifies the account that the enquiries are entered into and/or messages are sent from Use the function GetManagementCompanyList for the IDs accessible in the account.
PropertyID (Integer) *Required
-If not specified, pass 0
-This integer is only Required if the nodes "SendEnquireyEmail" or "AddAsEnquirey" are True
EnquireyArrivalDate (Boolean) *Required
-Only applicable if the nodes "SendEnquireyEmail" or "AddAsEnquirey" are True
-Note: Must pass a date, but only future dates are acceptable any past date will be inserted against the enquiry as now
EnquireyDepartureDate (Boolean) *Required
-Only applicable if the nodes "SendEnquireyEmail" or "AddAsEnquirey" are True
-Note: Must pass a date, but only future dates are acceptable any past date will be inserted against the enquiry as now
EnquireyComments (String) Optional
-Only applicable if the nodes "SendEnquireyEmail" or "AddAsEnquirey" are True
-If not specified (optional value) should be passed as a blank string
EnquiryPartySize (Integer) *Required
-If not specified, pass 0
-This integer is only applicable if the nodes "SendEnquireyEmail" or "AddAsEnquirey" are True
LeadSource (String, limited to 50 chars) Optional
-if no LeadSource pass empty string
leadID (Integer) *Required
-At this time this value should always be bassed as 0
Note: Future updates to this API may include a means for predefining a lead source and grouping leads by this source

Error Responses:

CRMAddLead: Error - Validation Error 1
CRMAddLead: Error - The First name, Last name, or both, MUST be entered.
CRMAddLead: Error - The Agent Account UserID must be greater than or equal to Zero.
CRMAddLead: Error - You do not have permissions to access the specified Agent/MC's Account.
CRMAddLead: Error - In order to send an e-mail enquirey or Add an E-mail enquiry the PropertyID MUST be greater than Zero.
CRMAddLead: Error - You do not have access rights to this property.
CRMAddLead: Error - In order to send an e-mail enquirey or Add an E-mail enquiry the you MUST pass a valid E-mail address.
CRMAddLead: Error - The first name must not exceed 100 chars.
CRMAddLead: Error - The last name must not exceed 100 chars.
CRMAddLead: Error - The Address1 must not exceed 50 chars.
CRMAddLead: Error - The Address2 must not exceed 50 chars.
CRMAddLead: Error - The City must not exceed 50 chars.
CRMAddLead: Error - The County must not exceed 50 chars.
CRMAddLead: Error - The State must not exceed 50 chars.
CRMAddLead: Error - The Country must not exceed 30 chars.
CRMAddLead: Error - The Zip must not exceed 20 chars.
CRMAddLead: Error - The Telephone must not exceed 35 chars.
CRMAddLead: Error - The CellPhone must not exceed 35 chars.
CRMAddLead: Error - The EmailAddress must not exceed 50 chars.
CRMAddLead: Error - The EmailAddress is not valid.
CRMAddLead: Error - The Comments must not exceed 3900 chars.
CRMAddLead: Error - The CombinedAddress must not exceed 350 chars.
CRMAddLead: Error - The PartnerName must not exceed 200 chars.
CRMAddLead: Error - The NamesOfFamilyMembers must not exceed 500 chars.
CRMAddLead: Error - The Hobbies must not exceed 500 chars.
CRMAddLead: Error - The FavoriteTravelDestinations must not exceed 500 chars.
CRMAddLead: Error - The SpecialRequirements must not exceed 500 chars.
CRMAddLead: Error - The PetDetails must not exceed 500 chars.
CRMAddLead: Error - The Occupation must not exceed 50 chars.
CRMAddLead: Error - This is not a valid parameter for Gender
CRMAddLead: Error - If the gender is passed as an Integer value as a string, it must be either 0 for male or 1 for female
CRMAddLead: Error - Invalid DateOfBirth
CRMAddLead: Error - Invalid WeddingAnniversary
CRMAddLead: Error - The LeadSource must not exceed 50 chars.
CRMAddLead: Error - The leadID is not yet supported via the API. No value other than 0 is accepted for this function at this time.
CRMAddLead: Error - Unkown error storing record (1).
CRMAddLead: Error - Unkown error storing record (2).
CRMAddLead: Error - Unknown error validating function input.
CRMAddLead: Error - The Enquirey was not entered or e-mailed.
CRMAddLead: Error - Unknown error adding WebsiteEnquirey.

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.

Parameter	Value
APIUserName:
APIPassword:
FirstName:
LastName:
Address1:
Address2:
City:
County:
State:
Country:
Zip:
Telephone:
CellPhone:
EmailAddress:
Comments:
CombinedAddress:
PartnerName:
NamesOfFamilyMembers:
Hobbies:
FavoriteTravelDestinations:
SpecialRequirements:
PetDetails:
Occupation:
TypicalPartySize:
Gender:
DateOfBirth:
WeddingAnniversary:
PortalActive:
AddressTidied:
AllowMarketingEmails:
AddAsEnquirey:
SendEnquireyEmail:
AgentAccountUserID:
PropertyID:
EnquireyArrivalDate:
EnquireyDepartureDate:
EnquireyComments:
EnquiryPartySize:
LeadSource:
leadID:

SOAP 1.1

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

POST /XMLadditionalfunctions15.025.asmx HTTP/1.1
Host: api.ciirus.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://xml.ciirus.com/CRMAddLead"

<?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>
    <CRMAddLead xmlns="http://xml.ciirus.com/">
      <APIUserName>string</APIUserName>
      <APIPassword>string</APIPassword>
      <FirstName>string</FirstName>
      <LastName>string</LastName>
      <Address1>string</Address1>
      <Address2>string</Address2>
      <City>string</City>
      <County>string</County>
      <State>string</State>
      <Country>string</Country>
      <Zip>string</Zip>
      <Telephone>string</Telephone>
      <CellPhone>string</CellPhone>
      <EmailAddress>string</EmailAddress>
      <Comments>string</Comments>
      <CombinedAddress>string</CombinedAddress>
      <PartnerName>string</PartnerName>
      <NamesOfFamilyMembers>string</NamesOfFamilyMembers>
      <Hobbies>string</Hobbies>
      <FavoriteTravelDestinations>string</FavoriteTravelDestinations>
      <SpecialRequirements>string</SpecialRequirements>
      <PetDetails>string</PetDetails>
      <Occupation>string</Occupation>
      <TypicalPartySize>int</TypicalPartySize>
      <Gender>string</Gender>
      <DateOfBirth>string</DateOfBirth>
      <WeddingAnniversary>string</WeddingAnniversary>
      <PortalActive>boolean</PortalActive>
      <AddressTidied>boolean</AddressTidied>
      <AllowMarketingEmails>boolean</AllowMarketingEmails>
      <AddAsEnquirey>boolean</AddAsEnquirey>
      <SendEnquireyEmail>boolean</SendEnquireyEmail>
      <AgentAccountUserID>int</AgentAccountUserID>
      <PropertyID>int</PropertyID>
      <EnquireyArrivalDate>dateTime</EnquireyArrivalDate>
      <EnquireyDepartureDate>dateTime</EnquireyDepartureDate>
      <EnquireyComments>string</EnquireyComments>
      <EnquiryPartySize>int</EnquiryPartySize>
      <LeadSource>string</LeadSource>
      <leadID>int</leadID>
    </CRMAddLead>
  </soap:Body>
</soap:Envelope>

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>
    <CRMAddLeadResponse xmlns="http://xml.ciirus.com/">
      <CRMAddLeadResult>string</CRMAddLeadResult>
    </CRMAddLeadResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

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

POST /XMLadditionalfunctions15.025.asmx HTTP/1.1
Host: api.ciirus.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <CRMAddLead xmlns="http://xml.ciirus.com/">
      <APIUserName>string</APIUserName>
      <APIPassword>string</APIPassword>
      <FirstName>string</FirstName>
      <LastName>string</LastName>
      <Address1>string</Address1>
      <Address2>string</Address2>
      <City>string</City>
      <County>string</County>
      <State>string</State>
      <Country>string</Country>
      <Zip>string</Zip>
      <Telephone>string</Telephone>
      <CellPhone>string</CellPhone>
      <EmailAddress>string</EmailAddress>
      <Comments>string</Comments>
      <CombinedAddress>string</CombinedAddress>
      <PartnerName>string</PartnerName>
      <NamesOfFamilyMembers>string</NamesOfFamilyMembers>
      <Hobbies>string</Hobbies>
      <FavoriteTravelDestinations>string</FavoriteTravelDestinations>
      <SpecialRequirements>string</SpecialRequirements>
      <PetDetails>string</PetDetails>
      <Occupation>string</Occupation>
      <TypicalPartySize>int</TypicalPartySize>
      <Gender>string</Gender>
      <DateOfBirth>string</DateOfBirth>
      <WeddingAnniversary>string</WeddingAnniversary>
      <PortalActive>boolean</PortalActive>
      <AddressTidied>boolean</AddressTidied>
      <AllowMarketingEmails>boolean</AllowMarketingEmails>
      <AddAsEnquirey>boolean</AddAsEnquirey>
      <SendEnquireyEmail>boolean</SendEnquireyEmail>
      <AgentAccountUserID>int</AgentAccountUserID>
      <PropertyID>int</PropertyID>
      <EnquireyArrivalDate>dateTime</EnquireyArrivalDate>
      <EnquireyDepartureDate>dateTime</EnquireyDepartureDate>
      <EnquireyComments>string</EnquireyComments>
      <EnquiryPartySize>int</EnquiryPartySize>
      <LeadSource>string</LeadSource>
      <leadID>int</leadID>
    </CRMAddLead>
  </soap12:Body>
</soap12:Envelope>

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

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <CRMAddLeadResponse xmlns="http://xml.ciirus.com/">
      <CRMAddLeadResult>string</CRMAddLeadResult>
    </CRMAddLeadResponse>
  </soap12:Body>
</soap12:Envelope>

HTTP GET

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

GET /XMLadditionalfunctions15.025.asmx/CRMAddLead?APIUserName=string&APIPassword=string&FirstName=string&LastName=string&Address1=string&Address2=string&City=string&County=string&State=string&Country=string&Zip=string&Telephone=string&CellPhone=string&EmailAddress=string&Comments=string&CombinedAddress=string&PartnerName=string&NamesOfFamilyMembers=string&Hobbies=string&FavoriteTravelDestinations=string&SpecialRequirements=string&PetDetails=string&Occupation=string&TypicalPartySize=string&Gender=string&DateOfBirth=string&WeddingAnniversary=string&PortalActive=string&AddressTidied=string&AllowMarketingEmails=string&AddAsEnquirey=string&SendEnquireyEmail=string&AgentAccountUserID=string&PropertyID=string&EnquireyArrivalDate=string&EnquireyDepartureDate=string&EnquireyComments=string&EnquiryPartySize=string&LeadSource=string&leadID=string HTTP/1.1
Host: api.ciirus.com

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

<?xml version="1.0" encoding="utf-8"?>
<string xmlns="http://xml.ciirus.com/">string</string>

HTTP POST

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

POST /XMLadditionalfunctions15.025.asmx/CRMAddLead HTTP/1.1
Host: api.ciirus.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

APIUserName=string&APIPassword=string&FirstName=string&LastName=string&Address1=string&Address2=string&City=string&County=string&State=string&Country=string&Zip=string&Telephone=string&CellPhone=string&EmailAddress=string&Comments=string&CombinedAddress=string&PartnerName=string&NamesOfFamilyMembers=string&Hobbies=string&FavoriteTravelDestinations=string&SpecialRequirements=string&PetDetails=string&Occupation=string&TypicalPartySize=string&Gender=string&DateOfBirth=string&WeddingAnniversary=string&PortalActive=string&AddressTidied=string&AllowMarketingEmails=string&AddAsEnquirey=string&SendEnquireyEmail=string&AgentAccountUserID=string&PropertyID=string&EnquireyArrivalDate=string&EnquireyDepartureDate=string&EnquireyComments=string&EnquiryPartySize=string&LeadSource=string&leadID=string

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

<?xml version="1.0" encoding="utf-8"?>
<string xmlns="http://xml.ciirus.com/">string</string>