Overview
Returns the Deactivated and Ported subscriber numbers based on the Organization code and status (All/Deactivated/Ported) code provided.
Syntax
[OperationContractAttribute()] SBT.API.DataContracts.Common.WSReportDeactResponse GetDeactivationNumbers( string securityToken, string orgCode, string fromDate, string toDate, string status )
WSDL
Production: https://ui.solutionsbytext.com/Sbt.App.SetUp/WSServices/ReportWSService.svc?singlewsdl
Staging: https://test.solutionsbytext.com/Sbt.App.SetUp/WSServices/ReportWSService.svc?singlewsdl
Parameters
securityToken
- String[1000] (Required) – Security Token to authenticate the user
orgCode
- String[50] (Required) - Default Organization Code for organization, division or group.
fromDate
- String[20] (Required) - Start date for report to display the Deactivated/Ported numbers. Date format is [mm/dd/yyyy].
toDate
- String[20] (Required) - End date for report to display the Deactivated/Ported numbers. Date format is [mm/dd/yyyy].
status
- String[20] (Required) - Enter numeric value 0-2; 0-All numbers (Deactivated and Ported), 1-Deactivated, 2-Ported. If nothing is entered, then '0' is default.
Name |
Type |
Description |
---|---|---|
Result |
bool |
True/False whether the call was successful or not. |
ErrorCode |
int |
For Success/Failure it returns an error number. |
Message |
string |
Message related to error code |
Response |
List <WSReportDeactResponseRow> |
If there are transaction details then below will be displayed, Group - Org name to which the message was sent to. Group Code - Org code to which the message was sent to. MobilePhoneNo – Mobile number of subscriber which is Deactivated/Ported. FirstName – First Name of the subscriber. LastName – Last Name of the subscriber. Carrier – Old Carrier name of the Mobile Number which we got from Aggregator. NewCarrier - Latest Carrier name of the Mobile Number which we got after lookup. Status – Status of the Mobile number (Deactivated / Ported) DeactivationDate – Date when mobile number tagged as deactivated/ported at Aggregator. CreatedOn – Date when deactivated/ported mobile number updated at T2C platform. UniqueID - UniqueID of the Subscriber |
Example
C#
ReportClient msgClient = new ReportClient("ReportWSServiceHttpEndpoint"); string securityToken = txtToken.Text; string orgCode = txtOrgCode.Text; string fromDate = dtFromDate.Text; string toDate = dtToDate.Text; string status = status.Text; WSReportDeactResponse response = msgClient.GetDeactivationNumbers(securityToken, orgCode, fromDate, toDate, status); if (!response.Result) { //handle error lblError.Text = response.Message; } else { //handle success lblError.Text = response.Message; }
PHP
<?php $client = new SoapClient("<< Get Deactivation Numbers WSDL URL -->>"); $param = array( 'securityToken' => 'securityToken', 'orgCode' => 'orgCode', 'fromDate' => '05/22/2018', 'toDate' => '05/22/2018', 'status' => ‘0’ or ’1’ or ’2’ ); $response = $client->__soapCall('GetDeactivationNumbers', array($param)); echo '<pre/>'; print_r($response); if($response->DeactivationNumberResult->Result){ echo 'Group: '.$response->DeactivationNumberResult->Group; echo '<br>'; echo 'GroupCode: '.$response->DeactivationNumberResult->GroupCode; echo '<br>'; echo 'MobilePhoneNo: '.$response->DeactivationNumberResult->MobilePhoneNo; echo '<br>'; echo 'FirstName: '.$response->DeactivationNumberResult->FirstName; echo '<br>'; echo 'LastName: '.$response->DeactivationNumberResult->LastName; echo '<br>'; echo 'Carrier: '.$response->DeactivationNumberResult->Carrier; echo '<br>'; echo 'NewCarrier: '.$response->DeactivationNumberResult->NewCarrier; echo '<br>'; echo 'Status: '.$response->DeactivationNumberResult->Status; echo '<br>'; echo 'DeactivationDate: '.$response->DeactivationNumberResult->DeactivationDate; echo '<br>'; echo 'CreatedOn: '.$response->DeactivationNumberResult->CreatedOn;} else { echo $response->DeactivationNumberResult->Message; } ?>
SOAP
Request:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://SBTService/ServiceContracts/"> <soapenv:Header/> <soapenv:Body> <ser:GetDeactivationNumbers> <ser:securityToken>Security Token </ser:securityToken> <ser:orgCode>Organization Code</ser:orgCode> <ser:fromDate>From Date</ser:fromDate> <ser:toDate>To Date</ser:toDate> <ser:status>status (0,1 or2)</ser:status> </ser:GetDeactivationNumbers> </soapenv:Body> </soapenv:Envelope>
Response
<a:WSReportDeactResponseRow> <a:Group>Group Name where Mobile is subscribed</a:Group> <a:GroupCode>Group Org Code</a:GroupCode> <a:MobilePhoneNo>Deactivated/Ported Mobile number</a:MobilePhoneNo> <a:FirstName/> <a:LastName/> <a:Carrier>Old Carrier Name</a:Carrier> <a:NewCarrier>New Carrier Name</a:NewCarrier> <a:Status>Deactivated / Ported</a:Status> <a:DeactivationDate>07/11/2017</a:DeactivationDate> <a:CreatedOn>07/12/2017</a:CreatedOn> </a:WSReportDeactResponseRow> </a:Response> </GetDeactivationNumbersResult> </GetDeactivationNumbersResponse> </s:Body> </s:Envelope>
REST
Method: GET
URL: https://ui.solutionsbytext.com/SBT.App.SetUp/RSServices/ReportRSService.svc/GetDeactivationNumbers?securityToken=SecurityToken&orgCode=OrgCode&fromDate=FromDate&toDate=ToDate&status=status (0, 1 or 2)
Response
The response will be in JSON format like below:
{" GetDeactivationNumbersResult": { "Result": true, "ErrorCode": 1523, "Message": "Successfully retrieved deactivation numbers", "Response": [{"List< WSReportDeactResponseRow> response – Subscribers details like Mobile Number,First Name, Last Name, Carrier, New Carrier, Status (Deactivated/Ported), Deactivation Date and CreatedOn date Information will display" }] }}