Difference between revisions of "API/Services/SetServiceContacts"

From Emersion
Jump to: navigation, search
(Created page with "=== Set Service Contacts === '''Purpose:''' Based on the requirements gathered in Get Service Contact Requirements this method...")
 
Line 3: Line 3:
 
'''Purpose:''' Based on the requirements gathered in [[API/Services/GetServiceContactRequirements|Get Service Contact Requirements]] this method will populate the service contact information that is required for an order.
 
'''Purpose:''' Based on the requirements gathered in [[API/Services/GetServiceContactRequirements|Get Service Contact Requirements]] this method will populate the service contact information that is required for an order.
  
−
 
+
'''WSDL:''' Services.wsdl
 
'''Inputs'''
 
'''Inputs'''
  
−
  <soapenv:Header/>
+
<soapenv:Header/>
 
   <soapenv:Body>
 
   <soapenv:Body>
 
       <ord:SetServiceContacts>
 
       <ord:SetServiceContacts>
 
         <ord:AccountPresaleSQID>112233</ord:AccountPresaleSQID>
 
         <ord:AccountPresaleSQID>112233</ord:AccountPresaleSQID>
 +
        <ord:ContactCollections>
 +
            <ord:Contact>
 +
              <con:Type>End User</con:Type>
 +
              <con:Title>MR</con:Title>
 +
              <con:FirstName>myfirstname</con:FirstName>
 +
              <con:LastName>mylastname</con:LastName>
 +
              <con:DateOfBirth>1980-01-01</con:DateOfBirth>
 +
              <con:Addresses>
 +
                  <add:Address>
  
−
...
+
'''Output'''
−
      </ord:SetServiceContacts>
+
 
−
  </soapenv:Body>
+
Address Details are validated based on the address type defined in the call.
 +
 
 +
{|
 +
|+ Address validation in the SetServiceContacts
 +
! <add:Details xsi:type="add:StandardAddressDetails"> || <add:Details xsi:type="add:ComplexAddressDetails"> || <add:Details xsi:type="add:PostalDeliveryAddressDetails"> || <add:Details xsi:type="add:UnstructuredAddressDetails">
 +
| <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: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: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: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>
 +
|}
  
−
'''Output'''
 
  
−
  <SOAP-ENV:Body>
 
−
      <ns1:SetServiceContactsResponse>
 
−
        <ns1:Status>true</ns1:Status>
 
−
      </ns1:SetServiceContactsResponse>
 
−
  </SOAP-ENV:Body>
 
  
 
'''Error String'''
 
'''Error String'''

Revision as of 10:48, 11 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>
     <ord:SetServiceContacts>
        <ord:AccountPresaleSQID>112233</ord:AccountPresaleSQID>
        <ord:ContactCollections>
           <ord:Contact>
              <con:Type>End User</con:Type>
              <con:Title>MR</con:Title>
              <con:FirstName>myfirstname</con:FirstName>
              <con:LastName>mylastname</con:LastName>
              <con:DateOfBirth>1980-01-01</con:DateOfBirth>
              <con:Addresses>
                 <add:Address>

Output

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

Address validation in the SetServiceContacts
<add:Details xsi:type="add:StandardAddressDetails"> <add:Details xsi:type="add:ComplexAddressDetails"> <add:Details xsi:type="add:PostalDeliveryAddressDetails"> <add:Details xsi:type="add:UnstructuredAddressDetails"> <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: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: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: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>


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.
  • "Error(s) found:" - could be one of more of the following:
    • "Only 1 Primary Address required."
    • "Only 1 Primary Phone Number required."
    • "Only 1 Primary Email Address required."
Retrieved from "https://mediawiki.emersion.com.au/wiki/index.php?title=API/Services/SetServiceContacts&oldid=4727"