API/Services/SetServiceContacts

From Emersion
Revision as of 16:11, 21 July 2016 by JLee (talk)
Jump to: navigation, search

Set Service Contacts

Purpose: Based on the requirements gathered in Get Service Contact Requirements this method will populate the service contact information that is required for an order.

WSDL: Services.wsdl

Inputs

  <soapenv:Header/>
  <soapenv:Body>
     <urn:SetServiceContacts>
        <urn:AccountPresaleSQID>362225</urn:AccountPresaleSQID>
        <urn:ContactCollections>
           <urn1:Contact>
              <urn1:Type>End User</urn1:Type>
              <urn1:Title>MR</urn1:Title>
              <urn1:FirstName>myFirstName</urn1:FirstName>
              <urn1:LastName>myLastName</urn1:LastName>
              <urn1:DateOfBirth>1980-01-01</urn1:DateOfBirth>


Output

Address Details are validated based on the address type defined in the call.

<add:Details xsi:type="add:StandardAddressDetails">

  <add:LotNumber>460</add:LotNumber>
  <add:StreetNumberStart>460</add:StreetNumberStart>
  <add:StreetNumberEnd></add:StreetNumberEnd>
  <add:StreetName>Bourke</add:StreetName>
  <add:StreetType>Street</add:StreetType>
  <add:Suburb>Melbourne</add:Suburb>
  <add:State>Victoria</add:State>
  <add:Postcode>3000</add:Postcode>

<add:Details xsi:type="add:ComplexAddressDetails">

  <add:UnitType>House</add:UnitType>
  <add:UnitNumber>1</add:UnitNumber>
  <add:UnitNumberEnd>1</add:UnitNumberEnd>
  <add:LevelType>Ground</add:LevelType>
  <add:LevelNumber>1</add:LevelNumber>
  <add:BuildingName>BuildingName</add:BuildingName>
  <add:SiteLocation>SiteLocation</add:SiteLocation>
  <add:SiteName>SiteName</add:SiteName>
  <add:LotNumber>460</add:LotNumber>
  <add:StreetNumberStart>460</add:StreetNumberStart>
  <add:StreetNumberEnd></add:StreetNumberEnd>
  <add:StreetName>Bourke</add:StreetName>
  <add:StreetType>Street</add:StreetType>
  <add:Suburb>Melbourne</add:Suburb>
  <add:State>Victoria</add:State>
  <add:Postcode>3000</add:Postcode>

<add:Details xsi:type="add:PostalDeliveryAddressDetails">

  <add:PostalDeliveryType>Post Office Box</add:PostalDeliveryType>
  <add:PostalDeliveryNumber>123</add:PostalDeliveryNumber>
  <add:Suburb>Melbourne</add:Suburb>
  <add:State>Victoria</add:State>
  <add:Postcode>3000</add:Postcode>

<add:Details xsi:type="add:UnstructuredAddressDetails">

  <add:Line1>460 Bourke Street</add:Line1>
  <add:Line2></add:Line2>
  <add:Suburb>Melbourne</add:Suburb>
  <add:State>Victoria</add:State>
  <add:Postcode>3000</add:Postcode>

further information

  </add:Details>
                    <add:Country>Australia</add:Country>
                    <add:Type>Business</add:Type>
                 </add:Address>
              </con:Addresses>
              <con:PhoneNumbers>
                 <phon:PhoneNumber>
                    <phon:Type>Mobile - Personal</phon:Type>
                    <phon:Number>0412345678</phon:Number>
                 </phon:PhoneNumber>
              </con:PhoneNumbers>
              <con:EmailAddresses>
                 <ema:EmailAddress>
                    <ema:Address>emesupport@emersion.com.au</ema:Address>
                    <ema:Type>Business</ema:Type>
                 </ema:EmailAddress>
              </con:EmailAddresses>
           </ord:Contact>
        </ord:ContactCollections>
     </ord:SetServiceContacts>
  </soapenv:Body>


Outputs

  <SOAP-ENV:Body>
     <ns1:SetServiceContactsResponse>
        <ns1:Status>true</ns1:Status>
     </ns1:SetServiceContactsResponse>
  </SOAP-ENV:Body>

Error String

  • "Missing Account Presale SQ ID" - Account Presale SQ ID is not supplied.
  • "Account Presale SQ does not exist" - Account Presale SQ ID supplied does not exist in system.
  • "Account does not exist" - Account ID supplied does not exist in system.
  • "Invalid Account ID" - Account ID supplied does not belong to the same parent group as the API caller.
  • "Missing Package Plan" - Package Plan must be selected before calling this function.
  • "No Service Contacts to set for Account Presale SQ:"
  • Error(s) found are stored in serialized array, and could be one of more of the following:
    • "Only 1 Primary Address required."
    • "Invalid Address Country"
    • "Invalid Address Type"
    • "Invalid Address Unit Type"
    • "Invalid Address Level Type"
    • "Missing Address Street Number Start"
    • "Missing Address Street Name"
    • "Invalid Address Street Suffix"
    • "Invalid Address Street Type"
    • "Missing Invalid Street Type"
    • "Invalid Address Postal Delivery Type" (for type='PostalDeliveryAddressDetails')
    • "Missing Address Postal Delivery Type" (for type='PostalDeliveryAddressDetails')
    • "Unknown Address Display Type. Valid types: StandardAddressDetails, ComplexAddressDetails, PostalDeliveryAddressDetails, UnstructuredAddressDetails"
    • "Missing Address Suburb"
    • "Invalid Address Postcode"
    • "Missing Address Postcode"
    • "Unknown Australian State"
    • "Only 1 Primary Phone Number required."
    • "Invalid Primary Phone Number Type"
    • "Missing Primary Phone Number Type"
    • "Invalid Primary Phone Number supplied."
    • "Only 1 Primary Email Address required."
    • "Invalid Email Address Type"
    • "Missing Email Address Type"
    • "Invalid Primary Email Address supplied."
    • "Minimum contact limit for Service Type (<ID>) is: <quantity>. Only <contact_count> Contact(s) supplied."
    • "Maximum contact limit for Service Type (<ID>) is: <quantity>. <contact_count> Contact(s) supplied."
    • "<ContactTypeName> (<ID>) is a required Contact Type but not supplied."
    • "Contact Type '<ContactTypeName>' is not supported for this Service Type (<ID>)"