Porta Plus 2 Web Services

<back to all web services

Product

The following routes are available for this service:
GET/GetProductAddons/{License}/{IProduct}/{SearchString}
GET/GetProductAddons/{License}/{IProduct}
GET/GetPurchasedProductAddons/{License}/{IAccount}
GET/GetProductAddons/{License}/{IProduct}/{SearchString}/{getAllProductAddons}
GET/GetProducts/{License}/{Currency}
GET/GetProducts/{License}/{Currency}/{ShowAllResellerProducts}
GET/GetProductsByReseller/{License}/{Currency}/{ResellerID}
GET/GetProductBySearch/{License}/{Currency}/{ICustomer}/{SearchString}
GET/GetProductBySearch/{License}/{Currency}/{ICustomer}/{SearchString}/{isClonedEnabled}
GET/GetProductAddonBySearch/{License}/{Currency}/{ICustomer}/{SearchString}/{getProductAddon}
GET/GetProductsList/{License}/{fromDate}/{ToDate}/{filterByActivationDate}
GET/getProductsPricebyTenantID/{License}/{TenantID}
GET/GetAccountInfoByAccountId/{License}/{AccountID}
GET/GetAccountInfoByIAccount/{License}/{IAccount}
GET/GetAccountInfoByIAccount/{License}/{IAccount}/{forBLF}
GET/GetCustomerProducts/{License}/{ICustomer}
GET/GetProductAccounts/{License}/{IProduct}
GET/GetAccounts/{License}/{ICustomer}/{IProduct}
GET/GetAccountsServiceFeatures/{License}/{ICustomer}/{IProduct}/{GetAccountServiceFeatures}
GET/GetMultipleProductAccountsServiceFeatures/{License}/{ICustomer}/{MultipleProducts}/{GetAccountServiceFeatures}
GET/GetMultipleProductAccountsbyProductSearchString/{License}/{ICustomer}/{MultipleProducts}/{GetAccountServiceFeatures}/{getservicefeaturesbyProdSS}
GET/GetAccounts/{License}/{ICustomer}/{IProduct}/{Aliases}
GET/GetAccountsAliasesForMultipleProducts/{License}/{ICustomer}/{MultipleProducts}/{Aliases}
GET/GetAccountsForMultipleProducts/{License}/{ICustomer}/{MultipleProducts}/{forACL}
GET/GetAccountsForMultipleProducts/{License}/{ICustomer}/{MultipleProducts}
GET/GetPagedAccountsForMultipleProducts/{License}/{ICustomer}/{MultipleProducts}/{PageNumber}/{PageOffset}/{SearchTerm}
GET/GetCustomerAllAccountsByAdvSearchString/{License}/{ICustomer}/{MultipleProducts}/{getNonDIDAccbySearchTerm}
GET/GetMultiProductAccountsbyProductSearchterm/{License}/{ICustomer}/{MultipleProducts}/{getNonDIDAccbySearchTerm}/{getaccountsforCLI}
GET/GetMultiProductAccountsbyZTProductSearchterm/{License}/{ICustomer}/{MultipleProducts}/{getNonDIDAccbySearchTerm}/{getaccountsforCLI}/{getZTPAccounts}
GET/GetAccountsForMultipleBlockedProducts/{License}/{ICustomer}/{MultipleProducts}/{GetBlockedAccounts}
GET/GetDIDAccountsForMultipleProducts/{License}/{ICustomer}/{MultipleProducts}/{GetDIDS}
GET/GetDIDAccountsForMultipleProductsbySearchTerm/{License}/{ICustomer}/{MultipleProducts}/{GetDIDS}/{forProductSearchTerm}
GET/GetCustomerAllDIDAccountsBySearchTerm/{License}/{ICustomer}/{MultipleProducts}/{GetDIDS}/{GetAccByProdSearchTerm}
GET/GetProductsBySearchString/{License}/{ICustomer}/{MultipleProducts}/{getProductsbySearch}
POST/GetAdminProductsBySearchString
GET/GetCustomerAllDIDAccountsByIProduct/{License}/{ICustomer}/{MultipleProducts}/{GetDIDS}/{GetAccByIProduct}
GET/GetDIDAccounts/{License}/{ICustomer}/{IProduct}/{GetDIDS}
GET/GetAccounts/{License}/{ICustomer}
GET/GetProducts/{License}
GET/GetAssignedProductAddOnstoAccount/{License}/{IAccount}/{getProductAddonFlag}
POST/GetProductAddOnsForMultipleAccounts
GET/GetCurrentActiveProductAddons/{License}/{IAccount}/{isActiveAddon}
GET/GetAllProductAddons/{License}/{IProduct}/{SearchString}/{isServiceEnabled}

To override the Content-type in your clients HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /json/reply/Product HTTP/1.1 
Host: api-uk.activesoftswitch.com 
Content-Type: application/json
Content-Length: length

