Difference between revisions of "API/Services/SetServiceContacts"

Latest revision as of 17:19, 21 July 2016

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>

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

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

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

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

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

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

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

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

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

further information

                    </urn1:Details>
                    <urn1:Country>Australia</urn1:Country>
                    <urn1:Type>Business</urn1:Type>
                 </urn1:Address>
              </urn1:Addresses>
              <urn1:PhoneNumbers>
                 <urn1:PhoneNumber>
                    <urn1:Type>Mobile - Personal</urn1:Type>
                    <urn1:Number>0412345678</urn1:Number>
                 </urn1:PhoneNumber>
              </urn1:PhoneNumbers>
              <urn1:EmailAddresses>
                 <urn1:EmailAddress>
                    <urn1:Address>emesupport@emersion.com.au</urn1:Address>
                    <urn1:Type>Business</urn1:Type>
                 </urn1:EmailAddress>
              </urn1:EmailAddresses>
           </urn1:Contact>
        </urn:ContactCollections>
     </urn: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>)"