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 .jsv suffix or ?format=jsv

HTTP + JSV

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

POST /jsv/reply/Product HTTP/1.1 
Host: api-uk.activesoftswitch.com 
Content-Type: text/jsv
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: text/jsv
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: 0001-01-01,
					effective_to: 0001-01-01,
					IAccountProductAddOn: 0,
					Product_Group_Name: String,
					IAddonProduct: 0,
					effective_from_ProductAddon: 0001-01-01,
					effective_to_ProductAddon: 0001-01-01,
					ProductAddon: String
				}
			],
			ICustomerSite: 0,
			MainProductName: String,
			custom: False,
			templateID: 0,
			template: String,
			GlobalTemplate: String,
			isGlobalTemplate: False,
			HGInfo: 
			[
				{
					i_c_group: 0,
					ActivationDate: 0001-01-01,
					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: 0001-01-01,
			last_usage: 0001-01-01,
			first_usage_time: 0001-01-01,
			issue_date: 0001-01-01,
			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: 0001-01-01,
				effective_to: 0001-01-01,
				IAccountProductAddOn: 0,
				Product_Group_Name: String,
				IAddonProduct: 0,
				effective_from_ProductAddon: 0001-01-01,
				effective_to_ProductAddon: 0001-01-01,
				ProductAddon: String
			}
		],
		ICustomerSite: 0,
		MainProductName: String,
		custom: False,
		templateID: 0,
		template: String,
		GlobalTemplate: String,
		isGlobalTemplate: False,
		HGInfo: 
		[
			{
				i_c_group: 0,
				ActivationDate: 0001-01-01,
				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: 0001-01-01,
		last_usage: 0001-01-01,
		first_usage_time: 0001-01-01,
		issue_date: 0001-01-01,
		inactivity_expire_time: 0
	},
	PortaProductInfo: 
	[
		{
			reseller_ID: 0,
			reseller: String,
			subreseller_ID: 0,
			subreseller: String,
			customer_ID: 0,
			customer: String,
			activation_date: 0001-01-01,
			product_ID: 0,
			product: String,
			id: String,
			IService: 0,
			Account_Subscription: 0,
			i_subscription: 0,
			Product_GroupName: String,
			Subscription_name: String,
			effective_from: 0001-01-01,
			effective_to: 0001-01-01,
			Subscription_Fees: 0,
			Currency: String,
			IAccount: 0,
			Price: 0,
			TerminationDate: 0001-01-01,
			Fee: 0,
			Charge_type: String,
			LineIdentity: String,
			BillStart: 0001-01-01,
			BillEnd: 0001-01-01,
			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: 0001-01-01,
			effective_to: 0001-01-01,
			IAccountProductAddOn: 0,
			Product_Group_Name: String,
			IAddonProduct: 0,
			effective_from_ProductAddon: 0001-01-01,
			effective_to_ProductAddon: 0001-01-01,
			ProductAddon: String
		}
	],
	NumberOfAccounts: 0,
	License: String,
	ContentId: 0,
	FeatureName: String
}