Difference between revisions of "API/Services/GetAccountDiscountSubscription"

Latest revision as of 17:04, 10 September 2014

Purpose

This Method will retrieve all account discount subscriptions for a given account based on status (optional).

Inputs

 <soapenv:Header/>
  <soapenv:Body>
     <ser:GetAccountDiscountSubscriptions>
        <ser:AccountID>?</ser:AccountID>
        <ser:Status>?</ser:Status>
     </ser:GetAccountDiscountSubscriptions>
  </soapenv:Body>

Important notes:

106. AccountID needs to be the ID of the Account in the Emersion system

107. Status needs to be the ID of PkgSubscriptionStatus in the Emersion system, optional

Example Validation Error:

  <SOAP-ENV:Body>
     <SOAP-ENV:Fault>
        <faultcode>SOAP-ENV:Client</faultcode>
        <faultstring>Validation Error</faultstring>
        <faultactor>http://emersion.com.au/Services</faultactor>
        <detail>Could not find Account ID!</detail>
     </SOAP-ENV:Fault>
  </SOAP-ENV:Body>

Validation rules:

108. Account exists

109. Account has a parent which matches the caller.

110. Status exists

Output

 <SOAP-ENV:Body>
     <ns1:GetAccountDiscountSubscriptionsResponse>
        <ns1:AccountDiscountSubscriptionItem>
           <ns1:AccountDiscountSubscriptionID>100012</ns1:AccountDiscountSubscriptionID>
           <ns1:StartDate>2013-10-15 14:08:05</ns1:StartDate>
           <ns1:EndDate>2013-10-15 15:19:26</ns1:EndDate>
           <ns1:AccountID>216754</ns1:AccountID>
           <ns1:AccountDiscountPlanID>3</ns1:AccountDiscountPlanID>
           <ns1:SubscriptionStatusID>6</ns1:SubscriptionStatusID>
        </ns1:AccountDiscountSubscriptionItem>         
     </ns1:GetAccountDiscountSubscriptionsResponse>
  </SOAP-ENV:Body>

Error String:

111. Invalid or Missing Account ID

112. Could not find Account ID!

113. You do not have permission to modify this Account!

114. Invalid Status ID!