https://mediawiki.emersion.com.au/wiki/index.php?action=history&feed=atom&title=API%2FServices%2FGetUsagePeriodSummary
API/Services/GetUsagePeriodSummary - Revision history
2026-04-29T10:16:02Z
Revision history for this page on the wiki
MediaWiki 1.29.2
https://mediawiki.emersion.com.au/wiki/index.php?title=API/Services/GetUsagePeriodSummary&diff=4455&oldid=prev
JLee at 02:26, 19 May 2016
2016-05-19T02:26:03Z
<p></p>
<table class="diff diff-contentalign-left" data-mw="interface">
<col class='diff-marker' />
<col class='diff-content' />
<col class='diff-marker' />
<col class='diff-content' />
<tr style='vertical-align: top;' lang='en'>
<td colspan='2' style="background-color: white; color:black; text-align: center;">← Older revision</td>
<td colspan='2' style="background-color: white; color:black; text-align: center;">Revision as of 02:26, 19 May 2016</td>
</tr><tr><td colspan="2" class="diff-lineno" id="mw-diff-left-l20" >Line 20:</td>
<td colspan="2" class="diff-lineno">Line 20:</td></tr>
<tr><td class='diff-marker'> </td><td style="background-color: #f9f9f9; color: #333333; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #e6e6e6; vertical-align: top; white-space: pre-wrap;"><div>         <ns1:Period></div></td><td class='diff-marker'> </td><td style="background-color: #f9f9f9; color: #333333; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #e6e6e6; vertical-align: top; white-space: pre-wrap;"><div>         <ns1:Period></div></td></tr>
<tr><td class='diff-marker'> </td><td style="background-color: #f9f9f9; color: #333333; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #e6e6e6; vertical-align: top; white-space: pre-wrap;"><div>             <ns1:Period></div></td><td class='diff-marker'> </td><td style="background-color: #f9f9f9; color: #333333; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #e6e6e6; vertical-align: top; white-space: pre-wrap;"><div>             <ns1:Period></div></td></tr>
<tr><td class='diff-marker'>−</td><td style="color:black; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #ffe49c; vertical-align: top; white-space: pre-wrap;"><div>               <ns1:ID>1234567</ns1:<del class="diffchange diffchange-inline">PeriodID</del>></div></td><td class='diff-marker'>+</td><td style="color:black; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #a3d3ff; vertical-align: top; white-space: pre-wrap;"><div>               <ns1:ID>1234567</ns1:<ins class="diffchange diffchange-inline">ID</ins>></div></td></tr>
<tr><td class='diff-marker'> </td><td style="background-color: #f9f9f9; color: #333333; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #e6e6e6; vertical-align: top; white-space: pre-wrap;"><div>               <ns1:StartDate>2015-07-01 00:00:00</ns1:StartDate></div></td><td class='diff-marker'> </td><td style="background-color: #f9f9f9; color: #333333; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #e6e6e6; vertical-align: top; white-space: pre-wrap;"><div>               <ns1:StartDate>2015-07-01 00:00:00</ns1:StartDate></div></td></tr>
<tr><td class='diff-marker'> </td><td style="background-color: #f9f9f9; color: #333333; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #e6e6e6; vertical-align: top; white-space: pre-wrap;"><div>               <ns1:EndDate>2015-08-01 00:00:00</ns1:EndDate></div></td><td class='diff-marker'> </td><td style="background-color: #f9f9f9; color: #333333; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #e6e6e6; vertical-align: top; white-space: pre-wrap;"><div>               <ns1:EndDate>2015-08-01 00:00:00</ns1:EndDate></div></td></tr>
</table>
JLee
https://mediawiki.emersion.com.au/wiki/index.php?title=API/Services/GetUsagePeriodSummary&diff=4454&oldid=prev
JLee: new api function
2016-05-19T02:25:03Z
<p>new api function</p>
<p><b>New page</b></p><div>'''Purpose '''<br />
<br />
Retrieve all service subscriptions period, its breakdown of Bolt-On, Data Usage and Normal Included Value based on 'Service Subscription ID' going back X periods or months as defined by the input data returning Telephony and Data records.<br />
<br />
<br />
'''Inputs'''<br />
<soapenv:Header/><br />
<soapenv:Body><br />
<ser:GetUsagePeriodSummary><br />
<ser:ServiceSubscriptionID>1234567</ser:ServiceSubscriptionID><br />
<ser:NumberOfPeriods>6</ser:NumberOfPeriods><br />
<ser:LengthType>month</ser:LengthType><br />
</ser:GetUsagePeriodSummary><br />
</soapenv:Body><br />
<br />
<br />
'''Output'''<br />
<SOAP-ENV:Body><br />
<ns1:GetUsagePeriodSummaryResponse><br />
<ns1:Period><br />
<ns1:Period><br />
<ns1:ID>1234567</ns1:PeriodID><br />
<ns1:StartDate>2015-07-01 00:00:00</ns1:StartDate><br />
<ns1:EndDate>2015-08-01 00:00:00</ns1:EndDate><br />
</ns1:Period><br />
<ns1:TelephonyUsageSummary><br />
<ns1:IncludedValues><br />
<ns1:IncludedValue><br />
<ns1:IncludedValueID/><br />
<ns1:IncludedValueSlotTypeID/><br />
<ns1:PercentageUsed/><br />
<ns1:IncludedValueUsed/><br />
<ns1:IncludedValueActual/><br />
<ns1:IncludedValueBase/><br />
<ns1:IncludedValueTypeID/><br />
<ns1:IncludedValueType/><br />
</ns1:IncludedValue><br />
<ns1:IncludedValue><br />
<ns1:IncludedValueID/><br />
<ns1:IncludedValueSlotTypeID/><br />
<ns1:PercentageUsed/><br />
<ns1:IncludedValueUsed/><br />
<ns1:IncludedValueActual/><br />
<ns1:IncludedValueBase/><br />
<ns1:IncludedValueTypeID/><br />
<ns1:IncludedValueType/><br />
</ns1:IncludedValue><br />
</ns1:IncludedValues><br />
<ns1:BoltOns><br />
<ns1:BoltOn><br />
<ns1:BoltOnPeriodID/><br />
<ns1:BoltOnPeriodStart/><br />
<ns1:BoltOnPeriodEnd/><br />
<ns1:PercentageUsed/><br />
<ns1:IncludedValueUsed/><br />
<ns1:IncludedValueActual/><br />
<ns1:IncludedValueBase/><br />
<ns1:IncludedValueTypeID/><br />
<ns1:IncludedValueType/><br />
<ns1:BoltOnAddOns><br />
<ns1:BoltOnAddOn><br />
<ns1:BoltOnAddOnPeriodID/><br />
<ns1:BoltOnAddOnPeriodStart/><br />
<ns1:BoltOnAddOnPeriodEnd/><br />
<ns1:PercentageUsed/><br />
<ns1:IncludedValueUsed/><br />
<ns1:IncludedValueActual/><br />
<ns1:IncludedValueBase/><br />
<ns1:IncludedValueTypeID/><br />
<ns1:IncludedValueType/><br />
</ns1:BoltOnAddOn><br />
<ns1:BoltOnAddOn><br />
<ns1:BoltOnAddOnPeriodID/><br />
<ns1:BoltOnAddOnPeriodStart/><br />
<ns1:BoltOnAddOnPeriodEnd/><br />
<ns1:PercentageUsed/><br />
<ns1:IncludedValueUsed/><br />
<ns1:IncludedValueActual/><br />
<ns1:IncludedValueBase/><br />
<ns1:IncludedValueTypeID/><br />
<ns1:IncludedValueType/><br />
</ns1:BoltOnAddOn><br />
</ns1:BoltOnAddOns><br />
</ns1:BoltOn><br />
<ns1:BoltOn><br />
<ns1:BoltOnPeriodID/><br />
<ns1:BoltOnPeriodStart/><br />
<ns1:BoltOnPeriodEnd/><br />
<ns1:PercentageUsed/><br />
<ns1:IncludedValueUsed/><br />
<ns1:IncludedValueActual/><br />
<ns1:IncludedValueBase/><br />
<ns1:IncludedValueTypeID/><br />
<ns1:IncludedValueType/><br />
<ns1:BoltOnAddOns><br />
<ns1:BoltOnAddOn><br />
<ns1:BoltOnAddOnPeriodID/><br />
<ns1:BoltOnAddOnPeriodStart/><br />
<ns1:BoltOnAddOnPeriodEnd/><br />
<ns1:PercentageUsed/><br />
<ns1:IncludedValueUsed/><br />
<ns1:IncludedValueActual/><br />
<ns1:IncludedValueBase/><br />
<ns1:IncludedValueTypeID/><br />
<ns1:IncludedValueType/><br />
</ns1:BoltOnAddOn><br />
<ns1:BoltOnAddOn><br />
<ns1:BoltOnAddOnPeriodID/><br />
<ns1:BoltOnAddOnPeriodStart/><br />
<ns1:BoltOnAddOnPeriodEnd/><br />
<ns1:PercentageUsed/><br />
<ns1:IncludedValueUsed/><br />
<ns1:IncludedValueActual/><br />
<ns1:IncludedValueBase/><br />
<ns1:IncludedValueTypeID/><br />
<ns1:IncludedValueType/><br />
</ns1:BoltOnAddOn><br />
</ns1:BoltOnAddOns><br />
</ns1:BoltOn><br />
</ns1:BoltOns><br />
</ns1:TelephonyUsageSummary><br />
<ns1:DataUsageSummary><br />
<ns1:AllocationType>Peak</ns1:AllocationType><br />
<ns1:ChargeUpload>1</ns1:ChargeUpload><br />
<ns1:ChargeDownload>1</ns1:ChargeDownload><br />
<ns1:PercentageUsed>50</ns1:PercentageUsed><br />
<ns1:IncludedValueUsed>2000000</ns1:IncludedValueUsed><br />
<ns1:IncludedValueBase>4000000</ns1:IncludedValueBase><br />
<ns1:IncludedValueActual>4000000</ns1:IncludedValueActual><br />
<ns1:IncludedValueLeft>2000000</ns1:IncludedValueLeft><br />
<ns1:IncludedValueType>MB</ns1:IncludedValueType><br />
<ns1:ActionAtEnd>CAP</ns1:ActionAtEnd><br />
</ns1:DataUsageSummary><br />
</ns1:Period><br />
</ns1:GetUsagePeriodSummaryResponse><br />
</SOAP-ENV:Body><br />
<br />
<br />
'''Error String'''<br />
<br />
* "Missing Service Subscription ID" - Service Subscription ID is not supplied.<br />
* "Service Subscription does not exist" - Service Subscription ID supplied does not exist in system.<br />
* "Invalid Service Subscription ID" - Service Subscription ID supplied does not belong to the same parent group as the API caller.<br />
* "Missing Number of Periods" - Number of Periods is not supplied.<br />
* "Missing Length Type (period / month)" - Length Type is not supplied.<br />
* "Invalid Length Type. Valid input: 'period' or 'month'" - Length Type supplied is not valid. Valid input is either 'period' or 'month'.</div>
JLee