API/Plans/GetTermsAndConditions

From Emersion
Jump to: navigation, search

Purpose

Retrieve all the terms and conditions against a Package or Service Plan ID and, optionally, against a Terms and Conditions ID.


Inputs <soapenv:Header/>

  <soapenv:Body>
     <plan:GetTermsAndConditions>
        <plan:ObjectMapping>
           <plan:PackagePlanID>999999</plan:PackagePlanID>
           <plan:ServicePlanID></plan:ServicePlanID>
        </plan:ObjectMapping>
        <plan:DateEffective>2016-12-31</plan:DateEffective>
        <plan:TermsAndConditionsID>999999</plan:TermsAndConditionsID>
     </plan:GetTermsAndConditions>
  </soapenv:Body>

Output <SOAP-ENV:Body>

 <ns1:GetTermsandConditionsResponse>
   <ns1:TermsandConditions>
     <ns1:TermsandConditionsName>Dummy</ns1:TermsandConditionsName>
     <ns1:TermsandConditionsID>999999</ns1:TermsandConditionsID>
     <ns1:TermsandConditionsStatus>Dummy</ns1:TermsandConditionsStatus>
     <ns1:EffectiveDate>2014-08-20</ns1:EffectiveDate>
     <ns1:TermsandConditionsText>Dummy</ns1:TermsandConditionsText>
     <ns1:TermsandConditionsType>Dummy</ns1:TermsandConditionsType>
   </ns1:TermsandConditions>
 </ns1:GetTermsandConditionsResponse>

</SOAP-ENV:Body>


Error Strings

  • "You cannot specify both Package and Service Plan IDs" - Both Package and Service Plan IDs are provided which is not valid
  • "Package Plan ID does not exist" - Package Plan ID provided does not exist in the system
  • "Package Plan ID does not belong to caller" - Package Plan ID does not belong to the calling customer account
  • "Service Plan ID does not exist" - Service Plan ID provided does not exist in the system
  • "Service Plan ID does not belong to caller" - Service Plan ID does not belong to the calling customer account
  • "Invalid Effective Date" - Effective Date provided is not valid
  • "Terms and Conditions ID does not exist" - Terms and Conditions ID provided does not exist in the system