{"Currency":"String","ICustomer":0,"IProduct":0,"GetDIDS":false,"Aliases":false,"MultipleProducts":"String","GetAccountServiceFeatures":false,"getservicefeaturesbyProdSS":false,"GetBlockedAccounts":false,"AccountID":"String","IAccount":0,"ShowAllResellerProducts":false,"ResellerID":0,"searchString":"String","name":"String","IService":0,"filterByActivationDate":"String","fromDate":"String","toDate":"String","getProductAddonFlag":false,"getProductAddon":false,"isClonedEnabled":false,"GetAccByProdSearchTerm":false,"GetAccByIProduct":false,"getNonDIDAccbySearchTerm":false,"getProductsbySearch":false,"getaccountsforCLI":false,"forProductSearchTerm":false,"isActiveAddon":false,"getAllProductAddons":false,"isServiceEnabled":false,"forACL":false,"forBLF":false,"LstIAccounts":[0],"PageNumber":0,"PageOffset":0,"SearchTerm":"String","getZTPAccounts":false,"License":"String","ContentId":0,"FeatureName":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"PortaProducts":[{"IProduct":0,"Name":"String","MaintanenceFee":0,"IProductGroup":0,"Description":"String","EndUserProductName":"String","addon_priority":0}],"Accounts":[{"AccountId":"String","IAccount":0,"i_c_ext":0,"ICustomer":0,"redirect_number":"String","DestinationName":"String","BillingModel":"ReChargeVoucher","ISO4217":"String","Balance":0,"Blockedfield":"String","Blocked":false,"UMEnabled":"String","IMasterAccount":0,"UILogin":"String","UIPassword":"String","VoipPassword":"String","SIPPassword":"String","CreditLimit":0,"IProduct":0,"BatchNamePrefix":"String","IBatch":0,"IRoutingPlan":0,"IEnv":0,"Email":"String","customUrl":"String","currentProfileImage":"String","Phone1":"String","Address":"String","CompanyName":"String","BillStatus":"String","FollowMeEnabled":"String","ServiceFlags":"String","IVDPlan":0,"Note":"String","subscribername":"String","SubscriberFName":"String","SubscriberLName":"String","Company":"String","Name":"String","FirstName":"String","MiddleInitials":"String","LastName":"String","Address1":"String","Address2":"String","Address3":"String","Address4":"String","Town":"String","Region":"String","City":"String","Postcode":"String","Country":"String","Phone2":"String","PhoneNo":"String","Salutation":"String","Fax":"String","availableBalance":0,"hideCLI":false,"DefaultValidIdentity":"String","ServiceFeatures":[{"ServiceFeatureName":"String","ServiceAttributeName":"String","ServiceAttributeId":0,"ServiceAttributeValue":"String"}],"ProductName":"String","i_ua":0,"i_ua_type":0,"Type":"String","ExtensionNumber":"String","fullname":"String","ActiveAddons":[{"IProduct":0,"Name":"String","MaintanenceFee":0,"IProductGroup":0,"Description":"String","i_subscription":0,"Subscription_Fees":0,"Currency":"String","IAccount":0,"effective_from":"\/Date(-62135596800000-0000)\/","effective_to":"\/Date(-62135596800000-0000)\/","IAccountProductAddOn":0,"Product_Group_Name":"String","IAddonProduct":0,"effective_from_ProductAddon":"\/Date(-62135596800000-0000)\/","effective_to_ProductAddon":"\/Date(-62135596800000-0000)\/","ProductAddon":"String"}],"ICustomerSite":0,"MainProductName":"String","custom":false,"templateID":0,"template":"String","GlobalTemplate":"String","isGlobalTemplate":false,"HGInfo":[{"i_c_group":0,"ActivationDate":"\/Date(-62135596800000-0000)\/","i_customer":0,"IAccount":0,"i_customerSpecified":false,"name":"String","fullname":"String","hunt_sequence":"String","hunt_keep_original_cli":"String","i_c_ext":0,"hunt_active":"String","id":"String","pickup_allowed":"String","assigned_extensions":[{"i_cg_ext":0,"i_cg_extSpecified":false,"i_c_ext":0,"i_c_extSpecified":false,"type":"String","id":"String","name":"String","hunt_order":0,"hunt_delay":0,"hunt_expire":0,"hunt_active":"String","huntstop":"String","primary_group":"String","IAccount":0}]}],"i_c_group":0,"VoiceDialing":false,"TranslateIncomingCLI":false,"activation_date":"\/Date(-62135596800000-0000)\/","last_usage":"\/Date(-62135596800000-0000)\/","first_usage_time":"\/Date(-62135596800000-0000)\/","issue_date":"\/Date(-62135596800000-0000)\/","inactivity_expire_time":0}],"AccountInfo":{"AccountId":"String","IAccount":0,"i_c_ext":0,"ICustomer":0,"redirect_number":"String","DestinationName":"String","BillingModel":"ReChargeVoucher","ISO4217":"String","Balance":0,"Blockedfield":"String","Blocked":false,"UMEnabled":"String","IMasterAccount":0,"UILogin":"String","UIPassword":"String","VoipPassword":"String","SIPPassword":"String","CreditLimit":0,"IProduct":0,"BatchNamePrefix":"String","IBatch":0,"IRoutingPlan":0,"IEnv":0,"Email":"String","customUrl":"String","currentProfileImage":"String","Phone1":"String","Address":"String","CompanyName":"String","BillStatus":"String","FollowMeEnabled":"String","ServiceFlags":"String","IVDPlan":0,"Note":"String","subscribername":"String","SubscriberFName":"String","SubscriberLName":"String","Company":"String","Name":"String","FirstName":"String","MiddleInitials":"String","LastName":"String","Address1":"String","Address2":"String","Address3":"String","Address4":"String","Town":"String","Region":"String","City":"String","Postcode":"String","Country":"String","Phone2":"String","PhoneNo":"String","Salutation":"String","Fax":"String","availableBalance":0,"hideCLI":false,"DefaultValidIdentity":"String","ServiceFeatures":[{"ServiceFeatureName":"String","ServiceAttributeName":"String","ServiceAttributeId":0,"ServiceAttributeValue":"String"}],"ProductName":"String","i_ua":0,"i_ua_type":0,"Type":"String","ExtensionNumber":"String","fullname":"String","ActiveAddons":[{"IProduct":0,"Name":"String","MaintanenceFee":0,"IProductGroup":0,"Description":"String","i_subscription":0,"Subscription_Fees":0,"Currency":"String","IAccount":0,"effective_from":"\/Date(-62135596800000-0000)\/","effective_to":"\/Date(-62135596800000-0000)\/","IAccountProductAddOn":0,"Product_Group_Name":"String","IAddonProduct":0,"effective_from_ProductAddon":"\/Date(-62135596800000-0000)\/","effective_to_ProductAddon":"\/Date(-62135596800000-0000)\/","ProductAddon":"String"}],"ICustomerSite":0,"MainProductName":"String","custom":false,"templateID":0,"template":"String","GlobalTemplate":"String","isGlobalTemplate":false,"HGInfo":[{"i_c_group":0,"ActivationDate":"\/Date(-62135596800000-0000)\/","i_customer":0,"IAccount":0,"i_customerSpecified":false,"name":"String","fullname":"String","hunt_sequence":"String","hunt_keep_original_cli":"String","i_c_ext":0,"hunt_active":"String","id":"String","pickup_allowed":"String","assigned_extensions":[{"i_cg_ext":0,"i_cg_extSpecified":false,"i_c_ext":0,"i_c_extSpecified":false,"type":"String","id":"String","name":"String","hunt_order":0,"hunt_delay":0,"hunt_expire":0,"hunt_active":"String","huntstop":"String","primary_group":"String","IAccount":0}]}],"i_c_group":0,"VoiceDialing":false,"TranslateIncomingCLI":false,"activation_date":"\/Date(-62135596800000-0000)\/","last_usage":"\/Date(-62135596800000-0000)\/","first_usage_time":"\/Date(-62135596800000-0000)\/","issue_date":"\/Date(-62135596800000-0000)\/","inactivity_expire_time":0},"PortaProductInfo":[{"reseller_ID":0,"reseller":"String","subreseller_ID":0,"subreseller":"String","customer_ID":0,"customer":"String","activation_date":"\/Date(-62135596800000-0000)\/","product_ID":0,"product":"String","id":"String","IService":0,"Account_Subscription":0,"i_subscription":0,"Product_GroupName":"String","Subscription_name":"String","effective_from":"\/Date(-62135596800000-0000)\/","effective_to":"\/Date(-62135596800000-0000)\/","Subscription_Fees":0,"Currency":"String","IAccount":0,"Price":0,"TerminationDate":"\/Date(-62135596800000-0000)\/","Fee":0,"Charge_type":"String","LineIdentity":"String","BillStart":"\/Date(-62135596800000-0000)\/","BillEnd":"\/Date(-62135596800000-0000)\/","Licence_Name":"String","SubscriberName":"String"}],"ProductAddonsInfo":[{"IProduct":0,"Name":"String","MaintanenceFee":0,"IProductGroup":0,"Description":"String","i_subscription":0,"Subscription_Fees":0,"Currency":"String","IAccount":0,"effective_from":"\/Date(-62135596800000-0000)\/","effective_to":"\/Date(-62135596800000-0000)\/","IAccountProductAddOn":0,"Product_Group_Name":"String","IAddonProduct":0,"effective_from_ProductAddon":"\/Date(-62135596800000-0000)\/","effective_to_ProductAddon":"\/Date(-62135596800000-0000)\/","ProductAddon":"String"}],"NumberOfAccounts":0,"License":"String","ContentId":0,"FeatureName":"String"}