This web service can be used to place back orders for DIDs you need. This service has 3 methods.
Method Signature
1. Get a list of countries which you can order.
Method: GetCountriesForBackOrder($UserID,$Pass)
2. Get a list of Areas you can order by country code.
Method: GetAreasForBackOrder($UserID,$Pass,$CountryCode,$Page)
2. Place Back Order for the DIDs you need.
Method: PlaceBackOrder($UserID,$Pass,$BackOrderList_ID,$Quantity,$UserData,$NotifyURL)
$UserID – $Pass : DIDx User ID and Password
$CountryCode – Country code to back order, which comes from method “GetCountriesForBackOrder” .
$Page – Each page returns a block of 100 areas in GetAreasForBackOrder(), starting from page 1.
$BackOrderList_ID – This ID will come from the method “GetAreasForBackOrder”
$Quantity – Quantity of DIDs you need.
$UserData – user provided value, which will return to notify URL.
$NotifyURL – Notification will be sent to this URL vi HTTP, when the back order will be completed.
Return variable:
1. ReturnValue? – contains User data.
2. DID – DID number which is being added to account as back order
3. Qty – Total quantity of DIDs in complete back order.
Note: Each notification contains one DID only.
Return Values
-1 – Invalid UserID/Password
-2 – Account is not Active
-3 – Invalid account type.
-4 – Invalid quantity provided.
-5 – Insufficient funds to place back order.
1 – Successfully placed back order.
Example Usage
We are providing a sample code in PHP that accesses and uses this service.
Click here for .net example for this function
For Method GetCountriesForBackOrder
~~#BD0000:parameters=array($UserID,$Pass );
$soapclient= new soapclient(‘http://api.didx.net/webservice/WebBackOrderDIDNumber.php’);
$SoapResult = array();
$SoapResult = $soapclient->call(“GetCountriesForBackOrder”, $parameters,’urn:GetCountriesForBackOrder)~~;
On return, the method will provide an array of CountryCode and CountryName
For Method GetAreasForBackOrder
~~#BD0000:parameters=array($UserID,$Pass,$CountryCode, $Page );
$soapclient= new soapclient(‘http://api.didx.net/webservice/WebBackOrderDIDNumber.php’);
$SoapResult = array();
$SoapResult = $soapclient->call(“GetAreasForBackOrder”, $parameters,’urn:GetAreasForBackOrder);~~
On return the method will provide an array of AreaCode,AreaName,NXX,RateCenter,VendorID,BackOrder_ID
Each query to get the areas, will return 100 areas. You need to provide the page no. for each block.
For Method PlaceBackOrder
~~#BD0000:parameters=array($UserID,$Pass,$BackOrder_ID,$Quantity );
$soapclient= new soapclient(‘https://www.didx.net/webservice/WebBackOrderDIDNumber.php’);
$SoapResult = array();
$SoapResult = $soapclient->call(“PlaceBackOrder”, $parameters,’urn:PlaceBackOrder);~~
Click here for .net example
Click the link below to view Video?
https://www.didx.net/videos/DIDXbackorder1/