This section lists and explains the various URL and data parameters which are present in this Create a Product API.
\nIt also contains the complete JSON request that can be used to Create a Product.
\nData Parameters
\nCheck out the field descriptions for each data parameter in the link provided below.
Data Parameters.
Create a recurring product with a one-time installation charge.
\nFor example, an recurring internet connection with a one-time WiFi router purchase.
\nData Parameters
\nCheck out the field descriptions for each data parameter in the link provided below. Data Parameter.
\n","urlObject":{"path":["rest","ProductService","v1","product"],"host":["{{Host}}"],"query":[],"variable":[]}},"response":[{"id":"07e4334e-6221-4c42-9fee-2a65bc73f51a","name":"Recurring Product with One-Time Charge","originalRequest":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"BearerUse this API payload request to create a product with a 24-month term.
\nWhen this product is purchased, a new subscription will be created for the end customer with a 24-month term.
\nIf the \"termAction\" value is not passed, then the subscription will be cancelled at the end of the term.
\nData Parameters
\nCheck out the field descriptions for each data parameter in the link provided below. Data Parameters.
\n","urlObject":{"path":["rest","ProductService","v1","product"],"host":["{{Host}}"],"query":[],"variable":[]}},"response":[{"id":"f8e779b0-c607-45d5-a3d5-a41425a6e80b","name":"Recurring Product with Term","originalRequest":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"BearerUse this API request to create a taxable product in the system. This request will allow you to add a tax code to the product.
\nThe taxation being done here is with the help of the Internal Taxation feature.
\nReference APIs
\nUse the following APIs to gather details that would be needed for the \"Taxable Product\" API.
\nFetch Tax Codes: This API will help retrieve the tax codes that are present in the system.
Data Parameters
\nCheck out the field descriptions for each data parameter in the link provided below. Data Parameters.
\n","urlObject":{"path":["rest","ProductService","v1","product"],"host":["{{Host}}"],"query":[],"variable":[]}},"response":[{"id":"f158d19f-a71b-41fb-8d09-a5b958bf4ea9","name":"Taxable Product (Internal Taxation)","originalRequest":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"BearerUse this API request to create a product with multiple price plans.
\nFor example, a smartphone product may have a 64 GB variant and a 126 GB variant.
\nIn this request, the 2 price plans contain 2 different type of charges, namely One-Time and a Recurring charge.
\nData Parameters
\nCheck out the field descriptions for each data parameter in the link provided below. Data Parameters.
\n","urlObject":{"path":["rest","ProductService","v1","product"],"host":["{{Host}}"],"query":[],"variable":[]}},"response":[{"id":"f8f2fb3e-a9e2-4fd0-bc81-4c84b023ec3b","name":"Product with Multiple Price Plans","originalRequest":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"BearerUse this request to create a product with an Ad-Hoc pricing.
\nAd-Hoc pricing will allow a business to charge a specific fee to a customer (against the product) at any point during their subscription.
\nData Parameters
\nCheck out the field descriptions for each data parameter in the link provided below. Data Parameters.
\n","urlObject":{"path":["rest","ProductService","v1","product"],"host":["{{Host}}"],"query":[],"variable":[]}},"response":[{"id":"b79f8f04-2262-4d0f-bfae-2655e91a5fc8","name":"Product with Ad-Hoc Charge","originalRequest":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"BearerIn this API, user can create a product with trial period. For example, if you wish to provide a product for trial usage by the customer, this API will be useful.
\nData Parameters
\nCheck out the field descriptions for each data parameter in the link provided below. Data Parameters.
\n","urlObject":{"path":["rest","ProductService","v1","product"],"host":["{{Host}}"],"query":[],"variable":[]}},"response":[{"id":"7bf8756d-1074-49be-9eb2-fed8e761fc2d","name":"Product with Trial Period","originalRequest":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"BearerProduct creation fails in the system if product name already exists.
\nData Parameters
\nCheck out the field descriptions for each data parameter in the link provided below. Data Parameters.
\n","urlObject":{"path":["rest","ProductService","v1","product"],"host":["{{Host}}"],"query":[],"variable":[]}},"response":[{"id":"834abb99-3050-43bd-86c3-e227ea197938","name":"Product with a Discount","originalRequest":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"BearerIn this API can be used to create a product by providing all the mandatory parameters.
\nData Parameters
\nCheck out the field descriptions for each data parameter in the link provided below. Data Parameters.
\n","urlObject":{"path":["rest","ProductService","v1","product"],"host":["{{Host}}"],"query":[],"variable":[]}},"response":[{"id":"c70019b1-5279-406a-ac70-19c6d54da426","name":"Create a Product - Success","originalRequest":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"BearerGenerate and pass the access token here.
This section lists and explains the various URL and data parameters which are present in this API.
\nIt also contains the complete JSON request that can be used to Create a Product.
\nData Parameters
\nTo check out the field descriptions for each data parameter in the link provided below. Data Parameters
\n","urlObject":{"path":["rest","ProductService","v1","product"],"host":["{{Host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"eba9b5fd-6a70-4a9e-a0a2-d0ad45693bb1"},{"name":"Create a Product - Failure","id":"c2ed5b09-1d15-4227-b532-eda5ee805079","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"POST","header":[{"key":"Authorization","type":"text","value":"BearerThis API is an example of a scenario where the product has failed while creating.
\nData Parameters
\nCheck out the field descriptions for each data parameter in the link provided below. Data Parameters
\n","urlObject":{"path":["rest","ProductService","v1","product"],"host":["{{Host}}"],"query":[],"variable":[]}},"response":[{"id":"c8f5fe07-a8e9-4155-9085-5fc7a627ce0a","name":"Create a Product - Failure","originalRequest":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"BearerThis API will be used to create a product with tier-based pricing module where various slabs can be created with different price.
\nData Parameters
\nCheck out the field descriptions for each data parameter in the link provided below. Data Parameters
\n","urlObject":{"path":["rest","ProductService","v1","product"],"host":["{{Host}}"],"query":[],"variable":[]}},"response":[{"id":"1f3ebb0c-fd02-4ff8-ad93-eebc596eb61f","name":"Product with Tier Pricing","originalRequest":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"BearerThis API is used to create a product in the application. Use this API to create products with settlement policies associated to it.
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"bcec2f26-d83b-42a4-9154-a3b213969a7b"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"473897a1-c5ef-4a47-832e-cbafa672f41c"}}],"_postman_id":"9a140f44-3f4b-4a91-a4d6-76b12f0e68b8"},{"name":"Search a Product","item":[{"name":"Search all Products","id":"70d09855-29ee-47cf-8aa4-6e20ed7579fd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"bearer {{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{Host}}/rest/ProductService/v1/products","description":"This API will used to fetch all the product present under the application.
\n","urlObject":{"path":["rest","ProductService","v1","products"],"host":["{{Host}}"],"query":[],"variable":[]}},"response":[{"id":"40035198-f786-481c-8f68-ba0b89d94e7a","name":"New Request","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"bearer {{token}}"},{"key":"Content-Type","value":"application/json"}],"url":"{{Host}}/rest/ProductService/v1/products"},"status":"OK","code":200,"_postman_previewlanguage":"JSON","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Tue, 19 Apr 2022 05:46:58 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"*, Content-Type, Pragma, Origin, Authorization, party, X-XSRF-TOKEN, X-Requested-With,Access-Control-Allow-Headers,Accept,Access-Control-Allow-Credentials,X-Auth-Token, version, cache"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST,OPTIONS,PUT,DELETE,GET"}],"cookie":[],"responseTime":null,"body":"{\r\n \"resultSize\": 9,\r\n \"product\": [\r\n {\r\n \"name\": \"2 Plans - Non taxable\",\r\n \"categoryName\": \"Base\",\r\n \"code\": \"PROD213\",\r\n \"id\": \"213\",\r\n \"status\": \"ACTIVE\"\r\n },\r\n {\r\n \"name\": \"2020 - Resell Product\",\r\n \"categoryName\": \"Data Services\",\r\n \"code\": \"PROD2002\",\r\n \"id\": \"2002\",\r\n \"status\": \"ACTIVE\"\r\n },\r\n {\r\n \"name\": \"Internet Data Plan\",\r\n \"categoryName\": \"Data Services\",\r\n \"code\": \"PROD2205\",\r\n \"id\": \"2205\",\r\n \"status\": \"ACTIVE\"\r\n },\r\n {\r\n \"name\": \"Internet Data Service (IDS)\",\r\n \"categoryName\": \"Base\",\r\n \"code\": \"PROD11608\",\r\n \"id\": \"11307\",\r\n \"status\": \"ACTIVE\"\r\n },\r\n {\r\n \"name\": \"Internet Package\",\r\n \"categoryName\": \"data Products\",\r\n \"code\": \"PROD2703\",\r\n \"id\": \"2703\",\r\n \"status\": \"ACTIVE\"\r\n },\r\n {\r\n \"name\": \"Internet Service\",\r\n \"categoryName\": \"Internet service\",\r\n \"code\": \"PROD12904\",\r\n \"id\": \"12604\",\r\n \"status\": \"ACTIVE\"\r\n },\r\n {\r\n \"name\": \"Push SMS\",\r\n \"categoryName\": \"Data Services\",\r\n \"code\": \"PROD3803\",\r\n \"id\": \"3803\",\r\n \"status\": \"ACTIVE\"\r\n },\r\n {\r\n \"name\": \"PV Sample Product\",\r\n \"categoryName\": \"VOIP\",\r\n \"code\": \"PROD13402\",\r\n \"id\": \"13102\",\r\n \"status\": \"ACTIVE\"\r\n },\r\n {\r\n \"name\": \"QBO Product\",\r\n \"categoryName\": \"Base\",\r\n \"code\": \"PROD402\",\r\n \"id\": \"402\",\r\n \"status\": \"ACTIVE\"\r\n }\r\n ],\r\n \"status\": \"OK\"\r\n}"}],"_postman_id":"70d09855-29ee-47cf-8aa4-6e20ed7579fd"},{"name":"Search a Product with searching parameteres","id":"95978090-d651-462f-a504-f00723199c65","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"GET","header":[],"url":"{{Host}}/rest/ProductService/v1/products?searchString={String}&searchBy={Search by}&","description":"This API can be used to search a product with searching parameters like seach string and search by which will enhance the search.
\n","urlObject":{"path":["rest","ProductService","v1","products"],"host":["{{Host}}"],"query":[{"description":{"content":"Enter the value through which you want to search the product.
\n","type":"text/plain"},"key":"searchString","value":"{String}"},{"description":{"content":"This URL parameter will help user to search based search by creteria. List search by options are given below:
\n- \n
- productName \n
- priceplanName \n
- categoryName \n
This API is used to search a particular product in the application using the product code.
\n","urlObject":{"path":["rest","ProductService","v1","products","PROD11005"],"host":["{{Host}}"],"query":[],"variable":[]}},"response":[{"id":"6a53124a-f9bd-480c-8afd-7797d5027b11","name":"Search a Product with product code","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"bearer{{token}}"},{"key":"Content-Type","value":"application/json"}],"url":"{{Host}}/rest/ProductService/v1/products/PROD11005"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Thu, 22 Feb 2024 05:26:55 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"4761"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"*, Content-Type, Pragma, Origin, Authorization, party, X-XSRF-TOKEN, X-Requested-With,Access-Control-Allow-Headers,Accept,Access-Control-Allow-Credentials,X-Auth-Token, version, cache"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST,OPTIONS,PUT,DELETE,GET"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"10705\",\n \"code\": \"PROD11005\",\n \"name\": \"INTERNET DATA PACKS\",\n \"categoryCode\": \"Data Services\",\n \"categoryName\": \"Data Services\",\n \"description\": \"Offering internet services for mobile devices.
\",\n \"availableFrom\": \"2021-10-20T00:00:00-07:00\",\n \"shippable\": false,\n \"amount\": 0,\n \"pricePlanInfos\": [\n {\n \"id\": \"11507\",\n \"name\": \"Data Pack @299\",\n \"description\": \"Internet services provided at INR 299/- are 1GB data/day, unlimited calling, unlimited SMS.
\",\n \"availableFrom\": \"2021-10-20T00:00:00-07:00\",\n \"term\": 1,\n \"pricePlanEventInfos\": [\n {\n \"id\": \"11507\",\n \"feeType\": \"4\",\n \"prorationMode\": 1,\n \"cancellationProrateMode\": 1,\n \"alignedTo\": 1,\n \"chargeInfos\": [\n {\n \"id\": \"11907\",\n \"chargeMode\": 1,\n \"amount\": 299,\n \"currencyCode\": 356,\n \"glCode\": \"Sales\",\n \"glString\": \"1111\",\n \"uomCode\": \"PACKAGE\",\n \"effectiveFrom\": \"2021-10-20T04:59:09-07:00\",\n \"stepMode\": 0,\n \"currencySymbol\": \"INR \",\n \"discountCode\": \"DISCOUNT2002\",\n \"discountInfo\": {\n \"id\": \"2302\",\n \"name\": \"Diwali Dhamaka\",\n \"description\": \"Half off price plan expenses\",\n \"availableFrom\": \"2021-10-25T00:00:00-07:00\",\n \"code\": \"DISCOUNT2002\",\n \"recurring\": false\n },\n \"disassociateDiscount\": false,\n \"forever\": false,\n \"taxMode\": 0,\n \"wholesaleTaxMode\": 0,\n \"units\": 1,\n \"increment\": 0,\n \"minimumQuantity\": 0,\n \"chargeCategoryGroup\": \"Default\",\n \"considerOrderQuantity\": 0,\n \"applyForExistingSubscriptions\": false,\n \"ratingType\": 1,\n \"localizedInvoiceDescriptions\": [\n {\n \"language\": \"US English\"\n }\n ],\n \"itemType\": 1,\n \"removeFloorAndCeiling\": false,\n \"applyRevisionsToPartners\": false,\n \"chargeGroupAttributeType\": 0,\n \"costCurrencyCode\": 356,\n \"isPushChargeChangesToBundle\": false,\n \"applyBundleRevisionsToPartners\": false,\n \"isBundleVersionRequired\": false,\n \"applyGrants\": false,\n \"billTimeTax\": false,\n \"matchingCurrency\": false,\n \"isRefundOnCancellation\": false\n }\n ],\n \"eventType\": \"RECURRING\",\n \"eventName\": \"MONTHLY\"\n }\n ],\n \"priceOverridable\": true,\n \"forever\": false,\n \"url\": \"https://api.billing.totogi.com/productpurchase?id=b25lYmlsbElkPW9uZWJpbGxkb2MmcGFydHlSb2xlSWQ9MiZwcm9kdWN0PVBST0QxMTAwNSZwcmljZXBsYW49RGF0YSBQYWNrIEAyOTk%3D\",\n \"termMode\": \"M\",\n \"termAction\": 1,\n \"priority\": 1,\n \"pricePlanType\": 1,\n \"advanceChargingCycle\": 1,\n \"alignToCycle\": true,\n \"taxInclusive\": true,\n \"pushPlanUpdatesToPartner\": false,\n \"pushGrantUpdatesToPartner\": false,\n \"grantVersioningRequired\": false,\n \"isWebStorePricePlan\": false,\n \"pushPlanChangesToResoldBundles\": false,\n \"priceLockable\": false,\n \"defaultSystemPlan\": false,\n \"localizedPricePlanNames\": [\n {\n \"language\": \"US English\",\n \"locale\": \"en_US\",\n \"name\": \"\"\n }\n ]\n },\n {\n \"id\": \"11508\",\n \"name\": \"Data pack @399\",\n \"description\": \"Internet services provided @399/- are 2GB data/day, unlimited calling, unlimited SMS.
\",\n \"availableFrom\": \"2021-10-20T00:00:00-07:00\",\n \"term\": 1,\n \"pricePlanEventInfos\": [\n {\n \"id\": \"11508\",\n \"feeType\": \"4\",\n \"prorationMode\": 1,\n \"cancellationProrateMode\": 1,\n \"alignedTo\": 1,\n \"chargeInfos\": [\n {\n \"id\": \"11908\",\n \"chargeMode\": 1,\n \"amount\": 399,\n \"currencyCode\": 356,\n \"glCode\": \"Sales\",\n \"glString\": \"2222\",\n \"uomCode\": \"PACKAGE\",\n \"effectiveFrom\": \"2021-10-20T05:05:20-07:00\",\n \"stepMode\": 0,\n \"currencySymbol\": \"INR \",\n \"discountCode\": \"DISCOUNT2002\",\n \"discountInfo\": {\n \"id\": \"2302\",\n \"name\": \"Diwali Dhamaka\",\n \"description\": \"Half off price plan expenses\",\n \"availableFrom\": \"2021-10-25T00:00:00-07:00\",\n \"code\": \"DISCOUNT2002\",\n \"recurring\": false\n },\n \"disassociateDiscount\": false,\n \"forever\": false,\n \"taxMode\": 0,\n \"wholesaleTaxMode\": 0,\n \"units\": 1,\n \"increment\": 0,\n \"minimumQuantity\": 0,\n \"chargeCategoryGroup\": \"Default\",\n \"considerOrderQuantity\": 0,\n \"applyForExistingSubscriptions\": false,\n \"ratingType\": 1,\n \"localizedInvoiceDescriptions\": [\n {\n \"language\": \"US English\"\n }\n ],\n \"itemType\": 1,\n \"removeFloorAndCeiling\": false,\n \"applyRevisionsToPartners\": false,\n \"chargeGroupAttributeType\": 0,\n \"costCurrencyCode\": 356,\n \"isPushChargeChangesToBundle\": false,\n \"applyBundleRevisionsToPartners\": false,\n \"isBundleVersionRequired\": false,\n \"applyGrants\": false,\n \"billTimeTax\": false,\n \"matchingCurrency\": false,\n \"isRefundOnCancellation\": false\n }\n ],\n \"eventType\": \"RECURRING\",\n \"eventName\": \"MONTHLY\"\n }\n ],\n \"priceOverridable\": true,\n \"forever\": false,\n \"url\": \"https://api.billing.totogi.com/productpurchase?id=b25lYmlsbElkPW9uZWJpbGxkb2MmcGFydHlSb2xlSWQ9MiZwcm9kdWN0PVBST0QxMTAwNSZwcmljZXBsYW49RGF0YSBwYWNrIEAzOTk%3D\",\n \"termMode\": \"M\",\n \"termAction\": 1,\n \"priority\": 2,\n \"pricePlanType\": 1,\n \"advanceChargingCycle\": 1,\n \"alignToCycle\": true,\n \"taxInclusive\": true,\n \"pushPlanUpdatesToPartner\": false,\n \"pushGrantUpdatesToPartner\": false,\n \"grantVersioningRequired\": false,\n \"isWebStorePricePlan\": false,\n \"pushPlanChangesToResoldBundles\": false,\n \"priceLockable\": false,\n \"defaultSystemPlan\": false,\n \"localizedPricePlanNames\": [\n {\n \"language\": \"US English\",\n \"locale\": \"en_US\",\n \"name\": \"\"\n }\n ]\n }\n ],\n \"type\": 0,\n \"changePlanScope\": 0,\n \"productServiceInfos\": [\n {\n \"id\": \"703\",\n \"serviceCode\": \"SER2\",\n \"serviceName\": \"BROADBAND\"\n }\n ],\n \"priceOverridable\": false,\n \"localizedProductNames\": [\n {\n \"language\": \"US English\",\n \"locale\": \"en_US\",\n \"name\": \"\"\n }\n ],\n \"priceLockable\": false,\n \"isResolded\": false,\n \"isPurchased\": true,\n \"status\": \"OK\"\n}\n"}],"_postman_id":"dd23919c-6a29-43b8-9fab-66375268240e"},{"name":"Search Product Link","id":"a3c268d3-0bd0-4a79-be80-e8efa4d147ce","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Bearer{{Token}}","type":"text"}],"url":"{{Host}}/rest/ProductService/v1/products/PROD2","description":"This API can be used to fetch the Product link of a specific product.
\n","urlObject":{"path":["rest","ProductService","v1","products","PROD2"],"host":["{{Host}}"],"query":[],"variable":[]}},"response":[{"id":"0f25105c-4e8c-4d87-87d2-db92f5e35799","name":"Fetch the Product Link","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer{{Token}}"}],"url":"{{Host}}/rest/ProductService/v1/products/PROD2/productLinks"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Headers","value":"*, Content-Type, Pragma, Origin, Authorization, party, X-XSRF-TOKEN, X-Requested-With,Access-Control-Allow-Headers,Accept,Access-Control-Allow-Credentials,X-Auth-Token, version, cache"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST,OPTIONS,PUT,DELETE,GET"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"243"},{"key":"Date","value":"Wed, 06 Sep 2023 07:40:56 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"productPricePlanLinkInfos\": [\n {\n \"name\": \"Internet @30Mbps\",\n \"url\": \"https://api.billing.totogi.com/productpurchase?id=b25lYmlsbElkPWthcnRoaWsxJnBhcnR5Um9sZUlkPTImcHJvZHVjdD1QUk9EMiZwcmljZXBsYW49SW50ZXJuZXQgQDMwTWJwcw%3D%3D\"\n }\n ],\n \"status\": \"OK\"\n}\n"}],"_postman_id":"a3c268d3-0bd0-4a79-be80-e8efa4d147ce"}],"id":"da747d5e-9a32-4907-a628-2036aa996041","description":"These APIs are used to find products defined in the BSS solution using a various of search parameters.
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"d8c3f0c4-2c12-47ce-8736-33ff04c81a00"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"923528df-6e9b-4439-bb2d-50d2c2036972"}}],"_postman_id":"da747d5e-9a32-4907-a628-2036aa996041"},{"name":"Updating a Product","item":[{"name":"Update a Product","id":"11a69c25-e2a0-42bd-93e5-7564218c47e7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"PUT","header":[{"key":"Authorization","value":"Bearer {{token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"id\": \"404\",\r\n \"code\": \"PROD403\",\r\n \"name\": \"Hosted VOIP\",\r\n \"categoryCode\": \"CAT2\",\r\n \"categoryName\": \"Base\",\r\n \"description\": \"Hosted VOIP
Hosted VOIP PP
This API is used to update the details of a product which is already present in the system. Users can make use of this API to update products containing multi-level channel management settlement policies associated with them.
\nData Parameters
\nCheck out the field descriptions for each data parameter in the link provided below.
Data Parameters.
Hosted VOIP
Hosted VOIP PP
The following API are for updating a product. These can be used if you want to modify the details in your existing product. Various examples are given to help you with updating product.
\n","_postman_id":"aad66aa4-0845-45c5-b726-fc767fd6d41d"},{"name":"Delete Product","item":[{"name":"Delete a Product","id":"db677581-8894-46be-9b29-5be60401b445","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"DELETE","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"}],"url":"{{Host}}/rest/ProductService/v1/products/{ProductCode}","description":"This API is used to delete the product using Product Code by providing it in the URL parameter as mentioned in the example.
\nNote: If the Product is in subscribed by customer, application will not allow to delete the product.
\n","urlObject":{"path":["rest","ProductService","v1","products","{ProductCode}"],"host":["{{Host}}"],"query":[],"variable":[]}},"response":[{"id":"d4cd35a0-2775-469e-a62b-117e9c17d075","name":"Delete a Product","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"}],"url":"{{Host}}/rest/ProductService/v1/products/PROD12904"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Tue, 14 Nov 2023 07:01:17 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"15"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"*, Content-Type, Pragma, Origin, Authorization, party, X-XSRF-TOKEN, X-Requested-With,Access-Control-Allow-Headers,Accept,Access-Control-Allow-Credentials,X-Auth-Token, version, cache"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST,OPTIONS,PUT,DELETE,GET"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"OK\"\n}"}],"_postman_id":"db677581-8894-46be-9b29-5be60401b445"},{"name":"Delete A Price Plan","id":"14741c42-15b2-4dcb-8525-417eb16a5c93","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"DELETE","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"}],"url":"{{Host}}/rest/ProductService/v1/products/priceplan/{PricePlan_ID}","description":"This API is used to delete the plans of the products without affecting rest of the plans and product.
\nNote: If you delete the Price plan, this will also result in deleting the charges present under that price plan.
\nIf this Price Plan is purchased and has an active subscription, the system will not allow to deletion of the API
\n","urlObject":{"path":["rest","ProductService","v1","products","priceplan","{PricePlan_ID}"],"host":["{{Host}}"],"query":[],"variable":[]}},"response":[{"id":"f75ae5f2-834d-4d32-b2fb-d1e12987a56f","name":"Delete A Price Plan","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"}],"url":"{{Host}}/rest/ProductService/v1/products/priceplan/19305"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Tue, 14 Nov 2023 06:55:24 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"15"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"*, Content-Type, Pragma, Origin, Authorization, party, X-XSRF-TOKEN, X-Requested-With,Access-Control-Allow-Headers,Accept,Access-Control-Allow-Credentials,X-Auth-Token, version, cache"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST,OPTIONS,PUT,DELETE,GET"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"OK\"\n}"}],"_postman_id":"14741c42-15b2-4dcb-8525-417eb16a5c93"},{"name":"Delete a Charge Details","id":"66d222a8-d74f-431f-8be3-b50eb3a61377","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"DELETE","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"}],"url":"{{Host}}/rest/ProductService/v1/products/priceplan/charge/{Charge_Id}","description":"This API is used delete the charge details of the product, without affecting product and plan.
\nNote: If only one charge is present under a Price Plan, the system will not allow to deletion.
\nIf this Price Plan is purchased and has an active subscription, the system will not allow to deletion of the API.
\n","urlObject":{"path":["rest","ProductService","v1","products","priceplan","charge","{Charge_Id}"],"host":["{{Host}}"],"query":[],"variable":[]}},"response":[{"id":"0c5c99ad-b6f0-4a50-a0cb-7209393e782b","name":"Delete Charge Details","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"}],"url":"{{Host}}/rest/ProductService/v1/products/priceplan/charge/19606"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Tue, 14 Nov 2023 06:54:15 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"15"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"*, Content-Type, Pragma, Origin, Authorization, party, X-XSRF-TOKEN, X-Requested-With,Access-Control-Allow-Headers,Accept,Access-Control-Allow-Credentials,X-Auth-Token, version, cache"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST,OPTIONS,PUT,DELETE,GET"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"OK\"\n}"}],"_postman_id":"66d222a8-d74f-431f-8be3-b50eb3a61377"}],"id":"59043be2-796f-4070-960c-f372eaf56da1","description":"In this section we will discuss about deleting a product, in the given example we have demonstrated how to delete product, price plan and charge details.
\n","_postman_id":"59043be2-796f-4070-960c-f372eaf56da1"},{"name":"Create a Bundle","item":[{"name":"Create a bundle","id":"2e592b99-a90d-4d4a-a810-a5c1866cc07f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"name\": \"Voice Call Bundle\",\r\n \"categoryCode\": \"CAT4603\",\r\n \"regulatoryCode\": \"03\",\r\n \"description\": \"This bundle will manage the voice call related items like voice plan, devices and etc\",\r\n \"priceOverridable\": \"false\",\r\n \"pricePlanInfos\": [\r\n {\r\n \"id\": \"13804\",\r\n \"bundleQuantity\": \"1\"\r\n },\r\n {\r\n \"id\": \"18705\",\r\n \"bundleQuantity\": \"1\"\r\n }\r\n ]\r\n}"},"url":"{{Host}}/rest/ProductService/v1/products/bundle","description":"This API is used to create bundles in the appliation. The bundles are set of similar product which business intended to sell as a combo package. You can create bundles using the existing product by passing priceplan Id in the request.
\n","urlObject":{"path":["rest","ProductService","v1","products","bundle"],"host":["{{Host}}"],"query":[],"variable":[]}},"response":[{"id":"9ab1c5e0-95c9-47a4-8ea5-6e75a591e314","name":"Create a bundle","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"name\": \"Voice Call Bundle\",\r\n \"categoryCode\": \"CAT4603\",\r\n \"regulatoryCode\": \"03\",\r\n \"description\": \"This bundle will manage the voice call related items like voice plan, devices and etc\",\r\n \"priceOverridable\": \"false\",\r\n \"pricePlanInfos\": [\r\n {\r\n \"id\": \"13804\",\r\n \"bundleQuantity\": \"1\"\r\n },\r\n {\r\n \"id\": \"18705\",\r\n \"bundleQuantity\": \"1\"\r\n }\r\n ]\r\n}"},"url":"{{Host}}/rest/ProductService/v1/products/bundle"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Thu, 06 Jul 2023 10:32:31 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"56"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"*, Content-Type, Pragma, Origin, Authorization, party, X-XSRF-TOKEN, X-Requested-With,Access-Control-Allow-Headers,Accept,Access-Control-Allow-Credentials,X-Auth-Token, version, cache"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST,OPTIONS,PUT,DELETE,GET"}],"cookie":[],"responseTime":null,"body":"{\n \"productCode\": \"PROD16902\",\n \"id\": \"2002001\",\n \"status\": \"OK\"\n}\n"}],"_postman_id":"2e592b99-a90d-4d4a-a810-a5c1866cc07f"}],"id":"648395c5-d01f-4960-a022-3d1f50829562","description":"This API will be used to create bundle in the application. Bundles are set of product which can be sold together. For exaple, you can sell your Internet subscription, Router, and installation charger as a bundle.
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"a2999d8d-0a8f-4e32-85be-05864bfb2d5f"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"62343b91-6dba-4ff5-8d10-6911d8f3333c"}}],"_postman_id":"648395c5-d01f-4960-a022-3d1f50829562"},{"name":"Updating a Bundle","item":[{"name":"Update a Bundle","id":"159380f0-2bb4-4363-8cf5-da594d066caf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"PUT","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"id\": \"2002001\",\r\n \"name\": \"Voice Call Bundle\",\r\n \"categoryCode\": \"CAT4603\",\r\n \"regulatoryCode\": \"03\",\r\n \"description\": \"This bundle will manage the voice call related items like voice plan, devices and etc\",\r\n \"priceOverridable\": \"false\",\r\n \"pricePlanInfos\": [\r\n {\r\n \"id\": \"13804\",\r\n \"bundleQuantity\": \"1\"\r\n },\r\n {\r\n \"id\": \"18705\",\r\n \"bundleQuantity\": \"1\"\r\n },\r\n {\r\n \"id\": \"18706\",\r\n \"bundleQuantity\": \"1\"\r\n }\r\n ]\r\n}"},"url":"{{Host}}/rest/ProductService/v1/products/bundle","description":"This API is used to update the bundle, with this you can update the quantity, name, and description.
\n","urlObject":{"path":["rest","ProductService","v1","products","bundle"],"host":["{{Host}}"],"query":[],"variable":[]}},"response":[{"id":"fd60a418-1eba-4c4c-9cc4-e2d04347f3ac","name":"Update a Bundle","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"id\": \"2002001\",\r\n \"name\": \"Voice Call Bundle\",\r\n \"categoryCode\": \"CAT4603\",\r\n \"regulatoryCode\": \"03\",\r\n \"description\": \"This bundle will manage the voice call related items like voice plan, devices and etc\",\r\n \"priceOverridable\": \"false\",\r\n \"pricePlanInfos\": [\r\n {\r\n \"id\": \"13804\",\r\n \"bundleQuantity\": \"1\"\r\n },\r\n {\r\n \"id\": \"18705\",\r\n \"bundleQuantity\": \"1\"\r\n },\r\n {\r\n \"id\": \"18706\",\r\n \"bundleQuantity\": \"1\"\r\n }\r\n ]\r\n}"},"url":"{{Host}}/rest/ProductService/v1/products/bundle"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Thu, 06 Jul 2023 10:50:23 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"30"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"*, Content-Type, Pragma, Origin, Authorization, party, X-XSRF-TOKEN, X-Requested-With,Access-Control-Allow-Headers,Accept,Access-Control-Allow-Credentials,X-Auth-Token, version, cache"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST,OPTIONS,PUT,DELETE,GET"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"2002001\",\n \"status\": \"OK\"\n}\n"}],"_postman_id":"159380f0-2bb4-4363-8cf5-da594d066caf"}],"id":"9602cd50-34a5-4d31-9dcb-7ecf4d5ad73b","description":"This API will be used to update or modify the details of a bundle. Using this you can edit the information about the bundle.
\n","_postman_id":"9602cd50-34a5-4d31-9dcb-7ecf4d5ad73b"},{"name":"Search Bundle","item":[{"name":"Search the list of Bundles","id":"1fce4bbe-e695-4ab3-876d-237a742c8cff","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"}],"url":"{{Host}}/rest/ProductService/v1/bundles?searchBy=bundleName&searchString=VoIP Bundle","description":"This API is used to search the bundles in the application. Search can be customized by various parameter in the URL. Using the search by and search string you can search the bundle.
\nURL Param:
\nMandatory:
\n- \n
- searchString - [STRING] \n
- searchBy
- \n
- bundleName
categoryName \n
\n - bundleName
Provide the bundle name in this parameter to search based on the name.
\n","type":"text/plain"},"key":"searchString","value":"VoIP Bundle"}],"variable":[]}},"response":[{"id":"c1b09d7c-bbf9-47a5-9ea8-9c11376ca186","name":"Search the list of Bundles","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"}],"url":{"raw":"{{Host}}/rest/ProductService/v1/bundles?searchBy=bundleName&searchString=Bundle","host":["{{Host}}"],"path":["rest","ProductService","v1","bundles"],"query":[{"key":"searchBy","value":"bundleName"},{"key":"searchString","value":"Bundle"}]}},"status":"OK","code":200,"_postman_previewlanguage":"JSON","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Thu, 27 Apr 2023 11:17:59 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"368"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"*, Content-Type, Pragma, Origin, Authorization, party, X-XSRF-TOKEN, X-Requested-With,Access-Control-Allow-Headers,Accept,Access-Control-Allow-Credentials,X-Auth-Token, version, cache"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST,OPTIONS,PUT,DELETE,GET"}],"cookie":[],"responseTime":null,"body":"{\r\n \"resultSize\": 3,\r\n \"bundles\": [\r\n {\r\n \"name\": \"Business Phone Bundle 1\",\r\n \"categoryName\": \"bundle\",\r\n \"code\": \"PROD5904\",\r\n \"id\": \"2001301\",\r\n \"status\": \"ACTIVE\"\r\n },\r\n {\r\n \"name\": \"Business Phone Bundle 2\",\r\n \"categoryName\": \"bundle\",\r\n \"code\": \"PROD5905\",\r\n \"id\": \"2001302\",\r\n \"status\": \"ACTIVE\"\r\n },\r\n {\r\n \"name\": \"iV Pro-Stack Bundle\",\r\n \"categoryName\": \"Level 4\",\r\n \"code\": \"PROD710\",\r\n \"id\": \"2000201\",\r\n \"status\": \"ACTIVE\"\r\n }\r\n ],\r\n \"status\": \"OK\"\r\n}"}],"_postman_id":"1fce4bbe-e695-4ab3-876d-237a742c8cff"},{"name":"Search the bundle","id":"91dc377b-846c-45ce-b980-5e89fb5b6358","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"}],"url":"{{Host}}/rest/ProductService/v1/bundles","description":"This API is used to search the list of bundle available in the system. It will search the list of all the bundles.
\n","urlObject":{"path":["rest","ProductService","v1","bundles"],"host":["{{Host}}"],"query":[],"variable":[]}},"response":[{"id":"8446eb46-736f-4af1-94b3-8ddeeba1ca6b","name":"Search the bundle","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"}],"url":"{{Host}}/rest/ProductService/v1/bundles"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 28 Jun 2023 09:41:48 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"2671"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"*, Content-Type, Pragma, Origin, Authorization, party, X-XSRF-TOKEN, X-Requested-With,Access-Control-Allow-Headers,Accept,Access-Control-Allow-Credentials,X-Auth-Token, version, cache"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST,OPTIONS,PUT,DELETE,GET"}],"cookie":[],"responseTime":null,"body":"{\n \"resultSize\": 18,\n \"bundles\": [\n {\n \"name\": \"Big Bundle\",\n \"categoryName\": \"Base\",\n \"code\": \"PROD6004\",\n \"id\": \"2000401\",\n \"status\": \"ACTIVE\"\n },\n {\n \"name\": \"big offer\",\n \"categoryName\": \"Channel\",\n \"code\": \"PROD11122\",\n \"id\": \"2001308\",\n \"status\": \"ACTIVE\"\n },\n {\n \"name\": \"Bundle 2020\",\n \"categoryName\": \"Base\",\n \"code\": \"PROD717\",\n \"id\": \"2000110\",\n \"status\": \"ACTIVE\"\n },\n {\n \"name\": \"Bundle Package\",\n \"categoryName\": \"Combo Package\",\n \"code\": \"PROD12304\",\n \"id\": \"2001701\",\n \"status\": \"ACTIVE\"\n },\n {\n \"name\": \"Bundle with Taxable and Non-Taxable\",\n \"categoryName\": \"Base\",\n \"code\": \"PROD214\",\n \"id\": \"2000001\",\n \"status\": \"ACTIVE\"\n },\n {\n \"name\": \"Combo bundle offer\",\n \"categoryName\": \"Airtel\",\n \"code\": \"PROD14105\",\n \"id\": \"2001901\",\n \"status\": \"ACTIVE\"\n },\n {\n \"name\": \"Combo Data Networks Bundle\",\n \"categoryName\": \"Internet Bundle\",\n \"code\": \"PROD7304\",\n \"id\": \"2000601\",\n \"status\": \"ACTIVE\"\n },\n {\n \"name\": \"Corporate VoIP Bundle\",\n \"categoryName\": \"VoIP Bundle\",\n \"code\": \"PROD8708\",\n \"id\": \"2000901\",\n \"status\": \"ACTIVE\"\n },\n {\n \"name\": \"Globe Master Bundle\",\n \"categoryName\": \"Base\",\n \"code\": \"PROD3504\",\n \"id\": \"2000201\",\n \"status\": \"ACTIVE\"\n },\n {\n \"name\": \"Gym Combo\",\n \"categoryName\": \"fitness\",\n \"code\": \"PROD7804\",\n \"id\": \"2000701\",\n \"status\": \"ACTIVE\"\n },\n {\n \"name\": \"Internal Bundle\",\n \"categoryName\": \"internal\",\n \"code\": \"PROD8605\",\n \"id\": \"2000802\",\n \"status\": \"ACTIVE\"\n },\n {\n \"name\": \"Internet Data Service Bundle\",\n \"categoryName\": \"Data Services\",\n \"code\": \"PROD11611\",\n \"id\": \"2001502\",\n \"status\": \"ACTIVE\"\n },\n {\n \"name\": \"Special Bundle\",\n \"categoryName\": \"Billing\",\n \"code\": \"PROD10302\",\n \"id\": \"2001101\",\n \"status\": \"ACTIVE\"\n },\n {\n \"name\": \"Telecom PBX 2020 Bundle\",\n \"categoryName\": \"Base\",\n \"code\": \"PROD708\",\n \"id\": \"2000104\",\n \"status\": \"ACTIVE\"\n },\n {\n \"name\": \"Television bundle\",\n \"categoryName\": \"mock Product\",\n \"code\": \"PROD11009\",\n \"id\": \"2001204\",\n \"status\": \"ACTIVE\"\n },\n {\n \"name\": \"Television Combo\",\n \"categoryName\": \"Television\",\n \"code\": \"PROD11127\",\n \"id\": \"2001313\",\n \"status\": \"ACTIVE\"\n },\n {\n \"name\": \"Television full plan\",\n \"categoryName\": \"All net\",\n \"code\": \"PROD11203\",\n \"id\": \"2001401\",\n \"status\": \"ACTIVE\"\n },\n {\n \"name\": \"VoIP Bundle\",\n \"categoryName\": \"All net\",\n \"code\": \"PROD14002\",\n \"id\": \"2001801\",\n \"status\": \"ACTIVE\"\n }\n ],\n \"status\": \"OK\"\n}"}],"_postman_id":"91dc377b-846c-45ce-b980-5e89fb5b6358"}],"id":"8c5a3eee-a296-44a5-9cdc-57c281930be3","description":"This API will be used to search the bundle in the application. Use this to search the bundles.
\n","_postman_id":"8c5a3eee-a296-44a5-9cdc-57c281930be3"}],"id":"c1905c37-756b-4974-b5bb-7a148e38a923","description":"This module provides the APIs to create, manage or retrieve product information from the application. Products are the key items that are sold by a business which could represent a service, a physical item or anything else that an end customer(Subscriber) buys from a business.
\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"064dbbea-3c1f-407f-93a8-244f4b8d2640"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"de7405c9-6d81-4b5f-a5c7-1970c22da807"}}],"_postman_id":"c1905c37-756b-4974-b5bb-7a148e38a923"},{"name":"Leads","item":[{"name":"Create Lead","item":[{"name":"Create a Lead - JSON","id":"43613687-42db-4350-b9cf-b836552e0cb3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"BearerProvide the generated access token in this field.
\n","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"accountName\": \"?\",\r\n \"accountNumber\": \"?\",\r\n \"externalId\": \"?\",\r\n \"accountType\": \"?\",\r\n \"primaryCurrencyId\": \"?\",\r\n \"contact\": [\r\n {\r\n \"contactType\": \"?\",\r\n \"salutation\": \"?\",\r\n \"firstName\": \"?\",\r\n \"middleName\": \"?\",\r\n \"lastName\": \"?\",\r\n \"primaryContact\": \"?\",\r\n \"billingContact\": \"?\",\r\n \"locale\": \"?\",\r\n \"designation\": \"?\",\r\n \"communicationPoint\": [\r\n {\r\n \"type\": \"?\",\r\n \"value\": \"?\"\r\n }\r\n ],\r\n \"userDetail\": {\r\n \"username\": \"?\",\r\n \"password\": \"?\"\r\n }\r\n }\r\n ],\r\n \"address\": [\r\n {\r\n \"addLine1\": \"?\",\r\n \"addLine2\": \"?\",\r\n \"city\": \"?\",\r\n \"state\": \"?\",\r\n \"county\": \"?\",\r\n \"country\": \"?\",\r\n \"zip\": \"?\",\r\n \"zipCodeExtension\": \"?\",\r\n \"defaultShipping\": \"?\",\r\n \"defaultBilling\": \"?\",\r\n \"addressAttribute\": [\r\n {\r\n \"key\": \"?\",\r\n \"value\": \"?\"\r\n }\r\n ]\r\n }\r\n ],\r\n \"accountAttribute\": [\r\n {\r\n \"key\": \"?\",\r\n \"value\": \"?\"\r\n }\r\n ],\r\n \"payInfo\": [\r\n {\r\n \"paymentMethod\": \"?\",\r\n \"isDefault\": \"?\",\r\n \"creditCardInfo\": {\r\n \"firstName\": \"?\",\r\n \"lastName\": \"?\",\r\n \"cardType\": \"?\",\r\n \"cardNumber\": \"?\",\r\n \"cardExpiryMonth\": \"?\",\r\n \"cardExpiryYear\": \"?\",\r\n \"cvv\": \"?\"\r\n },\r\n \"echeckInfo\": {\r\n \"accountHolderName\": \"?\",\r\n \"bankAccountNumber\": \"?\",\r\n \"bankAccountType\": \"?\",\r\n \"bankName\": \"?\",\r\n \"routingNumber\": \"?\"\r\n },\r\n \"paymentKeyInfo\": {\r\n \"key\": \"?\",\r\n \"keyReferencePaymentMethod\": \"?\"\r\n },\r\n \"profileAddress\": {\r\n \"address1\": \"?\",\r\n \"address2\": \"?\",\r\n \"city\": \"?\",\r\n \"county\": \"?\",\r\n \"state\": \"?\",\r\n \"zipCode\": \"?\",\r\n \"country\": \"?\"\r\n }\r\n }\r\n ],\r\n \"billingDayOfMonth\": \"?\",\r\n \"spendLimit\": \"?\",\r\n \"secondaryCurrencyId\": \"?\",\r\n \"taxExemptionCode\": {\r\n \"code\": [\r\n {\r\n \"code\": \"?\",\r\n \"description\": \"?\"\r\n }\r\n ],\r\n \"internalItemCode\": [\r\n {\r\n \"code\": \"?\",\r\n \"description\": \"?\"\r\n }\r\n ]\r\n },\r\n \"parentAccNumber\": \"?\",\r\n \"payingEntity\": \"?\",\r\n \"activationStartDate\": \"?\",\r\n \"creditLimit\": \"?\",\r\n \"paymentDueInterval\": \"?\",\r\n \"agentAccountNumber\": \"?\",\r\n \"agentAssociations\": [\r\n {\r\n \"agentAccId\": \"?\",\r\n \"channelSubTypeId\": \"?\"\r\n }\r\n ],\r\n \"invoiceFormat\": \"?\",\r\n \"invoiceDeliveryPreference\": \"?\",\r\n \"invoiceTemplateName\": \"?\",\r\n \"quoteTemplateName\": \"?\",\r\n \"billingDelay\": \"?\",\r\n \"billingSuppressionThreshold\": \"?\",\r\n \"exemptLateFee\": \"?\",\r\n \"carryForwardBalance\": \"?\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/rest/SubscriberService/v1/lead","description":"This is the full payload to create a lead. It can be also used as meta data for create lead.
\nData Parameters
\nCheck out the field descriptions for each data parameter in the link provided below.
Data Parameters
Provide the generated access token in this field.
\n","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"accountName\": \"John Doe\",\r\n \"accountType\": \"1001\",\r\n \"primaryCurrencyId\": \"840\",\r\n \"billingDayOfMonth\": \"1\",\r\n \"billingDelay\": \"4\",\r\n \"address\": [\r\n {\r\n \"addLine1\": \"AddressLine1\",\r\n \"addLine2\": \"AddressLine2\",\r\n \"city\": \"New York\",\r\n \"state\": \"NEW YORK\",\r\n \"country\": \"UNITED STATES\",\r\n \"zip\": \"10010\",\r\n \"defaultShipping\": true,\r\n \"defaultBilling\": true\r\n },\r\n {\r\n \"addLine1\": \"AddressLine3\",\r\n \"addLine2\": \"AddressLine4\",\r\n \"city\": \"Texas\",\r\n \"state\": \"AUSTIN\",\r\n \"country\": \"UNITED STATES\",\r\n \"zip\": \"100111\",\r\n \"defaultShipping\": false,\r\n \"defaultBilling\": false\r\n }\r\n ],\r\n \"contact\": [\r\n {\r\n \"contactType\": 0,\r\n \"firstName\": \"John\",\r\n \"lastName\": \"Doe\",\r\n \"communicationPoint\": [\r\n {\r\n \"type\": \"PHONE\",\r\n \"value\": \"9891919191\"\r\n },\r\n {\r\n \"type\": \"EMAIL\",\r\n \"value\": \"john@gmail.com\"\r\n }\r\n ],\r\n \"primaryContact\": true,\r\n \"billingContact\": true\r\n },\r\n {\r\n \"contactType\": 1,\r\n \"firstName\": \"James\",\r\n \"lastName\": \"Hancock\",\r\n \"communicationPoint\": [\r\n {\r\n \"type\": \"EMAIL\",\r\n \"value\": \"james@gmail.com\"\r\n },\r\n {\r\n \"type\": \"PHONE\",\r\n \"value\": \"9898989898\"\r\n }\r\n ],\r\n \"primaryContact\": false,\r\n \"billingContact\": false\r\n }\r\n ],\r\n \"payInfo\": [\r\n {\r\n \"paymentMethod\": \"CC\",\r\n \"creditCardInfo\": {\r\n \"firstName\": \"John\",\r\n \"lastName\": \"Doe\",\r\n \"cardType\": \"visa\",\r\n \"cardNumber\": \"****************\",\r\n \"cardExpiryMonth\": \"10\",\r\n \"cardExpiryYear\": \"2022\",\r\n \"cvv\": \"XXX\"\r\n },\r\n \"profileAddress\": {\r\n \"addLine1\": \"AddressLine1\",\r\n \"addLine2\": \"AddressLine2\",\r\n \"city\": \"New York\",\r\n \"state\": \"NEW YORK\",\r\n \"zip\": \"10010\",\r\n \"country\": \"UNITED STATES\"\r\n },\r\n \"isDefault\": true\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/rest/SubscriberService/v1/lead","description":"Use this sample request to create a new lead with basic account, contact, address, and payment details.
\nReference APIs
\nUse one or more of the following APIs to fetch additional details that may be required as part of the sample request payload.
\nnone
\nData Parameters
\nCheck out the field descriptions for each data parameter in the link provided below. Data Parameters
\n","urlObject":{"path":["rest","SubscriberService","v1","lead"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"9ff1645c-1e90-47ce-93b9-8b59ddf75c55","name":"Lead With Account Details","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"BearerProvide the generated access token in this field.
\n","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"accountType\": \"1001\",\r\n \"primaryCurrencyId\": \"840\",\r\n \"address\": [\r\n {\r\n \"addLine1\": \"AddressLine1\",\r\n \"city\": \"New York\",\r\n \"state\": \"NEW YORK\",\r\n \"country\": \"UNITED STATES\",\r\n \"zip\": \"100110\",\r\n \"defaultShipping\": true,\r\n \"defaultBilling\": true\r\n }\r\n ],\r\n \"contact\": [\r\n {\r\n \"contactType\": 0,\r\n \"firstName\": \"James\",\r\n \"lastName\": \"Hancock\",\r\n \"communicationPoint\": [\r\n {\r\n \"type\": \"EMAIL\",\r\n \"value\": \"james@gmail.com\"\r\n },\r\n {\r\n \"type\": \"CPHONE\",\r\n \"value\": \"9777787777\"\r\n }\r\n ],\r\n \"primaryContact\": true,\r\n \"billingContact\": true\r\n }\r\n ],\r\n \"agentAccountNumber\": \"SR2202\",\r\n \"agentAssociations\": [\r\n {\r\n \"agentAccId\": \"1302\",\r\n \"channelSubTypeId\": 6\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/rest/SubscriberService/v1/lead","description":"Use this sample request to create a new lead with with an agent account associated with it.
\nReference APIs
\nUse one or more of the following APIs to fetch additional details that may be required as part of the sample request payload.
\nFetch Channel Partner List: Use this API to fetch the list of all the agents that are available in the system.
Data Parameters
\nCheck out the field descriptions for each data parameter in the link provided below.
Data Parameters
Provide the generated access token in this field.
\n","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"accountType\": \"1001\",\r\n \"primaryCurrencyId\": \"840\",\r\n \"address\": [\r\n {\r\n \"addLine1\": \"AddressLine1\",\r\n \"city\": \"New York\",\r\n \"state\": \"NEW YORK\",\r\n \"country\": \"UNITED STATES\",\r\n \"zip\": \"100110\",\r\n \"defaultShipping\": true,\r\n \"defaultBilling\": true,\r\n \"addressAttribute\": [\r\n {\r\n \"key\": \"Landmark\",\r\n \"value\": \"Near to Bus stand\"\r\n },\r\n {\r\n \"key\": \"Town Name\",\r\n \"value\": \"Adams\"\r\n }\r\n ]\r\n }\r\n ],\r\n \"contact\": [\r\n {\r\n \"contactType\": 0,\r\n \"firstName\": \"James\",\r\n \"lastName\": \"Hancock\",\r\n \"communicationPoint\": [\r\n {\r\n \"type\": \"EMAIL\",\r\n \"value\": \"james@gmail.com\"\r\n },\r\n {\r\n \"type\": \"CPHONE\",\r\n \"value\": \"9777787777\"\r\n }\r\n ],\r\n \"primaryContact\": true,\r\n \"billingContact\": true\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/rest/SubscriberService/v1/lead","description":"Use this sample request to create a new lead with additional account and address attributes.
\nReference APIs
\nUse one or more of the following APIs to fetch additional details that may be required as part of the sample request payload.
\nData Parameters
\nCheck out the field descriptions for each data parameter in the link provided below. Data Parameters
\n","urlObject":{"path":["rest","SubscriberService","v1","lead"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"ea2278a0-5988-4711-ae88-0b35b211e8f3","name":"Lead Account With Attributes","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"BearerThese following API is used to create a lead, various examples have been added to the create lead refer the below API for creation.
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"680cb811-c6a5-443c-a432-95b714cf25cc"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"d8615288-78cd-48cd-97fb-f227216c2197"}}],"_postman_id":"6b77dafc-8152-4bbe-b79a-a1a9d27f6b24"},{"name":"Update Lead","item":[{"name":"Update Address","id":"a46e1f7b-dfc7-4bdd-9fda-63a797d3737d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"PUT","header":[{"key":"Authorization","value":"bearer {{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"accountName\": \"John H\",\r\n \"accountNumber\": \"SR001\",\r\n \"contact\": [\r\n {\r\n \"firstName\": \"John\",\r\n \"lastName\": \"Hayden\",\r\n \"primaryContact\": true,\r\n \"billingContact\": true,\r\n \"communicationPoint\": [\r\n {\r\n \"type\": \"EMAIL\",\r\n \"value\": \"johnhayden27@yopmail.com\"\r\n }\r\n ]\r\n }\r\n ],\r\n \"address\": [\r\n {\r\n \"addLine1\": \"196 Pathway Ln\",\r\n \"city\": \"West Lafayette\",\r\n \"state\": \"IN\",\r\n \"country\": \"UNITED STATES\",\r\n \"zip\": \"47906\",\r\n \"defaultShipping\": true,\r\n \"defaultBilling\": true\r\n }\r\n ],\r\n \"billingDayOfMonth\": \"1\"\r\n}"},"url":"{{Host}}/rest/SubscriberService/v1/leads/SR001","description":"This API will be used to update lead information like address. Either you can add a new order or you can modify the existing order.
\nData Parameters
\nCheck out the field descriptions for each data parameter in the link provided below. Data Parameters
\n","urlObject":{"path":["rest","SubscriberService","v1","leads","SR001"],"host":["{{Host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"a46e1f7b-dfc7-4bdd-9fda-63a797d3737d"}],"id":"0cffcde1-da6f-47e7-9060-0ee4a8b1fcd9","description":"This section we will discuss about updating/ modifying the lead information.
\n","_postman_id":"0cffcde1-da6f-47e7-9060-0ee4a8b1fcd9","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"f81f03f7-f879-450f-802e-bce891052b92","id":"f81f03f7-f879-450f-802e-bce891052b92","name":"Leads","type":"folder"}}},{"name":"Search Lead","item":[{"name":"Get Lead","id":"a772499c-c7a5-4c2f-af40-e31d1b4bbe5f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{Host}}/rest/SubscriberService/v1/leads/SR001","description":"This API is used to fetch the lead details. Using URL paramater as account number you can search for the specific lead account.
\n","urlObject":{"path":["rest","SubscriberService","v1","leads","SR001"],"host":["{{Host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"a772499c-c7a5-4c2f-af40-e31d1b4bbe5f"}],"id":"e54e618f-26c9-479c-b071-cbda03abe9a1","description":"These API is used to fetch or search a leads information. Below are some of the example with different URL parameter.
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"e7f2d0a9-61df-44be-b0a0-80dc60a1e657"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"b1061bf5-e09b-4694-a4aa-ddd8dd36e8b6"}}],"_postman_id":"e54e618f-26c9-479c-b071-cbda03abe9a1"}],"id":"f81f03f7-f879-450f-802e-bce891052b92","description":"This API is used to create a new lead by providing account information like the type of lead, address details, contact details, and payment information.
\nA lead account can later be converted into a subscriber/customer account in the system.
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"7557fd48-c48d-46d2-a819-cdc86c6ae91c"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"b95f0a88-f7ed-4656-a0ec-e09133665411"}}],"_postman_id":"f81f03f7-f879-450f-802e-bce891052b92"},{"name":"Pricing","item":[{"name":"Create Resell Template","item":[{"name":"Create Resell Template","id":"f7def0ca-8332-4573-afb5-6728e9e173a5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"POST","header":[{"description":"Generate and pass the access token here.
This API is used to create resell template. This request shows the complete JSON request of the Create Resell Template REST API.
\nData Parameters
\nYou can see the details of each data parameter below.
\n","urlObject":{"path":["rest","ProductService","v1","products","resellTemplate"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"f7def0ca-8332-4573-afb5-6728e9e173a5"},{"name":"Create Resell Template - Success","id":"07e631b1-4e52-422f-9d7f-e0c1d8031517","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"BearerThis API is used to create a resell template which contains one single product.
\nData Parameters
\nYou can see the details of each data parameter below.
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"a4e7cd27-f8e2-4d17-aa5c-4cfe1907df14","id":"a4e7cd27-f8e2-4d17-aa5c-4cfe1907df14","name":"Create Resell Template","type":"folder"}},"urlObject":{"path":["rest","ProductService","v1","products","resellTemplate"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"35f93c76-9349-416d-9d06-3c7fd82c6669","name":"Create Resell Template - Success","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"BearerUsers cannot create duplicate resell templates when the template name already exists in the system.
\nData Parameters
\nYou can see the details of each data parameter below.
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"a4e7cd27-f8e2-4d17-aa5c-4cfe1907df14","id":"a4e7cd27-f8e2-4d17-aa5c-4cfe1907df14","name":"Create Resell Template","type":"folder"}},"urlObject":{"path":["rest","ProductService","v1","products","resellTemplate"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"7a76b008-0ce2-4e67-b392-fef461efeaa9","name":"Create Resell Template - Failure","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"BearerThis API is used to create a resell template in the system.
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"8fbb0b6c-4f50-40cd-af0b-4c12268b350b"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"30a1e28d-f498-4454-bdab-973f15fd010f"}}],"_postman_id":"a4e7cd27-f8e2-4d17-aa5c-4cfe1907df14"},{"name":"Update Resell Template","item":[{"name":"Update Resell Template","id":"c057518c-8186-43bc-999c-5ea4db3cb811","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"PUT","header":[{"description":"Pass the generated access token here.
\n","key":"Authorization","type":"text","value":"BearerThis request shows the complete JSON request of the Update Resell Template REST API.
\nData Parameters
\nYou can see the details of each data parameter below.
\n","urlObject":{"path":["rest","ProductService","v1","products","resellTemplate"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"c057518c-8186-43bc-999c-5ea4db3cb811"},{"name":"Update Resell Template - Success","id":"f1bdc38b-f4c9-487a-bf77-da8875d46339","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"PUT","header":[{"key":"Authorization","type":"text","value":"BearerUpdate an existing resell template in the system by adding a new product. Provide the new product's product id.
\nData Parameters
\nYou can see the details of each data parameter below.
\n","urlObject":{"path":["rest","ProductService","v1","products","resellTemplate"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"151f37e7-8946-4a19-99c3-f831ef614e9b","name":"Update Resell Template with one product - Success","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"BearerUsers cannot add the product ids of products which have already expired.
\nData Parameters
\nYou can see the details of each data parameter below.
\n","urlObject":{"path":["rest","ProductService","v1","products","resellTemplate"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"9c323912-54f2-4499-9670-aa3b4413dd81","name":"Update Resell Template with one new product - Failure","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"BearerThis API is used to update an existing resell template in the system. You can add or remove products/bundles as part of the update operation.
\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"8cf06599-a24f-4054-8093-4267d5d712c7"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"f08369f7-c867-497d-8f6c-7852f87c9ea7"}}],"_postman_id":"b69956fa-ae40-4f83-ae80-98a451066d5a","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"9b279f5e-88ae-4cbf-8023-852d6fafef33","id":"9b279f5e-88ae-4cbf-8023-852d6fafef33","name":"Pricing","type":"folder"}}},{"name":"Get Resell Templates","item":[{"name":"Get Resell Templates","id":"026bc173-36c3-43c3-896f-c61a23128c65","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"GET","header":[{"key":"Authorization","type":"text","value":"BearerThis request shows the complete JSON response of the Fetch Resell Template REST API.
\nYou can see the details of each data parameter in the URL below. Data Parameters
\n","urlObject":{"path":["rest","ProductService","v1","products","resellTemplate","Fetch an existing resell template present in the system.
\n","urlObject":{"path":["rest","ProductService","v1","products","resellTemplate","Users cannot fetch a resell template if the resel template does not exist in the system.
\n","urlObject":{"path":["rest","ProductService","v1","products","resellTemplate","This API is used to fetch an existing resell template present in the system. The products/bundles within the resell template will be listed as part of the response.
\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"86c85ad1-1961-48ee-8f57-6f715166c286"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"da770978-458b-4fa8-aaa6-07e6acaf8e8e"}}],"_postman_id":"ff479105-6d51-49d9-9bdf-0dfaff7ffccb","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"9b279f5e-88ae-4cbf-8023-852d6fafef33","id":"9b279f5e-88ae-4cbf-8023-852d6fafef33","name":"Pricing","type":"folder"}}},{"name":"Resell a Template","item":[{"name":"Resell a Template","id":"8928e379-4778-4efe-b3e9-79c67286b1af","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"POST","header":[{"key":"Authorization","type":"text","value":"BearerThis request shows the complete JSON response of the Fetch Resell Template REST API.
\nData Parameters
\nYou can see the details of each data parameter below.
\n","urlObject":{"path":["rest","ProductService","v1","resell"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"8928e379-4778-4efe-b3e9-79c67286b1af"},{"name":"Resell a Template - Success","id":"395d4018-82ac-483b-b0aa-04a548d10e06","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"POST","header":[{"key":"Authorization","type":"text","value":"BearerResell an existing resell template in the system. Users must pass the channel partners account number as part of the request JSON body.
\nData Parameters
\nYou can see the details of each data parameter below.
\n","urlObject":{"path":["rest","ProductService","v1","resell"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"cd1bd978-daea-42b5-b348-6233304fad8a","name":"Resell a Template - Success","originalRequest":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"BearerTemplates cannot be resold to channel partners that do not exist in the system.
\nData Parameters
\nYou can see the details of each data parameter below.
\n","urlObject":{"path":["rest","ProductService","v1","resell"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"6af21f15-4d3e-41b5-a231-99a49f7801ef","name":"Resell a Template - Failure","originalRequest":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"BearerThis API is used to resell an existing resell template in the system. The products/bundles within the resell template can be resold to the next immediate level of channel partners.
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"eeba9bcb-c1ee-4763-a83b-c338aac146fa"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"ec2042d7-da2c-44b6-bdcc-521240b3cc20"}}],"_postman_id":"7fc89132-a5fd-4c83-b4c2-0d42651e4df0"}],"id":"9b279f5e-88ae-4cbf-8023-852d6fafef33","description":"This section deals with the various APIs required to manage Pricing and Product information in the application.
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"13362d5a-34fe-42ca-96b4-f308126f88fd"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"e6b429fc-f08d-4532-9a16-b95d819829a7"}}],"_postman_id":"9b279f5e-88ae-4cbf-8023-852d6fafef33"},{"name":"Customer Management","item":[{"name":"Create a Subscriber","item":[{"name":"Create Subscriber - Parameter Info","id":"29fdcf7e-327f-40be-8e65-a779b4190917","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"BearerProvide the generated access token in this field.
\n","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"accountName\": \"?\",\n \"accountNumber\": \"?\",\n \"externalId\": \"?\",\n \"accountType\": \"?\",\n \"primaryCurrencyId\": \"?\",\n \"contact\": [\n {\n \"salutation\": \"?\",\n \"firstName\": \"?\",\n \"middleName\": \"?\",\n \"lastName\": \"?\",\n \"primaryContact\": \"?\",\n \"billingContact\": \"?\",\n \"locale\": \"?\",\n \"designation\": \"?\",\n \"communicationPoint\": [\n {\n \"type\": \"?\",\n \"value\": \"?\"\n }\n ],\n \"userDetail\": {\n \"username\": \"?\",\n \"password\": \"?\"\n }\n }\n ],\n \"address\": [\n {\n \"addLine1\": \"?\",\n \"addLine2\": \"?\",\n \"city\": \"?\",\n \"state\": \"?\",\n \"county\": \"?\",\n \"country\": \"?\",\n \"zip\": \"?\",\n \"zipCodeExtension\": \"?\",\n \"defaultShipping\": \"?\",\n \"defaultBilling\": \"?\",\n \"addressAttribute\": [\n {\n \"key\": \"?\",\n \"value\": \"?\"\n }\n ]\n }\n ],\n \"accountAttribute\": [\n {\n \"key\": \"?\",\n \"value\": \"?\"\n }\n ],\n \"payInfo\": [\n {\n \"paymentMethod\": \"?\",\n \"isDefault\": \"?\",\n \"creditCardInfo\": {\n \"firstName\": \"?\",\n \"lastName\": \"?\",\n \"cardType\": \"?\",\n \"cardNumber\": \"?\",\n \"cardExpiryMonth\": \"?\",\n \"cardExpiryYear\": \"?\",\n \"cvv\": \"?\"\n },\n \"echeckInfo\": {\n \"accountHolderName\": \"?\",\n \"bankAccountNumber\": \"?\",\n \"bankAccountType\": \"?\",\n \"bankName\": \"?\",\n \"routingNumber\": \"?\"\n },\n \"paymentKeyInfo\": {\n \"key\": \"?\",\n \"keyReferencePaymentMethod\": \"?\"\n },\n \"profileAddress\": {\n \"address1\": \"?\",\n \"address2\": \"?\",\n \"city\": \"?\",\n \"county\": \"?\",\n \"state\": \"?\",\n \"zipCode\": \"?\",\n \"country\": \"?\"\n }\n }\n ],\n \"billingDayOfMonth\": \"?\",\n \"spendLimit\": \"?\",\n \"secondaryCurrencyId\": \"?\",\n \"taxExemptionCode\": {\n \"code\": [\n {\n \"code\": \"?\",\n \"description\": \"?\"\n }\n ],\n \"internalItemCode\": [\n {\n \"code\": \"?\",\n \"description\": \"?\"\n }\n ]\n },\n \"parentAccNumber\": \"?\",\n \"payingEntity\": \"?\",\n \"activationStartDate\": \"?\",\n \"creditLimit\": \"?\",\n \"paymentDueInterval\": \"?\",\n \"agentAccountNumber\": \"?\",\n \"agentAssociations\": [\n {\n \"agentAccId\": \"?\",\n \"channelSubTypeId\": \"?\"\n }\n ],\n \"invoiceFormat\": \"?\",\n \"invoiceDeliveryPreference\": \"?\",\n \"invoiceTemplateName\": \"?\",\n \"billingDelay\": \"?\",\n \"billingSuppressionThreshold\": \"?\",\n \"exemptLateFee\": \"?\",\n \"carryForwardBalance\": \"?\"\n}"},"url":"{{host}}/rest/SubscriberService/v1/subscriber","description":"This is the complete JSON request for the Create Subscriber REST API.
\nIt also contains the complete JSON request that can be used to Update a Subscriber.
\nData Parameters
\nCheck out the field descriptions for each data parameter in the link provided below. Data Parameters.
\n","urlObject":{"path":["rest","SubscriberService","v1","subscriber"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"29fdcf7e-327f-40be-8e65-a779b4190917"},{"name":"Create Subscriber - Success","id":"091fcaf0-6520-42df-b002-fedc127f3aa6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"POST","header":[{"key":"Authorization","type":"text","value":"BearerCreate a subscriber account by providing minimum data.
\nData Parameters
\nCheck out the field descriptions for each data parameter in the link provided below. Data Parameters
\n","urlObject":{"path":["rest","SubscriberService","v1","subscriber"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"88887062-7153-45af-897f-1cda035203b5","name":"Create Subscriber - Success","originalRequest":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"BearerSubscriber account creation fails if necessary data is not provided.
\nData Parameters
\nCheck out the field descriptions for each data parameter in the link provided below. Data Parameters
\n","urlObject":{"path":["rest","SubscriberService","v1","subscriber"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"766e1f6a-a317-4190-bbe5-17056ffdd422","name":"Create Subscriber - Failure","originalRequest":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"BearerThis API is used to create new subscribers by providing account information like basic subscriber type details, address details, contact details, and payment information.
\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"dfa67f92-59d7-4c94-baa0-809ba3c020d7"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"4ebe97b1-cacb-412f-8996-f53b8c56712b"}}],"_postman_id":"652dbd82-c6da-496b-acce-5623ea5d274b"},{"name":"Fetch Subscriber Details","item":[{"name":"Fetch Subscriber Details - Parameter Info","id":"1748457d-504c-4095-bc82-1979c8cab57c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"GET","header":[{"description":"Provide the generated access token in this field.
\n","key":"Authorization","type":"text","value":"Bearer {{token}}"},{"key":"Content-Type","type":"text","value":"application/json"}],"url":"{{Host}}/rest/SubscriberService/v1/subscribers/{accountNumber}","description":"This section lists and explains the various URL and data parameters which are present in this API.
\n\n\n
URL Parameters
\nMandatory
\n- \n
- accountNumber [string]: Enter the account number of the subscriber account. The API will return the details of this subscriber account. For example, SR1707 \n
","urlObject":{"path":["rest","SubscriberService","v1","subscribers","{accountNumber}"],"host":["{{Host}}"],"query":[],"variable":[]}},"response":[{"id":"b19bb7db-bebf-43c6-81b2-aea4523401ce","name":"Fetch Subscriber Details - Parameter Info","originalRequest":{"method":"GET","header":[{"description":"Provide the generated access token in this field.","key":"Authorization","type":"text","value":"Bearer {{token}}"},{"key":"Content-Type","type":"text","value":"application/json"}],"url":"{{Host}}/rest/SubscriberService/v1/subscribers/{accountNumber}"},"status":"OK","code":200,"_postman_previewlanguage":"JSON","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Fri, 22 Apr 2022 10:10:18 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"2144"},{"key":"Connection","value":"keep-alive"},{"key":"Set-Cookie","value":"JSESSIONID=459B592A6DC296E9804ED02C3D462207.worker4; Path=/; Secure; HttpOnly"},{"key":"Access-Control-Allow-Headers","value":"*, Content-Type, Pragma, Origin, Authorization, party, X-XSRF-TOKEN, X-Requested-With,Access-Control-Allow-Headers,Accept,Access-Control-Allow-Credentials,X-Auth-Token, version, cache"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST,OPTIONS,PUT,DELETE,GET"}],"cookie":[],"responseTime":null,"body":"{\"accountName\":\"VoIP\",\"accountNumber\":\"OBD-SR13203\",\"id\":\"13003\",\"createdDate\":\"2022-04-22T03:00:50-07:00\",\"accountStatus\":\"Active\",\"accountType\":\"1002\",\"primaryCurrencyId\":\"840\",\"secondaryCurrencyId\":\"0\",\"currencySymbol\":\"$\",\"address\":[{\"id\":\"13506\",\"addLine1\":\"Lane 4\",\"addLine2\":\"near church\",\"city\":\"Charlotte\",\"state\":\"NC\",\"country\":\"UNITED STATES\",\"zip\":\"28269\",\"defaultShipping\":true,\"defaultBilling\":true,\"addressAttribute\":[{\"key\":\"Address Type\",\"sequence\":0},{\"key\":\"Flat Number\",\"sequence\":0},{\"key\":\"iconectiv_nsc\",\"sequence\":0},{\"key\":\"Landmark_2\",\"sequence\":0},{\"key\":\"Locality\",\"sequence\":0},{\"key\":\"cancellation date\",\"sequence\":0},{\"key\":\"Landmark\",\"sequence\":0},{\"key\":\"PCODE\",\"sequence\":0},{\"key\":\"Nationality\",\"sequence\":0}]}],\"contact\":[{\"id\":\"13706\",\"contactType\":0,\"firstName\":\"John\",\"lastName\":\"Doe\",\"communicationPoint\":[{\"type\":\"PHONE\",\"value\":\"8787899878\"},{\"type\":\"EMAIL\",\"value\":\"john8989@yopmail.com\"}],\"userDetail\":{\"id\":\"13205\",\"username\":\"John8989@yopmail.com\",\"password\":\"32a2a40393952a9efb20a496617bfbfeb60f75768dc419f718d1864783ef6e8d\",\"userRoleName\":\"ROLE_SUBSCRIBER\"},\"primaryContact\":true,\"billingContact\":true,\"locale\":\"en_US\",\"registered\":true}],\"billInfo\":[{\"billinfoId\":\"13003\",\"billingFrequency\":1,\"billingDayOfMonth\":1,\"status\":\"Active\"}],\"invoiceInfo\":[{\"invoiceProfileId\":\"13003\"}],\"accountAttribute\":[{\"id\":\"13505\",\"key\":\"Fathers Name\",\"value\":\"-\",\"Sequence\":0},{\"key\":\"VAT No\",\"Sequence\":0},{\"key\":\"DoB\",\"Sequence\":0},{\"key\":\"origin\",\"Sequence\":0},{\"key\":\"Aadhar No\",\"Sequence\":0},{\"key\":\"Pan No\",\"Sequence\":0},{\"key\":\"Middle Name\",\"Sequence\":0},{\"key\":\"Order Date\",\"Sequence\":0},{\"key\":\"Pan Number\",\"Sequence\":0},{\"key\":\"Fax number\",\"Sequence\":0},{\"key\":\"DateOBirth\",\"Sequence\":0},{\"key\":\"SSN\",\"Sequence\":0}],\"subscriberId\":\"13305\",\"payingEntity\":0,\"activationStartDate\":\"2022-04-22T00:00:00-07:00\",\"invoiceFormat\":2,\"billingCycleDuration\":\"1\",\"exemptLateFee\":false,\"accountBalance\":{\"billedAmount\":0.000,\"unBilledAmount\":0.000,\"totalAmount\":0.000},\"isHierarchyPresent\":false,\"accountingDisplayName\":\"VoIP\",\"createBGPerOrder\":false,\"invoiceDeliveryPreference\":\"0\",\"isAgent\":false,\"status\":\"OK\"}"}],"_postman_id":"1748457d-504c-4095-bc82-1979c8cab57c"},{"name":"Fetch Subscriber Details - Example 1","id":"f705cbef-084b-482f-9765-87a03ad64f1a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"GET","header":[{"key":"Authorization","type":"text","value":"Bearer
This API is used to fetch the details of a subscriber account with the account number SR2604.
\n","urlObject":{"path":["rest","SubscriberService","v1","subscribers","SR2604"],"query":[],"variable":[]}},"response":[{"id":"3555db6c-4c8a-41f4-afd5-e9384bd24b6d","name":"Fetch Subscriber Details","originalRequest":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"BearerFetch the details of a subscriber account with account number SR22794. This example shows a failure scenario. It shows the output/response when there isn't any matching subscriber data in the system.
\n","urlObject":{"path":["rest","SubscriberService","v1","subscribers","SR22794"],"query":[],"variable":[]}},"response":[{"id":"914973ee-c3d0-426d-9542-576d338cd247","name":"Fetch Subscriber Details - Failure","originalRequest":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"Bearer
This API is used to fetch the details of pending bills(Unfinalized transactions) for the subscriber with charge breakup.
\n","urlObject":{"path":["rest","SubscriberService","v1","subscribers","{accountNumber}","pendingbill"],"host":["{{Host}}"],"query":[],"variable":[]}},"response":[{"id":"379a15a9-4d1a-4eb3-a0a2-d9d491c10b6e","name":"Fetch Pending Bills","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"}],"url":"{{Host}}/rest/SubscriberService/v1/subscribers/{accountNumber}/pendingbill"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Mon, 12 Feb 2024 04:26:21 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"561"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"*, Content-Type, Pragma, Origin, Authorization, party, X-XSRF-TOKEN, X-Requested-With,Access-Control-Allow-Headers,Accept,Access-Control-Allow-Credentials,X-Auth-Token, version, cache"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST,OPTIONS,PUT,DELETE,GET"}],"cookie":[],"responseTime":null,"body":"{\n \"billId\": \"1720672327542301336\",\n \"billNumber\": \"BI59008\",\n \"accountId\": \"15702\",\n \"chargeAmount\": 2562,\n \"adjustmentAmount\": 0,\n \"receivedAmount\": 0,\n \"startDate\": \"2024-01-01T00:00:00-08:00\",\n \"endDate\": \"2024-02-01T00:00:00-08:00\",\n \"recurringChargeAmount\": 2221.07,\n \"onetimeChargeAmount\": 0,\n \"usageChargeAmount\": 0,\n \"cancellationChargeAmount\": 0,\n \"suspensionChargeAmount\": 0,\n \"taxAmount\": 340.93,\n \"lateFee\": 0,\n \"discountAmount\": 0,\n \"creditAmount\": 0,\n \"adjustmentsAmount\": 0,\n \"carryForwardBalance\": 0,\n \"writeOff\": 0,\n \"payments\": 0,\n \"paymentFee\": 0,\n \"status\": \"OK\"\n}\n"}],"_postman_id":"8e380186-6d68-4110-86f7-9022e88750b7"}],"id":"27da57a0-91c1-40ea-b5e3-6cf335a38c0f","description":"In this section we will discuss about the retrieving of subscribers details. Various example is added to support use case scenario.
\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"7aa1e1d2-86ab-4bde-8375-193de2c27764"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"49e48bd5-a2ac-4042-8467-ae09ee641454"}}],"_postman_id":"27da57a0-91c1-40ea-b5e3-6cf335a38c0f"},{"name":"Update a Subcriber","item":[{"name":"Update a Subscriber - Parameter Info","id":"7d2df68c-1ef2-4703-89a6-6b282b98b609","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"PUT","header":[{"description":"Provide the generated access token in this field.
\n","key":"Authorization","type":"text","value":"BearerThis section lists and explains the various URL and data parameters which are present in this API.
\nIt also contains the complete JSON request that can be used to Update a Subscriber.
\nURL Parameters
\nMandatory
\nData Parameters
\nCheck out the field descriptions for each data parameter in the link provided below. Data Parameters
\n","urlObject":{"path":["rest","SubscriberService","v1","subscribers","{accountNumber}"],"query":[],"variable":[]}},"response":[],"_postman_id":"7d2df68c-1ef2-4703-89a6-6b282b98b609"},{"name":"Update a Subscriber - Example 1","id":"bd225588-be2c-407f-bd38-0d7fd2252e46","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"PUT","header":[{"key":"Authorization","type":"text","value":"BearerThis API is used to update the subscriber account SR2604 with a new contact and with a new address.
\nData Parameters
\nCheck out the field descriptions for each data parameter in the link provided below. Data Parameters
\n","urlObject":{"path":["rest","SubscriberService","v1","subscribers","SR2604"],"query":[],"variable":[]}},"response":[{"id":"fb3a4081-1173-4293-adff-98905c45dbb2","name":"Update a Subscriber - Example 1","originalRequest":{"method":"PUT","header":[{"key":"Authorization","type":"text","value":"BearerThis API is used to update the subscriber account SR24604 with a new contact and with a new address. This example shows a failure scenario. It shows the output/response when there isn't any matching subscriber data in the system.
\nData Parameters
\nCheck out the field descriptions for each data parameter in the link provided below. Data Parameters
\n","urlObject":{"path":["rest","SubscriberService","v1","subscribers","SR24604"],"query":[],"variable":[]}},"response":[{"id":"ddb105ed-27e8-4d71-86f4-157aaf12b6c0","name":"Update a Subscriber - Example 2","originalRequest":{"method":"PUT","header":[{"key":"Authorization","type":"text","value":"BearerThis API is used to update an existing subscriber's information like the subscribers address details, contact details, payment details or subscribers account attributes.
\nData Parameters
\nCheck out the field descriptions for each data parameter in the link provided below. Data Parameters
\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"194be38f-2da2-4bcf-810c-fa765b6dc349"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"18d86514-e8f3-4448-8b07-2b7e13accb82"}}],"_postman_id":"a63b1776-02bd-4716-863d-9ab92c5a2fe0"}],"id":"d420d997-5a0f-4418-bd3f-aa9408d23555","description":"This section deals with the various APIs required to manage customer/subscriber information in the BSS application. A subscriber in the application is the end customer to a business. With the help of our subscriber APIs, users can create, manage, or fetch subscriber related information with ease.
\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"8f43d8e9-53e7-4449-b527-ff5afca0f9d4"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"2351a72d-94a9-4169-9d39-e2fece90f8fe"}}],"_postman_id":"d420d997-5a0f-4418-bd3f-aa9408d23555"},{"name":"Partner Management","item":[{"name":"Create a Partner","item":[{"name":"Create a partner with attributes (address)","id":"9988e81f-265e-498a-9081-cb70a98799c2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"POST","header":[{"description":"Provide the generated access token here.
\n","key":"Authorization","type":"text","value":"BearerThis API is used to create a new partner account with an Address level attribute.
- \n
To create Partner, agents, and vendors using the following partyroletype:
\n- \n
- Values:
1003 - Partner
1005 - Agent
1006- Vendors \n
\n- Values:
Prerequisites:
\n- \n
Gather the
\nAttribute Namefrom the application. \nGather the
\nAttribute Valuefrom the application. \n
Data Parameters
\nCheck out the field descriptions for each data parameter in the link provided below. Data Parameters
\n","urlObject":{"path":["rest","PartnerService","v1","partners"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"c35dbb39-3851-4073-ba46-9a29a2b13e79","name":"Create a partner with attributes","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"BearerProvide the generated access token here.
\n","key":"Authorization","type":"text","value":"BearerThis API is used to create a new partner account with a Payment Due Interval of 15 days.
- \n
To create Partner, agents, and vendors using the following partyroletype:
\n- \n
- Values:
1003 - Partner
1005 - Agent
1006- Vendors \n
\n- Values:
\n\nNOTE: Ensure that the Multi Level Channel Management functionality has been enabled in your system to use this request.
\n
Data Parameters
\nCheck out the field descriptions for each data parameter in the link provided below. Data Parameters
\n","urlObject":{"path":["rest","PartnerService","v1","partners"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"4fed9120-b69e-47c3-81e5-fcb02888b22c","name":"Create a partner with a payment due interval","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"BearerProvide the generated access token here.
\n","key":"Authorization","type":"text","value":"BearerThis API is used to create a channel partner account and copy the selfcare settings from the parent account.
\n- \n
To create Partner, agents, and vendors using the following partyroletype:
\n- \n
- Values:
1003 - Partner
1005 - Agent
1006- Vendors \n
\n- Values:
Data Parameters
\nCheck out the field descriptions for each data parameter in the link provided below. Data Parameters
\n","urlObject":{"path":["rest","PartnerService","v1","partners"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"aa25a1ad-7219-4ff2-bda6-596395269cff","name":"Create a partner by copying selfcare settings","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"BearerProvide the generated access token here.
\n","key":"Authorization","type":"text","value":"BearerThis API is used to create a channel partner account and copy the SMTP settings from the parent account.
\n- \n
To create Partner, agents, and vendors using the following partyroletype:
\n- \n
- Values:
1003 - Partner
1005 - Agent
1006- Vendors \n
\n- Values:
Data Parameters
\nCheck out the field descriptions for each data parameter in the link provided below. Data Parameters
\n","urlObject":{"path":["rest","PartnerService","v1","partners"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"55412f8a-a93f-4a56-9be7-711855f0055d","name":"Create a partner by copying the SMTP Settings","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"BearerProvide the generated access token here.
\n","key":"Authorization","type":"text","value":"BearerThis API is used to create a channel partner account and resell (push) products to the partner during the account creation process.
\n\n\nNOTE: Ensure that the Multi Level Channel Management functionality has been enabled in your system to use this request.
\n
- \n
To create Partner, agents, and vendors using the following partyroletype:
\n- \n
- Values:
1003 - Partner
1005 - Agent
1006- Vendors \n
\n- Values:
Data Parameters
\nCheck out the field descriptions for each data parameter in the link provided below. Data Parameters
\n","urlObject":{"path":["rest","PartnerService","v1","partners"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"d649e274-b151-4227-a4d1-50fb0c91a81c","name":"Create a partner and resell products","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"BearerProvide the generated access token here.
\n","key":"Authorization","type":"text","value":"BearerThis API is used to create a partner account and configure the Settlement Type as Pay when invoiced.
\n\nNOTE: Ensure that the Multi Level Channel Management functionality has been enabled in your system to use this request.
\n
- \n
To create Partner, agents, and vendors using the following partyroletype:
\n- \n
- Values:
1003 - Partner
1005 - Agent
1006- Vendors \n
\n- Values:
Data Parameters
\nCheck out the field descriptions for each data parameter in the link provided below. Data Parameters
\n","urlObject":{"path":["rest","PartnerService","v1","partners"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"5ec7311b-5a9f-485b-989c-4db9c708a1b3","name":"Create a partner with settlement type","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"BearerProvide the generated access token here.
\n","key":"Authorization","type":"text","value":"BearerCreate a new partner account whose Settlement Mode is set as Statement.
\n\nNOTE: Ensure that the Multi Level Channel Management functionality has been enabled in your system to use this request.
\n
- \n
To create Partner, agents, and vendors using the following partyroletype:
\n- \n
- Values:
1003 - Partner
1005 - Agent
1006- Vendors \n
\n- Values:
Data Parameters
\nCheck out the field descriptions for each data parameter in the link provided below. Data Parameters
\n","urlObject":{"path":["rest","PartnerService","v1","partners"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"00742bfa-8dd6-47ab-a807-26ae7b3ae380","name":"Create partner with a settlement mode","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"BearerThis API is used to create a new partner account in the system. Partner accounts of various types (reseller, distributor etc) can be created using this REST API. This API can also be used to create a new Agent in the system.
\n","_postman_id":"6f765280-dcfc-40d7-a8c5-fed4e0eb8b3c"},{"name":"Update a Partner","item":[{"name":"Update a Partner - Parameter Info","id":"f99891ec-0706-4182-ad6a-49e34eeeea0d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"PUT","header":[{"description":"Provide the generated access token here.
\n","key":"Authorization","type":"text","value":"BearerThis API is used to update an existing partner account which is present in the system.
\nData Parameters
\nCheck out the field descriptions for each data parameter in the link provided below. Data Parameters
\n","urlObject":{"path":["rest","PartnerService","v1","partners"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"f99891ec-0706-4182-ad6a-49e34eeeea0d"},{"name":"Update a partner's contact details","id":"a4a3c394-20df-48d7-ab4b-3d84baf97062","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"PUT","header":[{"description":"Provide the generated access token here.
\n","key":"Authorization","type":"text","value":"BearerThis API is used to update a channel partner account and change existing contact details of a contact.
\nPrerequisites:
\n- \n
- Run the
Fetch Partner DetailsREST API to fetch theidof the contact. \n
Data Parameters
\nCheck out the field descriptions for each data parameter in the link provided below. Data Parameters
\n","urlObject":{"path":["rest","PartnerService","v1","partners"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"bc08992f-cf93-42c3-b34d-1df42c38b222","name":"Update a partner's contact details","originalRequest":{"method":"PUT","header":[{"description":"Provide the generated access token here.","key":"Authorization","type":"text","value":"BearerProvide the generated access token here.
\n","key":"Authorization","type":"text","value":"BearerThis API is used to update a channel partner account's Partner Settlement Mode from Invoice to Statement.
\n\nNOTE: Ensure that the Multi Level Channel Management functionality has been enabled in your system to use this request.
\n
Data Parameters
\nCheck out the field descriptions for each data parameter in the link provided below. Data Parameters
\n","urlObject":{"path":["rest","PartnerService","v1","partners"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"d777a5e7-570b-46f1-a63a-7dd7cf1b9e36","name":"Update a partner's settlement mode","originalRequest":{"method":"PUT","header":[{"description":"Provide the generated access token here.","key":"Authorization","type":"text","value":"BearerThis section lists and explains the various URL and data parameters which are present in this API.
\n","_postman_id":"203db902-4ca2-4ff1-be96-49d577b7a91d"},{"name":"Fetch Partner Details","item":[{"name":"Fetch Partner Details - Parameter Info","id":"e1630997-3a93-42f7-8d22-610ea5d3a087","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"GET","header":[{"description":"Provide the generated access token here.
\n","key":"Authorization","type":"text","value":"BearerThis API is used to fetch partner's details using the parameter as partner's account number.
\nURL Parameters
\n","urlObject":{"path":["rest","PartnerService","v1","partners","{Account Number)"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"e1630997-3a93-42f7-8d22-610ea5d3a087"},{"name":"Fetch a Partner's Details (with MLCM)","id":"7aa4dd6b-57d5-4420-97f1-5f2c738bbdcc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"GET","header":[{"description":"Provide the generated access token here.
\n","key":"Authorization","type":"text","value":"BearerThis API is used to fetch the details of a channel partner account.
\n","urlObject":{"path":["rest","PartnerService","v1","partners","SR4006"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"0823c09a-d973-4c05-bd99-9400890f86df","name":"Fetch a Partner's Details (with MLCM)","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"BearerIn this section we will discuss about retrieve the account details like partner's and agent's details.
\n","_postman_id":"d29f523e-2f4d-42a0-94e7-ee929b76e1d6"},{"name":"Create a Channel Subtype","item":[{"name":"Create a Channel Subtype - Parameter Info","id":"f60832bd-4914-4cb6-8a54-a00455ec485c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"POST","header":[{"description":"Provide the generated access token here.
\n","key":"Authorization","type":"text","value":"BearerThis API is used to create new channel types within the system. Users can use these channel types and use them to group channel partners with the same channel type. For example, there can be a \"Gold\" type channel partners.
\nData Parameters
\nCheck out the field descriptions for each data parameter in the link provided below. Data Parameters
\n","urlObject":{"path":["rest","PartnerService","v1","channelSubType"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"f60832bd-4914-4cb6-8a54-a00455ec485c"},{"name":"Create a Channel Subtype","id":"525892ac-50a8-496e-887b-a9f3ecc52433","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"POST","header":[{"description":"Provide the generated access token here.
\n","key":"Authorization","type":"text","value":"BearerThis API is used to create a subtype for a channel partner acount called Value Add Partner
\n\nNOTE: Ensure that the Multi Level Channel Management functionality has been enabled in your system to use this request.
\n
Data Parameters
\nCheck out the field descriptions for each data parameter in the link provided below. Data Parameters
\n","urlObject":{"path":["rest","PartnerService","v1","channelSubType"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"5666f6ad-78fe-4251-83ad-2f2a8b3172ec","name":"Create a Channel Subtype","originalRequest":{"method":"POST","header":[{"description":"Provide the generated access token here.","key":"Authorization","type":"text","value":"BearerThis section lists and explains the various URL and data parameters which are present in this API.
\n","_postman_id":"48d7c86f-432d-46bf-86c8-448a71127814"},{"name":"Fetch a Channel Subtype","item":[{"name":"Fetch a Channel Subtype - Parameter Info","id":"957eb64c-f00e-4cd2-89f4-94d928370d04","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"GET","header":[{"description":"Provide the generated access token here.
\n","key":"Authorization","type":"text","value":"BearerThis API is used to fetch the list of already created channel subtypes which are present in the system.
\nURL Parameters
\nData Parameters
\nCheck out the field descriptions for each data parameter in the link provided below. Data Parameter.
\n","urlObject":{"path":["rest","PartnerService","v1","channelSubTypes","{channelType}"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"957eb64c-f00e-4cd2-89f4-94d928370d04"},{"name":"Fetch Channel Subtypes (Partner)","id":"e7303d4d-c616-4c96-91c9-db1c00c1b9a3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"GET","header":[{"description":"Provide the generated access token here.
\n","key":"Authorization","type":"text","value":"BearerThis API is used to fetch all the existing channel subtypes present in the system, for the channel Partner.
The response will also return the details of the corresponding subtypes.
\n\n","urlObject":{"path":["rest","PartnerService","v1","channelSubTypes","1003"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"6f03047b-9a8d-4c67-aca0-1eea8e2b2b21","name":"Fetch Channel Subtypes (Partner)","originalRequest":{"method":"GET","header":[{"description":"Provide the generated access token here.","key":"Authorization","type":"text","value":"BearerNOTE: Ensure that the Multi Level Channel Management functionality has been enabled in your system to use this request.
\n
Provide the generated access token here.
\n","key":"Authorization","type":"text","value":"BearerThis API is used to fetch all the existing channel subtypes present in the system, for the channel Agent.
The response will also return the details of the corresponding subtypes.
\n\n","urlObject":{"path":["rest","PartnerService","v1","channelSubTypes","1005"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"1e5a0494-b330-4de7-8635-66e0aacc74af","name":"Fetch Channel Subtypes (Agent)","originalRequest":{"method":"GET","header":[{"description":"Provide the generated access token here.","key":"Authorization","type":"text","value":"BearerNOTE: Ensure that the Multi Level Channel Management functionality has been enabled in your system to use this request.
\n
This section lists and explains the various URL and data parameters which are present in this API.
\n","_postman_id":"97ad94bd-97ac-4a89-a07f-7cb6447806e8"},{"name":"Update a Channel Subtype","item":[{"name":"Update a Channel Subtype - Parameter Info","id":"60519b8c-c550-4b43-832b-e2ccfa3a9f0f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"PUT","header":[{"description":"Provide the generated access token here.
\n","key":"Authorization","type":"text","value":"BearerThis API is used to update an existing channel type which is already present in the system. Users can update information such as the name and the description of the type using this REST API.
\nData Parameters
\nCheck out the field descriptions for each data parameter in the link provided below. Data Parameter.
\n","urlObject":{"path":["rest","PartnerService","v1","channelSubType"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"60519b8c-c550-4b43-832b-e2ccfa3a9f0f"},{"name":"Update a Channel Subtype","id":"05e4e9f7-da3a-4f3c-ab7b-f512381fc21a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"PUT","header":[{"description":"Provide the generated access token here.
\n","key":"Authorization","type":"text","value":"BearerThis API is used to update the name of an existing Channel Subtype to Platinum Partners.
\n\nNOTE: Ensure that the Multi Level Channel Management functionality has been enabled in your system to use this request.
\n
Data Parameters
\nCheck out the field descriptions for each data parameter in the link provided below. Data Parameters.
\n","urlObject":{"path":["rest","PartnerService","v1","channelSubType"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"8bf1b38f-dbfd-4421-87db-cd3e9b7d03e2","name":"Update a Channel Subtype","originalRequest":{"method":"PUT","header":[{"description":"Provide the generated access token here.","key":"Authorization","type":"text","value":"BearerThis section lists and explains the various URL and data parameters which are present in this API.
\n","_postman_id":"33781c48-c365-4994-95aa-ace8ab98f49f"},{"name":"Delete a Channel Subtype","item":[{"name":"Delete a Channel Subtype - Parameter Info","id":"7acd0e32-3f0c-4e7b-a644-9d018c625444","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"DELETE","header":[{"description":"Provide the generated access token here.
\n","key":"Authorization","type":"text","value":"BearerThis section lists and explains the various URL and data parameters which are present in this API.
\nURL Parameters
\n","urlObject":{"path":["PartnerService","v1","channelSubType","{id}"],"host":["{{host}}rest"],"query":[],"variable":[]}},"response":[],"_postman_id":"7acd0e32-3f0c-4e7b-a644-9d018c625444"},{"name":"Delete a Channel Subtype","id":"9b351487-e701-4b07-8db5-e0d3ed2d0a6a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"DELETE","header":[{"description":"Provide the generated access token here.
\n","key":"Authorization","type":"text","value":"BearerThis API is used to delete an existing channel subtype from the system.
\n\n\n","urlObject":{"path":["rest","PartnerService","v1","channelSubType","124"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"c606c799-3705-4448-84f3-cf7331cad553","name":"Delete a Channel Subtype","originalRequest":{"method":"DELETE","header":[{"description":"Provide the generated access token here.","key":"Authorization","type":"text","value":"BearerNOTE: Ensure that the Multi Level Channel Management functionality has been enabled in your system to use this request.
\n
This API is used to delete a channel subtype from the system.
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"825655a3-a3c0-4223-9228-6e1b919d7a5c"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"0cd36fd5-5e6c-43f4-9901-3df494f2021d"}}],"_postman_id":"8cf192c1-29bd-450f-8315-90ec05a43316"},{"name":"Fetch All Partners (Partner Listing)","item":[{"name":"Fetch All Partners - Parameter Info","id":"40e39dc3-7ff9-4165-aebc-a8127475029a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"GET","header":[{"description":"Provide the generated access token here.
\n","key":"Authorization","type":"text","value":"BearerThis section lists and explains the various URL and data parameters which are present in this API.
\nURL Parameters
\nNOTE: The following is the URL when using search criteria.
\n/rest/PartnerService/v1/partners?channelType=1003&searchBy=accountNumber&searchString=SR2402&ascending=true&startCount=0&resultCount=2\n\nData Parameters
\nCheck out the field descriptions for each data parameter in the link provided below.
\n\n","urlObject":{"path":["rest","PartnerService","v1","partners"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"40e39dc3-7ff9-4165-aebc-a8127475029a"},{"name":"Fetch All Partners","id":"5541c020-2d00-4b87-908b-0b574f8a39e7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"GET","header":[{"description":"Provide the generated access token here.
\n","key":"Authorization","type":"text","value":"BearerThis API is used to fetch the list of all channel partners present in the system
\n\n\n","urlObject":{"path":["rest","PartnerService","v1","partners"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"bf91d210-bce3-444a-b9ad-3311e179f45f","name":"Fetch All Partners","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"BearerNOTE: Ensure that the Multi Level Channel Management functionality has been enabled in your system to use this request.
\n
Provide the generated access token here.
\n","key":"Authorization","type":"text","value":"BearerFetch the list of all agent accounts present in the system\n
\n
\n\n","urlObject":{"path":["rest","PartnerService","v1","partners"],"host":["{{host}}"],"query":[{"key":"channelType","value":"1005"},{"key":"ascending","value":"true"},{"key":"searchBy","value":"accountNumber"},{"key":"ascending","value":"true"},{"key":"startCount","value":"0"}],"variable":[]}},"response":[{"id":"7300edbf-3fa9-4dd4-a85d-75caba0bac17","name":"Fetch All Agents","originalRequest":{"method":"GET","header":[{"description":"Provide the generated access token here.","key":"Authorization","type":"text","value":"BearerNOTE: Ensure that the Multi Level Channel Management functionality has been enabled in your system to use this request.
\n
This API is used to search and list all partner accounts which are present in the system.
\nNOTE:
\n- \n
- This API supports proxy functionality as well. \n
- During proxy, this API returns the list of all agents which are present under the proxied partner account. \n
- During proxy, this API returns the list of all child partners, if Multi-Level Channel Management feature is enabled. \n
This API is used to create a settlement policy in the application.
\nData Parameter
\nIn this section information regarding the data parameters is provided. Data Parameters.
\n","urlObject":{"path":["rest","ProductService","v1","products","settlementpolicy"],"host":["{{Host}}"],"query":[],"variable":[]}},"response":[{"id":"1132f52c-ca8c-44ac-9e09-c935e204af3c","name":"Create a Settlement Policy","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"policyName\": \"Channel Settlement Contract\",\r\n \"description\": \"This settlement policy contains the settlement between the business and their Partner & Agents\",\r\n \"systemPolicy\": \"false\",\r\n \"settlementPolicyRuleArray\": [\r\n {\r\n \"channelType\": \"1003\",\r\n \"ruleId\": \"1\",\r\n \"value\": \"10\",\r\n \"valueType\": \"1\"\r\n },\r\n {\r\n \"channelType\": \"1003\",\r\n \"subChannelTypeId\": \"1\",\r\n \"ruleId\": \"1\",\r\n \"value\": \"12\",\r\n \"valueType\": \"1\"\r\n },\r\n {\r\n \"channelType\": \"1005\",\r\n \"ruleId\": \"6\",\r\n \"value\": \"5\",\r\n \"valueType\": \"2\"\r\n },\r\n {\r\n \"channelType\": \"1005\",\r\n \"subChannelTypeId\": \"6\",\r\n \"ruleId\": \"6\",\r\n \"value\": \"8\",\r\n \"valueType\": \"2\"\r\n }\r\n ]\r\n}"},"url":"{{Host}}/rest/ProductService/v1/products/settlementpolicy"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Thu, 06 Jul 2023 06:41:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"27"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"*, Content-Type, Pragma, Origin, Authorization, party, X-XSRF-TOKEN, X-Requested-With,Access-Control-Allow-Headers,Accept,Access-Control-Allow-Credentials,X-Auth-Token, version, cache"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST,OPTIONS,PUT,DELETE,GET"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"4902\",\n \"status\": \"OK\"\n}\n"}],"_postman_id":"0dcfdc7b-4335-45b6-a25e-661f693c2701"}],"id":"e20a9c97-7247-4d55-a130-48d5c1957b53","description":"In this section we will discuss about creation of a settlement policy. Various use case scenarios is added for better understanding.
\n","_postman_id":"e20a9c97-7247-4d55-a130-48d5c1957b53"},{"name":"Fetch Settlement Policy","item":[{"name":"Search a settlement policy using Id","id":"6333a476-3559-4bb6-b934-3ba60dabb9f9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{Host}}/rest/ProductService/v1/products/settlementpolicy/4902","description":"This API is used to retrieve the settlement policy using settelemt policy Id.
\n","urlObject":{"path":["rest","ProductService","v1","products","settlementpolicy","4902"],"host":["{{Host}}"],"query":[],"variable":[]}},"response":[{"id":"d51e567e-921c-45fd-a5a9-6806aceed1c3","name":"Search a settlement policy using Id","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{Host}}/rest/ProductService/v1/products/settlementpolicy/4902"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Thu, 06 Jul 2023 06:44:36 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"1949"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"*, Content-Type, Pragma, Origin, Authorization, party, X-XSRF-TOKEN, X-Requested-With,Access-Control-Allow-Headers,Accept,Access-Control-Allow-Credentials,X-Auth-Token, version, cache"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST,OPTIONS,PUT,DELETE,GET"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"4902\",\n \"policyName\": \"Channel Settlement Contract\",\n \"description\": \"This settlement policy contains the settlement between the business and their Partner & Agents\",\n \"isSystemPolicy\": false,\n \"settlementPolicyRuleArray\": [\n {\n \"id\": \"5804\",\n \"channelType\": 1005,\n \"ruleName\": \"Cost Markup\",\n \"ruleDescription\": \"This is Agent rule. This rule is used to define an agent commission based on the cost. Your business can use this rule to define a percentage on the cost of the product for the agent commission amount.\",\n \"ruleValue\": 5,\n \"ruleId\": \"6\",\n \"valueType\": 2,\n \"prorate\": true,\n \"applyRetailDiscount\": false,\n \"position\": \"A1\"\n },\n {\n \"id\": \"5802\",\n \"channelType\": 1003,\n \"ruleName\": \"Cost Markup\",\n \"ruleDescription\": \"This is Partner rule. This rule is used to define a settlement policy based on the cost. Your business can use this rule to define a markup amount as a percentage on the cost of the product for the settlement amount. It can also be a fixed markup amount on the cost as well.\",\n \"ruleValue\": 10,\n \"ruleId\": \"1\",\n \"valueType\": 1,\n \"prorate\": true,\n \"applyRetailDiscount\": false,\n \"position\": \"P1\"\n },\n {\n \"id\": \"5805\",\n \"channelType\": 1005,\n \"subChannelType\": \"6\",\n \"ruleName\": \"Cost Markup\",\n \"ruleDescription\": \"This is Agent rule. This rule is used to define an agent commission based on the cost. Your business can use this rule to define a percentage on the cost of the product for the agent commission amount.\",\n \"ruleValue\": 8,\n \"ruleId\": \"6\",\n \"valueType\": 2,\n \"prorate\": true,\n \"applyRetailDiscount\": false,\n \"position\": \"A2\"\n },\n {\n \"id\": \"5803\",\n \"channelType\": 1003,\n \"subChannelType\": \"1\",\n \"ruleName\": \"Cost Markup\",\n \"ruleDescription\": \"This is Partner rule. This rule is used to define a settlement policy based on the cost. Your business can use this rule to define a markup amount as a percentage on the cost of the product for the settlement amount. It can also be a fixed markup amount on the cost as well.\",\n \"ruleValue\": 12,\n \"ruleId\": \"1\",\n \"valueType\": 1,\n \"prorate\": true,\n \"applyRetailDiscount\": false,\n \"position\": \"P2\"\n }\n ],\n \"status\": \"OK\"\n}\n"}],"_postman_id":"6333a476-3559-4bb6-b934-3ba60dabb9f9"},{"name":"Search all the settlement policies","id":"796fbe6b-5da9-4e85-ad89-4308f609655a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"}],"url":"{{Host}}/rest/ProductService/v1/products/settlementpolicies","description":"This API is used to fetch all the settelemnt policy available in the application.
\n","urlObject":{"path":["rest","ProductService","v1","products","settlementpolicies"],"host":["{{Host}}"],"query":[],"variable":[]}},"response":[{"id":"8977c427-51b0-4311-b196-c93fd77ad9f6","name":"Search all the settlement policies","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer{{token}}"}],"url":"{{Host}}/rest/ProductService/v1/products/settlementpolicies"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Thu, 06 Jul 2023 06:48:25 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Set-Cookie","value":"JSESSIONID=18EC5FFE639DF9DED6785D94BB00062B.worker4; Path=/; Secure; HttpOnly"},{"key":"Access-Control-Allow-Headers","value":"*, Content-Type, Pragma, Origin, Authorization, party, X-XSRF-TOKEN, X-Requested-With,Access-Control-Allow-Headers,Accept,Access-Control-Allow-Credentials,X-Auth-Token, version, cache"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST,OPTIONS,PUT,DELETE,GET"}],"cookie":[],"responseTime":null,"body":"{\n \"settlementPolicyArray\": [\n {\n \"id\": \"2\",\n \"policyName\": \"Silver Channel Program\",\n \"description\": \"Silver Channel Program\",\n \"systemPolicy\": false,\n \"settlementPolicyRule\": [\n {\n \"id\": \"2\",\n \"channelType\": 1003,\n \"ruleName\": \"Wholesale Price\",\n \"ruleDescription\": \"This is Partner rule. This settlement rule can be used to define a fixed settlement amount for reselling a product. The Rule Value must be entered at a charge level. For example, the parent business can charge a fixed amount of US $50 for reselling a product to their channel partner.\",\n \"ruleId\": \"3\",\n \"valueType\": 1,\n \"prorate\": true,\n \"applyRetailDiscount\": false,\n \"position\": \"P1\"\n },\n {\n \"id\": \"3\",\n \"channelType\": 1003,\n \"subChannelType\": \"22\",\n \"ruleName\": \"Wholesale Price\",\n \"ruleDescription\": \"This is Partner rule. This settlement rule can be used to define a fixed settlement amount for reselling a product. The Rule Value must be entered at a charge level. For example, the parent business can charge a fixed amount of US $50 for reselling a product to their channel partner.\",\n \"ruleId\": \"3\",\n \"valueType\": 1,\n \"prorate\": true,\n \"applyRetailDiscount\": false,\n \"position\": \"P2\"\n },\n {\n \"id\": \"4\",\n \"channelType\": 1003,\n \"subChannelType\": \"3\",\n \"ruleName\": \"Wholesale Price\",\n \"ruleDescription\": \"This is Partner rule. This settlement rule can be used to define a fixed settlement amount for reselling a product. The Rule Value must be entered at a charge level. For example, the parent business can charge a fixed amount of US $50 for reselling a product to their channel partner.\",\n \"ruleId\": \"3\",\n \"valueType\": 1,\n \"prorate\": true,\n \"applyRetailDiscount\": false,\n \"position\": \"P3\"\n },\n {\n \"id\": \"4102\",\n \"channelType\": 1003,\n \"subChannelType\": \"1624\",\n \"ruleName\": \"Wholesale Price\",\n \"ruleDescription\": \"This is Partner rule. This settlement rule can be used to define a fixed settlement amount for reselling a product. The Rule Value must be entered at a charge level. For example, the parent business can charge a fixed amount of US $50 for reselling a product to their channel partner.\",\n \"ruleId\": \"3\",\n \"valueType\": 1,\n \"prorate\": true,\n \"applyRetailDiscount\": false,\n \"position\": \"P4\"\n },\n {\n \"id\": \"5602\",\n \"channelType\": 1003,\n \"subChannelType\": \"1129\",\n \"ruleName\": \"Retail Price\",\n \"ruleDescription\": \"This is Partner rule. This retail price settlement rule is based on the end retail price of a product. Use this rule and define a percentage on the end retail price of the product as the settlement amount. So for example, the parent account can define 70% of the end retail as their settlement policy.\",\n \"ruleValue\": 10,\n \"ruleId\": \"4\",\n \"valueType\": 2,\n \"prorate\": true,\n \"applyRetailDiscount\": false,\n \"position\": \"P5\"\n },\n {\n \"id\": \"5704\",\n \"channelType\": 1003,\n \"ruleName\": \"Wholesale Price\",\n \"ruleDescription\": \"This is Partner rule. This settlement rule can be used to define a fixed settlement amount for reselling a product. The Rule Value must be entered at a charge level. For example, the parent business can charge a fixed amount of US $50 for reselling a product to their channel partner.\",\n \"ruleValue\": 0,\n \"ruleId\": \"3\",\n \"valueType\": 1,\n \"prorate\": true,\n \"applyRetailDiscount\": false,\n \"position\": \"P6\"\n }\n ]\n },\n {\n \"id\": \"202\",\n \"policyName\": \"Channel Partner Policy\",\n \"description\": \"Channel Partner Policy\",\n \"systemPolicy\": false,\n \"settlementPolicyRule\": [\n {\n \"id\": \"202\",\n \"channelType\": 1003,\n \"ruleName\": \"Wholesale Price\",\n \"ruleDescription\": \"This is Partner rule. This settlement rule can be used to define a fixed settlement amount for reselling a product. The Rule Value must be entered at a charge level. For example, the parent business can charge a fixed amount of US $50 for reselling a product to their channel partner.\",\n \"ruleId\": \"3\",\n \"valueType\": 1,\n \"prorate\": true,\n \"applyRetailDiscount\": false,\n \"position\": \"P1\"\n }\n ]\n },\n {\n \"id\": \"205\",\n \"policyName\": \"Partner and Agent Policy\",\n \"description\": \"Partner and Agent Policy\",\n \"systemPolicy\": false,\n \"settlementPolicyRule\": [\n {\n \"id\": \"206\",\n \"channelType\": 1003,\n \"ruleName\": \"Wholesale Price\",\n \"ruleDescription\": \"This is Partner rule. This settlement rule can be used to define a fixed settlement amount for reselling a product. The Rule Value must be entered at a charge level. For example, the parent business can charge a fixed amount of US $50 for reselling a product to their channel partner.\",\n \"ruleId\": \"3\",\n \"valueType\": 1,\n \"prorate\": true,\n \"applyRetailDiscount\": false,\n \"position\": \"P1\"\n },\n {\n \"id\": \"205\",\n \"channelType\": 1005,\n \"ruleName\": \"Fixed Commission\",\n \"ruleDescription\": \"This is Agent rule. This commission rule can be used to define a fixed commission amount for agents on retailing a product. The Rule Value must be entered at a charge level. For example, the parent business can offer a fixed commission of US $50 to a sales agent for retailing a product via an end subscriber.\",\n \"ruleId\": \"7\",\n \"valueType\": 1,\n \"prorate\": true,\n \"applyRetailDiscount\": false,\n \"position\": \"A1\"\n }\n ]\n },\n {\n \"id\": \"503\",\n \"policyName\": \"SMS Policy\",\n \"description\": \"SMS Policy\",\n \"systemPolicy\": false,\n \"settlementPolicyRule\": [\n {\n \"id\": \"507\",\n \"channelType\": 1003,\n \"ruleName\": \"Retail Price\",\n \"ruleDescription\": \"This is Partner rule. This retail price settlement rule is based on the end retail price of a product. Use this rule and define a percentage on the end retail price of the product as the settlement amount. So for example, the parent account can define 70% of the end retail as their settlement policy.\",\n \"ruleValue\": 10,\n \"ruleId\": \"4\",\n \"valueType\": 2,\n \"prorate\": true,\n \"applyRetailDiscount\": false,\n \"position\": \"P1\"\n },\n {\n \"id\": \"508\",\n \"channelType\": 1003,\n \"subChannelType\": \"5\",\n \"ruleName\": \"Wholesale Price\",\n \"ruleDescription\": \"This is Partner rule. This settlement rule can be used to define a fixed settlement amount for reselling a product. The Rule Value must be entered at a charge level. For example, the parent business can charge a fixed amount of US $50 for reselling a product to their channel partner.\",\n \"ruleId\": \"3\",\n \"valueType\": 1,\n \"prorate\": true,\n \"applyRetailDiscount\": false,\n \"position\": \"P2\"\n }\n ]\n },\n {\n \"id\": \"602\",\n \"policyName\": \"Vested Networks Policy\",\n \"description\": \"Vested Networks Policy\",\n \"systemPolicy\": false,\n \"settlementPolicyRule\": [\n {\n \"id\": \"602\",\n \"channelType\": 1003,\n \"ruleName\": \"Retail Price\",\n \"ruleDescription\": \"This is Partner rule. This retail price settlement rule is based on the end retail price of a product. Use this rule and define a percentage on the end retail price of the product as the settlement amount. So for example, the parent account can define 70% of the end retail as their settlement policy.\",\n \"ruleValue\": 10,\n \"ruleId\": \"4\",\n \"valueType\": 2,\n \"prorate\": true,\n \"applyRetailDiscount\": false,\n \"position\": \"P1\"\n },\n {\n \"id\": \"603\",\n \"channelType\": 1003,\n \"subChannelType\": \"2\",\n \"ruleName\": \"Retail Price\",\n \"ruleDescription\": \"This is Partner rule. This retail price settlement rule is based on the end retail price of a product. Use this rule and define a percentage on the end retail price of the product as the settlement amount. So for example, the parent account can define 70% of the end retail as their settlement policy.\",\n \"ruleValue\": 5,\n \"ruleId\": \"4\",\n \"valueType\": 2,\n \"prorate\": true,\n \"applyRetailDiscount\": false,\n \"position\": \"P2\"\n }\n ]\n },\n {\n \"id\": \"702\",\n \"policyName\": \"Agent Multiple Rules\",\n \"description\": \"Agent Multiple Rules\",\n \"systemPolicy\": false,\n \"settlementPolicyRule\": [\n {\n \"id\": \"702\",\n \"channelType\": 1003,\n \"ruleName\": \"Retail Price\",\n \"ruleDescription\": \"This is Partner rule. This retail price settlement rule is based on the end retail price of a product. Use this rule and define a percentage on the end retail price of the product as the settlement amount. So for example, the parent account can define 70% of the end retail as their settlement policy.\",\n \"ruleValue\": 1,\n \"ruleId\": \"4\",\n \"valueType\": 2,\n \"prorate\": true,\n \"applyRetailDiscount\": false,\n \"position\": \"P1\"\n },\n {\n \"id\": \"703\",\n \"channelType\": 1005,\n \"ruleName\": \"Retail Price\",\n \"ruleDescription\": \"This is Agent rule. This retail price commission rule is based on the end retail price of a product. Use this rule and define a percentage on the end retail price of the product as the commission amount. So for example, the parent account can define 70% of the end retail as their commission policy.\",\n \"ruleValue\": 1,\n \"ruleId\": \"8\",\n \"valueType\": 2,\n \"prorate\": true,\n \"applyRetailDiscount\": false,\n \"position\": \"A1\"\n },\n {\n \"id\": \"704\",\n \"channelType\": 1005,\n \"subChannelType\": \"9\",\n \"ruleName\": \"Retail Price\",\n \"ruleDescription\": \"This is Agent rule. This retail price commission rule is based on the end retail price of a product. Use this rule and define a percentage on the end retail price of the product as the commission amount. So for example, the parent account can define 70% of the end retail as their commission policy.\",\n \"ruleValue\": 2,\n \"ruleId\": \"8\",\n \"valueType\": 2,\n \"prorate\": true,\n \"applyRetailDiscount\": false,\n \"position\": \"A2\"\n },\n {\n \"id\": \"705\",\n \"channelType\": 1005,\n \"subChannelType\": \"11\",\n \"ruleName\": \"Retail Price\",\n \"ruleDescription\": \"This is Agent rule. This retail price commission rule is based on the end retail price of a product. Use this rule and define a percentage on the end retail price of the product as the commission amount. So for example, the parent account can define 70% of the end retail as their commission policy.\",\n \"ruleValue\": 3,\n \"ruleId\": \"8\",\n \"valueType\": 2,\n \"prorate\": true,\n \"applyRetailDiscount\": false,\n \"position\": \"A3\"\n },\n {\n \"id\": \"706\",\n \"channelType\": 1005,\n \"subChannelType\": \"14\",\n \"ruleName\": \"Retail Price\",\n \"ruleDescription\": \"This is Agent rule. This retail price commission rule is based on the end retail price of a product. Use this rule and define a percentage on the end retail price of the product as the commission amount. So for example, the parent account can define 70% of the end retail as their commission policy.\",\n \"ruleValue\": 5,\n \"ruleId\": \"8\",\n \"valueType\": 2,\n \"prorate\": true,\n \"applyRetailDiscount\": false,\n \"position\": \"A4\"\n },\n {\n \"id\": \"707\",\n \"channelType\": 1005,\n \"subChannelType\": \"6\",\n \"ruleName\": \"Retail Price\",\n \"ruleDescription\": \"This is Agent rule. This retail price commission rule is based on the end retail price of a product. Use this rule and define a percentage on the end retail price of the product as the commission amount. So for example, the parent account can define 70% of the end retail as their commission policy.\",\n \"ruleValue\": 4,\n \"ruleId\": \"8\",\n \"valueType\": 2,\n \"prorate\": true,\n \"applyRetailDiscount\": false,\n \"position\": \"A5\"\n }\n ]\n },\n {\n \"id\": \"1103\",\n \"policyName\": \"Voice call policy\",\n \"description\": \"Voice call policy\",\n \"systemPolicy\": false,\n \"settlementPolicyRule\": [\n {\n \"id\": \"1204\",\n \"channelType\": 1003,\n \"ruleName\": \"Wholesale Price\",\n \"ruleDescription\": \"This is Partner rule. This settlement rule can be used to define a fixed settlement amount for reselling a product. The Rule Value must be entered at a charge level. For example, the parent business can charge a fixed amount of US $50 for reselling a product to their channel partner.\",\n \"ruleId\": \"3\",\n \"valueType\": 1,\n \"prorate\": true,\n \"applyRetailDiscount\": false,\n \"position\": \"P1\"\n },\n {\n \"id\": \"1205\",\n \"channelType\": 1003,\n \"subChannelType\": \"1\",\n \"ruleName\": \"Wholesale Price\",\n \"ruleDescription\": \"This is Partner rule. This settlement rule can be used to define a fixed settlement amount for reselling a product. The Rule Value must be entered at a charge level. For example, the parent business can charge a fixed amount of US $50 for reselling a product to their channel partner.\",\n \"ruleId\": \"3\",\n \"valueType\": 1,\n \"prorate\": true,\n \"applyRetailDiscount\": false,\n \"position\": \"P2\"\n }\n ]\n },\n {\n \"id\": \"1104\",\n \"policyName\": \"Reseller Policy\",\n \"description\": \"Reseller Policy\",\n \"systemPolicy\": false,\n \"settlementPolicyRule\": [\n {\n \"id\": \"1206\",\n \"channelType\": 1003,\n \"ruleName\": \"Wholesale Price\",\n \"ruleDescription\": \"This is Partner rule. This settlement rule can be used to define a fixed settlement amount for reselling a product. The Rule Value must be entered at a charge level. For example, the parent business can charge a fixed amount of US $50 for reselling a product to their channel partner.\",\n \"ruleId\": \"3\",\n \"valueType\": 1,\n \"prorate\": true,\n \"applyRetailDiscount\": false,\n \"position\": \"P1\"\n }\n ]\n },\n {\n \"id\": \"1105\",\n \"policyName\": \"RESELLER POLICY FOR PTNR\",\n \"description\": \"RESELLER POLICY\",\n \"systemPolicy\": false,\n \"settlementPolicyRule\": [\n {\n \"id\": \"1208\",\n \"channelType\": 1005,\n \"ruleName\": \"Retail Price\",\n \"ruleDescription\": \"This is Agent rule. This retail price commission rule is based on the end retail price of a product. Use this rule and define a percentage on the end retail price of the product as the commission amount. So for example, the parent account can define 70% of the end retail as their commission policy.\",\n \"ruleValue\": 15,\n \"ruleId\": \"8\",\n \"valueType\": 2,\n \"prorate\": true,\n \"applyRetailDiscount\": false,\n \"position\": \"A1\"\n },\n {\n \"id\": \"1207\",\n \"channelType\": 1003,\n \"ruleName\": \"Wholesale Price\",\n \"ruleDescription\": \"This is Partner rule. This settlement rule can be used to define a fixed settlement amount for reselling a product. The Rule Value must be entered at a charge level. For example, the parent business can charge a fixed amount of US $50 for reselling a product to their channel partner.\",\n \"ruleId\": \"3\",\n \"valueType\": 1,\n \"prorate\": true,\n \"applyRetailDiscount\": false,\n \"position\": \"P1\"\n },\n {\n \"id\": \"1209\",\n \"channelType\": 1003,\n \"subChannelType\": \"2\",\n \"ruleName\": \"Wholesale Price\",\n \"ruleDescription\": \"This is Partner rule. This settlement rule can be used to define a fixed settlement amount for reselling a product. The Rule Value must be entered at a charge level. For example, the parent business can charge a fixed amount of US $50 for reselling a product to their channel partner.\",\n \"ruleId\": \"3\",\n \"valueType\": 1,\n \"prorate\": true,\n \"applyRetailDiscount\": false,\n \"position\": \"P2\"\n }\n ]\n },\n {\n \"id\": \"1302\",\n \"policyName\": \"Settlement Retail Policy\",\n \"description\": \"Settlement Retail Policy\",\n \"systemPolicy\": false,\n \"settlementPolicyRule\": [\n {\n \"id\": \"1402\",\n \"channelType\": 1005,\n \"ruleName\": \"Retail Price\",\n \"ruleDescription\": \"This is Agent rule. This retail price commission rule is based on the end retail price of a product. Use this rule and define a percentage on the end retail price of the product as the commission amount. So for example, the parent account can define 70% of the end retail as their commission policy.\",\n \"ruleValue\": 20,\n \"ruleId\": \"8\",\n \"valueType\": 2,\n \"prorate\": true,\n \"applyRetailDiscount\": false,\n \"position\": \"A1\"\n },\n {\n \"id\": \"1403\",\n \"channelType\": 1003,\n \"ruleName\": \"Retail Price\",\n \"ruleDescription\": \"This is Partner rule. This retail price settlement rule is based on the end retail price of a product. Use this rule and define a percentage on the end retail price of the product as the settlement amount. So for example, the parent account can define 70% of the end retail as their settlement policy.\",\n \"ruleValue\": 10,\n \"ruleId\": \"4\",\n \"valueType\": 2,\n \"prorate\": true,\n \"applyRetailDiscount\": false,\n \"position\": \"P1\"\n }\n ]\n },\n {\n \"id\": \"1402\",\n \"policyName\": \"Global Agent Policy\",\n \"description\": \"Global Agent Policy\",\n \"systemPolicy\": false,\n \"settlementPolicyRule\": [\n {\n \"id\": \"1503\",\n \"channelType\": 1005,\n \"ruleName\": \"Fixed Commission\",\n \"ruleDescription\": \"This is Agent rule. This commission rule can be used to define a fixed commission amount for agents on retailing a product. The Rule Value must be entered at a charge level. For example, the parent business can offer a fixed commission of US $50 to a sales agent for retailing a product via an end subscriber.\",\n \"ruleId\": \"7\",\n \"valueType\": 1,\n \"prorate\": true,\n \"applyRetailDiscount\": false,\n \"position\": \"A1\"\n },\n {\n \"id\": \"1502\",\n \"channelType\": 1003,\n \"ruleName\": \"Wholesale Price\",\n \"ruleDescription\": \"This is Partner rule. This settlement rule can be used to define a fixed settlement amount for reselling a product. The Rule Value must be entered at a charge level. For example, the parent business can charge a fixed amount of US $50 for reselling a product to their channel partner.\",\n \"ruleId\": \"3\",\n \"valueType\": 1,\n \"prorate\": true,\n \"applyRetailDiscount\": false,\n \"position\": \"P1\"\n },\n {\n \"id\": \"1504\",\n \"channelType\": 1005,\n \"subChannelType\": \"9\",\n \"ruleName\": \"Fixed Commission\",\n \"ruleDescription\": \"This is Agent rule. This commission rule can be used to define a fixed commission amount for agents on retailing a product. The Rule Value must be entered at a charge level. For example, the parent business can offer a fixed commission of US $50 to a sales agent for retailing a product via an end subscriber.\",\n \"ruleId\": \"7\",\n \"valueType\": 1,\n \"prorate\": true,\n \"applyRetailDiscount\": false,\n \"position\": \"A2\"\n }\n ]\n },\n {\n \"id\": \"1602\",\n \"policyName\": \"freePolicy-Agent-10%\",\n \"description\": \"freePolicy-Agent-10%\",\n \"systemPolicy\": false,\n \"settlementPolicyRule\": [\n {\n \"id\": \"1703\",\n \"channelType\": 1005,\n \"ruleName\": \"Retail Price\",\n \"ruleDescription\": \"This is Agent rule. This retail price commission rule is based on the end retail price of a product. Use this rule and define a percentage on the end retail price of the product as the commission amount. So for example, the parent account can define 70% of the end retail as their commission policy.\",\n \"ruleValue\": 10,\n \"ruleId\": \"8\",\n \"valueType\": 2,\n \"prorate\": true,\n \"applyRetailDiscount\": false,\n \"position\": \"A1\"\n },\n {\n \"id\": \"1702\",\n \"channelType\": 1003,\n \"ruleName\": \"Wholesale Price\",\n \"ruleDescription\": \"This is Partner rule. This settlement rule can be used to define a fixed settlement amount for reselling a product. The Rule Value must be entered at a charge level. For example, the parent business can charge a fixed amount of US $50 for reselling a product to their channel partner.\",\n \"ruleId\": \"3\",\n \"valueType\": 1,\n \"prorate\": true,\n \"applyRetailDiscount\": false,\n \"position\": \"P1\"\n },\n {\n \"id\": \"1704\",\n \"channelType\": 1005,\n \"subChannelType\": \"9\",\n \"ruleName\": \"Retail Price\",\n \"ruleDescription\": \"This is Agent rule. This retail price commission rule is based on the end retail price of a product. Use this rule and define a percentage on the end retail price of the product as the commission amount. So for example, the parent account can define 70% of the end retail as their commission policy.\",\n \"ruleValue\": 15,\n \"ruleId\": \"8\",\n \"valueType\": 2,\n \"prorate\": true,\n \"applyRetailDiscount\": false,\n \"position\": \"A2\"\n }\n ]\n },\n {\n \"id\": \"1702\",\n \"policyName\": \"Reseller Policy -Xinix\",\n \"description\": \"Reseller Policy -Xinix\",\n \"systemPolicy\": false,\n \"settlementPolicyRule\": [\n {\n \"id\": \"1802\",\n \"channelType\": 1003,\n \"ruleName\": \"Wholesale Price\",\n \"ruleDescription\": \"This is Partner rule. This settlement rule can be used to define a fixed settlement amount for reselling a product. The Rule Value must be entered at a charge level. For example, the parent business can charge a fixed amount of US $50 for reselling a product to their channel partner.\",\n \"ruleId\": \"3\",\n \"valueType\": 1,\n \"prorate\": true,\n \"applyRetailDiscount\": false,\n \"position\": \"P1\"\n },\n {\n \"id\": \"1803\",\n \"channelType\": 1003,\n \"subChannelType\": \"2\",\n \"ruleName\": \"Wholesale Price\",\n \"ruleDescription\": \"This is Partner rule. This settlement rule can be used to define a fixed settlement amount for reselling a product. The Rule Value must be entered at a charge level. For example, the parent business can charge a fixed amount of US $50 for reselling a product to their channel partner.\",\n \"ruleId\": \"3\",\n \"valueType\": 1,\n \"prorate\": true,\n \"applyRetailDiscount\": false,\n \"position\": \"P2\"\n }\n ]\n },\n {\n \"id\": \"2104\",\n \"policyName\": \"Dealer Policy 2020\",\n \"description\": \"Dealer Policy 2020\",\n \"systemPolicy\": false,\n \"settlementPolicyRule\": [\n {\n \"id\": \"2204\",\n \"channelType\": 1003,\n \"ruleName\": \"Wholesale Price\",\n \"ruleDescription\": \"This is Partner rule. This settlement rule can be used to define a fixed settlement amount for reselling a product. The Rule Value must be entered at a charge level. For example, the parent business can charge a fixed amount of US $50 for reselling a product to their channel partner.\",\n \"ruleId\": \"3\",\n \"valueType\": 1,\n \"prorate\": true,\n \"applyRetailDiscount\": false,\n \"position\": \"P1\"\n },\n {\n \"id\": \"2205\",\n \"channelType\": 1003,\n \"subChannelType\": \"924\",\n \"ruleName\": \"Wholesale Price\",\n \"ruleDescription\": \"This is Partner rule. This settlement rule can be used to define a fixed settlement amount for reselling a product. The Rule Value must be entered at a charge level. For example, the parent business can charge a fixed amount of US $50 for reselling a product to their channel partner.\",\n \"ruleId\": \"3\",\n \"valueType\": 1,\n \"prorate\": true,\n \"applyRetailDiscount\": false,\n \"position\": \"P2\"\n }\n ]\n },\n {\n \"id\": \"2202\",\n \"policyName\": \"Agent Policy - KLaunch\",\n \"description\": \"Agent Policy - KLaunch\",\n \"systemPolicy\": false,\n \"settlementPolicyRule\": [\n {\n \"id\": \"2302\",\n \"channelType\": 1003,\n \"ruleName\": \"Wholesale Price\",\n \"ruleDescription\": \"This is Partner rule. This settlement rule can be used to define a fixed settlement amount for reselling a product. The Rule Value must be entered at a charge level. For example, the parent business can charge a fixed amount of US $50 for reselling a product to their channel partner.\",\n \"ruleId\": \"3\",\n \"valueType\": 1,\n \"prorate\": true,\n \"applyRetailDiscount\": false,\n \"position\": \"P1\"\n },\n {\n \"id\": \"2303\",\n \"channelType\": 1005,\n \"ruleName\": \"Fixed Commission\",\n \"ruleDescription\": \"This is Agent rule. This commission rule can be used to define a fixed commission amount for agents on retailing a product. The Rule Value must be entered at a charge level. For example, the parent business can offer a fixed commission of US $50 to a sales agent for retailing a product via an end subscriber.\",\n \"ruleId\": \"7\",\n \"valueType\": 1,\n \"prorate\": true,\n \"applyRetailDiscount\": false,\n \"position\": \"A1\"\n },\n {\n \"id\": \"2304\",\n \"channelType\": 1005,\n \"subChannelType\": \"1024\",\n \"ruleName\": \"Fixed Commission\",\n \"ruleDescription\": \"This is Agent rule. This commission rule can be used to define a fixed commission amount for agents on retailing a product. The Rule Value must be entered at a charge level. For example, the parent business can offer a fixed commission of US $50 to a sales agent for retailing a product via an end subscriber.\",\n \"ruleId\": \"7\",\n \"valueType\": 1,\n \"prorate\": true,\n \"applyRetailDiscount\": false,\n \"position\": \"A2\"\n }\n ]\n },\n {\n \"id\": \"2203\",\n \"policyName\": \"Active Commission Policy\",\n \"description\": \"Active Commission Policy\",\n \"systemPolicy\": false,\n \"settlementPolicyRule\": [\n {\n \"id\": \"2305\",\n \"channelType\": 1005,\n \"ruleName\": \"Fixed Commission\",\n \"ruleDescription\": \"This is Agent rule. This commission rule can be used to define a fixed commission amount for agents on retailing a product. The Rule Value must be entered at a charge level. For example, the parent business can offer a fixed commission of US $50 to a sales agent for retailing a product via an end subscriber.\",\n \"ruleId\": \"7\",\n \"valueType\": 1,\n \"prorate\": true,\n \"applyRetailDiscount\": false,\n \"position\": \"A1\"\n },\n {\n \"id\": \"2306\",\n \"channelType\": 1005,\n \"subChannelType\": \"1025\",\n \"ruleName\": \"Retail Price\",\n \"ruleDescription\": \"This is Agent rule. This retail price commission rule is based on the end retail price of a product. Use this rule and define a percentage on the end retail price of the product as the commission amount. So for example, the parent account can define 70% of the end retail as their commission policy.\",\n \"ruleValue\": 20,\n \"ruleId\": \"8\",\n \"valueType\": 2,\n \"prorate\": true,\n \"applyRetailDiscount\": false,\n \"position\": \"A2\"\n }\n ]\n },\n {\n \"id\": \"2302\",\n \"policyName\": \"Reseller Partner Policy\",\n \"description\": \"Reseller Partner Policy (New)\",\n \"systemPolicy\": false,\n \"settlementPolicyRule\": [\n {\n \"id\": \"2402\",\n \"channelType\": 1003,\n \"ruleName\": \"Retail Price\",\n \"ruleDescription\": \"This is Partner rule. This retail price settlement rule is based on the end retail price of a product. Use this rule and define a percentage on the end retail price of the product as the settlement amount. So for example, the parent account can define 70% of the end retail as their settlement policy.\",\n \"ruleValue\": 80,\n \"ruleId\": \"4\",\n \"valueType\": 2,\n \"prorate\": true,\n \"applyRetailDiscount\": false,\n \"position\": \"P1\"\n },\n {\n \"id\": \"2403\",\n \"channelType\": 1003,\n \"subChannelType\": \"1126\",\n \"ruleName\": \"Retail Price\",\n \"ruleDescription\": \"This is Partner rule. This retail price settlement rule is based on the end retail price of a product. Use this rule and define a percentage on the end retail price of the product as the settlement amount. So for example, the parent account can define 70% of the end retail as their settlement policy.\",\n \"ruleValue\": 70,\n \"ruleId\": \"4\",\n \"valueType\": 2,\n \"prorate\": true,\n \"applyRetailDiscount\": false,\n \"position\": \"P2\"\n }\n ]\n },\n {\n \"id\": \"2602\",\n \"policyName\": \"ProudCo Policies\",\n \"description\": \"This policy contains the details of all the wholesale prices and the agent commissions as offered by ProudCo.\",\n \"systemPolicy\": false,\n \"settlementPolicyRule\": [\n {\n \"id\": \"2803\",\n \"channelType\": 1003,\n \"ruleName\": \"Retail Price\",\n \"ruleDescription\": \"This is Partner rule. This retail price settlement rule is based on the end retail price of a product. Use this rule and define a percentage on the end retail price of the product as the settlement amount. So for example, the parent account can define 70% of the end retail as their settlement policy.\",\n \"ruleValue\": 70,\n \"ruleId\": \"4\",\n \"valueType\": 2,\n \"prorate\": true,\n \"applyRetailDiscount\": false,\n \"position\": \"P1\"\n },\n {\n \"id\": \"2802\",\n \"channelType\": 1005,\n \"ruleName\": \"Retail Price\",\n \"ruleDescription\": \"This is Agent rule. This retail price commission rule is based on the end retail price of a product. Use this rule and define a percentage on the end retail price of the product as the commission amount. So for example, the parent account can define 70% of the end retail as their commission policy.\",\n \"ruleValue\": 15,\n \"ruleId\": \"8\",\n \"valueType\": 2,\n \"prorate\": true,\n \"applyRetailDiscount\": false,\n \"position\": \"A1\"\n },\n {\n \"id\": \"2804\",\n \"channelType\": 1003,\n \"subChannelType\": \"1324\",\n \"ruleName\": \"Wholesale Price\",\n \"ruleDescription\": \"This is Partner rule. This settlement rule can be used to define a fixed settlement amount for reselling a product. The Rule Value must be entered at a charge level. For example, the parent business can charge a fixed amount of US $50 for reselling a product to their channel partner.\",\n \"ruleId\": \"3\",\n \"valueType\": 1,\n \"prorate\": true,\n \"applyRetailDiscount\": false,\n \"position\": \"P2\"\n },\n {\n \"id\": \"2806\",\n \"channelType\": 1005,\n \"subChannelType\": \"7\",\n \"ruleName\": \"Fixed Commission\",\n \"ruleDescription\": \"This is Agent rule. This commission rule can be used to define a fixed commission amount for agents on retailing a product. The Rule Value must be entered at a charge level. For example, the parent business can offer a fixed commission of US $50 to a sales agent for retailing a product via an end subscriber.\",\n \"ruleId\": \"7\",\n \"valueType\": 1,\n \"prorate\": true,\n \"applyRetailDiscount\": false,\n \"position\": \"A2\"\n },\n {\n \"id\": \"2805\",\n \"channelType\": 1003,\n \"subChannelType\": \"3\",\n \"ruleName\": \"Cost Markup\",\n \"ruleDescription\": \"This is Partner rule. This rule is used to define a settlement policy based on the cost. Your business can use this rule to define a markup amount as a percentage on the cost of the product for the settlement amount. It can also be a fixed markup amount on the cost as well.\",\n \"ruleValue\": 50,\n \"ruleId\": \"1\",\n \"valueType\": 2,\n \"prorate\": true,\n \"applyRetailDiscount\": false,\n \"position\": \"P3\"\n }\n ]\n },\n {\n \"id\": \"2702\",\n \"policyName\": \"Call Harbor Policy\",\n \"description\": \"Call Harbor Policy\",\n \"systemPolicy\": false,\n \"settlementPolicyRule\": [\n {\n \"id\": \"2903\",\n \"channelType\": 1003,\n \"ruleName\": \"Wholesale Price\",\n \"ruleDescription\": \"This is Partner rule. This settlement rule can be used to define a fixed settlement amount for reselling a product. The Rule Value must be entered at a charge level. For example, the parent business can charge a fixed amount of US $50 for reselling a product to their channel partner.\",\n \"ruleId\": \"3\",\n \"valueType\": 1,\n \"prorate\": true,\n \"applyRetailDiscount\": false,\n \"position\": \"P1\"\n },\n {\n \"id\": \"2902\",\n \"channelType\": 1005,\n \"ruleName\": \"Retail Price\",\n \"ruleDescription\": \"This is Agent rule. This retail price commission rule is based on the end retail price of a product. Use this rule and define a percentage on the end retail price of the product as the commission amount. So for example, the parent account can define 70% of the end retail as their commission policy.\",\n \"ruleValue\": 10,\n \"ruleId\": \"8\",\n \"valueType\": 2,\n \"prorate\": true,\n \"applyRetailDiscount\": false,\n \"position\": \"A1\"\n },\n {\n \"id\": \"2904\",\n \"channelType\": 1005,\n \"subChannelType\": \"9\",\n \"ruleName\": \"Retail Price\",\n \"ruleDescription\": \"This is Agent rule. This retail price commission rule is based on the end retail price of a product. Use this rule and define a percentage on the end retail price of the product as the commission amount. So for example, the parent account can define 70% of the end retail as their commission policy.\",\n \"ruleValue\": 30,\n \"ruleId\": \"8\",\n \"valueType\": 2,\n \"prorate\": true,\n \"applyRetailDiscount\": false,\n \"position\": \"A2\"\n },\n {\n \"id\": \"2905\",\n \"channelType\": 1005,\n \"subChannelType\": \"1424\",\n \"ruleName\": \"Retail Price\",\n \"ruleDescription\": \"This is Agent rule. This retail price commission rule is based on the end retail price of a product. Use this rule and define a percentage on the end retail price of the product as the commission amount. So for example, the parent account can define 70% of the end retail as their commission policy.\",\n \"ruleValue\": 20,\n \"ruleId\": \"8\",\n \"valueType\": 2,\n \"prorate\": true,\n \"applyRetailDiscount\": false,\n \"position\": \"A3\"\n }\n ]\n },\n {\n \"id\": \"2703\",\n \"policyName\": \"Call Harbor Policy 2\",\n \"description\": \"Call Harbor Policy 2\",\n \"systemPolicy\": false,\n \"settlementPolicyRule\": [\n {\n \"id\": \"2906\",\n \"channelType\": 1005,\n \"ruleName\": \"Fixed Commission\",\n \"ruleDescription\": \"This is Agent rule. This commission rule can be used to define a fixed commission amount for agents on retailing a product. The Rule Value must be entered at a charge level. For example, the parent business can offer a fixed commission of US $50 to a sales agent for retailing a product via an end subscriber.\",\n \"ruleId\": \"7\",\n \"valueType\": 1,\n \"prorate\": true,\n \"applyRetailDiscount\": false,\n \"position\": \"A1\"\n }\n ]\n },\n {\n \"id\": \"2802\",\n \"policyName\": \"Juxto Settlement Policy\",\n \"description\": \"Juxto Settlement Policy\",\n \"systemPolicy\": false,\n \"settlementPolicyRule\": [\n {\n \"id\": \"3002\",\n \"channelType\": 1003,\n \"ruleName\": \"Cost Markup\",\n \"ruleDescription\": \"This is Partner rule. This rule is used to define a settlement policy based on the cost. Your business can use this rule to define a markup amount as a percentage on the cost of the product for the settlement amount. It can also be a fixed markup amount on the cost as well.\",\n \"ruleValue\": 25,\n \"ruleId\": \"1\",\n \"valueType\": 2,\n \"prorate\": true,\n \"applyRetailDiscount\": false,\n \"position\": \"P1\"\n },\n {\n \"id\": \"3003\",\n \"channelType\": 1003,\n \"subChannelType\": \"1524\",\n \"ruleName\": \"Cost Markup\",\n \"ruleDescription\": \"This is Partner rule. This rule is used to define a settlement policy based on the cost. Your business can use this rule to define a markup amount as a percentage on the cost of the product for the settlement amount. It can also be a fixed markup amount on the cost as well.\",\n \"ruleValue\": 20,\n \"ruleId\": \"1\",\n \"valueType\": 2,\n \"prorate\": true,\n \"applyRetailDiscount\": false,\n \"position\": \"P2\"\n }\n ]\n },\n {\n \"id\": \"2902\",\n \"policyName\": \"JUXTO MSP Policy\",\n \"description\": \"JUXTO MSP Policy\",\n \"systemPolicy\": false,\n \"settlementPolicyRule\": [\n {\n \"id\": \"3102\",\n \"channelType\": 1003,\n \"ruleName\": \"Retail List Price\",\n \"ruleDescription\": \"This is a partner rule. This Retail List Price settlement rule is based on the end retail price of a product. Use this rule and define a percentage on the end retail price of the product as the settlement amount. So for example, the parent account can define 70% of the end retail as their settlement policy. It will calculate the settlement amount before the discounts are applied.\",\n \"ruleValue\": 10,\n \"ruleId\": \"18\",\n \"valueType\": 2,\n \"prorate\": true,\n \"applyRetailDiscount\": false,\n \"position\": \"P1\"\n },\n {\n \"id\": \"3103\",\n \"channelType\": 1003,\n \"subChannelType\": \"1624\",\n \"ruleName\": \"Cost Markup\",\n \"ruleDescription\": \"This is Partner rule. This rule is used to define a settlement policy based on the cost. Your business can use this rule to define a markup amount as a percentage on the cost of the product for the settlement amount. It can also be a fixed markup amount on the cost as well.\",\n \"ruleValue\": 25,\n \"ruleId\": \"1\",\n \"valueType\": 2,\n \"prorate\": true,\n \"applyRetailDiscount\": false,\n \"position\": \"P2\"\n }\n ]\n },\n {\n \"id\": \"2903\",\n \"policyName\": \"JUXTO MSP Policy 2\",\n \"description\": \"JUXTO MSP Policy 2\",\n \"systemPolicy\": false,\n \"settlementPolicyRule\": [\n {\n \"id\": \"3104\",\n \"channelType\": 1003,\n \"ruleName\": \"Wholesale Price\",\n \"ruleDescription\": \"This is Partner rule. This settlement rule can be used to define a fixed settlement amount for reselling a product. The Rule Value must be entered at a charge level. For example, the parent business can charge a fixed amount of US $50 for reselling a product to their channel partner.\",\n \"ruleId\": \"3\",\n \"valueType\": 1,\n \"prorate\": true,\n \"applyRetailDiscount\": false,\n \"position\": \"P1\"\n },\n {\n \"id\": \"3105\",\n \"channelType\": 1003,\n \"subChannelType\": \"1624\",\n \"ruleName\": \"Retail Price\",\n \"ruleDescription\": \"This is Partner rule. This retail price settlement rule is based on the end retail price of a product. Use this rule and define a percentage on the end retail price of the product as the settlement amount. So for example, the parent account can define 70% of the end retail as their settlement policy.\",\n \"ruleValue\": 80,\n \"ruleId\": \"4\",\n \"valueType\": 2,\n \"prorate\": true,\n \"applyRetailDiscount\": false,\n \"position\": \"P2\"\n }\n ]\n },\n {\n \"id\": \"3102\",\n \"policyName\": \"New Partner Policy\",\n \"description\": \"New Partner Policy\",\n \"systemPolicy\": false,\n \"settlementPolicyRule\": [\n {\n \"id\": \"3402\",\n \"channelType\": 1003,\n \"ruleName\": \"Retail Price\",\n \"ruleDescription\": \"This is Partner rule. This retail price settlement rule is based on the end retail price of a product. Use this rule and define a percentage on the end retail price of the product as the settlement amount. So for example, the parent account can define 70% of the end retail as their settlement policy.\",\n \"ruleValue\": 10,\n \"ruleId\": \"4\",\n \"valueType\": 2,\n \"prorate\": true,\n \"applyRetailDiscount\": false,\n \"position\": \"P1\"\n },\n {\n \"id\": \"3403\",\n \"channelType\": 1003,\n \"subChannelType\": \"1124\",\n \"ruleName\": \"Retail Price\",\n \"ruleDescription\": \"This is Partner rule. This retail price settlement rule is based on the end retail price of a product. Use this rule and define a percentage on the end retail price of the product as the settlement amount. So for example, the parent account can define 70% of the end retail as their settlement policy.\",\n \"ruleValue\": 34,\n \"ruleId\": \"4\",\n \"valueType\": 2,\n \"prorate\": true,\n \"applyRetailDiscount\": false,\n \"position\": \"P2\"\n }\n ]\n },\n {\n \"id\": \"3202\",\n \"policyName\": \"Local Distributor Policy\",\n \"description\": \"This is the LDP.\",\n \"systemPolicy\": false,\n \"settlementPolicyRule\": [\n {\n \"id\": \"3504\",\n \"channelType\": 1005,\n \"ruleName\": \"Retail Price\",\n \"ruleDescription\": \"This is Agent rule. This retail price commission rule is based on the end retail price of a product. Use this rule and define a percentage on the end retail price of the product as the commission amount. So for example, the parent account can define 70% of the end retail as their commission policy.\",\n \"ruleValue\": 10,\n \"ruleId\": \"8\",\n \"valueType\": 2,\n \"prorate\": true,\n \"applyRetailDiscount\": false,\n \"position\": \"A1\"\n },\n {\n \"id\": \"3502\",\n \"channelType\": 1003,\n \"ruleName\": \"Retail Price\",\n \"ruleDescription\": \"This is Partner rule. This retail price settlement rule is based on the end retail price of a product. Use this rule and define a percentage on the end retail price of the product as the settlement amount. So for example, the parent account can define 70% of the end retail as their settlement policy.\",\n \"ruleValue\": 60,\n \"ruleId\": \"4\",\n \"valueType\": 2,\n \"prorate\": true,\n \"applyRetailDiscount\": false,\n \"position\": \"P1\"\n },\n {\n \"id\": \"3503\",\n \"channelType\": 1003,\n \"subChannelType\": \"1824\",\n \"ruleName\": \"Retail Price\",\n \"ruleDescription\": \"This is Partner rule. This retail price settlement rule is based on the end retail price of a product. Use this rule and define a percentage on the end retail price of the product as the settlement amount. So for example, the parent account can define 70% of the end retail as their settlement policy.\",\n \"ruleValue\": 50,\n \"ruleId\": \"4\",\n \"valueType\": 2,\n \"prorate\": true,\n \"applyRetailDiscount\": false,\n \"position\": \"P2\"\n },\n {\n \"id\": \"3505\",\n \"channelType\": 1005,\n \"subChannelType\": \"1825\",\n \"ruleName\": \"Retail Price\",\n \"ruleDescription\": \"This is Agent rule. This retail price commission rule is based on the end retail price of a product. Use this rule and define a percentage on the end retail price of the product as the commission amount. So for example, the parent account can define 70% of the end retail as their commission policy.\",\n \"ruleValue\": 20,\n \"ruleId\": \"8\",\n \"valueType\": 2,\n \"prorate\": true,\n \"applyRetailDiscount\": false,\n \"position\": \"A2\"\n },\n {\n \"id\": \"3602\",\n \"channelType\": 1003,\n \"subChannelType\": \"1126\",\n \"ruleName\": \"Retail Price\",\n \"ruleDescription\": \"This is Partner rule. This retail price settlement rule is based on the end retail price of a product. Use this rule and define a percentage on the end retail price of the product as the settlement amount. So for example, the parent account can define 70% of the end retail as their settlement policy.\",\n \"ruleValue\": 70,\n \"ruleId\": \"4\",\n \"valueType\": 2,\n \"prorate\": true,\n \"applyRetailDiscount\": false,\n \"position\": \"P3\"\n }\n ]\n },\n {\n \"id\": \"3402\",\n \"policyName\": \"New Agent VoIP Policy\",\n \"description\": \"New Agent VoIP Policy\",\n \"systemPolicy\": false,\n \"settlementPolicyRule\": [\n {\n \"id\": \"3802\",\n \"channelType\": 1005,\n \"ruleName\": \"Retail Price\",\n \"ruleDescription\": \"This is Agent rule. This retail price commission rule is based on the end retail price of a product. Use this rule and define a percentage on the end retail price of the product as the commission amount. So for example, the parent account can define 70% of the end retail as their commission policy.\",\n \"ruleValue\": 5,\n \"ruleId\": \"8\",\n \"valueType\": 2,\n \"prorate\": true,\n \"applyRetailDiscount\": false,\n \"position\": \"A1\"\n },\n {\n \"id\": \"3803\",\n \"channelType\": 1005,\n \"subChannelType\": \"2024\",\n \"ruleName\": \"Retail Price\",\n \"ruleDescription\": \"This is Agent rule. This retail price commission rule is based on the end retail price of a product. Use this rule and define a percentage on the end retail price of the product as the commission amount. So for example, the parent account can define 70% of the end retail as their commission policy.\",\n \"ruleValue\": 10,\n \"ruleId\": \"8\",\n \"valueType\": 2,\n \"prorate\": true,\n \"applyRetailDiscount\": false,\n \"position\": \"A2\"\n },\n {\n \"id\": \"3804\",\n \"channelType\": 1005,\n \"subChannelType\": \"9\",\n \"ruleName\": \"Retail Price\",\n \"ruleDescription\": \"This is Agent rule. This retail price commission rule is based on the end retail price of a product. Use this rule and define a percentage on the end retail price of the product as the commission amount. So for example, the parent account can define 70% of the end retail as their commission policy.\",\n \"ruleValue\": 20,\n \"ruleId\": \"8\",\n \"valueType\": 2,\n \"prorate\": true,\n \"applyRetailDiscount\": false,\n \"position\": \"A3\"\n }\n ]\n },\n {\n \"id\": \"4002\",\n \"policyName\": \"321M22_SettlementPolicy1\",\n \"description\": \"Sample settlement policy created for understanding purposes\",\n \"systemPolicy\": false,\n \"settlementPolicyRule\": [\n {\n \"id\": \"4702\",\n \"channelType\": 1003,\n \"ruleName\": \"Wholesale Price\",\n \"ruleDescription\": \"This is Partner rule. This settlement rule can be used to define a fixed settlement amount for reselling a product. The Rule Value must be entered at a charge level. For example, the parent business can charge a fixed amount of US $50 for reselling a product to their channel partner.\",\n \"ruleId\": \"3\",\n \"valueType\": 1,\n \"end\": 365,\n \"prorate\": true,\n \"applyRetailDiscount\": false,\n \"position\": \"P1\"\n },\n {\n \"id\": \"4703\",\n \"channelType\": 1005,\n \"ruleName\": \"Retail Price\",\n \"ruleDescription\": \"This is Agent rule. This retail price commission rule is based on the end retail price of a product. Use this rule and define a percentage on the end retail price of the product as the commission amount. So for example, the parent account can define 70% of the end retail as their commission policy.\",\n \"ruleValue\": 10,\n \"ruleId\": \"8\",\n \"valueType\": 2,\n \"end\": 365,\n \"prorate\": true,\n \"applyRetailDiscount\": false,\n \"position\": \"A1\"\n }\n ]\n },\n {\n \"id\": \"4802\",\n \"channelType\": 1003,\n \"ruleName\": \"Wholesale Discount\",\n \"ruleDescription\": \"This is a partner rule. Use this rule to define a discount on the retail price that you are offering to your channel partner. The wholesale price will be calculated as the difference between the retail price and the discounted amount. For example, if the \\\"Wholesale Discount\\\" value is set to 30%, then the wholesale price for partner will be calculated as 70% of the end retail price.\",\n \"ruleValue\": 12,\n \"ruleId\": \"20\",\n \"valueType\": 2,\n \"prorate\": true,\n \"applyRetailDiscount\": false,\n \"position\": \"P1\"\n },\n {\n \"id\": \"4804\",\n \"channelType\": 1003,\n \"subChannelType\": \"1124\",\n \"ruleName\": \"Retail Price\",\n \"ruleDescription\": \"This is Partner rule. This retail price settlement rule is based on the end retail price of a product. Use this rule and define a percentage on the end retail price of the product as the settlement amount. So for example, the parent account can define 70% of the end retail as their settlement policy.\",\n \"ruleValue\": 40,\n \"ruleId\": \"4\",\n \"valueType\": 2,\n \"prorate\": true,\n \"applyRetailDiscount\": false,\n \"position\": \"P2\"\n },\n {\n \"id\": \"4805\",\n \"channelType\": 1005,\n \"subChannelType\": \"14\",\n \"ruleName\": \"Retail Price\",\n \"ruleDescription\": \"This is Agent rule. This retail price commission rule is based on the end retail price of a product. Use this rule and define a percentage on the end retail price of the product as the commission amount. So for example, the parent account can define 70% of the end retail as their commission policy.\",\n \"ruleValue\": 5,\n \"ruleId\": \"8\",\n \"valueType\": 2,\n \"prorate\": true,\n \"applyRetailDiscount\": false,\n \"position\": \"A2\"\n }\n ]\n},\n{\n\"status\": \"OK\"\n}"}],"_postman_id":"796fbe6b-5da9-4e85-ad89-4308f609655a"},{"name":"Fetch Settlement Policy Rules","id":"b933475f-a785-47f1-934c-0ab82e23bf24","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"}],"url":"{{Host}}/rest/ProductService/v1/products/settlementrules","description":"This API is used to fetch the settlement policy rules. It will help to get details of the settlement rules.
\n","urlObject":{"path":["rest","ProductService","v1","products","settlementrules"],"host":["{{Host}}"],"query":[],"variable":[]}},"response":[{"id":"b59b941e-dab7-4faf-aeab-182481e45e2a","name":"Fetch Settlement Policy Rules","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"}],"url":"{{Host}}/rest/ProductService/v1/products/settlementrules"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Thu, 06 Jul 2023 07:19:50 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"5624"},{"key":"Connection","value":"keep-alive"},{"key":"Set-Cookie","value":"JSESSIONID=D3C12C09F8E3856934BF3F25A8889EE8.worker3; Path=/; Secure; HttpOnly"},{"key":"Access-Control-Allow-Headers","value":"*, Content-Type, Pragma, Origin, Authorization, party, X-XSRF-TOKEN, X-Requested-With,Access-Control-Allow-Headers,Accept,Access-Control-Allow-Credentials,X-Auth-Token, version, cache"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST,OPTIONS,PUT,DELETE,GET"}],"cookie":[],"responseTime":null,"body":"{\n \"settlementRuleArray\": [\n {\n \"id\": \"3\",\n \"ruleName\": \"Wholesale Price\",\n \"description\": \"This is Partner rule. This settlement rule can be used to define a fixed settlement amount for reselling a product. The Rule Value must be entered at a charge level. For example, the parent business can charge a fixed amount of US $50 for reselling a product to their channel partner.\",\n \"ruleValueTypeArray\": [\n 1\n ],\n \"ruleParameterArray\": [\n 8\n ],\n \"channelType\": 1003\n },\n {\n \"id\": \"37\",\n \"ruleName\": \"Cost Markup\",\n \"description\": \"This is Vendor rule. This rule is used to define a settlement policy based on the cost. Your business can use this rule to define a markup amount as a percentage on the cost of the product for the settlement amount. It can also be a fixed markup amount on the cost as well.\",\n \"ruleValueTypeArray\": [\n 2,\n 1\n ],\n \"ruleParameterArray\": [\n 1\n ],\n \"channelType\": 1006\n },\n {\n \"id\": \"4\",\n \"ruleName\": \"Retail Price\",\n \"description\": \"This is Partner rule. This retail price settlement rule is based on the end retail price of a product. Use this rule and define a percentage on the end retail price of the product as the settlement amount. So for example, the parent account can define 70% of the end retail as their settlement policy.\",\n \"ruleValueTypeArray\": [\n 2\n ],\n \"ruleParameterArray\": [\n 4\n ],\n \"channelType\": 1003\n },\n {\n \"id\": \"18\",\n \"ruleName\": \"Retail List Price\",\n \"description\": \"This is a partner rule. This Retail List Price settlement rule is based on the end retail price of a product. Use this rule and define a percentage on the end retail price of the product as the settlement amount. So for example, the parent account can define 70% of the end retail as their settlement policy. It will calculate the settlement amount before the discounts are applied.\",\n \"ruleValueTypeArray\": [\n 2\n ],\n \"ruleParameterArray\": [\n 4\n ],\n \"channelType\": 1003\n },\n {\n \"id\": \"20\",\n \"ruleName\": \"Wholesale Discount\",\n \"description\": \"This is a partner rule. Use this rule to define a discount on the retail price that you are offering to your channel partner. The wholesale price will be calculated as the difference between the retail price and the discounted amount. For example, if the \\\"Wholesale Discount\\\" value is set to 30%, then the wholesale price for partner will be calculated as 70% of the end retail price.\",\n \"ruleValueTypeArray\": [\n 2\n ],\n \"ruleParameterArray\": [\n 4\n ],\n \"channelType\": 1003\n },\n {\n \"id\": \"38\",\n \"ruleName\": \"Retail Price\",\n \"description\": \"This is Vendor rule. This retail price settlement rule is based on the end retail price of a product. Use this rule and define a percentage on the end retail price of the product as the settlement amount. So for example, the parent account can define 70% of the end retail as their settlement policy.\",\n \"ruleValueTypeArray\": [\n 2\n ],\n \"ruleParameterArray\": [\n 4\n ],\n \"channelType\": 1006\n },\n {\n \"id\": \"1\",\n \"ruleName\": \"Cost Markup\",\n \"description\": \"This is Partner rule. This rule is used to define a settlement policy based on the cost. Your business can use this rule to define a markup amount as a percentage on the cost of the product for the settlement amount. It can also be a fixed markup amount on the cost as well.\",\n \"ruleValueTypeArray\": [\n 2,\n 1\n ],\n \"ruleParameterArray\": [\n 1\n ],\n \"channelType\": 1003\n },\n {\n \"id\": \"8\",\n \"ruleName\": \"Retail Price\",\n \"description\": \"This is Agent rule. This retail price commission rule is based on the end retail price of a product. Use this rule and define a percentage on the end retail price of the product as the commission amount. So for example, the parent account can define 70% of the end retail as their commission policy.\",\n \"ruleValueTypeArray\": [\n 2\n ],\n \"ruleParameterArray\": [\n 4\n ],\n \"channelType\": 1005\n },\n {\n \"id\": \"19\",\n \"ruleName\": \"Retail List Price\",\n \"description\": \"This is an agent rule. This Retail List Price commission rule is based on the end retail price of a product. Use this rule and define a percentage on the end retail price of the product as the commission amount. So for example, the parent account can define 70% of the end retail as their commission policy. It will calculate the settlement amount before the discounts are applied.\",\n \"ruleValueTypeArray\": [\n 2\n ],\n \"ruleParameterArray\": [\n 4\n ],\n \"channelType\": 1005\n },\n {\n \"id\": \"7\",\n \"ruleName\": \"Fixed Commission\",\n \"description\": \"This is Agent rule. This commission rule can be used to define a fixed commission amount for agents on retailing a product. The Rule Value must be entered at a charge level. For example, the parent business can offer a fixed commission of US $50 to a sales agent for retailing a product via an end subscriber.\",\n \"ruleValueTypeArray\": [\n 1\n ],\n \"ruleParameterArray\": [\n 8\n ],\n \"channelType\": 1005\n },\n {\n \"id\": \"9\",\n \"ruleName\": \"Cost Margin\",\n \"description\": \"This rule is used to determine the agent commission when a business wishes to charge a margin percentage on the difference between retail price and cost of the product.\",\n \"ruleValueTypeArray\": [\n 2\n ],\n \"ruleParameterArray\": [\n 1,\n 4\n ],\n \"channelType\": 1005\n },\n {\n \"id\": \"11\",\n \"ruleName\": \"Wholesale Price\",\n \"description\": \"This is Agent rule. Use this rule to offer a commission based on the wholesale amount charged to the agent. The commission amount will be calculated as the difference of the retail price and the wholesale price charged to the agent. For example, a business can charge a fixed wholesale price of US $30 on a retail price of US $50. The commission amount thus offered to the agent will be US $20.\",\n \"ruleValueTypeArray\": [\n 1\n ],\n \"ruleParameterArray\": [\n 8\n ],\n \"channelType\": 1005\n },\n {\n \"id\": \"6\",\n \"ruleName\": \"Cost Markup\",\n \"description\": \"This is Agent rule. This rule is used to define an agent commission based on the cost. Your business can use this rule to define a percentage on the cost of the product for the agent commission amount.\",\n \"ruleValueTypeArray\": [\n 2\n ],\n \"ruleParameterArray\": [\n 1\n ],\n \"channelType\": 1005\n }\n ],\n \"status\": \"OK\"\n}\n"}],"_postman_id":"b933475f-a785-47f1-934c-0ab82e23bf24"}],"id":"c932baea-0583-45c2-9fb0-fa21e89876cc","description":"In this section we will discuss about retrieving the settlement policy. Various example are added with different URL parameters.
\n","_postman_id":"c932baea-0583-45c2-9fb0-fa21e89876cc"},{"name":"Update a Settlement Policy","item":[{"name":"Update a settlement Policy","id":"8d1a3021-a230-4c7a-ab44-5783879c4f3a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"PUT","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"id\": \"4902\",\r\n \"policyName\": \"Channel Settlement Contract\",\r\n \"description\": \"This settlement policy contains the settlement between the business and their Partner & Agents\",\r\n \"systemPolicy\": \"False\",\r\n \"settlementPolicyRuleArray\": [\r\n {\r\n \"id\": \"5804\",\r\n \"channelType\": \"1005\",\r\n \"subChannelTypeId\": \"6\",\r\n \"ruleId\": \"6\",\r\n \"value\": \"10\",\r\n \"valueType\": \"2\",\r\n \"start\": \"2023-01-06T00:00:00-00:00\",\r\n \"end\": \"2023-30-06T00:00:00-00:00\"\r\n }\r\n ]\r\n}\r\n"},"url":"{{Host}}/rest/ProductService/v1/products/settlementpolicy","description":"This API is used to update a settlement policy, fields like rule value, and etc can be modified.
\nData Parameter
\nIn this section information regarding the data parameters is provided. Data Parameters.
\n","urlObject":{"path":["rest","ProductService","v1","products","settlementpolicy"],"host":["{{Host}}"],"query":[],"variable":[]}},"response":[{"id":"45c72cc3-7d85-4e3d-8dff-177d29014fff","name":"Update a settlement Policy","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"id\": \"4902\",\r\n \"policyName\": \"Channel Settlement Contract\",\r\n \"description\": \"This settlement policy contains the settlement between the business and their Partner & Agents\",\r\n \"systemPolicy\": \"False\",\r\n \"settlementPolicyRuleArray\": [\r\n {\r\n \"id\": \"5804\",\r\n \"channelType\": \"1005\",\r\n \"subChannelTypeId\": \"6\",\r\n \"ruleId\": \"6\",\r\n \"value\": \"10\",\r\n \"valueType\": \"2\",\r\n \"start\": \"2023-01-06T00:00:00-00:00\",\r\n \"end\": \"2023-30-06T00:00:00-00:00\"\r\n }\r\n ]\r\n}\r\n"},"url":"{{Host}}/rest/ProductService/v1/products/settlementpolicy"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Thu, 06 Jul 2023 07:46:24 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"27"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"*, Content-Type, Pragma, Origin, Authorization, party, X-XSRF-TOKEN, X-Requested-With,Access-Control-Allow-Headers,Accept,Access-Control-Allow-Credentials,X-Auth-Token, version, cache"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST,OPTIONS,PUT,DELETE,GET"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"4902\",\n \"status\": \"OK\"\n}\n"}],"_postman_id":"8d1a3021-a230-4c7a-ab44-5783879c4f3a"}],"id":"93687e69-efd2-474a-8ba8-30e3e72703c6","description":"This section will discuss about the operations related to update settlement policy. Various examples are added for your reference.
\n","_postman_id":"93687e69-efd2-474a-8ba8-30e3e72703c6"}],"id":"d324da43-f68c-4b12-8e06-e100c50f214b","description":"In this section we will discuss about the settlement and it's operations. Like creating a settlement policy, updating a settlement policy, and fetching the settlement policy details.
\n","_postman_id":"d324da43-f68c-4b12-8e06-e100c50f214b"}],"id":"c042aa1f-c4fe-4b52-baf0-f12b5ccbaee1","description":"This section deals with the various APIs required to manage partner accounts and their corresponding operations in the application.
\n","_postman_id":"c042aa1f-c4fe-4b52-baf0-f12b5ccbaee1"},{"name":"Subscription","item":[{"name":"Place an Order","item":[{"name":"Place an order with single Price Plan","id":"7ef041fd-148c-4907-89e1-d5f230a1b47c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"accountNumber\": \"OBD-SR15403\",\r\n \"orderState\": \"1005\",\r\n \"orderElement\": [\r\n {\r\n \"quantity\": \"2\",\r\n \"actionType\": \"New\",\r\n \"referenceId\": \"10502\"\r\n }\r\n ]\r\n}"},"url":"{{Host}}/rest/OrderService/v1/order","description":"This API is used to place an order for your subscribers. Refer this example for placing order with single price plan.
\nData Paramters
\nThis section will provide the information data parameters of the request. Data Parameters.
\n","urlObject":{"path":["rest","OrderService","v1","order"],"host":["{{Host}}"],"query":[],"variable":[]}},"response":[{"id":"1faff1bf-6832-445d-9ceb-de35d45eeca3","name":"Place an order with single Price Plan","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"accountNumber\": \"OBD-SR15403\",\r\n \"orderState\": \"1005\",\r\n \"orderElement\": [\r\n {\r\n \"quantity\": \"2\",\r\n \"actionType\": \"New\",\r\n \"referenceId\": \"10502\"\r\n }\r\n ]\r\n}"},"url":"{{Host}}/rest/OrderService/v1/order"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 28 Jun 2023 09:29:07 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"120"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"*, Content-Type, Pragma, Origin, Authorization, party, X-XSRF-TOKEN, X-Requested-With,Access-Control-Allow-Headers,Accept,Access-Control-Allow-Credentials,X-Auth-Token, version, cache"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST,OPTIONS,PUT,DELETE,GET"}],"cookie":[],"responseTime":null,"body":"{\n \"accountNumber\": \"OBD-SR15403\",\n \"orderNumber\": \"OBD-OR36127\",\n \"orderName\": \"OBD-OR36127\",\n \"orderAmount\": 0,\n \"status\": \"OK\"\n}\n"}],"_postman_id":"7ef041fd-148c-4907-89e1-d5f230a1b47c"},{"name":"Place an order by providing a flexible discount","id":"32c7be9c-f2d7-4ea0-b5d1-2560b42ab361","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Bearer {{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"accountNumber\": \"OBD-SR15403\",\r\n \"orderElement\": [\r\n {\r\n \"quantity\": \"1\",\r\n \"referenceId\": \"10502\",\r\n \"actionType\": \"New\",\r\n \"flexibleDiscountCycle\":\"1,3-5,7\",\r\n \"overridenVariableDiscount\":\"20\"\r\n }\r\n ]\r\n}"},"url":"{{Host}}/rest/OrderService/v1/order","description":"This API is used to place an order by providing a flexible discount. Refer this request if you wish to place an order with discount added to order.
\nData Paramters
\nThis section will provide the information data parameters of the request. Data Parameters.
\n","urlObject":{"path":["rest","OrderService","v1","order"],"host":["{{Host}}"],"query":[],"variable":[]}},"response":[{"id":"90922b39-954a-47fd-a06b-3b2ee5fb75d2","name":"Place an order by providing a flexible discount","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"accountNumber\": \"OBD-SR15403\",\r\n \"orderElement\": [\r\n {\r\n \"quantity\": \"1\",\r\n \"referenceId\": \"10502\",\r\n \"actionType\": \"New\",\r\n \"flexibleDiscountCycle\":\"1,3-5,7\",\r\n \"overridenVariableDiscount\":\"20\"\r\n }\r\n ]\r\n}"},"url":"{{Host}}/rest/OrderService/v1/order"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 28 Jun 2023 09:34:13 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"120"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"*, Content-Type, Pragma, Origin, Authorization, party, X-XSRF-TOKEN, X-Requested-With,Access-Control-Allow-Headers,Accept,Access-Control-Allow-Credentials,X-Auth-Token, version, cache"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST,OPTIONS,PUT,DELETE,GET"}],"cookie":[],"responseTime":null,"body":"{\n \"accountNumber\": \"OBD-SR15403\",\n \"orderNumber\": \"OBD-OR36202\",\n \"orderName\": \"OBD-OR36202\",\n \"orderAmount\": 0,\n \"status\": \"OK\"\n}\n"}],"_postman_id":"32c7be9c-f2d7-4ea0-b5d1-2560b42ab361"},{"name":"Place an order for a bundle","id":"86deabe8-4a2e-4296-a72b-c4ffa8847d52","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"accountNumber\": \"OBD-SR15403\",\r\n \"orderState\": \"1005\",\r\n \"orderElement\": [\r\n {\r\n \"actionType\": \"New\",\r\n \"quantity\": \"1\",\r\n \"referenceId\": \"2001801\",\r\n \"type\":1\r\n }\r\n ]\r\n}"},"url":"{{Host}}/rest/OrderService/v1/order","description":"This API is used to place an order for the bundles. Bundles is a collection of products provided as a combo package.
\nData Paramters
\nThis section will provide the information data parameters of the request. Data Parameters.
\n","urlObject":{"path":["rest","OrderService","v1","order"],"host":["{{Host}}"],"query":[],"variable":[]}},"response":[{"id":"e4370c4f-fc53-45c0-b895-30486669d5dd","name":"Place an order for a bundle","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"accountNumber\": \"OBD-SR15403\",\r\n \"orderState\": \"1005\",\r\n \"orderElement\": [\r\n {\r\n \"actionType\": \"New\",\r\n \"quantity\": \"1\",\r\n \"referenceId\": \"2001801\",\r\n \"type\":1\r\n }\r\n ]\r\n}"},"url":"{{Host}}/rest/OrderService/v1/order"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 28 Jun 2023 09:55:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"120"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"*, Content-Type, Pragma, Origin, Authorization, party, X-XSRF-TOKEN, X-Requested-With,Access-Control-Allow-Headers,Accept,Access-Control-Allow-Credentials,X-Auth-Token, version, cache"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST,OPTIONS,PUT,DELETE,GET"}],"cookie":[],"responseTime":null,"body":"{\n \"accountNumber\": \"OBD-SR15403\",\n \"orderNumber\": \"OBD-OR36128\",\n \"orderName\": \"OBD-OR36128\",\n \"orderAmount\": 2,\n \"status\": \"OK\"\n}\n"}],"_postman_id":"86deabe8-4a2e-4296-a72b-c4ffa8847d52"},{"name":"Place an order for a bundle by providing the subscription identifiers for the price plans","id":"94a385ab-88ba-412f-8d22-28114a937f20","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"accountNumber\": \"OBD-SR15403\",\r\n \"orderState\": \"1005\",\r\n \"orderElement\": [\r\n {\r\n \"actionType\": \"New\",\r\n \"quantity\": \"1\",\r\n \"referenceId\": \"10502\",\r\n \"type\":1,\r\n \"bundleService\": [\r\n {\r\n \"subscriptionIdentifier\": \"SUB_1234\",\r\n \"priceplanId\": \"13404\"\r\n },\r\n {\r\n \"subscriptionIdentifier\": \"SUB_5678\",\r\n \"priceplanId\": \"8303\"\r\n }\r\n ]\r\n }\r\n ]\r\n}"},"url":"{{Host}}/rest/OrderService/v1/order","description":"This API is used to place an order for bundles by assigning a subscription identifier.
\nData Paramters
\nThis section will provide the information data parameters of the request. Data Parameters.
\n","urlObject":{"path":["rest","OrderService","v1","order"],"host":["{{Host}}"],"query":[],"variable":[]}},"response":[{"id":"28b6e55d-ad02-478b-9b18-99b436b2025d","name":"Place an order for a bundle by providing the subscription identifiers for the price plans","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"accountNumber\": \"OBD-SR15403\",\r\n \"orderState\": \"1005\",\r\n \"orderElement\": [\r\n {\r\n \"actionType\": \"New\",\r\n \"quantity\": \"1\",\r\n \"referenceId\": \"10502\",\r\n \"type\":1,\r\n \"bundleService\": [\r\n {\r\n \"subscriptionIdentifier\": \"SUB_1234\",\r\n \"priceplanId\": \"13404\"\r\n },\r\n {\r\n \"subscriptionIdentifier\": \"SUB_5678\",\r\n \"priceplanId\": \"8303\"\r\n }\r\n ]\r\n }\r\n ]\r\n}"},"url":"{{Host}}/rest/OrderService/v1/order"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 28 Jun 2023 10:02:17 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"160"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"*, Content-Type, Pragma, Origin, Authorization, party, X-XSRF-TOKEN, X-Requested-With,Access-Control-Allow-Headers,Accept,Access-Control-Allow-Credentials,X-Auth-Token, version, cache"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST,OPTIONS,PUT,DELETE,GET"}],"cookie":[],"responseTime":null,"body":"{\n \"accountNumber\": \"OBD-SR15403\",\n \"orderNumber\": \"OR22903\",\n \"orderName\": \"OR22903\",\n \"status\": \"OK\"\n}"}],"_postman_id":"94a385ab-88ba-412f-8d22-28114a937f20"},{"name":"Place an order for multiple price plans","id":"7840288c-e1e3-4c49-885b-0944efc5d95c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"accountNumber\": \"OBD-SR15403\",\r\n \"orderState\": \"1001\",\r\n \"orderElement\": [\r\n {\r\n \"quantity\": \"1\",\r\n \"referenceId\": \"11604\",\r\n \"fulfilledDate\": \"2023-06-01T00:00:00-08:00\",\r\n \"actionType\": \"New\",\r\n \"subscriptionIdentifier\": \"SUB24511-Internet Service1\"\r\n },\r\n {\r\n \"quantity\": \"1\",\r\n \"referenceId\": \"11613\",\r\n \"fulfilledDate\": \"2023-06-01T00:00:00-08:00\",\r\n \"actionType\": \"New\",\r\n \"subscriptionIdentifier\": \"SUB24511-SMS Service1\"\r\n }\r\n ]\r\n}"},"url":"{{Host}}/rest/OrderService/v1/order","description":"This API is used to place order with multiple price plan using single request. Provide multiple price plan id in reference id to place order.
\nData Paramters
\nThis section will provide the information data parameters of the request. Data Parameters.
\n","urlObject":{"path":["rest","OrderService","v1","order"],"host":["{{Host}}"],"query":[],"variable":[]}},"response":[{"id":"d5f775d9-c8b8-4f7f-ac75-8110c05acbb0","name":"Place an order for multiple price plans","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"accountNumber\": \"OBD-SR15403\",\r\n \"orderState\": \"1001\",\r\n \"orderElement\": [\r\n {\r\n \"quantity\": \"1\",\r\n \"referenceId\": \"11604\",\r\n \"fulfilledDate\": \"2023-06-01T00:00:00-08:00\",\r\n \"actionType\": \"New\",\r\n \"subscriptionIdentifier\": \"SUB24511-Internet Service1\"\r\n },\r\n {\r\n \"quantity\": \"1\",\r\n \"referenceId\": \"11613\",\r\n \"fulfilledDate\": \"2023-06-01T00:00:00-08:00\",\r\n \"actionType\": \"New\",\r\n \"subscriptionIdentifier\": \"SUB24511-SMS Service1\"\r\n }\r\n ]\r\n}"},"url":"{{Host}}/rest/OrderService/v1/order"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 28 Jun 2023 10:28:26 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"123"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"*, Content-Type, Pragma, Origin, Authorization, party, X-XSRF-TOKEN, X-Requested-With,Access-Control-Allow-Headers,Accept,Access-Control-Allow-Credentials,X-Auth-Token, version, cache"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST,OPTIONS,PUT,DELETE,GET"}],"cookie":[],"responseTime":null,"body":"{\n \"accountNumber\": \"OBD-SR15403\",\n \"orderNumber\": \"OBD-OR36204\",\n \"orderName\": \"OBD-OR36204\",\n \"orderAmount\": 1138.1,\n \"status\": \"OK\"\n}\n"}],"_postman_id":"7840288c-e1e3-4c49-885b-0944efc5d95c"}],"id":"8fd56eaa-190c-4177-b9de-713c96f6751a","description":"In this section will discuss about operations related to place order. Through various examples will cater different use case scenarios for placing the order.
\n","_postman_id":"8fd56eaa-190c-4177-b9de-713c96f6751a"},{"name":"Search an Order","item":[{"name":"Search order","id":"9bc83ba3-f444-427a-b228-ece4ee2d079d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"}],"url":"{{Host}}/rest/OrderService/v1/orders","description":"This API is used to fetch details about the order. It will fetch the details of all the orders available in the application.
\n","urlObject":{"path":["rest","OrderService","v1","orders"],"host":["{{Host}}"],"query":[],"variable":[]}},"response":[{"id":"e0285b7f-4aae-4190-bb07-011a49366330","name":"Search order","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer{{token}}"}],"url":"{{Host}}/rest/OrderService/v1/orders"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 05 Jul 2023 11:20:01 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"*, Content-Type, Pragma, Origin, Authorization, party, X-XSRF-TOKEN, X-Requested-With,Access-Control-Allow-Headers,Accept,Access-Control-Allow-Credentials,X-Auth-Token, version, cache"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST,OPTIONS,PUT,DELETE,GET"}],"cookie":[],"responseTime":null,"body":"{\n \"totalCount\": 3,\n \"startCount\": 0,\n \"endCount\": 99,\n \"order\": [\n {\n \"orderId\": \"1655437591203318852\",\n \"accountNumber\": \"OBD-SR15403\",\n \"accountName\": \"John Hallet\",\n \"orderName\": \"OBD-OR36807\",\n \"orderNumber\": \"OBD-OR36807\",\n \"orderAmount\": \"700.0000\",\n \"state\": 1005,\n \"createdDate\": \"2023-07-05T04:17:58-07:00\",\n \"fulfilledDate\": \"2023-07-05T00:00:00-07:00\",\n \"itemCount\": 1,\n \"orderType\": 2,\n \"orderSubmissionDate\": \"2023-07-05T04:17:58-07:00\",\n \"accountId\": \"15702\",\n \"orderStatus\": \"Pending Billing\",\n \"sellerName\": \"Totogi\",\n \"currencySymbol\": \"$\",\n \"partyRoleId\": \"2\",\n \"submitter\": \"SYSTEM\"\n },\n {\n \"orderId\": \"1655436456602143811\",\n \"accountNumber\": \"OBD-SR15403\",\n \"accountName\": \"John Hallet\",\n \"orderName\": \"OBD-OR36806\",\n \"orderNumber\": \"OBD-OR36806\",\n \"orderAmount\": \"100.0000\",\n \"state\": 1006,\n \"createdDate\": \"2023-07-05T04:13:28-07:00\",\n \"orderDate\": \"2023-07-01T00:00:00-07:00\",\n \"fulfilledDate\": \"2023-07-01T00:00:00-07:00\",\n \"itemCount\": 1,\n \"orderType\": 2,\n \"orderSubmissionDate\": \"2023-07-05T04:13:28-07:00\",\n \"accountId\": \"15702\",\n \"orderStatus\": \"Billing Active\",\n \"sellerName\": \"Totogi\",\n \"currencySymbol\": \"$\",\n \"partyRoleId\": \"2\",\n \"submitter\": \"Totogi Demo\"\n },\n {\n \"orderId\": \"1594906536914742329\",\n \"accountNumber\": \"OBD-SR15003\",\n \"accountName\": \"john mike\",\n \"orderName\": \"OBD-OR28604\",\n \"orderNumber\": \"OBD-OR28604\",\n \"orderAmount\": \"760.0000\",\n \"state\": 1006,\n \"createdDate\": \"2023-01-19T02:29:10-08:00\",\n \"orderDate\": \"2023-01-19T00:00:00-08:00\",\n \"fulfilledDate\": \"2023-01-19T00:00:00-08:00\",\n \"itemCount\": 1,\n \"orderType\": 2,\n \"orderSubmissionDate\": \"2023-01-19T02:29:10-08:00\",\n \"accountId\": \"14803\",\n \"orderStatus\": \"Billing Active\",\n \"sellerName\": \"Totogi\",\n \"currencySymbol\": \"INR \",\n \"partyRoleId\": \"2\",\n \"submitter\": \"Pavan BV\"\n }\n ],\n \"status\": \"OK\"\n}"}],"_postman_id":"9bc83ba3-f444-427a-b228-ece4ee2d079d"},{"name":"Search order using order number","id":"9e1d114f-85c7-4fdf-a38f-ba9efc364cc2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"}],"url":"{{Host}}/rest/OrderService/v1/orders/?{Order_Number}","description":"This API is used to search order using order number. This will provide you specific details regarding the order.
\n","urlObject":{"path":["rest","OrderService","v1","orders",""],"host":["{{Host}}"],"query":[{"description":{"content":"Enter the order number to fetch the order details.\nExample: OBD-OR36807
\n","type":"text/plain"},"key":"{Order_Number}","value":null}],"variable":[]}},"response":[{"id":"e5ff2634-467f-4941-8df9-2e8dde83348b","name":"Search order using order number","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"}],"url":{"raw":"{{Host}}/rest/OrderService/v1/orders/?{Order_Number}","host":["{{Host}}"],"path":["rest","OrderService","v1","orders",""],"query":[{"key":"{Order_Number}","value":null,"description":"Enter the order number to fetch the order details.\nExample: OBD-OR36807"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 05 Jul 2023 11:26:18 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"2324"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"*, Content-Type, Pragma, Origin, Authorization, party, X-XSRF-TOKEN, X-Requested-With,Access-Control-Allow-Headers,Accept,Access-Control-Allow-Credentials,X-Auth-Token, version, cache"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST,OPTIONS,PUT,DELETE,GET"}],"cookie":[],"responseTime":null,"body":"{\n \"accountNumber\": \"OBD-SR15403\",\n \"orderNumber\": \"OBD-OR36807\",\n \"orderId\": \"1655437591203318852\",\n \"orderState\": \"1005\",\n \"orderLevelDiscount\": false,\n \"orderName\": \"OBD-OR36807\",\n \"customerDetail\": {\n \"accContactId\": \"16705\",\n \"billAddId\": \"16304\"\n },\n \"orderElement\": [\n {\n \"type\": \"2\",\n \"subscriptionIdentifier\": \"MODIFYTEST\",\n \"instanceId\": \"20209\",\n \"referenceId\": \"18606\",\n \"actionType\": \"changed\",\n \"elementId\": \"1655437591329155573\",\n \"quantity\": \"7.00\",\n \"fulfilledDate\": \"2023-07-05T00:00:00-07:00\",\n \"term\": 0,\n \"termMode\": \"N\",\n \"alignToCycle\": false,\n \"termAction\": 0,\n \"chargeDetail\": {\n \"grossAmount\": \"700.0000\",\n \"discountAmount\": \"0.0000\",\n \"customDiscountAmount\": \"0\",\n \"netAmount\": \"700.0000\",\n \"taxAmount\": \"0.0000\",\n \"trialDiscount\": \"0.0000\",\n \"couponDiscount\": \"0.0000\",\n \"subtotal\": \"700.0000\"\n },\n \"chargeLevelDetails\": [\n {\n \"chargeId\": \"19706\",\n \"grossAmount\": \"700.0000\",\n \"discountAmount\": \"0.0000\",\n \"customDiscountAmount\": \"0\",\n \"netAmount\": \"700.0000\",\n \"taxAmount\": \"0.0000\",\n \"eventType\": \"REC\",\n \"stepMode\": 0,\n \"invoiceDescription\": \"Recurring Charge\",\n \"eventName\": \"MONTHLY\",\n \"chargeMode\": 1,\n \"unitGrossAmount\": \"100.0000\",\n \"unitSubtotal\": \"100.0000\",\n \"subtotal\": \"700.0000\",\n \"taxLineItem\": {},\n \"margins\": [\n {\n \"wholesaleCost\": 0,\n \"wholesaleTotalCost\": 0,\n \"wholesaleMargin\": 700,\n \"wholesaleMarginPercentage\": 100,\n \"totalRevenue\": 700,\n \"revenueUnitPrice\": 100,\n \"partyRoleId\": 2,\n \"taxAmount\": 0,\n \"taxUnitPrice\": 0\n }\n ]\n }\n ],\n \"overrideCharge\": [\n {\n \"chargeType\": \"REC\",\n \"chargeId\": \"19706\",\n \"priceplanEventId\": \"18906\",\n \"amount\": 100\n }\n ],\n \"overrideSettlementRuleArray\": [],\n \"shipAddId\": \"16304\",\n \"productName\": \"RECURRING1\",\n \"productDescription\": \"RECURRING1
URL Params
\nMandatory:
\n- \n
- searchString - [string]: This is the field for giving the string which should be searched. \n
- searchBy: This is the field, based on what it has to be searched. list of supported parameter. \n
- orderNumber: The specific number allocated to the order. \n
- AccountNumber: The account number of the subscriber whose invoices we are fetching. \n
- OrderName: The order name can be also used in the search by \n
- startCount: [int]: The count with which the response must start with. The default value must be set to \"0\".
resultCount - [int]: This is the number of response elements which the response must show. \n
Optional:
\n- \n
- orderBy - [string]: This determines what field of the output response must the entire response should be ordered with. \n
- ascending - [boolean]: This field is used to determine if the output should be displayed in ascending or not. \n
In this section will discuss about retrieving the order details using various example will fetch the details.
\n","_postman_id":"dc7d8b92-cd99-4aad-baed-192ece4c5584"},{"name":"Operation on Subscription","item":[{"name":"Subscription Cancellation","id":"a0d3af83-bf9c-456d-adb4-569977650466","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"accountNumber\": \"OBD-SR15403\",\r\n \"orderElement\": [\r\n {\r\n \"quantity\": \"1\",\r\n \"subscriptionIdentifier\": \"OBD-SR15403-Product1\",\r\n \"referenceId\": \"16502\",\r\n \"fulfilledDate\": \"2023-05-07T00:00:00-08:00\",\r\n \"reasonCode\": \"ORD-RC1002\",\r\n \"actionType\": \"Cancel\",\r\n \"releaseIdentifier\": \"false\"\r\n }\r\n ]\r\n}"},"url":"{{Host}}/rest/OrderService/v1/order","description":"This API is used to cancel the subscription.
\nData Paramters
\nThis section will provide the information data parameters of the request. Data Parameters.
\n","urlObject":{"path":["rest","OrderService","v1","order"],"host":["{{Host}}"],"query":[],"variable":[]}},"response":[{"id":"c4cd3761-95bc-45b9-a97c-8baa4bab7d58","name":"Subscription Cancellation","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"accountNumber\": \"OBD-SR15403\",\r\n \"orderElement\": [\r\n {\r\n \"quantity\": \"1\",\r\n \"subscriptionIdentifier\": \"OBD-SR15403-Product1\",\r\n \"referenceId\": \"16502\",\r\n \"fulfilledDate\": \"2023-05-07T00:00:00-08:00\",\r\n \"reasonCode\": \"ORD-RC1002\",\r\n \"actionType\": \"Cancel\",\r\n \"releaseIdentifier\": \"false\"\r\n }\r\n ]\r\n}"},"url":"{{Host}}/rest/OrderService/v1/order"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 05 Jul 2023 06:44:53 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"122"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"*, Content-Type, Pragma, Origin, Authorization, party, X-XSRF-TOKEN, X-Requested-With,Access-Control-Allow-Headers,Accept,Access-Control-Allow-Credentials,X-Auth-Token, version, cache"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST,OPTIONS,PUT,DELETE,GET"}],"cookie":[],"responseTime":null,"body":"{\n \"accountNumber\": \"OBD-SR15403\",\n \"orderNumber\": \"OBD-OR36702\",\n \"orderName\": \"OBD-OR36702\",\n \"orderAmount\": 100,\n \"status\": \"OK\"\n}"}],"_postman_id":"a0d3af83-bf9c-456d-adb4-569977650466"},{"name":"Purchase an add-on product for an existing subscription.","id":"4bc0da99-b8ce-4107-9257-1343533d61a9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"accountNumber\": \"OBD-SR15403\",\r\n \"orderState\": \"1005\",\r\n \"orderElement\": [\r\n {\r\n \"quantity\": \"1\",\r\n \"referenceId\": \"11605\",\r\n \"fulfilledDate\": \"2019-04-01T00:00:00-08:00\",\r\n \"actionType\": \"New\",\r\n \"subscriptionIdentifier\": \"OBD-SR15403-Product1\"\r\n }\r\n ]\r\n}"},"url":"{{Host}}/rest/OrderService/v1/order","description":"This API is used to place order for an Add-on for an existing subscription.
\n- \n
- Ensure that the subscription identifier passed is accurate. \n
- Use the Get Order or the Get Subscriptions based on Account Number REST APIs to determine the proper subscription identifier. \n
Data Paramters
\nThis section will provide the information data parameters of the request. Data Parameters.
\n","urlObject":{"path":["rest","OrderService","v1","order"],"host":["{{Host}}"],"query":[],"variable":[]}},"response":[{"id":"7923f3d1-7262-47df-8b37-8be0c8a8263d","name":"Purchase an add-on product for an existing subscription.","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"accountNumber\": \"OBD-SR15403\",\r\n \"orderState\": \"1005\",\r\n \"orderElement\": [\r\n {\r\n \"quantity\": \"1\",\r\n \"referenceId\": \"11605\",\r\n \"fulfilledDate\": \"2019-04-01T00:00:00-08:00\",\r\n \"actionType\": \"New\",\r\n \"subscriptionIdentifier\": \"OBD-SR15403-Product1\"\r\n }\r\n ]\r\n}"},"url":"{{Host}}/rest/OrderService/v1/order"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 05 Jul 2023 07:12:42 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"123"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"*, Content-Type, Pragma, Origin, Authorization, party, X-XSRF-TOKEN, X-Requested-With,Access-Control-Allow-Headers,Accept,Access-Control-Allow-Credentials,X-Auth-Token, version, cache"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST,OPTIONS,PUT,DELETE,GET"}],"cookie":[],"responseTime":null,"body":"{\n \"accountNumber\": \"OBD-SR15403\",\n \"orderNumber\": \"OBD-OR36703\",\n \"orderName\": \"OBD-OR36703\",\n \"orderAmount\": 2000,\n \"status\": \"OK\"\n}\n"}],"_postman_id":"4bc0da99-b8ce-4107-9257-1343533d61a9"},{"name":"Place an order to switch price plans of an existing subscription.","id":"6e41b908-ba86-4844-8a1d-e98e694e8260","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"accountNumber\": \"OBD-SR15403\",\r\n \"orderState\": \"1005\",\r\n \"orderElement\": [\r\n {\r\n \"quantity\": \"1\",\r\n \"type\": \"2\",\r\n \"actionType\": \"ChangePriceplan\",\r\n \"referenceId\": \"12114\",\r\n \"fulfilledDate\": \"2022-02-01T00:00:00+05:30\",\r\n \"subscriptionIdentifier\": \"OBD-SR15403-Product1\"\r\n }\r\n ]\r\n}"},"url":"{{Host}}/rest/OrderService/v1/order","description":"This is API is used switch the existing subscription to another.
\nData Paramters
\nThis section will provide the information data parameters of the request. Data Parameters.
\n","urlObject":{"path":["rest","OrderService","v1","order"],"host":["{{Host}}"],"query":[],"variable":[]}},"response":[{"id":"0402bc6e-f8b7-4463-bbec-b02a38bf4a97","name":"Place an order to switch price plans of an existing subscription.","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"accountNumber\": \"OBD-SR15403\",\r\n \"orderState\": \"1005\",\r\n \"orderElement\": [\r\n {\r\n \"quantity\": \"1\",\r\n \"type\": \"2\",\r\n \"actionType\": \"ChangePriceplan\",\r\n \"referenceId\": \"12114\",\r\n \"fulfilledDate\": \"2022-02-01T00:00:00+05:30\",\r\n \"subscriptionIdentifier\": \"OBD-SR15403-Product1\"\r\n }\r\n ]\r\n}"},"url":"{{Host}}/rest/OrderService/v1/order"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 05 Jul 2023 07:39:55 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"122"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"*, Content-Type, Pragma, Origin, Authorization, party, X-XSRF-TOKEN, X-Requested-With,Access-Control-Allow-Headers,Accept,Access-Control-Allow-Credentials,X-Auth-Token, version, cache"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST,OPTIONS,PUT,DELETE,GET"}],"cookie":[],"responseTime":null,"body":"{\n \"accountNumber\": \"OBD-SR15403\",\n \"orderNumber\": \"OBD-OR36803\",\n \"orderName\": \"OBD-OR36803\",\n \"orderAmount\": 999,\n \"status\": \"OK\"\n}\n"}],"_postman_id":"6e41b908-ba86-4844-8a1d-e98e694e8260"},{"name":"Increase the quantity of a subscription.","id":"c59861b7-4d40-4fa4-86a0-74e95b07cf8b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"accountNumber\": \"OBD-SR15403\",\r\n \"orderState\": \"1005\",\r\n \"orderElement\": [\r\n {\r\n \"quantity\": \"20\",\r\n \"type\": \"2\",\r\n \"actionType\": \"Changed\",\r\n \"referenceId\": \"18605\",\r\n \"subscriptionIdentifier\": \"OBD-SUB21703-OBD-SR15403-Octave Telephone\"\r\n }\r\n ]\r\n}"},"url":"{{Host}}/rest/OrderService/v1/order","description":"This API is used to increase the quantity of the subscription.
\nData Paramters
\nThis section will provide the information data parameters of the request. Data Parameters.
\n","urlObject":{"path":["rest","OrderService","v1","order"],"host":["{{Host}}"],"query":[],"variable":[]}},"response":[{"id":"7f4d762c-592b-426f-8925-7a2865e68a60","name":"Increase the quantity of a subscription.","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"accountNumber\": \"OBD-SR15403\",\r\n \"orderState\": \"1005\",\r\n \"orderElement\": [\r\n {\r\n \"quantity\": \"20\",\r\n \"type\": \"2\",\r\n \"actionType\": \"Changed\",\r\n \"referenceId\": \"18605\",\r\n \"subscriptionIdentifier\": \"OBD-SUB21703-OBD-SR15403-Octave Telephone\"\r\n }\r\n ]\r\n}"},"url":"{{Host}}/rest/OrderService/v1/order"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 05 Jul 2023 10:28:04 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"122"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"*, Content-Type, Pragma, Origin, Authorization, party, X-XSRF-TOKEN, X-Requested-With,Access-Control-Allow-Headers,Accept,Access-Control-Allow-Credentials,X-Auth-Token, version, cache"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST,OPTIONS,PUT,DELETE,GET"}],"cookie":[],"responseTime":null,"body":"{\n \"accountNumber\": \"OBD-SR15403\",\n \"orderNumber\": \"OBD-OR36805\",\n \"orderName\": \"OBD-OR36805\",\n \"orderAmount\": 567.7896,\n \"status\": \"OK\"\n}\n"}],"_postman_id":"c59861b7-4d40-4fa4-86a0-74e95b07cf8b"}],"id":"bb4a16b3-e7a1-4282-be98-3e1edda70db8","description":"This section is about operations available on the subscriptions. Such as cancellation, switch the plan, place order for add-on.
\n","_postman_id":"bb4a16b3-e7a1-4282-be98-3e1edda70db8"},{"name":"Validate an Order","item":[{"name":"Validate an order by providing minimum parameters.","id":"a283079b-b5ea-476a-83fd-03a23fc75767","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"accountNumber\": \"OBD-SR15403\",\r\n \"orderState\": \"1005\",\r\n \"orderElement\": [\r\n {\r\n \"actionType\": \"New\",\r\n \"quantity\": \"2\",\r\n \"referenceId\": \"11613\",\r\n \"type\": 2\r\n }\r\n ]\r\n}"},"url":"{{Host}}/rest/OrderService/v1/order/validate","description":"Validate Order
\nThis API is used to validate an order for errors before placing the order in the system. It can be used for the following operations too.
\n- \n
- increase/decrease the quantity of a subscription \n
- change price plans within a product \n
- cancelling a subscription \n
- suspend/resume a subscription \n
Data Paramters
\nThis section will provide the information data parameters of the request. Data Parameters.
\n","urlObject":{"path":["rest","OrderService","v1","order","validate"],"host":["{{Host}}"],"query":[],"variable":[]}},"response":[{"id":"a5cd8b82-6ca7-430b-a080-1dafdd4140f0","name":"Validate an order by providing minimum parameters.","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"accountNumber\": \"OBD-SR15403\",\r\n \"orderState\": \"1005\",\r\n \"orderElement\": [\r\n {\r\n \"actionType\": \"New\",\r\n \"quantity\": \"2\",\r\n \"referenceId\": \"11613\",\r\n \"type\": 2\r\n }\r\n ]\r\n}"},"url":"{{Host}}/rest/OrderService/v1/order/validate"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 05 Jul 2023 12:05:58 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"1348"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"*, Content-Type, Pragma, Origin, Authorization, party, X-XSRF-TOKEN, X-Requested-With,Access-Control-Allow-Headers,Accept,Access-Control-Allow-Credentials,X-Auth-Token, version, cache"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST,OPTIONS,PUT,DELETE,GET"}],"cookie":[],"responseTime":null,"body":"{\n \"accountNumber\": \"OBD-SR15403\",\n \"chargeDetail\": {\n \"grossAmount\": \"1198.0000\",\n \"discountAmount\": \"0.0000\",\n \"netAmount\": \"1198.0000\",\n \"taxAmount\": \"0.0000\",\n \"trialDiscount\": \"0.0000\",\n \"couponDiscount\": \"0.0000\",\n \"subtotal\": \"1198.0000\"\n },\n \"element\": [\n {\n \"type\": \"2\",\n \"referenceId\": \"11613\",\n \"quantity\": \"2\",\n \"elementIndex\": 1,\n \"isAddon\": false,\n \"elementDetail\": [\n {\n \"priceplanId\": \"11613\",\n \"productId\": \"10803\",\n \"applyPromotion\": true,\n \"quantity\": \"2\",\n \"priceEffectiveDate\": \"2023-07-05T05:05:58-07:00\",\n \"productDiscountable\": false,\n \"chargeDetail\": [\n {\n \"chargeId\": \"12055\",\n \"grossAmount\": \"1198.0000\",\n \"discountAmount\": \"0.0000\",\n \"customDiscountAmount\": \"0\",\n \"netAmount\": \"1198.0000\",\n \"taxAmount\": \"0.0000\",\n \"eventType\": \"REC\",\n \"stepMode\": 0,\n \"invoiceDescription\": \"Recurring Charge\",\n \"eventName\": \"MONTHLY\",\n \"chargeMode\": 1,\n \"unitGrossAmount\": \"599.0000\",\n \"unitSubtotal\": \"599.0000\",\n \"subtotal\": \"1198.0000\",\n \"margins\": [\n {\n \"wholesaleCost\": 0,\n \"wholesaleTotalCost\": 0,\n \"wholesaleMargin\": 1198,\n \"wholesaleMarginPercentage\": 100,\n \"totalRevenue\": 1198,\n \"revenueUnitPrice\": 599,\n \"cost\": 0,\n \"attributes\": \"{\\\"cc\\\":[]}\",\n \"partyRoleId\": 2,\n \"taxAmount\": 0,\n \"taxUnitPrice\": 0\n }\n ]\n }\n ]\n }\n ],\n \"chargeDetail\": {\n \"grossAmount\": \"1198.0000\",\n \"discountAmount\": \"0.0000\",\n \"customDiscountAmount\": \"0.0000\",\n \"netAmount\": \"1198.0000\",\n \"taxAmount\": \"0.0000\",\n \"trialDiscount\": \"0.0000\",\n \"couponDiscount\": \"0.0000\",\n \"subtotal\": \"1198.0000\"\n },\n \"term\": 12\n }\n ],\n \"status\": \"OK\"\n}\n"}],"_postman_id":"a283079b-b5ea-476a-83fd-03a23fc75767"},{"name":"Validate an order comprising of valid values for the Override Settlement Rule Array.","id":"b281b096-e4a0-4484-bb83-de2a505631e3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"accountNumber\": \"OBD-SR15403\",\r\n \"orderLevelDiscount\": \"false\",\r\n \"orderLevelTerm\": \"false\",\r\n \"orderElement\": [\r\n {\r\n \"quantity\": \"1\",\r\n \"referenceId\": \"15603\",\r\n \"term\": \"2\",\r\n \"fulfilledDate\": \"2023-07-06T00:00:00-08:00\",\r\n \"actionType\": \"New\",\r\n \"overrideSettlementRuleArray\": [\r\n {\r\n \"chargeId\": \"16603\",\r\n \"settlementPolicyId\": \"4802\",\r\n \"overrideAgentRuleValueArray\": [\r\n {\r\n \"settlementPolicyRuleId\": \"5502\",\r\n \"ruleValue\": 25\r\n }\r\n ]\r\n }\r\n ]\r\n }\r\n ]\r\n}"},"url":"{{Host}}/rest/OrderService/v1/order/validate","description":"This API is used to validate the order with settlement rule.
\nData Paramters
\nThis section will provide the information data parameters of the request. Data Parameters.
\n","urlObject":{"path":["rest","OrderService","v1","order","validate"],"host":["{{Host}}"],"query":[],"variable":[]}},"response":[{"id":"115e6ebe-0433-49cc-afba-dfe1e3dbf259","name":"Validate an order comprising of valid values for the Override Settlement Rule Array.","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"accountNumber\": \"OBD-SR15403\",\r\n \"orderLevelDiscount\": \"false\",\r\n \"orderLevelTerm\": \"false\",\r\n \"orderElement\": [\r\n {\r\n \"quantity\": \"1\",\r\n \"referenceId\": \"15603\",\r\n \"term\": \"2\",\r\n \"fulfilledDate\": \"2023-07-06T00:00:00-08:00\",\r\n \"actionType\": \"New\",\r\n \"overrideSettlementRuleArray\": [\r\n {\r\n \"chargeId\": \"16603\",\r\n \"settlementPolicyId\": \"4802\",\r\n \"overrideAgentRuleValueArray\": [\r\n {\r\n \"settlementPolicyRuleId\": \"5502\",\r\n \"ruleValue\": 25\r\n }\r\n ]\r\n }\r\n ]\r\n }\r\n ]\r\n}"},"url":"{{Host}}/rest/OrderService/v1/order/validate"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Thu, 06 Jul 2023 06:13:52 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"1564"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"*, Content-Type, Pragma, Origin, Authorization, party, X-XSRF-TOKEN, X-Requested-With,Access-Control-Allow-Headers,Accept,Access-Control-Allow-Credentials,X-Auth-Token, version, cache"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST,OPTIONS,PUT,DELETE,GET"}],"cookie":[],"responseTime":null,"body":"{\n \"accountNumber\": \"OBD-SR15403\",\n \"chargeDetail\": {\n \"grossAmount\": \"200.0000\",\n \"discountAmount\": \"0.0000\",\n \"netAmount\": \"236.0000\",\n \"taxAmount\": \"36.0000\",\n \"trialDiscount\": \"0.0000\",\n \"couponDiscount\": \"0.0000\",\n \"subtotal\": \"200.0000\"\n },\n \"element\": [\n {\n \"type\": \"2\",\n \"referenceId\": \"15603\",\n \"quantity\": \"1\",\n \"elementIndex\": 1,\n \"isAddon\": false,\n \"elementDetail\": [\n {\n \"priceplanId\": \"15603\",\n \"productId\": \"14203\",\n \"applyPromotion\": true,\n \"quantity\": \"1\",\n \"priceEffectiveDate\": \"2023-07-05T23:13:52-07:00\",\n \"productDiscountable\": false,\n \"chargeDetail\": [\n {\n \"chargeId\": \"16603\",\n \"grossAmount\": \"200.0000\",\n \"discountAmount\": \"0.0000\",\n \"customDiscountAmount\": \"0\",\n \"netAmount\": \"236.0000\",\n \"taxAmount\": \"36.0000\",\n \"eventType\": \"REC\",\n \"stepMode\": 0,\n \"invoiceDescription\": \"Recurring Charge\",\n \"eventName\": \"MONTHLY\",\n \"chargeMode\": 1,\n \"unitGrossAmount\": \"200.0000\",\n \"unitSubtotal\": \"200.0000\",\n \"subtotal\": \"200.0000\",\n \"taxLineItem\": {\n \"totalTax\": 36,\n \"lineItems\": [\n {\n \"code\": \"CGST\",\n \"description\": \"CGST\",\n \"taxAmount\": 18,\n \"taxConfig\": \"FlatTax_Multiple\"\n },\n {\n \"code\": \"SGST\",\n \"description\": \"SGST\",\n \"taxAmount\": 18,\n \"taxConfig\": \"FlatTax_Multiple\"\n }\n ]\n },\n \"margins\": [\n {\n \"wholesaleCost\": 0,\n \"wholesaleTotalCost\": 0,\n \"wholesaleMargin\": 200,\n \"wholesaleMarginPercentage\": 100,\n \"totalRevenue\": 200,\n \"revenueUnitPrice\": 200,\n \"cost\": 0,\n \"attributes\": \"{\\\"cc\\\":[]}\",\n \"partyRoleId\": 2,\n \"taxAmount\": 0,\n \"taxUnitPrice\": 0\n }\n ]\n }\n ]\n }\n ],\n \"chargeDetail\": {\n \"grossAmount\": \"200.0000\",\n \"discountAmount\": \"0.0000\",\n \"customDiscountAmount\": \"0.0000\",\n \"netAmount\": \"236.0000\",\n \"taxAmount\": \"36.0000\",\n \"trialDiscount\": \"0.0000\",\n \"couponDiscount\": \"0.0000\",\n \"subtotal\": \"200.0000\"\n },\n \"term\": 2\n }\n ],\n \"status\": \"OK\"\n}\n"}],"_postman_id":"b281b096-e4a0-4484-bb83-de2a505631e3"}],"id":"7bb72844-324d-4808-a1b0-9f1dfa85b6b2","description":"This API is used to validate the order ensure the parameters.
\n","_postman_id":"7bb72844-324d-4808-a1b0-9f1dfa85b6b2"},{"name":"Delete Transaction","id":"e4a36001-76ed-4595-bfc1-6590792123dc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"DELETE","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"}],"url":"{{Host}}/rest/SubscriberService/v1/subscribers/OBD-SR16003/bills/BI53403/transactions","description":"This API is used to delete the transaction under a subscriber account.
\nURL Parameter
\n- \n
Account number: Enter the account number of the subscriber account whose transaction you wish to delete.
\n \nBill number: Enter the bill number available under the transactions to delete the whole transaction irrespective of the charge type.
\n \n
In this section will discuss about the subscriptions like placing an order, updating the order, retrieving the order, and actions on subscription like suspend and cancellation.
\n","_postman_id":"b783487c-299f-4b18-a84c-1263fbfcdd3c"},{"name":"Rate a Usage Subscription","item":[{"name":"Rate a Usage Subscription","id":"5780a975-d430-4848-ae2c-52cbf113cf69","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"header\": \"AccountNumber,CallStartDateTime,CallEndDateTime,CallType,CallSource,CallDestination,Duration,PerMinRate,Amount,TierType,SourceCountry,SourceState,SourceLATA,SourceRateCenter,DestinationCountry,DestinationState,DestinationLATA,DesinationRateCenter,CallID,BdrID,SourceIP,DestinationIP,RateAttempts,LRN,SIPPeerID,LocationID\",\r\n \"transactions\": [\r\n \"2001082,2/28/2021 4:42:24 AM,2/28/2021 4:47:24 AM,INTERNATIONAL,7829065046,+491232212123,4386,0.0025,0.0125,0,US,MN,628,TWINCITIES,US,IN,336,IN_INDIANAPLS,327463240186,327463240186,121.33.16.85,1,13171231234, 2323\",\r\n \"2001082,2/28/2021 4:42:24 AM,2/28/2021 4:47:24 AM,INTERNATIONAL,7829065046,+441232212123,5724,0.0025,0.0125,0,US,MN,628,TWINCITIES,US,IN,336,IN_INDIANAPLS,327463240186,327463240186,121.33.16.85,1,13171231234,2323\",\r\n \"2001082,2/28/2021 4:42:24 AM,2/28/2021 4:47:24 AM,INTERNATIONAL,7829065046,+331232212123,7645,0.0025,0.0125,0,US,MN,628,TWINCITIES,US,IN,336,IN_INDIANAPLS,327463240186,327463240186,121.33.16.85,1,13171231234,2323\"\r\n ],\r\n \"importType\": \"0\",\r\n \"columnSeparator\": \",\",\r\n \"textDelimiter\": \"\\\"\",\r\n \"verifyOnly\": false,\r\n \"ratingEngineName\": \"BW_Demo\",\r\n \"fileName\": \"voice_usage.csv\",\r\n \"correlationId\": \"1234\"\r\n}"},"url":"{{Host}}/rest/UtilityService/v1/transactions","description":"This API is used to rate the usage subscription. Through this we can trigger the operation from REST API. Ensure you have configured the rating engine before running the API.
\nData Paramters
\nThis section will provide the information data parameters of the request. Data Parameters.
\n","urlObject":{"path":["rest","UtilityService","v1","transactions"],"host":["{{Host}}"],"query":[],"variable":[]}},"response":[{"id":"ed1fa762-af03-4592-9b97-cabc4ea14c03","name":"Rate a Usage Subscription","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"header\": \"AccountNumber,CallStartDateTime,CallEndDateTime,CallType,CallSource,CallDestination,Duration,PerMinRate,Amount,TierType,SourceCountry,SourceState,SourceLATA,SourceRateCenter,DestinationCountry,DestinationState,DestinationLATA,DesinationRateCenter,CallID,BdrID,SourceIP,DestinationIP,RateAttempts,LRN,SIPPeerID,LocationID\",\r\n \"transactions\": [\r\n \"2001082,2/28/2021 4:42:24 AM,2/28/2021 4:47:24 AM,INTERNATIONAL,7829065046,+491232212123,4386,0.0025,0.0125,0,US,MN,628,TWINCITIES,US,IN,336,IN_INDIANAPLS,327463240186,327463240186,121.33.16.85,1,13171231234, 2323\",\r\n \"2001082,2/28/2021 4:42:24 AM,2/28/2021 4:47:24 AM,INTERNATIONAL,7829065046,+441232212123,5724,0.0025,0.0125,0,US,MN,628,TWINCITIES,US,IN,336,IN_INDIANAPLS,327463240186,327463240186,121.33.16.85,1,13171231234,2323\",\r\n \"2001082,2/28/2021 4:42:24 AM,2/28/2021 4:47:24 AM,INTERNATIONAL,7829065046,+331232212123,7645,0.0025,0.0125,0,US,MN,628,TWINCITIES,US,IN,336,IN_INDIANAPLS,327463240186,327463240186,121.33.16.85,1,13171231234,2323\"\r\n ],\r\n \"importType\": \"0\",\r\n \"columnSeparator\": \",\",\r\n \"textDelimiter\": \"\\\"\",\r\n \"verifyOnly\": false,\r\n \"ratingEngineName\": \"BW_Demo\",\r\n \"fileName\": \"voice_usage.csv\",\r\n \"correlationId\": \"1234\"\r\n}"},"url":"{{Host}}/rest/UtilityService/v1/transactions"},"status":"OK","code":200,"_postman_previewlanguage":"JSON","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Mon, 05 Jun 2023 14:06:51 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"78"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"*, Content-Type, Pragma, Origin, Authorization, party, X-XSRF-TOKEN, X-Requested-With,Access-Control-Allow-Headers,Accept,Access-Control-Allow-Credentials,X-Auth-Token, version, cache"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST,OPTIONS,PUT,DELETE,GET"}],"cookie":[],"responseTime":null,"body":"{\r\n \"correlationId\":\"1234\",\r\n \"message\":\"Request has been triggered.\",\r\n \"status\":\"OK\"\r\n}"}],"_postman_id":"5780a975-d430-4848-ae2c-52cbf113cf69"},{"name":"Import CDR file","id":"9af99f3e-8814-4fa4-a686-236bc8ff7425","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Bearer {{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"id\": \"b5bef509-198c-4553-9f60-b4be55985b1\",\r\n \"topic\": \"firefly_usage_event\",\r\n \"partition\": 0,\r\n \"value\": {\r\n \"content\": {\r\n \"customerId\": \"OB1372339130427506690@XYZCorp\",\r\n \"meterApiName\": \"firefly_images\",\r\n \"meterValue\": 1,\r\n \"meterTimeInMillis\": \"2023-06-01T15:19:12.372Z\",\r\n \"dimensions\": {\r\n \"iterations\": 2,\r\n \"sampling_algo\": \"hybrid_ddim\",\r\n \"image_resolution\": \"1024*1024\",\r\n \"ims_client_id\": \"clio-playground-web\",\r\n \"graph_urn\": \"urn:graph:GuidedText2Image_v3\",\r\n \"product\": \"FireFlyApp\",\r\n \"is_beta\": false\r\n }\r\n },\r\n \"headers\": {\r\n \"Accept\": [\r\n \"application/json\"\r\n ]\r\n }\r\n }\r\n}"},"url":"{{Host}}/rest/UtilityService/v1/custom/transactions","description":"This API is used to process the CDR file through API. This will trigger the CDR import into the applications.
\n","urlObject":{"path":["rest","UtilityService","v1","custom","transactions"],"host":["{{Host}}"],"query":[],"variable":[]}},"response":[{"id":"bfa30ed9-a505-459b-9b48-00d1ac0ab471","name":"New Request","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"id\": \"b5bef509-198c-4553-9f60-b4be55985b1\",\r\n \"topic\": \"firefly_usage_event\",\r\n \"partition\": 0,\r\n \"value\": {\r\n \"content\": {\r\n \"customerId\": \"OB1372339130427506690@XYZCorp\",\r\n \"meterApiName\": \"firefly_images\",\r\n \"meterValue\": 1,\r\n \"meterTimeInMillis\": \"2023-06-01T15:19:12.372Z\",\r\n \"dimensions\": {\r\n \"iterations\": 2,\r\n \"sampling_algo\": \"hybrid_ddim\",\r\n \"image_resolution\": \"1024*1024\",\r\n \"ims_client_id\": \"clio-playground-web\",\r\n \"graph_urn\": \"urn:graph:GuidedText2Image_v3\",\r\n \"product\": \"FireFlyApp\",\r\n \"is_beta\": false\r\n }\r\n },\r\n \"headers\": {\r\n \"Accept\": [\r\n \"application/json\"\r\n ]\r\n }\r\n }\r\n}"},"url":"{{Host}}/rest/UtilityService/v1/custom/transactions"},"status":"Not Found","code":404,"_postman_previewlanguage":"html","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Mon, 12 Jun 2023 06:28:18 GMT"},{"key":"Content-Type","value":"text/html;charset=ISO-8859-1"},{"key":"Content-Length","value":"912"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"*, Content-Type, Pragma, Origin, Authorization, party, X-XSRF-TOKEN, X-Requested-With,Access-Control-Allow-Headers,Accept,Access-Control-Allow-Credentials,X-Auth-Token, version, cache"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST,OPTIONS,PUT,DELETE,GET"},{"key":"Set-Cookie","value":"JSESSIONID=F6E69EDE641F08FE91AA8FAA64C2F7C9.worker4; Path=/; Secure; HttpOnly"}],"cookie":[],"responseTime":null,"body":"\n\n\n\n \n \n\n
\n \n\n\n"}],"_postman_id":"9af99f3e-8814-4fa4-a686-236bc8ff7425"}],"id":"41e3d9ea-1c08-45bd-abbf-662887ce3dce","description":"\n ![\"404\"](\"../404/images/404_image.png\")
\n
\n \n \n
\n \n\n\n\n\t\n \n
\n \n \n \n\n\t\t\n ERROR 404!!!
\nSorry,that page doesn't exist!
\nThis section will discuss about consumption based pricing model. Rate a usage based subscription through API.
\n","_postman_id":"41e3d9ea-1c08-45bd-abbf-662887ce3dce"},{"name":"Invoices","item":[{"name":"Rectify Invoice","item":[{"name":"Rectify an Invoice - Parameter Info","id":"af565c91-53cc-4ce8-8576-104c4dcdd9a7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"PUT","header":[{"description":"Provide the generated access token in this field.
\n","key":"Authorization","type":"text","value":"Bearer {{token}}"},{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{host}}/rest/InvoiceService/v1/invoices/{invoiceNumber}/rectify?retainInvoiceNumber=true&retainDueDates=true&retainInvoiceDate=true&retainAutoPayDate=true&retainPreviousDue=true","description":"This section lists and explains the various URL and data parameters which are present in this API.\n
URL Parameters
\n\n\n
Data Parameters
\nnone
\n","urlObject":{"path":["rest","InvoiceService","v1","invoices","{invoiceNumber}","rectify"],"host":["{{host}}"],"query":[{"key":"retainInvoiceNumber","value":"true"},{"key":"retainDueDates","value":"true"},{"key":"retainInvoiceDate","value":"true"},{"key":"retainAutoPayDate","value":"true"},{"key":"retainPreviousDue","value":"true"}],"variable":[]}},"response":[{"id":"e2e50861-99b3-4632-aa1f-26196458b920","name":"Rectify an Invoice - Parameter Info","originalRequest":{"method":"PUT","header":[{"description":"Provide the generated access token in this field.","key":"Authorization","type":"text","value":"Bearer {{token}}"},{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"{{host}}/rest/InvoiceService/v1/invoices/{invoiceNumber}/rectify?retainInvoiceNumber=true&retainDueDates=true&retainInvoiceDate=true&retainAutoPayDate=true&retainPreviousDue=true","host":["{{host}}"],"path":["rest","InvoiceService","v1","invoices","{invoiceNumber}","rectify"],"query":[{"key":"retainInvoiceNumber","value":"true"},{"key":"retainDueDates","value":"true"},{"key":"retainInvoiceDate","value":"true"},{"key":"retainAutoPayDate","value":"true"},{"key":"retainPreviousDue","value":"true"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Tue, 13 Feb 2024 07:25:21 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"45"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"*, Content-Type, Pragma, Origin, Authorization, party, X-XSRF-TOKEN, X-Requested-With,Access-Control-Allow-Headers,Accept,Access-Control-Allow-Credentials,X-Auth-Token, version, cache"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST,OPTIONS,PUT,DELETE,GET"}],"cookie":[],"responseTime":null,"body":"{\n \"invoiceNumber\": \"OBD-IN42047\",\n \"status\": \"OK\"\n}\n"}],"_postman_id":"af565c91-53cc-4ce8-8576-104c4dcdd9a7"},{"name":"Rectify an Invoice","id":"729ef6bf-5e41-4fce-a7e6-1f77db0fc4be","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"description":"Provide the generated access token in this field.
\n","key":"Authorization","type":"text","value":"BearerRectify an invoice with the invoice number IN5205 that is already created in the system.
This API is used to rectify the invoices using various parameters such as invoivce numbers and etc.
\n","_postman_id":"87553db5-3c78-402b-aa9e-5d5cb6592223"},{"name":"Search Invoice","item":[{"name":"Search Invoice - Parameter Info","id":"5717085f-e079-4312-bee5-72736511e94c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"Provide the generated access token in this field.
\n","key":"Authorization","type":"text","value":"BearerThis section lists and explains the various URL and data parameters which are present in this API. \n
\n
\n\n
URL Parameters
\nThis section contains information on the URL payload.\n
\n
\nnone
\n\n
\n\nNOTE: The URL
\nQuery Parametershave been explained below.
\n
\n\n
Data Parameters
\nThis section contains information on the JSON request payload and on the response parameters.
\n\n\n
none
\n","urlObject":{"path":["rest","InvoiceService","v1","invoices"],"host":["{{host}}"],"query":[{"description":{"content":"This is the account number of the subscriber account whose invoice(s) you wish to fetch and view.\n
\n
\nThis field is mandatory and is Required.
The count with which the response must start with.\n
\n
\nThe default value must be set to \"0\".
This is the number of response elements which the response must show.
\n","type":"text/plain"},"key":"resultCount","value":"Provide the generated access token in this field.
\n","key":"Authorization","type":"text","value":"BearerSearch and list all invoices for the account number SR3902 that is already present in the system.
This API is used to list invoice(s) for a particulat subscriber account that is present in the system.
\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"da9a3dec-776f-47a5-b7d9-2c3bc21abf4d"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"292afb39-d678-459f-b19e-f8b659a19c7b"}}],"_postman_id":"88767665-3220-4872-8211-d5e37574d194"},{"name":"Make Bill Adjustment","item":[{"name":"Make Bill Adjustment - Parameter Info","id":"339acced-e31c-4f2a-befd-5df564acfc9b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"Provide the generated access token in this field.
\n","key":"Authorization","type":"text","value":"BearerThis API is used to create the bill adjustment through API. Users can provide the invoice number in the URL.
\n\n
URL Parameters
\nThis section contains information on the URL payload.
\n\n\nNOTE: The URL
\nQuery Parameters(if any) have been explained below.
\n
Data Parameters
\nThis section contains information on the JSON request payload and on the response parameters.
\n","urlObject":{"path":["rest","InvoiceService","v1","invoices","{invoiceNumber}","adjustment"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"339acced-e31c-4f2a-befd-5df564acfc9b"},{"name":"Make a Bill Adjustment","id":"2b104f1e-6d2d-4a32-8fa2-5df3c4d6ae47","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"Provide the generated access token in this field.
\n","key":"Authorization","type":"text","value":"BearerMake a US $20 bill-level credit adjustment against the invoice IN4714 that is already present in the system.
\n\n
Prerequisites:
\n- \n
- Run the
Fetch Reason CodesREST API to fetch the value for thereasonCode. \n
This section will discuss about the adjustment and the operations related to adjustment.
\n","_postman_id":"a25c0c9f-14da-4bba-9343-97600ccb45ed"},{"name":"Modify Invoice","item":[{"name":"Regenerate an invoice and retain invoice number, due dates, and invoice date.","id":"ef3cab37-380c-42d9-92ce-11fd97298542","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"PUT","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"modificationType\":\"regenerate\",\r\n\t\"retainInvoiceNumber\":\"true\",\r\n\t\"retainDueDate\":\"true\",\r\n\t\"retainInvoiceDate\":\"true\"\r\n}"},"url":"{{Host}}/rest/InvoiceService/v1/invoices/{invoice_number}/modify","description":"This API is used to regenerate the invoice by retaining the information.
\nURL Params
\ninvoiceNumber [string]: This is the invoice number of the invoice which you wish to regenerate or rectify. {Mandatory}
\nData Params
\nMandatory:
\n- \n
- modificationType [string]: This field is used to state the type of modification that is being done on the invoice. The values can be as follows.
regenerate: If you wish to regenerate the invoice
rectify: If you wish to rectify the invoice \n
Optional:
\n- \n
- retainInvoiceNumber [boolean]: Pass this field if you wish to retain the invoice number. \n
- retainDueDates [boolean]: Pass this field if you wish to retain the due dates. \n
- retainInvoiceDate [boolean]: Pass this field if you wish to retain the invoice date. \n
This API is used to regenerate without retaining with any information.
\nURL Params
\ninvoiceNumber .[string]: This is the invoice number of the invoice which you wish to regenerate or rectify. {Mandatory}
\nData Params
\nMandatory:
\n- \n
- modificationType [string]: This field is used to state the type of modification that is being done on the invoice. The values can be as follows.
regenerate: If you wish to regenerate the invoice
rectify: If you wish to rectify the invoice \n
Optional:
\n- \n
- retainInvoiceNumber [boolean]: Pass this field if you wish to retain the invoice number. \n
- retainDueDates [boolean]: Pass this field if you wish to retain the due dates. \n
- retainInvoiceDate [boolean]: Pass this field if you wish to retain the invoice date. \n
This API is used to rectify an invoice with retaining the informations.
\nURL Params
\ninvoiceNumber .[string]: This is the invoice number of the invoice which you wish to regenerate or rectify. {Mandatory}
\nData Params
\nMandatory:
\n- \n
- modificationType [string]: This field is used to state the type of modification that is being done on the invoice. The values can be as follows.
regenerate: If you wish to regenerate the invoice
rectify: If you wish to rectify the invoice \n
Optional:
\n- \n
- retainInvoiceNumber [boolean]: Pass this field if you wish to retain the invoice number. \n
- retainDueDates [boolean]: Pass this field if you wish to retain the due dates. \n
- retainInvoiceDate [boolean]: Pass this field if you wish to retain the invoice date. \n
This API is used rectify the invoice without retaining any information.
\nURL Params
\ninvoiceNumber .[string]: This is the invoice number of the invoice which you wish to regenerate or rectify. {Mandatory}
\nData Params
\nMandatory:
\n- \n
- modificationType [string]: This field is used to state the type of modification that is being done on the invoice. The values can be as follows.
regenerate: If you wish to regenerate the invoice
rectify: If you wish to rectify the invoice \n
Optional:
\n- \n
- retainInvoiceNumber [boolean]: Pass this field if you wish to retain the invoice number. \n
- retainDueDates [boolean]: Pass this field if you wish to retain the due dates. \n
- retainInvoiceDate [boolean]: Pass this field if you wish to retain the invoice date. \n
This API is used to modify an invoice. It allows a business to regenerate and rectify an invoice.
\n","_postman_id":"dac218ac-08d0-4ad3-b463-c1b1106d5539"},{"name":"Fetch an Invoice","item":[{"name":"Retrieve an invoice XML by passing the invoice number.","id":"c78983e0-4569-4443-b7e5-655ba897a624","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"url":"{{Host}}/rest/InvoiceService/v1/invoices/{invoice_number}?contentType=xml","description":"This API is used to retrieve invoice XML later can be converted into the PDF.
\nURL Params
\nMandatory:
\n- \n
- invoiceNumber [string]: This is the invoice number of the invoice for which you wish to fetch the XML/PDF for. \n
Optional:
\n- \n
- contentType=xml [string]: Specify the generation of XML in this field. The field name must be passed along with the \"?\". The value must be \"xml\". \n
GST-SGST-CGST-SGST-CThis section will discuss about fetching the invoice details and operations.
\n","_postman_id":"cb03022e-4eee-4a99-8c40-d99274963db1"}],"id":"1d1f2f52-2b64-458a-86e3-09ab5fb29f00","description":"This section deals with the various APIs required to manage subscriber invoices in the application.
\n","_postman_id":"1d1f2f52-2b64-458a-86e3-09ab5fb29f00"},{"name":"Promotions","item":[{"name":"Fetch All Resource Types","item":[{"name":"Fetch all Resource type","id":"ab753375-c4f1-405a-9006-5c743a7c83fd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth1","oauth1":{"basicConfig":[],"advancedConfig":[{"key":"signatureMethod","value":"This API is used to fetch the list of all the resource type available in the application.
\n","urlObject":{"path":["rest","PromotionService","v1","promotions","resourcetypes"],"host":["{{Host}}"],"query":[],"variable":[]}},"response":[{"id":"816ff86f-7701-4ead-aece-df8c04d136b9","name":"New Request","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"url":"{{Host}}/rest/PromotionService/v1/promotions/resourcetypes"},"status":"OK","code":200,"_postman_previewlanguage":"JSON","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Mon, 25 Apr 2022 10:14:56 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"224"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"*, Content-Type, Pragma, Origin, Authorization, party, X-XSRF-TOKEN, X-Requested-With,Access-Control-Allow-Headers,Accept,Access-Control-Allow-Credentials,X-Auth-Token, version, cache"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST,OPTIONS,PUT,DELETE,GET"}],"cookie":[],"responseTime":null,"body":"{\"resourceTypes\":[\"MB\",\"GB\",\"TB\",\"HOUR\",\"MINUTE\",\"SECOND\",\"LICENSE\",\"INSTANCE\",\"ADDRESS\",\"BOX\",\"CARTRIDGE\",\"CASE\",\"CARTON\",\"DOZEN\",\"EACH\",\"GROSS\",\"KIT\",\"LOT\",\"PACKAGE\",\"SET\",\"UNIT\",\"USER\",\"DOMAIN\",\"KB\",\"TEXT\"],\"status\":\"OK\"}"}],"_postman_id":"ab753375-c4f1-405a-9006-5c743a7c83fd"}],"id":"0b8ccbec-cea4-41ee-b0d9-b3e65cbb66e8","description":"This section we will discuss about fetching all resource types available in the application.
\n","_postman_id":"0b8ccbec-cea4-41ee-b0d9-b3e65cbb66e8"},{"name":"Coupons","item":[{"name":"Create a Coupon","item":[{"name":"Create a Coupon","id":"4027d6a3-5a93-446a-b384-b6827e94395d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"name\": \"Voice 10% coupon\",\r\n \"description\": \"This is summer freebie which has a value of 10% on the voice users\",\r\n \"availableFrom\": \"2023-04-27T00:00:00+05:30\",\r\n \"availableTo\": \"2023-05-26T23:59:59+05:30\",\r\n \"mode\": 2,\r\n \"promotionType\": 2,\r\n \"promotionStatus\": 1,\r\n \"Value\": 10,\r\n \"recurring\": true,\r\n \"code\": \"6500FF\",\r\n \"usageCount\": \"400\"\r\n}"},"url":"{{Host}}/rest/PromotionService/v1/promotion","description":"This API will be used to create coupon in the application using API.
\nData Paramters
\nThis section will provide the information data parameters of the request. Data Parameters.
\n","urlObject":{"path":["rest","PromotionService","v1","promotion"],"host":["{{Host}}"],"query":[],"variable":[]}},"response":[{"id":"f2906ff9-24a3-423c-a6b1-4971ca83df0e","name":"Create a Coupon","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"name\": \"Voice 10% coupon\",\r\n \"description\": \"This is summer freebie which has a value of 10% on the voice users\",\r\n \"availableFrom\": \"2023-04-27T00:00:00+05:30\",\r\n \"availableTo\": \"2023-05-26T23:59:59+05:30\",\r\n \"mode\": 2,\r\n \"promotionType\": 2,\r\n \"promotionStatus\": 1,\r\n \"discountValue\": 25,\r\n \"recurring\": true,\r\n \"code\": \"6500FF\",\r\n \"usageCount\":\"400\"\r\n}\r\n"},"url":"{{Host}}/rest/PromotionService/v1/promotion"},"status":"OK","code":200,"_postman_previewlanguage":"JSON","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 26 Apr 2023 11:50:15 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"61"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"*, Content-Type, Pragma, Origin, Authorization, party, X-XSRF-TOKEN, X-Requested-With,Access-Control-Allow-Headers,Accept,Access-Control-Allow-Credentials,X-Auth-Token, version, cache"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST,OPTIONS,PUT,DELETE,GET"}],"cookie":[],"responseTime":null,"body":"{\r\n \"promotionId\":\"3702\",\r\n \"promotionCode\":\"6500FF\",\r\n \"status\":\"OK\"\r\n}"}],"_postman_id":"4027d6a3-5a93-446a-b384-b6827e94395d"}],"id":"247afb3c-6289-4f58-be5e-21c9cdd6f4c2","description":"This section we will discuss about creating coupon through API.
\n","_postman_id":"247afb3c-6289-4f58-be5e-21c9cdd6f4c2"},{"name":"Update a Coupon","item":[{"name":"Update a coupon","id":"7685d4b8-4739-4603-b261-142b36cc6277","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"PUT","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"promotionId\": \"3702\",\r\n \"name\": \"Voice 10% coupon\",\r\n \"description\": \"This is summer freebie which has a value of 10% on the voice users\",\r\n \"availableFrom\": \"2023-04-27T00:00:00+05:30\",\r\n \"availableTo\": \"2023-05-26T23:59:59+05:30\",\r\n \"mode\": 2,\r\n \"promotionType\": 2,\r\n \"promotionStatus\": 1,\r\n \"discountValue\": 10,\r\n \"recurring\": true,\r\n \"code\": \"6500FF\",\r\n \"usageCount\": \"400\"\r\n}"},"url":"{{Host}}/rest/PromotionService/v1/promotion","description":"This API is used to update the coupon with existing info.
\nData Paramters
\nThis section will provide the information data parameters of the request. Data Parameters.
\n","urlObject":{"path":["rest","PromotionService","v1","promotion"],"host":["{{Host}}"],"query":[],"variable":[]}},"response":[{"id":"edc219f0-f907-41f0-8f8f-e39cde09b5be","name":"Update a coupon","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"promotionId\": \"3702\",\r\n \"name\": \"Voice 10% coupon\",\r\n \"description\": \"This is summer freebie which has a value of 10% on the voice users\",\r\n \"availableFrom\": \"2023-04-27T00:00:00+05:30\",\r\n \"availableTo\": \"2023-05-26T23:59:59+05:30\",\r\n \"mode\": 2,\r\n \"promotionType\": 2,\r\n \"promotionStatus\": 1,\r\n \"discountValue\": 10,\r\n \"recurring\": true,\r\n \"code\": \"6500FF\",\r\n \"usageCount\": \"400\"\r\n}"},"url":"{{Host}}/rest/PromotionService/v1/promotion"},"status":"OK","code":200,"_postman_previewlanguage":"JSON","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 26 Apr 2023 11:56:23 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"36"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"*, Content-Type, Pragma, Origin, Authorization, party, X-XSRF-TOKEN, X-Requested-With,Access-Control-Allow-Headers,Accept,Access-Control-Allow-Credentials,X-Auth-Token, version, cache"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST,OPTIONS,PUT,DELETE,GET"}],"cookie":[],"responseTime":null,"body":"{\r\n \"promotionId\":\"3702\",\r\n \"status\":\"OK\"\r\n}"}],"_postman_id":"7685d4b8-4739-4603-b261-142b36cc6277"}],"id":"38f538dd-83c3-4db6-9174-8343dff0f3c8","description":"This section will discuss about coupon and their actions. These will help you to modify the coupon details.
\n","_postman_id":"38f538dd-83c3-4db6-9174-8343dff0f3c8"},{"name":"Fetch the Coupons","item":[{"name":"Fetch the list of Coupons","id":"78c89710-8cdb-4387-b06a-bb2d62fb1155","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"}],"url":"{{Host}}/rest/PromotionService/v1/promotions?promotionType=COUPON","description":"This API is used to fetch the list of coupons. Using promotion code you get fetch the coupons list.
\n","urlObject":{"path":["rest","PromotionService","v1","promotions"],"host":["{{Host}}"],"query":[{"key":"promotionType","value":"COUPON"}],"variable":[]}},"response":[{"id":"180dddb4-4b0b-4b09-8fe8-d60dd9f583e8","name":"Fetch the list of Coupons","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"}],"url":{"raw":"{{Host}}/rest/PromotionService/v1/promotions?promotionType=COUPON","host":["{{Host}}"],"path":["rest","PromotionService","v1","promotions"],"query":[{"key":"promotionType","value":"COUPON"}]}},"status":"OK","code":200,"_postman_previewlanguage":"JSON","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 26 Apr 2023 11:41:58 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"2056"},{"key":"Connection","value":"keep-alive"},{"key":"Set-Cookie","value":"JSESSIONID=79D1663D970E50280E278855E34216FA.worker4; Path=/; Secure; HttpOnly"},{"key":"Access-Control-Allow-Headers","value":"*, Content-Type, Pragma, Origin, Authorization, party, X-XSRF-TOKEN, X-Requested-With,Access-Control-Allow-Headers,Accept,Access-Control-Allow-Credentials,X-Auth-Token, version, cache"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST,OPTIONS,PUT,DELETE,GET"}],"cookie":[],"responseTime":null,"body":"{\r\n \"resultSize\": 3,\r\n \"promotionInfos\": [\r\n {\r\n \"name\": \"10% coupon\",\r\n \"description\": \"10% coupon\",\r\n \"availableFrom\": \"2021-10-27T00:00:00-07:00\",\r\n \"availableTo\": \"2021-11-27T23:59:59-08:00\",\r\n \"mode\": 2,\r\n \"promotionStatus\": 1,\r\n \"code\": \"COUPON101\",\r\n \"value\": 10.0000,\r\n \"recurring\": true\r\n },\r\n {\r\n \"name\": \"Free coupon\",\r\n \"description\": \"Free coupon\",\r\n \"availableFrom\": \"2022-05-10T00:00:00-07:00\",\r\n \"availableTo\": \"2022-05-31T23:59:59-07:00\",\r\n \"mode\": 2,\r\n \"promotionStatus\": 1,\r\n \"code\": \"Freebee\",\r\n \"value\": 10.0000,\r\n \"recurring\": true\r\n },\r\n {\r\n \"name\": \"Newyear coupon\",\r\n \"description\": \"Newyear Discount\",\r\n \"availableFrom\": \"2021-10-20T00:00:00-07:00\",\r\n \"availableTo\": \"2021-11-04T23:59:59-07:00\",\r\n \"mode\": 2,\r\n \"promotionStatus\": 1,\r\n \"code\": \"DI1001\",\r\n \"value\": 20.0000,\r\n \"recurring\": true,\r\n \"usageCount\": 0\r\n }\r\n ],\r\n \"status\": \"OK\"\r\n}"}],"_postman_id":"78c89710-8cdb-4387-b06a-bb2d62fb1155"},{"name":"Fetch a specific Coupon","id":"336d18cf-5776-4ff0-98cc-dbf23a990322","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"}],"url":"{{Host}}/rest/PromotionService/v1/promotions/?{promotionCode}","description":"This API is used to fetch a specific coupon details using promotion code.
\n","urlObject":{"path":["rest","PromotionService","v1","promotions",""],"host":["{{Host}}"],"query":[{"description":{"content":"Enter the code for the coupon to fetch details.
\n","type":"text/plain"},"key":"{promotionCode}","value":null}],"variable":[]}},"response":[{"id":"6bbd4521-7cc2-4377-adae-0e3d6cbfc4ce","name":"Fetch a specific Coupon","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"}],"url":{"raw":"{{Host}}/rest/PromotionService/v1/promotions/?{promotionCode}","host":["{{Host}}"],"path":["rest","PromotionService","v1","promotions",""],"query":[{"key":"{promotionCode}","value":null,"description":"Enter the code for the coupon to fetch details.\n"}]}},"status":"OK","code":200,"_postman_previewlanguage":"JSON","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 26 Apr 2023 12:04:17 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"389"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"*, Content-Type, Pragma, Origin, Authorization, party, X-XSRF-TOKEN, X-Requested-With,Access-Control-Allow-Headers,Accept,Access-Control-Allow-Credentials,X-Auth-Token, version, cache"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST,OPTIONS,PUT,DELETE,GET"}],"cookie":[],"responseTime":null,"body":"{\r\n \"promotionInfo\": {\r\n \"id\": \"3702\",\r\n \"name\": \"Voice 10% coupon\",\r\n \"description\": \"This is summer freebie which has a value of 10% on the voice users\",\r\n \"availableFrom\": \"2023-04-26T00:00:00-07:00\",\r\n \"availableTo\": \"2023-05-27T23:59:59-07:00\",\r\n \"mode\": 2,\r\n \"promotionType\": 2,\r\n \"promotionStatus\": 1,\r\n \"code\": \"6500FF\",\r\n \"glCode\": \"P2001\",\r\n \"value\": 10.0000,\r\n \"currencyId\": \"840\",\r\n \"recurring\": true,\r\n \"usageCount\": 400\r\n },\r\n \"status\": \"OK\"\r\n}"}],"_postman_id":"336d18cf-5776-4ff0-98cc-dbf23a990322"}],"id":"d30f6ac9-13bb-4159-9ced-f851498dd717","description":"This section will discuss about fetching information about a coupon. These example will help you to fetch details using URLs and parameters.
\n","_postman_id":"d30f6ac9-13bb-4159-9ced-f851498dd717"}],"id":"608bbf16-55b1-424f-96ad-c9722e34e7c4","description":"This section will discuss about the create coupon, modify coupons, fetch and delete coupon.
\n","_postman_id":"608bbf16-55b1-424f-96ad-c9722e34e7c4"},{"name":"Discounts","item":[{"name":"Create a Discount","item":[{"name":"Create a Discount","id":"c0ea7ec4-808f-48d6-afa7-732c988b7704","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"name\": \"?\",\r\n\t\"description\": \"?\",\r\n\t\"isRepeat\": ?,\r\n\t\"glCode\": \"?\",\r\n\t\"promotionMode\": ?,\r\n\t\"value\": ?\r\n\t}","options":{"raw":{"language":"json"}}},"url":"{{Host}}/rest/PromotionService/v1/promotions/discount","description":"This API is used to create discount in the application. Refer to the request given below.
\nData Paramters
\nThis section will provide the information data parameters of the request. Data Parameters.
\n","urlObject":{"path":["rest","PromotionService","v1","promotions","discount"],"host":["{{Host}}"],"query":[],"variable":[]}},"response":[{"id":"c0bed7ee-d822-4bd7-9f75-c6f0b44cf104","name":"Create a Discount","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"name\": \"Internet Discount\",\r\n\t\"description\": \"Offer applicable only in July\",\r\n\t\"isRepeat\": true,\r\n\t\"glCode\": \"P200P\",\r\n\t\"promotionMode\": 1,\r\n\t\"value\": 50\r\n\t}","options":{"raw":{"language":"json"}}},"url":"{{Host}}/rest/PromotionService/v1/promotions/discount"},"status":"OK","code":200,"_postman_previewlanguage":"JSON","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 26 Apr 2023 06:22:13 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"49"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"*, Content-Type, Pragma, Origin, Authorization, party, X-XSRF-TOKEN, X-Requested-With,Access-Control-Allow-Headers,Accept,Access-Control-Allow-Credentials,X-Auth-Token, version, cache"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST,OPTIONS,PUT,DELETE,GET"}],"cookie":[],"responseTime":null,"body":"{\r\n \"id\":\"3602\",\r\n \"code\":\"DISCOUNT3002\",\r\n \"status\":\"OK\"\r\n}"}],"_postman_id":"c0ea7ec4-808f-48d6-afa7-732c988b7704"},{"name":"Create Discount with Rule","id":"2306249c-c3e2-475b-813f-762e5330b02f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"name\": \"?\",\r\n\t\"description\": \"?\",\r\n\t\"isRepeat\": ?,\r\n\t\"glCode\": \"?\",\r\n\t\"promotionMode\": ?,\r\n\t\"ruleCode\":\"?\"\r\n\t}","options":{"raw":{"language":"json"}}},"url":"{{Host}}/rest/PromotionService/v1/promotions/discount","description":"This API will be used to create discount having a condition or rule applied to it. In this you can associate a rule to the discount.
\nTo create discount rule refer this, Click here
\nData Paramters
\nThis section will provide the information data parameters of the request. Data Parameters.
\n","urlObject":{"path":["rest","PromotionService","v1","promotions","discount"],"host":["{{Host}}"],"query":[],"variable":[]}},"response":[{"id":"4397dce1-2cd8-49d2-a1e5-c16085fb4d11","name":"Create Discount with Rule","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"name\": \"VOIP monthly Offer\",\r\n\t\"description\": \"Offer applicable only in July\",\r\n\t\"isRepeat\": true,\r\n\t\"glCode\": \"P200P\",\r\n\t\"promotionMode\": 3,\r\n\t\"ruleCode\":\"VOIP_Rule\"\r\n\t}","options":{"raw":{"language":"json"}}},"url":"{{Host}}/rest/PromotionService/v1/promotions/discount"},"status":"OK","code":200,"_postman_previewlanguage":"JSON","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 26 Apr 2023 06:40:15 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"49"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"*, Content-Type, Pragma, Origin, Authorization, party, X-XSRF-TOKEN, X-Requested-With,Access-Control-Allow-Headers,Accept,Access-Control-Allow-Credentials,X-Auth-Token, version, cache"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST,OPTIONS,PUT,DELETE,GET"}],"cookie":[],"responseTime":null,"body":"{\r\n \"id\":\"3603\",\r\n \"code\":\"DISCOUNT3003\",\r\n \"status\":\"OK\"\r\n}"}],"_postman_id":"2306249c-c3e2-475b-813f-762e5330b02f"}],"id":"7282cfad-7463-49b7-845a-9647e043f2e5","description":"This API is used for creating the discount in the application. These discount can be a freebie given to the subscriber to get some discount on the subscription amount.
\n","_postman_id":"7282cfad-7463-49b7-845a-9647e043f2e5"},{"name":"Update a Discount","item":[{"name":"Update a Discount","id":"20b9dcce-886a-42cf-b64a-9a440d48dd58","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"PUT","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"name\": \"ISP Discount\",\r\n \"description\": \"This is a one-time discount for the premium plan.\",\r\n \"availableFrom\": \"2021-01-13T00:00:00-08:00\",\r\n \"mode\": 2,\r\n \"promotionStatus\": 1,\r\n \"code\": \"DISCOUNT1002\",\r\n \"value\": 25.0000,\r\n \"recurring\": true\r\n}"},"url":"{{Host}}/rest/PromotionService/v1/promotions/discounts/DISCOUNT1002","description":"This API is used modify the discount and details such as name, description, and etc.
\nData Paramters
\nThis section will provide the information data parameters of the request. Data Parameters.
\n","urlObject":{"path":["rest","PromotionService","v1","promotions","discounts","DISCOUNT1002"],"host":["{{Host}}"],"query":[],"variable":[]}},"response":[{"id":"a3be6fda-a28b-45f0-9f8c-7e774e20409b","name":"Update a Discount","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"name\": \"ISP Discount\",\r\n \"description\": \"This is a one-time discount for the premium plan.\",\r\n \"availableFrom\": \"2021-01-13T00:00:00-08:00\",\r\n \"mode\": 2,\r\n \"promotionStatus\": 1,\r\n \"code\": \"DISCOUNT1002\",\r\n \"value\": 25.0000,\r\n \"recurring\": true\r\n}"},"url":"{{Host}}/rest/PromotionService/v1/promotions/discounts/DISCOUNT1002"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Mon, 24 Jul 2023 10:50:59 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"27"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"*, Content-Type, Pragma, Origin, Authorization, party, X-XSRF-TOKEN, X-Requested-With,Access-Control-Allow-Headers,Accept,Access-Control-Allow-Credentials,X-Auth-Token, version, cache"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST,OPTIONS,PUT,DELETE,GET"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"1202\",\n \"status\": \"OK\"\n}\n"}],"_postman_id":"20b9dcce-886a-42cf-b64a-9a440d48dd58"}],"id":"278de38b-d7c0-4a39-80ab-ba00be369d9d","description":"This section will discuss about modifying the discount details, users can modify the details like name, description, and etc.
\n","_postman_id":"278de38b-d7c0-4a39-80ab-ba00be369d9d"},{"name":"Fetch Discount","item":[{"name":"Fetch List of Discounts","id":"0b8e86f4-e397-4170-8288-c3d261849e95","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"}],"url":"{{Host}}/rest/PromotionService/v1/promotions?promotionType=DISCOUNT","description":"This API is used to fetch list of all the discount available in the application.
\n","urlObject":{"path":["rest","PromotionService","v1","promotions"],"host":["{{Host}}"],"query":[{"key":"promotionType","value":"DISCOUNT"}],"variable":[]}},"response":[{"id":"b0e23127-bd60-456a-aa3e-5f47986d0ec8","name":"Fetch List of Discounts","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"}],"url":{"raw":"{{Host}}/rest/PromotionService/v1/promotions?promotionType=DISCOUNT","host":["{{Host}}"],"path":["rest","PromotionService","v1","promotions"],"query":[{"key":"promotionType","value":"DISCOUNT"}]}},"status":"OK","code":200,"_postman_previewlanguage":"JSON","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 26 Apr 2023 06:02:29 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"6132"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"*, Content-Type, Pragma, Origin, Authorization, party, X-XSRF-TOKEN, X-Requested-With,Access-Control-Allow-Headers,Accept,Access-Control-Allow-Credentials,X-Auth-Token, version, cache"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST,OPTIONS,PUT,DELETE,GET"}],"cookie":[],"responseTime":null,"body":"{\r\n \"resultSize\": 11,\r\n \"promotionInfos\": [\r\n {\r\n \"name\": \"VoIP Discount\",\r\n \"description\": \"This discount is valid for the VoIP customers\",\r\n \"availableFrom\": \"2021-11-21T00:00:00-08:00\",\r\n \"mode\": 2,\r\n \"promotionStatus\": 1,\r\n \"code\": \"DISCOUNT2103\",\r\n \"value\": 10.0000,\r\n \"recurring\": true\r\n },\r\n {\r\n \"name\": \"Christmas Discount\",\r\n \"description\": \"Christmas Discount\",\r\n \"availableFrom\": \"2020-07-27T00:00:00-07:00\",\r\n \"mode\": 2,\r\n \"promotionStatus\": 1,\r\n \"code\": \"DISCOUNT602\",\r\n \"value\": 15.0000,\r\n \"recurring\": true\r\n },\r\n {\r\n \"name\": \"Discount Demo 1\",\r\n \"description\": \"\",\r\n \"availableFrom\": \"2022-06-13T00:00:00-07:00\",\r\n \"mode\": 3,\r\n \"promotionStatus\": 1,\r\n \"code\": \"DISCOUNT2602\",\r\n \"value\": 0,\r\n \"recurring\": true,\r\n \"ruleCode\": \"Discount Demo\"\r\n },\r\n {\r\n \"name\": \"Fitness Discount\",\r\n \"description\": \"FD\",\r\n \"availableFrom\": \"2021-08-19T00:00:00-07:00\",\r\n \"mode\": 2,\r\n \"promotionStatus\": 1,\r\n \"code\": \"DISCOUNT1702\",\r\n \"value\": 15.0000,\r\n \"recurring\": true\r\n },\r\n {\r\n \"name\": \"Great Sale November\",\r\n \"description\": \"Great Sale November\",\r\n \"availableFrom\": \"2021-10-25T00:00:00-07:00\",\r\n \"mode\": 2,\r\n \"promotionStatus\": 1,\r\n \"code\": \"DISCOUNT2004\",\r\n \"value\": 10.0000,\r\n \"recurring\": true\r\n },\r\n {\r\n \"name\": \"New Purchase Discount\",\r\n \"description\": \"New Purchase Discount\",\r\n \"availableFrom\": \"2021-10-27T00:00:00-07:00\",\r\n \"mode\": 2,\r\n \"promotionStatus\": 1,\r\n \"code\": \"DISCOUNT2006\",\r\n \"value\": 5.0000,\r\n \"recurring\": true\r\n },\r\n {\r\n \"name\": \"New Subscriber Discount\",\r\n \"description\": \"new subscriber\",\r\n \"availableFrom\": \"2020-08-04T00:00:00-07:00\",\r\n \"mode\": 2,\r\n \"promotionStatus\": 1,\r\n \"code\": \"DISCOUNT702\",\r\n \"value\": 15.0000,\r\n \"recurring\": true\r\n },\r\n {\r\n \"name\": \"New Year Discount\",\r\n \"description\": \"New Year Discount\",\r\n \"availableFrom\": \"2021-01-12T00:00:00-08:00\",\r\n \"mode\": 2,\r\n \"promotionStatus\": 1,\r\n \"code\": \"DISCOUNT902\",\r\n \"value\": 10.0000,\r\n \"recurring\": true\r\n },\r\n {\r\n \"name\": \"Summer Offer\",\r\n \"description\": \"\",\r\n \"availableFrom\": \"2023-04-11T00:00:00-07:00\",\r\n \"mode\": 2,\r\n \"promotionStatus\": 1,\r\n \"code\": \"DISCOUNT2904\",\r\n \"value\": 50.0000,\r\n \"recurring\": true\r\n },\r\n {\r\n \"name\": \"Summer vacation\",\r\n \"description\": \"20% discount on channels for summer holidays\",\r\n \"availableFrom\": \"2023-04-11T00:00:00-07:00\",\r\n \"mode\": 2,\r\n \"promotionStatus\": 1,\r\n \"code\": \"DISCOUNT2903\",\r\n \"value\": 20.0000,\r\n \"recurring\": true\r\n },\r\n {\r\n \"name\": \"Voice Discount\",\r\n \"description\": \"Voice Discount\",\r\n \"availableFrom\": \"2021-11-18T00:00:00-08:00\",\r\n \"mode\": 2,\r\n \"promotionStatus\": 1,\r\n \"code\": \"DISCOUNT2102\",\r\n \"value\": 10.0000,\r\n \"recurring\": true\r\n }\r\n ],\r\n \"status\": \"OK\"\r\n}"}],"_postman_id":"0b8e86f4-e397-4170-8288-c3d261849e95"},{"name":"Fetch a Specific Discount","id":"9bf77a52-03fe-4f2d-9cf2-4ce2cf317675","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"}],"url":"{{Host}}/rest/PromotionService/v1/promotions/?{Discount_code}","description":"This API is used to fetch the discount, It is used to search specific discount using discount code in the URL parameter.
\n","urlObject":{"path":["rest","PromotionService","v1","promotions",""],"host":["{{Host}}"],"query":[{"description":{"content":"Enter the code, fetched from the GET operation for fetching information regarding specific discount.
\n","type":"text/plain"},"key":"{Discount_code}","value":null}],"variable":[]}},"response":[{"id":"2094c6ff-e58c-4e91-9e0a-7427100d8f73","name":"Fetch a Specific Discount","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"}],"url":{"raw":"{{Host}}/rest/PromotionService/v1/promotions/?{Discount_code}","host":["{{Host}}"],"path":["rest","PromotionService","v1","promotions",""],"query":[{"key":"{Discount_code}","value":null,"description":"Enter the code, fetched from the GET operation for fetching information regarding specific discount."}]}},"status":"OK","code":200,"_postman_previewlanguage":"JSON","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 26 Apr 2023 06:15:48 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"281"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"*, Content-Type, Pragma, Origin, Authorization, party, X-XSRF-TOKEN, X-Requested-With,Access-Control-Allow-Headers,Accept,Access-Control-Allow-Credentials,X-Auth-Token, version, cache"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST,OPTIONS,PUT,DELETE,GET"}],"cookie":[],"responseTime":null,"body":"{\"promotionInfo\":{\"id\":\"2402\",\"name\":\"VoIP Discount\",\"description\":\"VoIP Discount\",\"availableFrom\":\"2021-11-18T00:00:00-08:00\",\"mode\":2,\"promotionType\":3,\"promotionStatus\":1,\"code\":\"DISCOUNT2102\",\"glCode\":\"P2002\",\"value\":10.0000,\"currencyId\":\"840\",\"recurring\":false},\"status\":\"OK\"}"}],"_postman_id":"9bf77a52-03fe-4f2d-9cf2-4ce2cf317675"}],"id":"75695809-a30a-40e8-8bd9-7b86202e568b","description":"This section will discuss about the fetching the discount details. Using various URL and parameters.
\n","_postman_id":"75695809-a30a-40e8-8bd9-7b86202e568b"}],"id":"451d0be3-0b12-4069-95e0-ab8cd4339d58","description":"In this section, we will discuss about the API for discount. It will carry create, update, search, and delete operations.
\n","_postman_id":"451d0be3-0b12-4069-95e0-ab8cd4339d58"},{"name":"Grants","item":[{"name":"Create a Grant","item":[{"name":"Create a Grant","id":"c4f0991f-5b4b-4e3b-84c9-01538f669218","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth1","oauth1":{"basicConfig":[],"advancedConfig":[{"key":"signatureMethod","value":"This API is used to create grant using the following request in the application.
\nData Paramters
\nThis section will provide the information data parameters of the request. Data Parameters.
\n","urlObject":{"path":["rest","PromotionService","v1","promotions","grant"],"host":["{{Host}}"],"query":[],"variable":[]}},"response":[{"id":"e4c2841f-4f4c-49f8-997f-b9f911d276b0","name":"New Request","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"name\": \"Extra 2 Hour\",\r\n \"code\": \"FREEBIE402\",\r\n \"description\": \"extra 20 hour with every voice call subscription above $500\",\r\n \"availableFrom\": \"2022-05-01T00:00:00Z\",\r\n \"availableTo\": \"2023-05-31T00:00:00Z\",\r\n \"resourceType\": \"HOUR\",\r\n \"value\": \"10\",\r\n \"isRecurring\": \"true\",\r\n \"carryForward\": \"\",\r\n \"validityMode\": \"YEAR\",\r\n \"validityUnit\": \"10\",\r\n \"prorate\": \"false\",\r\n \"availableFor\": \"1\",\r\n \"forever\": \"false\",\r\n \"increment\": \"0\",\r\n \"minimumQuantity\": \"0\",\r\n \"grantCriterias\": [\r\n {\r\n \"eventType\": \"VOICE\",\r\n \"eventCategory\": \"LONG_DISTANCE\",\r\n \"timeCode\": \"Standard\",\r\n \"chargeCategoryGroup\": \"A\",\r\n \"increment\": \"10\",\r\n \"minimumQuantity\": \"5\"\r\n }\r\n ]\r\n}"},"url":"{{Host}}/rest/PromotionService/v1/promotions/grant"},"status":"OK","code":200,"_postman_previewlanguage":"JSON","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Mon, 25 Apr 2022 10:23:41 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"57"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"*, Content-Type, Pragma, Origin, Authorization, party, X-XSRF-TOKEN, X-Requested-With,Access-Control-Allow-Headers,Accept,Access-Control-Allow-Credentials,X-Auth-Token, version, cache"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST,OPTIONS,PUT,DELETE,GET"}],"cookie":[],"responseTime":null,"body":"{\"grantId\":\"2902\",\"grantCode\":\"FREEBIE402\",\"status\":\"OK\"}"}],"_postman_id":"c4f0991f-5b4b-4e3b-84c9-01538f669218"}],"id":"ea16081f-85b8-43f7-b61f-ed6020cf7244","description":"This section will discuss about the grants and creation of the grants.
\n","_postman_id":"ea16081f-85b8-43f7-b61f-ed6020cf7244"},{"name":"Update a grant","item":[{"name":"Update a Grant","id":"df51a4e9-12ad-4c9e-803f-bcb6d95a93b8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"PUT","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"id\": \"2902\",\r\n \"name\": \"Extra 2 Hour\",\r\n \"description\": \"This grant provides extra 2 hours of voice calls\",\r\n \"availableFrom\": \"2023-04-27T00:00:00+05:30\",\r\n \"resourceType\": \"MB\",\r\n \"value\": 1000,\r\n \"isRecurring\": true,\r\n \"carryForward\": false,\r\n \"glCode\": \"P2005\",\r\n \"validityMode\": \"DAY\",\r\n \"validityUnit\": 1,\r\n \"prorate\": true,\r\n \"availableFor\": 2,\r\n \"repeatWithInChargingCycle\": true,\r\n \"grantCriterias\": [],\r\n \"increment\": 0,\r\n \"minimumQuantity\": 0,\r\n \"chargeMode\": 1\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"{{Host}}/rest/PromotionService/v1/promotions/grant","description":"This API is used to modify the details of the grants.
\nData Paramters
\nThis section will provide the information data parameters of the request. Data Parameters.
\n","urlObject":{"path":["rest","PromotionService","v1","promotions","grant"],"host":["{{Host}}"],"query":[],"variable":[]}},"response":[{"id":"6503aab8-6cf0-4ce3-b561-d93edc236552","name":"Update a Grant","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"id\": \"2902\",\r\n \"name\": \"Extra 2 Hour\",\r\n \"description\": \"This grant provides extra 2 hours of voice calls\",\r\n \"availableFrom\": \"2023-04-27T00:00:00+05:30\",\r\n \"resourceType\": \"MB\",\r\n \"value\": 1000,\r\n \"isRecurring\": true,\r\n \"carryForward\": false,\r\n \"glCode\": \"P2005\",\r\n \"validityMode\": \"DAY\",\r\n \"validityUnit\": 1,\r\n \"prorate\": true,\r\n \"availableFor\": 2,\r\n \"repeatWithInChargingCycle\": true,\r\n \"grantCriterias\": [],\r\n \"increment\": 0,\r\n \"minimumQuantity\": 0,\r\n \"chargeMode\": 1\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"{{Host}}/rest/PromotionService/v1/promotions/grant"},"status":"OK","code":200,"_postman_previewlanguage":"JSON","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 26 Apr 2023 10:16:16 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"32"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"*, Content-Type, Pragma, Origin, Authorization, party, X-XSRF-TOKEN, X-Requested-With,Access-Control-Allow-Headers,Accept,Access-Control-Allow-Credentials,X-Auth-Token, version, cache"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST,OPTIONS,PUT,DELETE,GET"}],"cookie":[],"responseTime":null,"body":"{\r\n \"grantId\":\"2902\",\r\n \"status\":\"OK\"\r\n}"}],"_postman_id":"df51a4e9-12ad-4c9e-803f-bcb6d95a93b8"}],"id":"84b5b01c-df92-45b4-ae11-ae48abfb42cb","description":"This section will discuss about updating the grants available in the application.
\n","_postman_id":"84b5b01c-df92-45b4-ae11-ae48abfb42cb"},{"name":"Fetch a Grant","item":[{"name":"Fetch a Specific Grant","id":"c3948136-52de-4ec2-8559-9a618dc7509c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"url":"{{Host}}/rest/PromotionService/v1/promotions/grants/FREEBIE402","description":"This API is used to retrieve the details of a specific grants using the name.
\n","urlObject":{"path":["rest","PromotionService","v1","promotions","grants","FREEBIE402"],"host":["{{Host}}"],"query":[],"variable":[]}},"response":[{"id":"85e54fbb-8a3c-4156-9ee3-b6e496ea3959","name":"{{Host}}/rest/PromotionService/v1/promotions/grants/FREEBIE402","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{Host}}/rest/PromotionService/v1/promotions/grants/FREEBIE402"},"status":"OK","code":200,"_postman_previewlanguage":"JSON","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Mon, 25 Apr 2022 10:32:21 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"619"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"*, Content-Type, Pragma, Origin, Authorization, party, X-XSRF-TOKEN, X-Requested-With,Access-Control-Allow-Headers,Accept,Access-Control-Allow-Credentials,X-Auth-Token, version, cache"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST,OPTIONS,PUT,DELETE,GET"}],"cookie":[],"responseTime":null,"body":"{\"id\":\"2902\",\"code\":\"FREEBIE402\",\"name\":\"Extra 2 Hour\",\"description\":\"extra 20 hour with every voice call subscription above $500\",\"availableFrom\":\"2022-05-01T00:00:00-07:00\",\"availableTo\":\"2023-05-31T23:59:59-07:00\",\"resourceType\":\"HOUR\",\"value\":10,\"isRecurring\":true,\"carryForward\":false,\"glCode\":\"P2005\",\"validityMode\":\"YEAR\",\"validityUnit\":10,\"prorate\":false,\"availableFor\":1,\"repeatWithInChargingCycle\":false,\"grantCriterias\":[{\"id\":\"102\",\"eventType\":\"VOICE\",\"eventCategory\":\"LONG_DISTANCE\",\"timeCode\":\"Standard\",\"chargeCategoryGroup\":\"A\"}],\"increment\":0.0000,\"minimumQuantity\":0.0000,\"chargeMode\":1,\"status\":\"OK\"}"},{"id":"655b5b50-7304-45b8-ae83-e9b1e2d9ddc0","name":"Fetch a Specific Grant","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text","disabled":true}],"url":"{{Host}}/rest/PromotionService/v1/promotions/grants/FREEBIE402"},"status":"OK","code":200,"_postman_previewlanguage":"JSON","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 26 Apr 2023 10:00:14 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"791"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"*, Content-Type, Pragma, Origin, Authorization, party, X-XSRF-TOKEN, X-Requested-With,Access-Control-Allow-Headers,Accept,Access-Control-Allow-Credentials,X-Auth-Token, version, cache"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST,OPTIONS,PUT,DELETE,GET"}],"cookie":[],"responseTime":null,"body":"{\r\n \"id\": \"2902\",\r\n \"code\": \"FREEBIE402\",\r\n \"name\": \"Extra 2 Hour\",\r\n \"description\": \"extra 20 hour with every voice call subscription above $500\",\r\n \"availableFrom\": \"2022-05-01T00:00:00-07:00\",\r\n \"availableTo\": \"2023-05-31T23:59:59-07:00\",\r\n \"resourceType\": \"HOUR\",\r\n \"value\": 10,\r\n \"isRecurring\": true,\r\n \"carryForward\": false,\r\n \"glCode\": \"P2005\",\r\n \"validityMode\": \"YEAR\",\r\n \"validityUnit\": 10,\r\n \"prorate\": false,\r\n \"availableFor\": 1,\r\n \"allocationCriteria\": 0,\r\n \"grantCriterias\": [\r\n {\r\n \"id\": \"102\",\r\n \"eventType\": \"VOICE\",\r\n \"eventCategory\": \"LONG_DISTANCE\",\r\n \"timeCode\": \"Standard\",\r\n \"chargeCategoryGroup\": \"A\",\r\n \"increment\": 10.0000,\r\n \"minimumQuantity\": 5.0000\r\n }\r\n ],\r\n \"increment\": 0.0000,\r\n \"minimumQuantity\": 1.0000,\r\n \"chargeMode\": 1,\r\n \"thresholdLimits\": [],\r\n \"forever\": false,\r\n \"isValidityForever\": false,\r\n \"grantStatus\": \"Active\",\r\n \"isGrantPurchased\": false,\r\n \"isCurrencyResource\": false,\r\n \"status\": \"OK\"\r\n}"}],"_postman_id":"c3948136-52de-4ec2-8559-9a618dc7509c"},{"name":"Fetch the list of Grants","id":"19456f07-0616-464c-a9e2-a8672fa36d1a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"}],"url":"{{Host}}/rest/PromotionService/v1/promotions/grants","description":"This API is used to fetch the list of all the grants available in the application.
\n","urlObject":{"path":["rest","PromotionService","v1","promotions","grants"],"host":["{{Host}}"],"query":[],"variable":[]}},"response":[{"id":"de1ae33a-0e6e-4bfa-9e8b-754cae0247da","name":"Fetch the list of Grants","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"}],"url":"{{Host}}/rest/PromotionService/v1/promotions/grants"},"status":"OK","code":200,"_postman_previewlanguage":"JSON","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 26 Apr 2023 09:06:10 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"3420"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"*, Content-Type, Pragma, Origin, Authorization, party, X-XSRF-TOKEN, X-Requested-With,Access-Control-Allow-Headers,Accept,Access-Control-Allow-Credentials,X-Auth-Token, version, cache"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST,OPTIONS,PUT,DELETE,GET"}],"cookie":[],"responseTime":null,"body":"{\"grants\":[{\"id\":\"3509\",\"code\":\"FREEBIE2906\",\"name\":\"Extra 2gb\",\"availableFrom\":\"2023-04-12T00:00:00-07:00\",\"resourceType\":\"GB\",\"value\":2.0000000000,\"isRecurring\":true,\"grantStatus\":\"Active\",\"availableFor\":1},{\"id\":\"2902\",\"code\":\"FREEBIE402\",\"name\":\"Extra 2 Hour\",\"availableFrom\":\"2022-05-01T00:00:00-07:00\",\"resourceType\":\"HOUR\",\"value\":10.0000000000,\"isRecurring\":true,\"grantStatus\":\"Active\",\"availableFor\":1,\"availableTo\":\"2023-05-31T23:59:59-07:00\"},{\"id\":\"2308\",\"code\":\"FREEBIE2007\",\"name\":\"Diwali\",\"availableFrom\":\"2021-10-27T00:00:00-07:00\",\"resourceType\":\"GB\",\"value\":10.0000000000,\"isRecurring\":true,\"grantStatus\":\"Active\",\"availableFor\":1},{\"id\":\"1607\",\"code\":\"FREEBIE1406\",\"name\":\"TollFree Inbound Minutes\",\"availableFrom\":\"2021-04-15T00:00:00-07:00\",\"resourceType\":\"MINUTE\",\"value\":2000.0000000000,\"isRecurring\":true,\"grantStatus\":\"Active\",\"availableFor\":2},{\"id\":\"1606\",\"code\":\"FREEBIE1405\",\"name\":\"Long Distance Minute\",\"availableFrom\":\"2021-04-15T00:00:00-07:00\",\"resourceType\":\"MINUTE\",\"value\":1000.0000000000,\"isRecurring\":true,\"grantStatus\":\"Active\",\"availableFor\":2},{\"id\":\"1605\",\"code\":\"FREEBIE1404\",\"name\":\"1000 Free Minutes\",\"availableFrom\":\"2021-04-15T00:00:00-07:00\",\"resourceType\":\"MINUTE\",\"value\":1000.0000000000,\"isRecurring\":true,\"grantStatus\":\"Active\",\"availableFor\":1},{\"id\":\"1604\",\"code\":\"FREEBIE1403\",\"name\":\"500 Free Minutes\",\"availableFrom\":\"2021-04-15T00:00:00-07:00\",\"resourceType\":\"MINUTE\",\"value\":500.0000000000,\"isRecurring\":true,\"grantStatus\":\"Active\",\"availableFor\":1},{\"id\":\"1603\",\"code\":\"FREEBIE1402\",\"name\":\"100 Free Minutes\",\"availableFrom\":\"2021-04-15T00:00:00-07:00\",\"resourceType\":\"MINUTE\",\"value\":100.0000000000,\"isRecurring\":true,\"grantStatus\":\"Active\",\"availableFor\":1},{\"id\":\"1103\",\"code\":\"FREEBIE903\",\"name\":\"60 Minutes Grant\",\"availableFrom\":\"2021-01-12T00:00:00-08:00\",\"resourceType\":\"MINUTE\",\"value\":60.0000000000,\"isRecurring\":true,\"grantStatus\":\"Active\",\"availableFor\":1},{\"id\":\"902\",\"code\":\"FREEBIE802\",\"name\":\"Test Grant\",\"availableFrom\":\"2020-12-29T00:00:00-08:00\",\"resourceType\":\"MB\",\"value\":87.0000000000,\"isRecurring\":true,\"grantStatus\":\"Active\",\"availableFor\":1},{\"id\":\"502\",\"code\":\"FREEBIE502\",\"name\":\"50 Second Freebie\",\"availableFrom\":\"2020-07-23T00:00:00-07:00\",\"resourceType\":\"SECOND\",\"value\":50.0000000000,\"isRecurring\":true,\"grantStatus\":\"Active\",\"availableFor\":1},{\"id\":\"302\",\"code\":\"FREEBIE302\",\"name\":\"100 Mins Domestic calls Free\",\"availableFrom\":\"2020-07-10T00:00:00-07:00\",\"resourceType\":\"SECOND\",\"value\":6000.0000000000,\"isRecurring\":true,\"grantStatus\":\"Active\",\"availableFor\":1},{\"id\":\"202\",\"code\":\"FREEBIE202\",\"name\":\"1000 Seconds\",\"availableFrom\":\"2020-05-06T00:00:00-07:00\",\"resourceType\":\"SECOND\",\"value\":1000.0000000000,\"isRecurring\":true,\"grantStatus\":\"Active\",\"availableFor\":1},{\"id\":\"102\",\"code\":\"FREEBIE102\",\"name\":\"1000 GB\",\"availableFrom\":\"2019-09-24T00:00:00-07:00\",\"resourceType\":\"GB\",\"value\":1000.0000000000,\"isRecurring\":true,\"grantStatus\":\"Active\",\"availableFor\":1},{\"id\":\"2\",\"code\":\"FREEBIE2\",\"name\":\"500 GB\",\"availableFrom\":\"2019-09-16T00:00:00-07:00\",\"resourceType\":\"GB\",\"value\":500.0000000000,\"isRecurring\":true,\"grantStatus\":\"Active\",\"availableFor\":2},{\"id\":\"703\",\"code\":\"FREEBIE703\",\"name\":\"20 Minute Freebie\",\"availableFrom\":\"2020-08-09T00:00:00-07:00\",\"resourceType\":\"MINUTE\",\"value\":20.0000000000,\"isRecurring\":true,\"grantStatus\":\"Expired\",\"availableFor\":1,\"availableTo\":\"2020-08-29T23:59:59-07:00\"}],\"status\":\"OK\"}"},{"id":"85703de7-d18f-48ba-a956-d34eb7fbe3e8","name":"Fetch the list of Grants","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"}],"url":"{{Host}}/rest/PromotionService/v1/promotions/grants"},"status":"OK","code":200,"_postman_previewlanguage":"JSON","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 26 Apr 2023 09:06:10 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"3420"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"*, Content-Type, Pragma, Origin, Authorization, party, X-XSRF-TOKEN, X-Requested-With,Access-Control-Allow-Headers,Accept,Access-Control-Allow-Credentials,X-Auth-Token, version, cache"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST,OPTIONS,PUT,DELETE,GET"}],"cookie":[],"responseTime":null,"body":"{\r\n \"grants\": [\r\n {\r\n \"id\": \"3509\",\r\n \"code\": \"FREEBIE2906\",\r\n \"name\": \"Extra 2gb\",\r\n \"availableFrom\": \"2023-04-12T00:00:00-07:00\",\r\n \"resourceType\": \"GB\",\r\n \"value\": 2.0000000000,\r\n \"isRecurring\": true,\r\n \"grantStatus\": \"Active\",\r\n \"availableFor\": 1\r\n },\r\n {\r\n \"id\": \"2902\",\r\n \"code\": \"FREEBIE402\",\r\n \"name\": \"Extra 2 Hour\",\r\n \"availableFrom\": \"2022-05-01T00:00:00-07:00\",\r\n \"resourceType\": \"HOUR\",\r\n \"value\": 10.0000000000,\r\n \"isRecurring\": true,\r\n \"grantStatus\": \"Active\",\r\n \"availableFor\": 1,\r\n \"availableTo\": \"2023-05-31T23:59:59-07:00\"\r\n },\r\n {\r\n \"id\": \"2308\",\r\n \"code\": \"FREEBIE2007\",\r\n \"name\": \"Diwali\",\r\n \"availableFrom\": \"2021-10-27T00:00:00-07:00\",\r\n \"resourceType\": \"GB\",\r\n \"value\": 10.0000000000,\r\n \"isRecurring\": true,\r\n \"grantStatus\": \"Active\",\r\n \"availableFor\": 1\r\n },\r\n {\r\n \"id\": \"1607\",\r\n \"code\": \"FREEBIE1406\",\r\n \"name\": \"TollFree Inbound Minutes\",\r\n \"availableFrom\": \"2021-04-15T00:00:00-07:00\",\r\n \"resourceType\": \"MINUTE\",\r\n \"value\": 2000.0000000000,\r\n \"isRecurring\": true,\r\n \"grantStatus\": \"Active\",\r\n \"availableFor\": 2\r\n },\r\n {\r\n \"id\": \"1606\",\r\n \"code\": \"FREEBIE1405\",\r\n \"name\": \"Long Distance Minute\",\r\n \"availableFrom\": \"2021-04-15T00:00:00-07:00\",\r\n \"resourceType\": \"MINUTE\",\r\n \"value\": 1000.0000000000,\r\n \"isRecurring\": true,\r\n \"grantStatus\": \"Active\",\r\n \"availableFor\": 2\r\n },\r\n {\r\n \"id\": \"1605\",\r\n \"code\": \"FREEBIE1404\",\r\n \"name\": \"1000 Free Minutes\",\r\n \"availableFrom\": \"2021-04-15T00:00:00-07:00\",\r\n \"resourceType\": \"MINUTE\",\r\n \"value\": 1000.0000000000,\r\n \"isRecurring\": true,\r\n \"grantStatus\": \"Active\",\r\n \"availableFor\": 1\r\n },\r\n {\r\n \"id\": \"1604\",\r\n \"code\": \"FREEBIE1403\",\r\n \"name\": \"500 Free Minutes\",\r\n \"availableFrom\": \"2021-04-15T00:00:00-07:00\",\r\n \"resourceType\": \"MINUTE\",\r\n \"value\": 500.0000000000,\r\n \"isRecurring\": true,\r\n \"grantStatus\": \"Active\",\r\n \"availableFor\": 1\r\n },\r\n {\r\n \"id\": \"1603\",\r\n \"code\": \"FREEBIE1402\",\r\n \"name\": \"100 Free Minutes\",\r\n \"availableFrom\": \"2021-04-15T00:00:00-07:00\",\r\n \"resourceType\": \"MINUTE\",\r\n \"value\": 100.0000000000,\r\n \"isRecurring\": true,\r\n \"grantStatus\": \"Active\",\r\n \"availableFor\": 1\r\n },\r\n {\r\n \"id\": \"1103\",\r\n \"code\": \"FREEBIE903\",\r\n \"name\": \"60 Minutes Grant\",\r\n \"availableFrom\": \"2021-01-12T00:00:00-08:00\",\r\n \"resourceType\": \"MINUTE\",\r\n \"value\": 60.0000000000,\r\n \"isRecurring\": true,\r\n \"grantStatus\": \"Active\",\r\n \"availableFor\": 1\r\n },\r\n {\r\n \"id\": \"902\",\r\n \"code\": \"FREEBIE802\",\r\n \"name\": \"Test Grant\",\r\n \"availableFrom\": \"2020-12-29T00:00:00-08:00\",\r\n \"resourceType\": \"MB\",\r\n \"value\": 87.0000000000,\r\n \"isRecurring\": true,\r\n \"grantStatus\": \"Active\",\r\n \"availableFor\": 1\r\n },\r\n {\r\n \"id\": \"502\",\r\n \"code\": \"FREEBIE502\",\r\n \"name\": \"50 Second Freebie\",\r\n \"availableFrom\": \"2020-07-23T00:00:00-07:00\",\r\n \"resourceType\": \"SECOND\",\r\n \"value\": 50.0000000000,\r\n \"isRecurring\": true,\r\n \"grantStatus\": \"Active\",\r\n \"availableFor\": 1\r\n },\r\n {\r\n \"id\": \"302\",\r\n \"code\": \"FREEBIE302\",\r\n \"name\": \"100 Mins Domestic calls Free\",\r\n \"availableFrom\": \"2020-07-10T00:00:00-07:00\",\r\n \"resourceType\": \"SECOND\",\r\n \"value\": 6000.0000000000,\r\n \"isRecurring\": true,\r\n \"grantStatus\": \"Active\",\r\n \"availableFor\": 1\r\n },\r\n {\r\n \"id\": \"202\",\r\n \"code\": \"FREEBIE202\",\r\n \"name\": \"1000 Seconds\",\r\n \"availableFrom\": \"2020-05-06T00:00:00-07:00\",\r\n \"resourceType\": \"SECOND\",\r\n \"value\": 1000.0000000000,\r\n \"isRecurring\": true,\r\n \"grantStatus\": \"Active\",\r\n \"availableFor\": 1\r\n },\r\n {\r\n \"id\": \"102\",\r\n \"code\": \"FREEBIE102\",\r\n \"name\": \"1000 GB\",\r\n \"availableFrom\": \"2019-09-24T00:00:00-07:00\",\r\n \"resourceType\": \"GB\",\r\n \"value\": 1000.0000000000,\r\n \"isRecurring\": true,\r\n \"grantStatus\": \"Active\",\r\n \"availableFor\": 1\r\n },\r\n {\r\n \"id\": \"2\",\r\n \"code\": \"FREEBIE2\",\r\n \"name\": \"500 GB\",\r\n \"availableFrom\": \"2019-09-16T00:00:00-07:00\",\r\n \"resourceType\": \"GB\",\r\n \"value\": 500.0000000000,\r\n \"isRecurring\": true,\r\n \"grantStatus\": \"Active\",\r\n \"availableFor\": 2\r\n },\r\n {\r\n \"id\": \"703\",\r\n \"code\": \"FREEBIE703\",\r\n \"name\": \"20 Minute Freebie\",\r\n \"availableFrom\": \"2020-08-09T00:00:00-07:00\",\r\n \"resourceType\": \"MINUTE\",\r\n \"value\": 20.0000000000,\r\n \"isRecurring\": true,\r\n \"grantStatus\": \"Expired\",\r\n \"availableFor\": 1,\r\n \"availableTo\": \"2020-08-29T23:59:59-07:00\"\r\n }\r\n ],\r\n \"status\": \"OK\"\r\n}"}],"_postman_id":"19456f07-0616-464c-a9e2-a8672fa36d1a"},{"name":"Fetch Grants list for an Account","id":"6f4e2296-71d8-49ea-a21a-3ef92172090c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"}],"url":"{{Host}}/rest/SubscriberService/v1/subscribers/This API is used to fetching the list of Grants for particular subscriber account.
\nMandatory:
\n- \n
- accountNumber = [STRING]
- \n
- Example: SR1707 \n
\n
Optional:
\n- \n
subscriptionIdentifier: Use this parameter if you wish to list grants based on a subscription identifier. For example, /rest/SubscriberService/v1/subscribers//grants?detailed=true&subscriptionIdentifier=SUB-2230
\n \ngrantName: Use this parameter if you wish to list grants based on a specific grant name. For example, /rest/SubscriberService/v1/subscribers//grants?detailed=true&grantName=500GB
\n \nfromDate: Use this parameter if you wish to list grants based on effective from date.
\n \ntoDate: Use this parameter if you wish to list grants based on the effective to date.
\n \navailableOn: Use this parameter if you wish to list grants based on the type of grant i.e. whether it is an account level grant or a subscription level grant.
\n \nstartCount: Enter the start count of the result.
\n \nresultCount: Enter the total result count in this field.
\n \n
This section will disuss about retrieving the grant details available in the application.
\n","_postman_id":"8b79214e-f3e1-4a81-a149-35d4e6e90d5b"}],"id":"ae7cec97-3e1c-4773-a34e-22e463315e6e","description":"In this section we will discuss about grants and its operation like creating grants, updating grants, fetch grants, and delete grants.
\n","_postman_id":"ae7cec97-3e1c-4773-a34e-22e463315e6e"},{"name":"Counters","item":[{"name":"Create Counter","item":[{"name":"Create a Counter","id":"956d1409-ac11-4cd1-80d7-e47b3e44b5bb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"name\": \"Voice Call Counter\",\r\n \"description\": \"This will count the voice call\",\r\n \"availableFor\": 3,\r\n \"incrementType\": 1,\r\n \"resourceType\": \"MINUTE\",\r\n \"counterMode\": 1,\r\n \"counterCode\": \"\",\r\n \"ceiling\": 80.0000000000,\r\n \"alerts\": [\r\n 5,10\r\n ]\r\n}\r\n"},"url":"{{Host}}/rest/PromotionService/v1/promotions/counter","description":"This API is used to create a counter in the application through request added below.
\n","urlObject":{"path":["rest","PromotionService","v1","promotions","counter"],"host":["{{Host}}"],"query":[],"variable":[]}},"response":[{"id":"eeaee241-9edc-490d-9fca-de7a0d097d0c","name":"Create a Counter","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"name\": \"Voice Call Counter\",\r\n \"description\": \"This will count the voice call\",\r\n \"availableFor\": 3,\r\n \"incrementType\": 1,\r\n \"resourceType\": \"MINUTE\",\r\n \"counterMode\": 1,\r\n \"counterCode\": \"\",\r\n \"ceiling\": 80.0000000000,\r\n \"alerts\": [\r\n 5,10\r\n ]\r\n}\r\n"},"url":"{{Host}}/rest/PromotionService/v1/promotions/counter"},"status":"OK","code":200,"_postman_previewlanguage":"JSON","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 26 Apr 2023 10:50:04 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"56"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"*, Content-Type, Pragma, Origin, Authorization, party, X-XSRF-TOKEN, X-Requested-With,Access-Control-Allow-Headers,Accept,Access-Control-Allow-Credentials,X-Auth-Token, version, cache"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST,OPTIONS,PUT,DELETE,GET"}],"cookie":[],"responseTime":null,"body":"{\r\n \"counterId\": \"102\",\r\n \"counterCode\": \"RC1002\",\r\n \"status\": \"OK\"\r\n}"}],"_postman_id":"956d1409-ac11-4cd1-80d7-e47b3e44b5bb"}],"id":"44a9e3a8-692d-43ac-8319-bae0e6ef000e","description":"This section will discuss creation of the counter in the application.
\n","_postman_id":"44a9e3a8-692d-43ac-8319-bae0e6ef000e"},{"name":"Update Counter","item":[{"name":"Update the Counter","id":"6e97f50a-702b-432c-aa1e-fd0644d5ef28","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"id\": \"102\",\r\n \"name\": \"Voice Call Counter\",\r\n \"description\": \"This will count the voice call\",\r\n \"availableFor\": 3,\r\n \"incrementType\": 1,\r\n \"resourceType\": \"MB\",\r\n \"counterMode\": 1,\r\n \"counterCode\": \"\",\r\n \"ceiling\": 80,\r\n \"alerts\": [\r\n 5,\r\n 10\r\n ]\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"{{Host}}/rest/PromotionService/v1/promotions/counters/?{counterCode}","description":"This API is used to modify counter details in the application.
\n","urlObject":{"path":["rest","PromotionService","v1","promotions","counters",""],"host":["{{Host}}"],"query":[{"description":{"content":"Enter the code to update the counter details.
\n","type":"text/plain"},"key":"{counterCode}","value":null}],"variable":[]}},"response":[{"id":"3c0835ef-9dde-408c-b4d0-e774b14d67c4","name":"Update the Counter","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"id\": \"102\",\r\n \"name\": \"Voice Call Counter\",\r\n \"description\": \"This will count the voice call\",\r\n \"availableFor\": 3,\r\n \"incrementType\": 1,\r\n \"resourceType\": \"MB\",\r\n \"counterMode\": 1,\r\n \"counterCode\": \"\",\r\n \"ceiling\": 80,\r\n \"alerts\": [\r\n 5,\r\n 10\r\n ]\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"{{Host}}/rest/PromotionService/v1/promotions/counters/RC1002"},"status":"OK","code":200,"_postman_previewlanguage":"JSON","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 26 Apr 2023 11:15:07 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"33"},{"key":"Connection","value":"keep-alive"},{"key":"Set-Cookie","value":"JSESSIONID=3AB55BCDA929BE07A30AAD4F0D5E9667.worker3; Path=/; Secure; HttpOnly"},{"key":"Access-Control-Allow-Headers","value":"*, Content-Type, Pragma, Origin, Authorization, party, X-XSRF-TOKEN, X-Requested-With,Access-Control-Allow-Headers,Accept,Access-Control-Allow-Credentials,X-Auth-Token, version, cache"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST,OPTIONS,PUT,DELETE,GET"}],"cookie":[],"responseTime":null,"body":"{\r\n \"counterId\":\"102\",\r\n \"status\":\"OK\"\r\n}"}],"_postman_id":"6e97f50a-702b-432c-aa1e-fd0644d5ef28"}],"id":"baabb3a4-0959-4782-9577-a8fe6dbeafa8","description":"This section will discuss about the modifying a counter details using various examples.
\n","_postman_id":"baabb3a4-0959-4782-9577-a8fe6dbeafa8"},{"name":"Fetch a Counter","item":[{"name":"Fetch the list of Counters","id":"7b3e3135-c14f-4ed5-9d9c-6fe56ddddfa7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"}],"url":"{{Host}}/rest/PromotionService/v1/promotions/counters","description":"This API is used to fetch the counter details using the GET request.
\n","urlObject":{"path":["rest","PromotionService","v1","promotions","counters"],"host":["{{Host}}"],"query":[],"variable":[]}},"response":[{"id":"8e7ccd00-541e-441d-8a3b-00e76487ebdd","name":"Fetch the list of Counters","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"}],"url":"{{Host}}/rest/PromotionService/v1/promotions/counters"},"status":"OK","code":200,"_postman_previewlanguage":"JSON","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 26 Apr 2023 10:30:53 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"354"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"*, Content-Type, Pragma, Origin, Authorization, party, X-XSRF-TOKEN, X-Requested-With,Access-Control-Allow-Headers,Accept,Access-Control-Allow-Credentials,X-Auth-Token, version, cache"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST,OPTIONS,PUT,DELETE,GET"}],"cookie":[],"responseTime":null,"body":"{\r\n \"resultSize\": 2,\r\n \"counters\": [\r\n {\r\n \"id\": \"3\",\r\n \"code\": \"CN20201\",\r\n \"name\": \"New Counter\",\r\n \"description\": \"New Counter\",\r\n \"availableFor\": 3,\r\n \"incrementType\": 2,\r\n \"resourceType\": \"SECOND\",\r\n \"status\": \"OK\"\r\n },\r\n {\r\n \"id\": \"2\",\r\n \"code\": \"cn1001\",\r\n \"name\": \"PostGrant COunter\",\r\n \"description\": \"PostGrant COunter\",\r\n \"availableFor\": 2,\r\n \"incrementType\": 2,\r\n \"resourceType\": \"SECOND\",\r\n \"status\": \"OK\"\r\n }\r\n ],\r\n \"status\": \"OK\"\r\n}"}],"_postman_id":"7b3e3135-c14f-4ed5-9d9c-6fe56ddddfa7"},{"name":"Fetch specific Counter","id":"e45645f1-eeae-4847-87fd-fb6a22a06830","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"}],"url":"{{Host}}/rest/PromotionService/v1/promotions/counters/cn1001","description":"This API is used to fetch a specific counter available in the application. Using the promotion code the details can be fetch.
\n","urlObject":{"path":["rest","PromotionService","v1","promotions","counters","cn1001"],"host":["{{Host}}"],"query":[],"variable":[]}},"response":[{"id":"94478088-5c8a-4260-b3dc-04bb789a302a","name":"Fetch specific Counter","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"}],"url":"{{Host}}/rest/PromotionService/v1/promotions/counters/cn1001"},"status":"OK","code":200,"_postman_previewlanguage":"JSON","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 26 Apr 2023 10:37:13 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"229"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"*, Content-Type, Pragma, Origin, Authorization, party, X-XSRF-TOKEN, X-Requested-With,Access-Control-Allow-Headers,Accept,Access-Control-Allow-Credentials,X-Auth-Token, version, cache"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST,OPTIONS,PUT,DELETE,GET"}],"cookie":[],"responseTime":null,"body":"{\r\n \"id\": \"2\",\r\n \"code\": \"cn1001\",\r\n \"name\": \"PostGrant COunter\",\r\n \"description\": \"PostGrant COunter\",\r\n \"availableFor\": 2,\r\n \"incrementType\": 2,\r\n \"resourceType\": \"SECOND\",\r\n \"counterMode\": 1,\r\n \"isCurrencyResource\": false,\r\n \"isCounterPurchased\": true,\r\n \"status\": \"OK\"\r\n}"}],"_postman_id":"e45645f1-eeae-4847-87fd-fb6a22a06830"},{"name":"Fetch list of Grants for Subscriber Account","id":"b3d700ba-e168-4663-a702-d1916a9b1cd3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"}],"url":"{{Host}}/rest/SubscriberService/v1/subscribers/OBD-SR14702/counters?detailed=true","description":"This API is used to list of grants available in the subscriber's account. Using account number the one can fetch the details.
\n","urlObject":{"path":["rest","SubscriberService","v1","subscribers","OBD-SR14702","counters"],"host":["{{Host}}"],"query":[{"key":"detailed","value":"true"}],"variable":[]}},"response":[{"id":"d864960e-e0e7-4b41-a3b7-302a61104e6d","name":"Fetch list of Grants for Subscriber Account","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"}],"url":{"raw":"{{Host}}/rest/SubscriberService/v1/subscribers/OBD-SR14702/counters?detailed=true","host":["{{Host}}"],"path":["rest","SubscriberService","v1","subscribers","OBD-SR14702","counters"],"query":[{"key":"detailed","value":"true"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Thu, 15 Jun 2023 07:12:49 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"1525"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"*, Content-Type, Pragma, Origin, Authorization, party, X-XSRF-TOKEN, X-Requested-With,Access-Control-Allow-Headers,Accept,Access-Control-Allow-Credentials,X-Auth-Token, version, cache"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST,OPTIONS,PUT,DELETE,GET"}],"cookie":[],"responseTime":null,"body":"{\n \"accountNumber\": \"OBD-SR14702\",\n \"counterNameDetails\": [\n {\n \"counterName\": \"New Counter\",\n \"uom\": \"SECOND\",\n \"counterValue\": 0,\n \"balance\": [\n {\n \"id\": \"603\",\n \"counterName\": \"New Counter\",\n \"uom\": \"SECOND\",\n \"availableFor\": \"Plan\",\n \"subscriptionIdentifier\": \"OBD-SUB21302-OBD-SR14702-Internet Plan\",\n \"counterValue\": 0,\n \"subscriptionType\": 1,\n \"groupingCycle\": 6\n },\n {\n \"id\": \"605\",\n \"counterName\": \"New Counter\",\n \"uom\": \"SECOND\",\n \"availableFor\": \"Plan\",\n \"subscriptionIdentifier\": \"OBD-SUB21302-OBD-SR14702-Internet Plan\",\n \"counterValue\": 0,\n \"subscriptionType\": 1,\n \"groupingCycle\": 6\n },\n {\n \"id\": \"607\",\n \"counterName\": \"New Counter\",\n \"uom\": \"SECOND\",\n \"availableFor\": \"Plan\",\n \"subscriptionIdentifier\": \"OBD-SUB21302-OBD-SR14702-Internet Plan\",\n \"counterValue\": 0,\n \"subscriptionType\": 1,\n \"groupingCycle\": 6\n },\n {\n \"id\": \"609\",\n \"counterName\": \"New Counter\",\n \"uom\": \"SECOND\",\n \"availableFor\": \"Plan\",\n \"subscriptionIdentifier\": \"OBD-SUB21302-OBD-SR14702-Internet Plan\",\n \"counterValue\": 0,\n \"subscriptionType\": 1,\n \"groupingCycle\": 6\n }\n ]\n },\n {\n \"counterName\": \"PostGrant COunter\",\n \"uom\": \"SECOND\",\n \"counterValue\": 0,\n \"balance\": [\n {\n \"id\": \"602\",\n \"counterName\": \"PostGrant COunter\",\n \"uom\": \"SECOND\",\n \"availableFor\": \"Account\",\n \"counterValue\": 0,\n \"groupingCycle\": 6\n },\n {\n \"id\": \"604\",\n \"counterName\": \"PostGrant COunter\",\n \"uom\": \"SECOND\",\n \"availableFor\": \"Account\",\n \"counterValue\": 0,\n \"groupingCycle\": 6\n },\n {\n \"id\": \"606\",\n \"counterName\": \"PostGrant COunter\",\n \"uom\": \"SECOND\",\n \"availableFor\": \"Account\",\n \"counterValue\": 0,\n \"groupingCycle\": 6\n },\n {\n \"id\": \"608\",\n \"counterName\": \"PostGrant COunter\",\n \"uom\": \"SECOND\",\n \"availableFor\": \"Account\",\n \"counterValue\": 0,\n \"groupingCycle\": 6\n }\n ]\n }\n ],\n \"resultSize\": 2,\n \"status\": \"OK\"\n}"}],"_postman_id":"b3d700ba-e168-4663-a702-d1916a9b1cd3"},{"name":"Fetch list of Grants for Subscriber Account with Counter name","id":"cc15aa93-6f27-43be-933f-c7237965854a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"}],"url":"{{Host}}/rest/SubscriberService/v1/subscribers/OBD-SR14702/counters?detailed=true&counterName=New Counter","description":"This API is used to fetch the list of grants for subscriber aacount using counter name.
\n","urlObject":{"path":["rest","SubscriberService","v1","subscribers","OBD-SR14702","counters"],"host":["{{Host}}"],"query":[{"key":"detailed","value":"true"},{"key":"counterName","value":"New Counter"}],"variable":[]}},"response":[{"id":"aba9f571-42c1-4cda-b1dd-1336364e30d5","name":"Fetch list of Grants for Subscriber Account with Counter name","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"}],"url":{"raw":"{{Host}}/rest/SubscriberService/v1/subscribers/OBD-SR14702/counters?detailed=true&counterName=New Counter","host":["{{Host}}"],"path":["rest","SubscriberService","v1","subscribers","OBD-SR14702","counters"],"query":[{"key":"detailed","value":"true"},{"key":"counterName","value":"New Counter"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Thu, 15 Jun 2023 07:33:56 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"957"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"*, Content-Type, Pragma, Origin, Authorization, party, X-XSRF-TOKEN, X-Requested-With,Access-Control-Allow-Headers,Accept,Access-Control-Allow-Credentials,X-Auth-Token, version, cache"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST,OPTIONS,PUT,DELETE,GET"}],"cookie":[],"responseTime":null,"body":"{\n \"accountNumber\": \"OBD-SR14702\",\n \"counterNameDetails\": [\n {\n \"counterName\": \"New Counter\",\n \"uom\": \"SECOND\",\n \"counterValue\": 0,\n \"balance\": [\n {\n \"id\": \"603\",\n \"counterName\": \"New Counter\",\n \"uom\": \"SECOND\",\n \"availableFor\": \"Plan\",\n \"subscriptionIdentifier\": \"OBD-SUB21302-OBD-SR14702-Internet Plan\",\n \"counterValue\": 0,\n \"subscriptionType\": 1,\n \"groupingCycle\": 6\n },\n {\n \"id\": \"605\",\n \"counterName\": \"New Counter\",\n \"uom\": \"SECOND\",\n \"availableFor\": \"Plan\",\n \"subscriptionIdentifier\": \"OBD-SUB21302-OBD-SR14702-Internet Plan\",\n \"counterValue\": 0,\n \"subscriptionType\": 1,\n \"groupingCycle\": 6\n },\n {\n \"id\": \"607\",\n \"counterName\": \"New Counter\",\n \"uom\": \"SECOND\",\n \"availableFor\": \"Plan\",\n \"subscriptionIdentifier\": \"OBD-SUB21302-OBD-SR14702-Internet Plan\",\n \"counterValue\": 0,\n \"subscriptionType\": 1,\n \"groupingCycle\": 6\n },\n {\n \"id\": \"609\",\n \"counterName\": \"New Counter\",\n \"uom\": \"SECOND\",\n \"availableFor\": \"Plan\",\n \"subscriptionIdentifier\": \"OBD-SUB21302-OBD-SR14702-Internet Plan\",\n \"counterValue\": 0,\n \"subscriptionType\": 1,\n \"groupingCycle\": 6\n }\n ]\n }\n ],\n \"resultSize\": 1,\n \"status\": \"OK\"\n}"}],"_postman_id":"cc15aa93-6f27-43be-933f-c7237965854a"},{"name":"Fetch list of Grants for Subscriber Account with Subscription Identifier","id":"40065092-a595-49fa-8bd4-0d0c4fe049f7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"url":"{{Host}}/rest/SubscriberService/v1/subscribers/OBD-SR14702/counters?detailed=true&subscriptionIdentifier=OBD-SUB21302-OBD-SR14702-Internet Plan&counterName=New Counter","description":"This API is used to fetch list of grants for subscriber account with subscription identfier.
\n","urlObject":{"path":["rest","SubscriberService","v1","subscribers","OBD-SR14702","counters"],"host":["{{Host}}"],"query":[{"key":"detailed","value":"true"},{"key":"subscriptionIdentifier","value":"OBD-SUB21302-OBD-SR14702-Internet Plan"},{"key":"counterName","value":"New Counter"}],"variable":[]}},"response":[{"id":"fc885d1b-e59f-4238-90f5-d7c8b30e8f36","name":"Fetch list of Grants for Subscriber Account with Subscription Identifier","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"url":{"raw":"{{Host}}/rest/SubscriberService/v1/subscribers/OBD-SR14702/counters?detailed=true&subscriptionIdentifier=OBD-SUB21302-OBD-SR14702-Internet Plan&counterName=New Counter","host":["{{Host}}"],"path":["rest","SubscriberService","v1","subscribers","OBD-SR14702","counters"],"query":[{"key":"detailed","value":"true"},{"key":"subscriptionIdentifier","value":"OBD-SUB21302-OBD-SR14702-Internet Plan"},{"key":"counterName","value":"New Counter"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Thu, 15 Jun 2023 07:43:26 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"957"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"*, Content-Type, Pragma, Origin, Authorization, party, X-XSRF-TOKEN, X-Requested-With,Access-Control-Allow-Headers,Accept,Access-Control-Allow-Credentials,X-Auth-Token, version, cache"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST,OPTIONS,PUT,DELETE,GET"}],"cookie":[],"responseTime":null,"body":"{\n \"accountNumber\": \"OBD-SR14702\",\n \"counterNameDetails\": [\n {\n \"counterName\": \"New Counter\",\n \"uom\": \"SECOND\",\n \"counterValue\": 0,\n \"balance\": [\n {\n \"id\": \"603\",\n \"counterName\": \"New Counter\",\n \"uom\": \"SECOND\",\n \"availableFor\": \"Plan\",\n \"subscriptionIdentifier\": \"OBD-SUB21302-OBD-SR14702-Internet Plan\",\n \"counterValue\": 0,\n \"subscriptionType\": 1,\n \"groupingCycle\": 6\n },\n {\n \"id\": \"605\",\n \"counterName\": \"New Counter\",\n \"uom\": \"SECOND\",\n \"availableFor\": \"Plan\",\n \"subscriptionIdentifier\": \"OBD-SUB21302-OBD-SR14702-Internet Plan\",\n \"counterValue\": 0,\n \"subscriptionType\": 1,\n \"groupingCycle\": 6\n },\n {\n \"id\": \"607\",\n \"counterName\": \"New Counter\",\n \"uom\": \"SECOND\",\n \"availableFor\": \"Plan\",\n \"subscriptionIdentifier\": \"OBD-SUB21302-OBD-SR14702-Internet Plan\",\n \"counterValue\": 0,\n \"subscriptionType\": 1,\n \"groupingCycle\": 6\n },\n {\n \"id\": \"609\",\n \"counterName\": \"New Counter\",\n \"uom\": \"SECOND\",\n \"availableFor\": \"Plan\",\n \"subscriptionIdentifier\": \"OBD-SUB21302-OBD-SR14702-Internet Plan\",\n \"counterValue\": 0,\n \"subscriptionType\": 1,\n \"groupingCycle\": 6\n }\n ]\n }\n ],\n \"resultSize\": 1,\n \"status\": \"OK\"\n}"}],"_postman_id":"40065092-a595-49fa-8bd4-0d0c4fe049f7"}],"id":"d80afb98-b389-4640-bcfc-d61b38377d6b","description":"This section will discuss to fetch the counter details using various examples.
\n","_postman_id":"d80afb98-b389-4640-bcfc-d61b38377d6b"}],"id":"24efec14-bcf5-46c7-9212-cef892fc770c","description":"In this section, we will discuss about the counters and its operations like create counter, update counter, fetch a counter, and delete a counter.
\n","_postman_id":"24efec14-bcf5-46c7-9212-cef892fc770c"}],"id":"8610df0e-1e11-47f9-ab87-931d1f31c152","description":"This section deals with the various APIs required to create, update, and manage product promotions such as grants in the application.
\n","_postman_id":"8610df0e-1e11-47f9-ab87-931d1f31c152"},{"name":"Payments","item":[{"name":"Make Payment","item":[{"name":"Make a Payment - Parameter Info","id":"d9e24121-08da-4402-9379-bc4fc1b33773","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth1","oauth1":{"basicConfig":[],"advancedConfig":[{"key":"signatureMethod","value":"Provide the generated access token in this field.
\n","key":"Authorization","type":"text","value":"Bearer{{token}}"},{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\"invoiceNumber\":\"?\",\n\"description\":\"?\",\n\"paymentDate\":\"YYYY-MM-DD\",\n\"accountNumber\":\"?\",\n\"paymentMethod\":\"?\",\n\"referenceNumber\":\"?\",\n\"paymentAmount\":\"?\"\n}"},"url":"{{Host}}/rest/PaymentService/v1/payment","description":"This section lists and explains the various URL and data parameters which are present in this API.
\nURL Parameters
\nnone
\nData Parameters
\nCheck out the field descriptions for each data parameter below.
\nRequest Data Parameters
\nNote: Only one type of payment can be choosen either account level or invoice level. Both cannot be passed in the same request.
\n","urlObject":{"path":["rest","PaymentService","v1","payment"],"host":["{{Host}}"],"query":[],"variable":[]}},"response":[{"id":"2fb8c193-5bd5-4ff1-bb04-1fc624f16fa4","name":"Make a Payment - Parameter Info","originalRequest":{"method":"POST","header":[{"description":"Provide the generated access token in this field.","key":"Authorization","type":"text","value":"Bearer{{token}}"},{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\"invoiceNumber\":\"OBD-IN23739\",\n\"description\":\"Payment of due invoice\",\n\"paymentDate\":\"2022-04-19\",\n\"accountNumber\":\"SR12604\",\n\"paymentMethod\":\"CC\",\n\"referenceNumber\":\"\",\n\"paymentAmount\":\"554\"\n}"},"url":"{{Host}}/rest/PaymentService/v1/payment"},"status":"OK","code":200,"_postman_previewlanguage":"JSON","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Tue, 19 Apr 2022 07:48:26 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"173"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"*, Content-Type, Pragma, Origin, Authorization, party, X-XSRF-TOKEN, X-Requested-With,Access-Control-Allow-Headers,Accept,Access-Control-Allow-Credentials,X-Auth-Token, version, cache"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST,OPTIONS,PUT,DELETE,GET"}],"cookie":[],"responseTime":null,"body":"{\"invoiceNumber\":\"OBD-IN23739\",\"accountId\":\"12304\",\"responseCode\":\"1\",\"reasonResponseCode\":\"1\",\"transactionNumber\":\"60191488184\",\"isCustomOpgUrlEnabled\":false,\"status\":\"OK\"}"}],"_postman_id":"d9e24121-08da-4402-9379-bc4fc1b33773"}],"id":"941c523f-5534-4e4f-8da8-357d644488e9","description":"This API is used to make a payment toward a specific outstanding unpaid invoice which belongs to an existing subscriber account.
\n","_postman_id":"941c523f-5534-4e4f-8da8-357d644488e9"},{"name":"Search Payment","item":[{"name":"Search Payment - Parameter Info","id":"0b849c1e-c3f6-46e8-b896-3bde879d0ad1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth1","oauth1":{"basicConfig":[],"advancedConfig":[{"key":"signatureMethod","value":"Provide the generated access token in this field.
\n","key":"Authorization","type":"text","value":"Bearer{{token}}"},{"key":"Content-Type","type":"text","value":"application/json"}],"url":"{{host}}/rest/PaymentService/v1/payments?rangeFrom=This section lists and explains the various URL and data parameters which are present in this API.
\nURL Parameters
\nData Parameters
\nnone
\n","urlObject":{"path":["rest","PaymentService","v1","payments"],"host":["{{host}}"],"query":[{"key":"rangeFrom","value":"This API is used to fetch the details of payment receipt for the Subscriber. This will help to get information of specific subscriber.
\n","urlObject":{"path":["rest","PaymentService","v1","payments","{accountNumber}"],"host":["{{Host}}"],"query":[{"key":"startCount","value":"{value}"},{"key":"resultCount","value":"{value}"}],"variable":[]}},"response":[{"id":"c1dee736-9095-4ffb-9446-2c332dda634e","name":"Fetch Payment Receipt for Specific Subscriber","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"url":{"raw":"{{Host}}/rest/PaymentService/v1/payments/OBD-SR15403?startCount={value}&resultCount={value}","host":["{{Host}}"],"path":["rest","PaymentService","v1","payments","OBD-SR15403"],"query":[{"key":"startCount","value":"{value}"},{"key":"resultCount","value":"{value}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Thu, 08 Feb 2024 07:21:34 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"761"},{"key":"Connection","value":"keep-alive"},{"key":"Set-Cookie","value":"JSESSIONID=30ED84BAA41638EFC4B2D90F46A726EA.worker3; Path=/; Secure; HttpOnly"},{"key":"Access-Control-Allow-Headers","value":"*, Content-Type, Pragma, Origin, Authorization, party, X-XSRF-TOKEN, X-Requested-With,Access-Control-Allow-Headers,Accept,Access-Control-Allow-Credentials,X-Auth-Token, version, cache"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST,OPTIONS,PUT,DELETE,GET"}],"cookie":[],"responseTime":null,"body":"{\n \"accountId\": \"15702\",\n \"resultSize\": 0,\n \"payment\": [\n {\n \"invoiceNumber\": \"OBD-IN37831\",\n \"amount\": 2700.85,\n \"receiptNumber\": \"REC28102\",\n \"paymentMethod\": \"CC\",\n \"paymentDate\": \"2023-12-29T00:47:55-08:00\",\n \"id\": \"1719542466744453207\",\n \"effectiveDate\": \"2023-12-29T00:47:53-08:00\",\n \"balance\": 0,\n \"paymentStatus\": \"CLOSED\",\n \"isARRevamp\": true,\n \"isRefund\": false,\n \"paymentRef\": \"120012588558\",\n \"paymentProfile\": \"**** **** **** 1111\",\n \"type\": \"VISA\"\n },\n {\n \"invoiceNumber\": \"OBD-IN37402\",\n \"amount\": 100,\n \"receiptNumber\": \"REC25602\",\n \"paymentMethod\": \"CHECK\",\n \"paymentDate\": \"2023-07-31T05:03:13-07:00\",\n \"id\": \"1664871061621079698\",\n \"effectiveDate\": \"2023-07-31T05:03:13-07:00\",\n \"balance\": 0,\n \"paymentStatus\": \"Reversed\",\n \"isARRevamp\": true,\n \"isRefund\": false\n }\n ],\n \"currencySymbol\": \"$\",\n \"partyRoleType\": \"1004\",\n \"status\": \"OK\"\n}\n"}],"_postman_id":"d0a63dfd-7371-413f-8f97-b0643229a74d"}],"id":"5f8c2d40-0069-4a89-b0f5-db485a5a6935","description":"In this section we will discuss about fetching the payment and details. Using this will fetch details about payment using various URL parameters.
\n","_postman_id":"5f8c2d40-0069-4a89-b0f5-db485a5a6935"}],"id":"5ebc4f01-ab62-4166-bed0-3756d5ac4262","description":"This section deals with the various APIs required to manage subscriber payments in the application.
\n","_postman_id":"5ebc4f01-ab62-4166-bed0-3756d5ac4262"},{"name":"Service Desk","item":[{"name":"Tickets","item":[{"name":"Create a Ticket","item":[{"name":"Create a Ticket","id":"bb16c93b-ba6c-438d-9141-38ed61ddd2a2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"subject\": \"My internet connection\",\r\n \"description\": \"Internet not working network issue\",\r\n \"accountNumber\": \"OBD-SR13403\",\r\n \"priority\": 4,\r\n \"ticketType\": 0,\r\n \"classificationId\": \"28\",\r\n \"contactId\": \"16604\",\r\n \"addressId\": \"16203\",\r\n \"attachments\": [\r\n {\r\n \"filename\": \"Ticket.pdf\",\r\n \"fileContent\": \"JVBERi0xLjQKJdPr6eEKMSAwIG9iago8PC9UaXRsZSAoVGlja2V0KQovUHJvZHVjZXIgKFNraWEvUERGIG0xMTQgR29vZ2xlIERvY3MgUmKL0luZm8gMSAwIFI+PgpzdGFydHhyZWYKMTc1MzAKJSVFT0YK\",\r\n \"operationType\": 0\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{Host}}/rest/TicketManagementService/v1/ticket","description":"This API example is to create a ticket from a business portal. This would be the equivalent of your CSR / agent user creating a ticket from the CSR / business portal.
\nData Parameter
\nCheck out the field descriptions for each data parameter in the link provided below. Data Parameters.
\n","urlObject":{"path":["rest","TicketManagementService","v1","ticket"],"host":["{{Host}}"],"query":[],"variable":[]}},"response":[{"id":"2cc50838-e17f-45be-92b7-d476600b2218","name":"Create a Ticket","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"subject\": \"My internet connection\",\r\n \"description\": \"Internet not working network issue\",\r\n \"accountNumber\": \"OBD-SR13403\",\r\n \"priority\": 4,\r\n \"ticketType\": 0,\r\n \"classificationId\": \"28\",\r\n \"contactId\": \"16604\",\r\n \"addressId\": \"16203\",\r\n \"attachments\": [\r\n {\r\n \"filename\": \"Ticket.pdf\",\r\n \"fileContent\": \"JVBERi0xLjQKJdPr6eEKMSAwIG9iago8PC9UaXRsZSAoVGlja2V0KQovUHJvZHVjZXIgKFNraWEvUERGIG0xMTQgR29vZ2xlIERvY3MgUmKL0luZm8gMSAwIFI+PgpzdGFydHhyZWYKMTc1MzAKJSVFT0YK\",\r\n \"operationType\": 0\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{Host}}/rest/TicketManagementService/v1/ticket"},"status":"OK","code":200,"_postman_previewlanguage":"JSON","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Mon, 24 Apr 2023 10:30:14 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"55"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"*, Content-Type, Pragma, Origin, Authorization, party, X-XSRF-TOKEN, X-Requested-With,Access-Control-Allow-Headers,Accept,Access-Control-Allow-Credentials,X-Auth-Token, version, cache"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST,OPTIONS,PUT,DELETE,GET"}],"cookie":[],"responseTime":null,"body":"{\r\n\"id\":\"2704\",\r\n\"ticketNumber\":\"OBD-SR3404\",\r\n\"status\":\"OK\"\r\n}"}],"_postman_id":"bb16c93b-ba6c-438d-9141-38ed61ddd2a2"},{"name":"Create a Ticket from Self-care","id":"0e62fc6d-d92b-44a7-96e8-cbefbddd06af","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"","description":"This is an example of a ticket created from the end customer / self-service portal. This API can be used from your end customer portal to let your end customer / subscriber create a ticket.
\n","urlObject":{"query":[],"variable":[]}},"response":[],"_postman_id":"0e62fc6d-d92b-44a7-96e8-cbefbddd06af"}],"id":"9dcac3f5-b57c-4a7b-9117-db222b46e855","description":"This API can be used to create a new ticket in the BSS application. A ticket created from API would also be visible in the BSS UI.
\n","_postman_id":"9dcac3f5-b57c-4a7b-9117-db222b46e855"},{"name":"Update a Ticket","item":[{"name":"Update the ticket","id":"1ae38cbb-20cc-4cf2-8a49-38d32236ad9e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"","description":"This API is used to update the ticket available in the application using example added below users can update the ticket details.
\n","urlObject":{"query":[],"variable":[]}},"response":[],"_postman_id":"1ae38cbb-20cc-4cf2-8a49-38d32236ad9e"}],"id":"be017846-5269-4e64-b394-74d670c624db","description":"Update ticket APIs can be used to update an existing ticket that is existing in the BSS application. Tickets can be created in any channel(Business portal, Selfcare, API) and managed through any channel. For eg a ticket created by a CSR in the business portal can be updated from your cusotm portal using the Update ticket API.
\n","_postman_id":"be017846-5269-4e64-b394-74d670c624db"},{"name":"Search the Ticket","item":[{"name":"Search the ticket","id":"9dfe0a7f-a297-4500-9bbe-363dc9dfd3ed","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"url":"{{Host}}/rest/TicketManagementService/v1/tickets/?{ticketNumber}","description":"This API is used to search ticket details using ticket number in the URL.
\n","urlObject":{"path":["rest","TicketManagementService","v1","tickets",""],"host":["{{Host}}"],"query":[{"description":{"content":"Enter the ticket number for searching the ticket in the system.
\n","type":"text/plain"},"key":"{ticketNumber}","value":null}],"variable":[]}},"response":[{"id":"a8dc37cd-c0bf-4ea6-9c4e-04ec8d723e32","name":"{{Host}}/rest/TicketManagementService/v1/tickets/{Ticket Number}","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{token}}"}],"url":"{{Host}}/rest/TicketManagementService/v1/tickets/{Ticket Number}"},"status":"OK","code":200,"_postman_previewlanguage":"JSON","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Fri, 22 Apr 2022 08:05:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"1956"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"*, Content-Type, Pragma, Origin, Authorization, party, X-XSRF-TOKEN, X-Requested-With,Access-Control-Allow-Headers,Accept,Access-Control-Allow-Credentials,X-Auth-Token, version, cache"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST,OPTIONS,PUT,DELETE,GET"}],"cookie":[],"responseTime":null,"body":"{\r\n \"ticketNumber\": \"SR2202\",\r\n \"ticketSource\": \"CSR\",\r\n \"subject\": \"Product description incorrect\",\r\n \"description\": \"Product description has to be updated \",\r\n \"ticketStatus\": \"OPEN\",\r\n \"classificationId\": \"2647\",\r\n \"ticketType\": \"System\",\r\n \"isBillable\": false,\r\n \"isEscalated\": false,\r\n \"isDeleted\": false,\r\n \"ticketPriority\": \"Medium\",\r\n \"assigneeId\": \"10405\",\r\n \"assigneeUsername\": \"harshkumar.singh@gmail.com\",\r\n \"assigneeFirstName\": \"Harsh\",\r\n \"assigneeLastName\": \"Singh\",\r\n \"managerId\": \"10405\",\r\n \"managerUsername\": \"harshkumar.singh@gmail.com\",\r\n \"managerFirstName\": \"Harsh\",\r\n \"managerLastName\": \"Singh\",\r\n \"remarks\": \"\",\r\n \"deptId\": \"1908\",\r\n \"deptName\": \"Documentation Team\",\r\n \"incidentTypeId\": \"1128\",\r\n \"incidentType\": \"Request Information\",\r\n \"incidentSubTypeId\": \"1129\",\r\n \"incidentSubType\": \"Product Info\",\r\n \"responseTime\": 5760,\r\n \"responseDueDate\": \"2022-01-31T23:45:53-08:00\",\r\n \"resolutionTime\": 5760,\r\n \"resolutionDueDate\": \"2022-01-31T23:45:53-08:00\",\r\n \"assignedDate\": \"2022-01-27T23:45:53-08:00\",\r\n \"isResponded\": false,\r\n \"overDueInMinutes\": 115279,\r\n \"partyRoleId\": \"2\",\r\n \"createdBy\": \"10404\",\r\n \"createdByUsername\": \"rajalakshmi@gmail.com\",\r\n \"createdByFirstName\": \"Rajalakshmi\",\r\n \"createdByLastName\": \"Ravichandran\",\r\n \"createdDate\": \"2022-01-27T23:45:53-08:00\",\r\n \"lastModifiedBy\": \"10404\",\r\n \"lastModifiedByUsername\": \"rajalakshmi@gmail.com\",\r\n \"lastModifiedByFirstName\": \"Rajalakshmi\",\r\n \"lastModifiedByLasttName\": \"Ravichandran\",\r\n \"lastModifiedDate\": \"2022-01-27T23:45:53-08:00\",\r\n \"loggedUserId\": \"10405\",\r\n \"loggedUserEmailId\": \"harshkumar.singh@gmail.com\",\r\n \"historyList\": [],\r\n \"watchers\": [],\r\n \"conversations\": [],\r\n \"timeLogs\": [],\r\n \"attachments\": [],\r\n \"recentHistoryInfo\": {\r\n \"id\": \"2007\",\r\n \"createdBy\": \"10404\",\r\n \"createdByUsername\": \"rajalakshmi@gmail.com\",\r\n \"createdByFirstName\": \"Rajalakshmi\",\r\n \"createdByLastName\": \"Ravichandran\",\r\n \"createdDate\": \"2022-01-27T23:45:53-08:00\",\r\n \"historyAttributes\": {\r\n \"attributeMap\": {\r\n \"status\": \"OPEN\"\r\n },\r\n \"description\": \"New ticket created.\"\r\n }\r\n },\r\n \"customAttributes\": [],\r\n \"isPrivateComment\": true,\r\n \"status\": \"OK\"\r\n}"}],"_postman_id":"9dfe0a7f-a297-4500-9bbe-363dc9dfd3ed"},{"name":"Fetch the Ticket history","id":"726c3c9f-c6ff-45f4-a6a8-d9e7b29aabf1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"url":"{{Host}}/rest/TicketManagementService/v1/searchTicketHistory?ticketNumber={ticket_number}","description":"This API is used to fetch the history of the ticket. Details such as operations taken on the ticket will be shown.
\n","urlObject":{"path":["rest","TicketManagementService","v1","searchTicketHistory"],"host":["{{Host}}"],"query":[{"description":{"content":"Enter the ticket number for which user want to see the history.
\n","type":"text/plain"},"key":"ticketNumber","value":"{ticket_number}"}],"variable":[]}},"response":[{"id":"5026f5a4-9c24-4c8b-a766-2da437035c4f","name":"Fetch the Ticket history","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{token}}","type":"text"},{"key":"","value":"","type":"text","disabled":true}],"url":{"raw":"{{Host}}/rest/TicketManagementService/v1/searchTicketHistory?ticketNumber={ticket_number}","host":["{{Host}}"],"path":["rest","TicketManagementService","v1","searchTicketHistory"],"query":[{"key":"ticketNumber","value":"{ticket_number}","description":"Enter the ticket number for which user want to see the history. "}]}},"status":"OK","code":200,"_postman_previewlanguage":"JSON","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Mon, 24 Apr 2023 11:01:43 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"804"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"*, Content-Type, Pragma, Origin, Authorization, party, X-XSRF-TOKEN, X-Requested-With,Access-Control-Allow-Headers,Accept,Access-Control-Allow-Credentials,X-Auth-Token, version, cache"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST,OPTIONS,PUT,DELETE,GET"}],"cookie":[],"responseTime":null,"body":"{\r\n \"historyInfoList\":\r\n [\r\n {\r\n \"id\":\"3807\",\r\n \"createdBy\":\"10405\",\r\n \"createdByUsername\":\"VOIP@yopmail.com\",\r\n \"createdByFirstName\":\"John\",\r\n \"createdByLastName\":\"Hayden\",\r\n \"createdDate\":\"2023-04-24T03:39:04-07:00\",\r\n \"historyAttributes\":\r\n {\r\n \"attributeMap\":\r\n {\r\n \"assignee\":\"John;Micheal\"\r\n },\r\n \"description\":\"Assignee changed.\"\r\n },\r\n \"ticketNumber\":\"OBD-SR3404\",\r\n \"subject\":\"My internet connection\",\r\n \"accountNumber\":\"OBD-SR13403\"\r\n },\r\n {\r\n \"id\":\"3806\",\r\n \"createdBy\":\"10405\",\r\n \"createdByUsername\":\"VOIP@yopmail.com\",\r\n \"createdByFirstName\":\"John\",\r\n \"createdByLastName\":\"Hayden\",\r\n \"createdDate\":\"2023-04-24T03:30:14-07:00\",\r\n \"historyAttributes\":\r\n {\r\n \"attributeMap\":\r\n {\r\n \"status\":\"OPEN\"\r\n },\r\n \"description\":\"New ticket created.\"\r\n },\r\n \"ticketNumber\":\"OBD-SR3404\",\r\n \"subject\":\"My internet connection\",\r\n \"accountNumber\":\"OBD-SR13403\"\r\n }\r\n ],\r\n \"status\":\"OK\"\r\n }"}],"_postman_id":"726c3c9f-c6ff-45f4-a6a8-d9e7b29aabf1"}],"id":"b4c0f3dd-67a3-49fa-ab21-67ea7608a7cb","description":"This section will discuss about searching a ticket with various examples using URL parameters.
\n","_postman_id":"b4c0f3dd-67a3-49fa-ab21-67ea7608a7cb"},{"name":"Service Desk Settings","item":[{"name":"Create Incident Types","id":"00321cdf-df8e-4f1f-a0a0-e7d6d7e28071","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\"listName\": \"Product Enhancement\",\r\n\"dependency\":1,\r\n\"depth\":0,\r\n\"listContentInfoList\": [\r\n{\r\n\"value\": \"New feature release\",\r\n\"sequence\": 1,\r\n\"operationType\": 0\r\n},\r\n{\r\n\"value\": \"Existing feature release\",\r\n\"sequence\": 2,\r\n\"operationType\": 0\r\n}\r\n]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{Host}}/rest/CommonService/v1/customListsWithHierarchy","description":"This API is used to create incident type in the application.
\n","urlObject":{"path":["rest","CommonService","v1","customListsWithHierarchy"],"host":["{{Host}}"],"query":[],"variable":[]}},"response":[{"id":"9d51388c-5fa4-4e56-9baa-a1a17f7231ce","name":"Create Incident Types","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\"listName\": \"Product Enhancement\",\r\n\"dependency\":1,\r\n\"depth\":0,\r\n\"listContentInfoList\": [\r\n{\r\n\"value\": \"New feature release\",\r\n\"sequence\": 1,\r\n\"operationType\": 0\r\n},\r\n{\r\n\"value\": \"Existing feature release\",\r\n\"sequence\": 2,\r\n\"operationType\": 0\r\n}\r\n]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{Host}}/rest/CommonService/v1/customListsWithHierarchy"},"status":"OK","code":200,"_postman_previewlanguage":"JSON","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Tue, 25 Apr 2023 12:34:19 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"15"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"*, Content-Type, Pragma, Origin, Authorization, party, X-XSRF-TOKEN, X-Requested-With,Access-Control-Allow-Headers,Accept,Access-Control-Allow-Credentials,X-Auth-Token, version, cache"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST,OPTIONS,PUT,DELETE,GET"}],"cookie":[],"responseTime":null,"body":"{\r\n \"status\":\"OK\"\r\n}"}],"_postman_id":"00321cdf-df8e-4f1f-a0a0-e7d6d7e28071"},{"name":"Update the Department","id":"16273ecc-204b-44dd-bbb4-792c77bdae9a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"PUT","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\"id\":\"4\",\r\n\"name\": \"Purchase\",\r\n\"partyRoleId\": \"2\",\r\n\"members\": [\r\n{\r\n\"isManager\": false,\r\n\"isDefaultAssignee\": false,\r\n\"userId\": \"10405\"\r\n},\r\n{\r\n\"id\":\"5\",\r\n\"isManager\": true,\r\n\"isDefaultAssignee\": false,\r\n\"userId\": \"2\",\r\n\"operationType\" : 1\r\n},\r\n{\r\n\"id\":\"902\",\r\n\"isManager\": false,\r\n\"isDefaultAssignee\": false,\r\n\"userId\": \"12807\",\r\n\"operationType\" : 2\r\n}\r\n]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{Host}}/rest/TicketManagementService/v1/departments","description":"This API is used to update the department available in the application.
\n","urlObject":{"path":["rest","TicketManagementService","v1","departments"],"host":["{{Host}}"],"query":[],"variable":[]}},"response":[{"id":"64a9d2f4-e8b4-4aa2-ae64-d24abea932bb","name":"Update the Department","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\"id\":\"4\",\r\n\"name\": \"Purchase\",\r\n\"partyRoleId\": \"2\",\r\n\"members\": [\r\n{\r\n\"isManager\": false,\r\n\"isDefaultAssignee\": false,\r\n\"userId\": \"10405\"\r\n},\r\n{\r\n\"id\":\"5\",\r\n\"isManager\": true,\r\n\"isDefaultAssignee\": false,\r\n\"userId\": \"2\",\r\n\"operationType\" : 1\r\n},\r\n{\r\n\"id\":\"902\",\r\n\"isManager\": false,\r\n\"isDefaultAssignee\": false,\r\n\"userId\": \"12807\",\r\n\"operationType\" : 2\r\n}\r\n]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{Host}}/rest/TicketManagementService/v1/departments"},"status":"OK","code":200,"_postman_previewlanguage":"JSON","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Mon, 24 Apr 2023 12:29:43 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"24"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"*, Content-Type, Pragma, Origin, Authorization, party, X-XSRF-TOKEN, X-Requested-With,Access-Control-Allow-Headers,Accept,Access-Control-Allow-Credentials,X-Auth-Token, version, cache"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST,OPTIONS,PUT,DELETE,GET"}],"cookie":[],"responseTime":null,"body":"{\r\n \"id\":\"4\",\r\n \"status\":\"OK\"\r\n}"}],"_postman_id":"16273ecc-204b-44dd-bbb4-792c77bdae9a"},{"name":"Search Department with Users","id":"b58a547b-fa73-40bc-bbb7-0772aad1620c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"}],"url":"{{Host}}/rest/TicketManagementService/v1/searchDepartments?includeUsers=true","description":"This API is used to fetch departments with their users.
\n","urlObject":{"path":["rest","TicketManagementService","v1","searchDepartments"],"host":["{{Host}}"],"query":[{"key":"includeUsers","value":"true"}],"variable":[]}},"response":[{"id":"46cd3368-1fe4-46f9-bd2b-e0b061d21040","name":"Search Department with Users","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"}],"url":{"raw":"{{Host}}/rest/TicketManagementService/v1/searchDepartments?includeUsers=true","host":["{{Host}}"],"path":["rest","TicketManagementService","v1","searchDepartments"],"query":[{"key":"includeUsers","value":"true"}]}},"status":"OK","code":200,"_postman_previewlanguage":"JSON","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Mon, 24 Apr 2023 11:39:46 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"3627"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"*, Content-Type, Pragma, Origin, Authorization, party, X-XSRF-TOKEN, X-Requested-With,Access-Control-Allow-Headers,Accept,Access-Control-Allow-Credentials,X-Auth-Token, version, cache"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST,OPTIONS,PUT,DELETE,GET"}],"cookie":[],"responseTime":null,"body":"{\r\n \"resultSize\": 2,\r\n \"departmentList\": [\r\n {\r\n \"id\": \"2\",\r\n \"name\": \"Engineering\",\r\n \"members\": [\r\n {\r\n \"id\": \"702\",\r\n \"userId\": \"10405\",\r\n \"username\": \"Johnh\",\r\n \"contactName\": \"John Hayden\",\r\n \"isManager\": false,\r\n \"isDefaultAssignee\": true\r\n },\r\n {\r\n \"id\": \"3\",\r\n \"userId\": \"2\",\r\n \"username\": \"MatthewCruise01\",\r\n \"contactName\": \"Matthew Cruise\",\r\n \"isManager\": true,\r\n \"isDefaultAssignee\": false\r\n },\r\n {\r\n \"id\": \"902\",\r\n \"userId\": \"12807\",\r\n \"username\": \"JackReeves27\",\r\n \"contactName\": \"Jack Reeves\",\r\n \"isManager\": false,\r\n \"isDefaultAssignee\": false\r\n }\r\n ]\r\n },\r\n {\r\n \"id\": \"5\",\r\n \"name\": \"Technical Support\",\r\n \"members\": [\r\n {\r\n \"id\": \"1104\",\r\n \"userId\": \"15806\",\r\n \"username\": \"WilliamBale11\",\r\n \"contactName\": \"William Bale\",\r\n \"isManager\": true,\r\n \"isDefaultAssignee\": false\r\n },\r\n {\r\n \"id\": \"1103\",\r\n \"userId\": \"15805\",\r\n \"username\": \"AshleyKidman20\",\r\n \"contactName\": \"Ashley Kidman\",\r\n \"isManager\": false,\r\n \"isDefaultAssignee\": true\r\n }\r\n ]\r\n }"}],"_postman_id":"b58a547b-fa73-40bc-bbb7-0772aad1620c"},{"name":"Seach Department","id":"a820cf2f-b094-4524-b7e7-0105bc6340bb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"}],"url":"{{Host}}/rest/TicketManagementService/v1/searchDepartments","description":"This API is used to fetch department available in the system.
\n","urlObject":{"path":["rest","TicketManagementService","v1","searchDepartments"],"host":["{{Host}}"],"query":[],"variable":[]}},"response":[{"id":"a601d0f3-8fb5-45c4-b065-2a2319a60f8f","name":"Seach Department","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"}],"url":"{{Host}}/rest/TicketManagementService/v1/searchDepartments"},"status":"OK","code":200,"_postman_previewlanguage":"JSON","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Mon, 24 Apr 2023 11:56:01 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"734"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"*, Content-Type, Pragma, Origin, Authorization, party, X-XSRF-TOKEN, X-Requested-With,Access-Control-Allow-Headers,Accept,Access-Control-Allow-Credentials,X-Auth-Token, version, cache"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST,OPTIONS,PUT,DELETE,GET"}],"cookie":[],"responseTime":null,"body":"{\r\n \"resultSize\": 19,\r\n \"departmentList\": [\r\n {\r\n \"id\": \"2\",\r\n \"name\": \"Engineering\"\r\n },\r\n {\r\n \"id\": \"3\",\r\n \"name\": \"Sales \\u0026 Marketing\"\r\n },\r\n {\r\n \"id\": \"4\",\r\n \"name\": \"Operations\"\r\n },\r\n {\r\n \"id\": \"5\",\r\n \"name\": \"Technical Support\"\r\n },\r\n {\r\n \"id\": \"6\",\r\n \"name\": \"Finance\"\r\n },\r\n {\r\n \"id\": \"7\",\r\n \"name\": \"Administration\"\r\n },\r\n {\r\n \"id\": \"8\",\r\n \"name\": \"Documentation\"\r\n },\r\n {\r\n \"id\": \"9\",\r\n \"name\": \"VOIP Devices\"\r\n },\r\n {\r\n \"id\": \"408\",\r\n \"name\": \"Product Management\"\r\n },\r\n {\r\n \"id\": \"508\",\r\n \"name\": \"Customer Support\"\r\n },\r\n {\r\n \"id\": \"808\",\r\n \"name\": \"DGI Training Dept\"\r\n },\r\n {\r\n \"id\": \"908\",\r\n \"name\": \"Service Portal Dept\"\r\n },\r\n {\r\n \"id\": \"1508\",\r\n \"name\": \"CSE\"\r\n },\r\n {\r\n \"id\": \"1908\",\r\n \"name\": \"Documentation Team\"\r\n },\r\n {\r\n \"id\": \"1909\",\r\n \"name\": \"Logistics\"\r\n },\r\n {\r\n \"id\": \"2408\",\r\n \"name\": \"30Mar22TestOrg\"\r\n },\r\n {\r\n \"id\": \"2409\",\r\n \"name\": \"30Mar22TestOrg2\"\r\n },\r\n {\r\n \"id\": \"2808\",\r\n \"name\": \"training team\"\r\n },\r\n {\r\n \"id\": \"3708\",\r\n \"name\": \"Network \"\r\n }\r\n ],\r\n \"status\": \"OK\"\r\n}"}],"_postman_id":"a820cf2f-b094-4524-b7e7-0105bc6340bb"},{"name":"Get Incident Type","id":"e7c25833-b4ad-4b99-ad2e-d91a1c3098c6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"url":"{{Host}}/rest/TicketManagementService/v1/getIncidentTypes","description":"This API is used to fetch the incident in the application.
\n","urlObject":{"path":["rest","TicketManagementService","v1","getIncidentTypes"],"host":["{{Host}}"],"query":[],"variable":[]}},"response":[{"id":"0fcd15ef-baa3-489d-b263-0d631891e87b","name":"Get Incident Type","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"url":"{{Host}}/rest/TicketManagementService/v1/getIncidentTypes"},"status":"OK","code":200,"_postman_previewlanguage":"JSON","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Tue, 25 Apr 2023 12:22:59 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"887"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"*, Content-Type, Pragma, Origin, Authorization, party, X-XSRF-TOKEN, X-Requested-With,Access-Control-Allow-Headers,Accept,Access-Control-Allow-Credentials,X-Auth-Token, version, cache"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST,OPTIONS,PUT,DELETE,GET"}],"cookie":[],"responseTime":null,"body":"{\r\n \"resultSize\": 36,\r\n \"incidentTypes\": {\r\n \"44\": \"Information Request\",\r\n \"23\": \"Shipping\",\r\n \"48\": \"Accounts Receivable\",\r\n \"29\": \"Product Issues\",\r\n \"132\": \"Incorrect Documentation\",\r\n \"1635\": \"Bandwidth\",\r\n \"330\": \"Product New Requests\",\r\n \"135\": \"Faulty Product\",\r\n \"1334\": \"training session below average\",\r\n \"1234\": \"Check30Mar22\",\r\n \"52\": \"Accounts Payable\",\r\n \"1636\": \"Bandwidth \",\r\n \"54\": \"Application Access\",\r\n \"33\": \"Shipping Issues\",\r\n \"12\": \"Marketing\",\r\n \"37\": \"Service Outage\",\r\n \"59\": \"General\",\r\n \"16\": \"Provisioning\",\r\n \"19\": \"Installation\",\r\n \"1130\": \"Delivery Problem\",\r\n \"1128\": \"Request Information\",\r\n \"1127\": \"Request Documentation\",\r\n \"2\": \"Product Defect\",\r\n \"126\": \"Damage\",\r\n \"5\": \"Product Enhancement\",\r\n \"226\": \"Missing Images\",\r\n \"326\": \"Feature Enhancement\",\r\n \"8\": \"Pre-sales\",\r\n \"426\": \"Network Problems\",\r\n \"129\": \"Delivery\",\r\n \"526\": \"hardware issues\",\r\n \"329\": \"Product Enhancements\",\r\n \"626\": \"Software Issues\",\r\n \"726\": \"Car Defects\",\r\n \"40\": \"Service Request\",\r\n \"826\": \"UI Issue\"\r\n },\r\n \"status\": \"OK\"\r\n}"}],"_postman_id":"e7c25833-b4ad-4b99-ad2e-d91a1c3098c6"},{"name":"Get Incident SubTypes","id":"e3980639-07ad-4169-a293-ce468a317a88","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"}],"url":"{{Host}}/rest/TicketManagementService/v1/getIncidentSubTypes/?{Incident_Id}","description":"This API is used to fetch the incident sub-types in the application.
\n","urlObject":{"path":["rest","TicketManagementService","v1","getIncidentSubTypes",""],"host":["{{Host}}"],"query":[{"description":{"content":"Provide the incident id to get the list of sub-incident type.
\n","type":"text/plain"},"key":"{Incident_Id}","value":null}],"variable":[]}},"response":[{"id":"56be7d4a-6093-42b7-9491-8af55031e996","name":"Get Incident SubTypes","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"}],"url":{"raw":"{{Host}}/rest/TicketManagementService/v1/getIncidentSubTypes/?{Incident_Id}","host":["{{Host}}"],"path":["rest","TicketManagementService","v1","getIncidentSubTypes",""],"query":[{"key":"{Incident_Id}","value":null,"description":"Provide the incident id to get the list of sub-incident type. "}]}},"status":"OK","code":200,"_postman_previewlanguage":"JSON","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Tue, 25 Apr 2023 12:42:50 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"96"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"*, Content-Type, Pragma, Origin, Authorization, party, X-XSRF-TOKEN, X-Requested-With,Access-Control-Allow-Headers,Accept,Access-Control-Allow-Credentials,X-Auth-Token, version, cache"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST,OPTIONS,PUT,DELETE,GET"}],"cookie":[],"responseTime":null,"body":"{\r\n \"resultSize\":2,\r\n \"incidentSubTypes\":\r\n {\r\n \"3\":\"Application Issue\",\r\n \"4\":\"Hardware Issue\"\r\n },\r\n \"status\":\"OK\"\r\n}"}],"_postman_id":"e3980639-07ad-4169-a293-ce468a317a88"},{"name":"Get Ticket Classifications List","id":"93e9c356-141a-4849-b21d-007e3d7073be","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"}],"url":"{{Host}}/rest/TicketManagementService/v1/searchTicketClassifications","description":"This API is used to fetch the list of ticket classification available in the application.
\n","urlObject":{"path":["rest","TicketManagementService","v1","searchTicketClassifications"],"host":["{{Host}}"],"query":[],"variable":[]}},"response":[{"id":"17fe52f8-cdd6-4929-8013-3ecb8d343658","name":"Get Ticket Classifications List","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"}],"url":"{{Host}}/rest/TicketManagementService/v1/searchTicketClassifications"},"status":"OK","code":200,"_postman_previewlanguage":"JSON","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Tue, 25 Apr 2023 13:07:11 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"*, Content-Type, Pragma, Origin, Authorization, party, X-XSRF-TOKEN, X-Requested-With,Access-Control-Allow-Headers,Accept,Access-Control-Allow-Credentials,X-Auth-Token, version, cache"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST,OPTIONS,PUT,DELETE,GET"}],"cookie":[],"responseTime":null,"body":"{\r\n \"resultSize\": 30,\r\n \"ticketClassificationList\": [\r\n {\r\n \"deptId\": \"2\",\r\n \"deptName\": \"Engineering\",\r\n \"incidentTypeId\": \"2\",\r\n \"incidentType\": \"Product Defect\",\r\n \"incidentSubTypeList\": [\r\n {\r\n \"ticketClassificationId\": \"2\",\r\n \"incidentSubTypeId\": \"3\",\r\n \"incidentSubType\": \"Application Issue\",\r\n \"isDefault\": true,\r\n \"priority\": 0,\r\n \"responseTime\": 0,\r\n \"resolutionTime\": 0,\r\n \"visibility\": 4\r\n },\r\n {\r\n \"ticketClassificationId\": \"3\",\r\n \"incidentSubTypeId\": \"4\",\r\n \"incidentSubType\": \"Hardware Issue\",\r\n \"isDefault\": false,\r\n \"priority\": 0,\r\n \"responseTime\": 0,\r\n \"resolutionTime\": 0,\r\n \"visibility\": 4\r\n }\r\n ],\r\n \"partyRoleId\": \"2\"\r\n },\r\n {\r\n \"deptId\": \"2\",\r\n \"deptName\": \"Engineering\",\r\n \"incidentTypeId\": \"5\",\r\n \"incidentType\": \"Product Enhancement\",\r\n \"incidentSubTypeList\": [\r\n {\r\n \"ticketClassificationId\": \"4\",\r\n \"incidentSubTypeId\": \"6\",\r\n \"incidentSubType\": \"Feature Request\",\r\n \"isDefault\": true,\r\n \"priority\": 0,\r\n \"responseTime\": 0,\r\n \"resolutionTime\": 0,\r\n \"visibility\": 4\r\n },\r\n {\r\n \"ticketClassificationId\": \"5\",\r\n \"incidentSubTypeId\": \"7\",\r\n \"incidentSubType\": \"Customization\",\r\n \"isDefault\": false,\r\n \"priority\": 0,\r\n \"responseTime\": 0,\r\n \"resolutionTime\": 0,\r\n \"visibility\": 4\r\n }\r\n ],\r\n \"partyRoleId\": \"2\"\r\n },\r\n {\r\n \"deptId\": \"2\",\r\n \"deptName\": \"Engineering\",\r\n \"incidentTypeId\": \"126\",\r\n \"incidentType\": \"Damage\",\r\n \"incidentSubTypeList\": [\r\n {\r\n \"ticketClassificationId\": \"46\",\r\n \"incidentSubTypeId\": \"128\",\r\n \"incidentSubType\": \"warehouse\",\r\n \"isDefault\": true,\r\n \"priority\": 4,\r\n \"responseTime\": 1,\r\n \"resolutionTime\": 1,\r\n \"visibility\": 0\r\n }\r\n ],\r\n \"partyRoleId\": \"2\"\r\n },\r\n {\r\n \"deptId\": \"2\",\r\n \"deptName\": \"Engineering\",\r\n \"incidentTypeId\": \"129\",\r\n \"incidentType\": \"Delivery\",\r\n \"incidentSubTypeList\": [\r\n {\r\n \"ticketClassificationId\": \"47\",\r\n \"incidentSubTypeId\": \"131\",\r\n \"incidentSubType\": \"Inhouse\",\r\n \"isDefault\": true,\r\n \"priority\": 4,\r\n \"responseTime\": 1,\r\n \"resolutionTime\": 1,\r\n \"visibility\": 0\r\n }\r\n ],\r\n \"partyRoleId\": \"2\"\r\n },\r\n {\r\n \"deptId\": \"3\",\r\n \"deptName\": \"Sales \\u0026 Marketing\",\r\n \"incidentTypeId\": \"8\",\r\n \"incidentType\": \"Pre-sales\",\r\n \"incidentSubTypeList\": [\r\n {\r\n \"ticketClassificationId\": \"6\",\r\n \"incidentSubTypeId\": \"9\",\r\n \"incidentSubType\": \"Lead Generation\",\r\n \"isDefault\": true,\r\n \"priority\": 0,\r\n \"responseTime\": 0,\r\n \"resolutionTime\": 0,\r\n \"visibility\": 0\r\n },\r\n {\r\n \"ticketClassificationId\": \"7\",\r\n \"incidentSubTypeId\": \"10\",\r\n \"incidentSubType\": \"Cold-Calling\",\r\n \"isDefault\": false,\r\n \"priority\": 0,\r\n \"responseTime\": 0,\r\n \"resolutionTime\": 0,\r\n \"visibility\": 0\r\n },\r\n {\r\n \"ticketClassificationId\": \"8\",\r\n \"incidentSubTypeId\": \"11\",\r\n \"incidentSubType\": \"Qualification\",\r\n \"isDefault\": false,\r\n \"priority\": 0,\r\n \"responseTime\": 0,\r\n \"resolutionTime\": 0,\r\n \"visibility\": 0\r\n }\r\n ],\r\n \"partyRoleId\": \"2\"\r\n },\r\n {\r\n \"deptId\": \"3\",\r\n \"deptName\": \"Sales \\u0026 Marketing\",\r\n \"incidentTypeId\": \"12\",\r\n \"incidentType\": \"Marketing\",\r\n \"incidentSubTypeList\": [\r\n {\r\n \"ticketClassificationId\": \"9\",\r\n \"incidentSubTypeId\": \"13\",\r\n \"incidentSubType\": \"Email Campaign\",\r\n \"isDefault\": true,\r\n \"priority\": 0,\r\n \"responseTime\": 0,\r\n \"resolutionTime\": 0,\r\n \"visibility\": 0\r\n },\r\n {\r\n \"ticketClassificationId\": \"10\",\r\n \"incidentSubTypeId\": \"14\",\r\n \"incidentSubType\": \"Social Media Blogging\",\r\n \"isDefault\": false,\r\n \"priority\": 0,\r\n \"responseTime\": 0,\r\n \"resolutionTime\": 0,\r\n \"visibility\": 0\r\n },\r\n {\r\n \"ticketClassificationId\": \"11\",\r\n \"incidentSubTypeId\": \"15\",\r\n \"incidentSubType\": \"Paid-Advertisement\",\r\n \"isDefault\": false,\r\n \"priority\": 0,\r\n \"responseTime\": 0,\r\n \"resolutionTime\": 0,\r\n \"visibility\": 0\r\n }\r\n ],\r\n \"partyRoleId\": \"2\"\r\n },\r\n {\r\n \"deptId\": \"4\",\r\n \"deptName\": \"Operations\",\r\n \"incidentTypeId\": \"16\",\r\n \"incidentType\": \"Provisioning\",\r\n \"incidentSubTypeList\": [\r\n {\r\n \"ticketClassificationId\": \"12\",\r\n \"incidentSubTypeId\": \"17\",\r\n \"incidentSubType\": \"Device Configuration\",\r\n \"isDefault\": true,\r\n \"priority\": 0,\r\n \"responseTime\": 0,\r\n \"resolutionTime\": 0,\r\n \"visibility\": 4\r\n },\r\n {\r\n \"ticketClassificationId\": \"13\",\r\n \"incidentSubTypeId\": \"18\",\r\n \"incidentSubType\": \"Software Configuration\",\r\n \"isDefault\": false,\r\n \"priority\": 0,\r\n \"responseTime\": 0,\r\n \"resolutionTime\": 0,\r\n \"visibility\": 4\r\n }\r\n ],\r\n \"partyRoleId\": \"2\"\r\n },\r\n {\r\n \"deptId\": \"4\",\r\n \"deptName\": \"Operations\",\r\n \"incidentTypeId\": \"19\",\r\n \"incidentType\": \"Installation\",\r\n \"incidentSubTypeList\": [\r\n {\r\n \"ticketClassificationId\": \"14\",\r\n \"incidentSubTypeId\": \"20\",\r\n \"incidentSubType\": \"Scheduling\",\r\n \"isDefault\": true,\r\n \"priority\": 0,\r\n \"responseTime\": 0,\r\n \"resolutionTime\": 0,\r\n \"visibility\": 0\r\n },\r\n {\r\n \"ticketClassificationId\": \"15\",\r\n \"incidentSubTypeId\": \"21\",\r\n \"incidentSubType\": \"Device Installation\",\r\n \"isDefault\": false,\r\n \"priority\": 0,\r\n \"responseTime\": 0,\r\n \"resolutionTime\": 0,\r\n \"visibility\": 0\r\n },\r\n {\r\n \"ticketClassificationId\": \"16\",\r\n \"incidentSubTypeId\": \"22\",\r\n \"incidentSubType\": \"Activation\",\r\n \"isDefault\": false,\r\n \"priority\": 0,\r\n \"responseTime\": 0,\r\n \"resolutionTime\": 0,\r\n \"visibility\": 0\r\n }\r\n ],\r\n \"partyRoleId\": \"2\"\r\n },\r\n {\r\n \"deptId\": \"4\",\r\n \"deptName\": \"Operations\",\r\n \"incidentTypeId\": \"23\",\r\n \"incidentType\": \"Shipping\",\r\n \"incidentSubTypeList\": [\r\n {\r\n \"ticketClassificationId\": \"17\",\r\n \"incidentSubTypeId\": \"24\",\r\n \"incidentSubType\": \"Ship Device\",\r\n \"isDefault\": true,\r\n \"priority\": 0,\r\n \"responseTime\": 0,\r\n \"resolutionTime\": 0,\r\n \"visibility\": 0\r\n },\r\n {\r\n \"ticketClassificationId\": \"18\",\r\n \"incidentSubTypeId\": \"25\",\r\n \"incidentSubType\": \"Shipping Label\",\r\n \"isDefault\": false,\r\n \"priority\": 0,\r\n \"responseTime\": 0,\r\n \"resolutionTime\": 0,\r\n \"visibility\": 0\r\n },\r\n {\r\n \"ticketClassificationId\": \"19\",\r\n \"incidentSubTypeId\": \"26\",\r\n \"incidentSubType\": \"Tracking\",\r\n \"isDefault\": false,\r\n \"priority\": 0,\r\n \"responseTime\": 0,\r\n \"resolutionTime\": 0,\r\n \"visibility\": 0\r\n },\r\n {\r\n \"ticketClassificationId\": \"20\",\r\n \"incidentSubTypeId\": \"27\",\r\n \"incidentSubType\": \"Lost Device\",\r\n \"isDefault\": false,\r\n \"priority\": 0,\r\n \"responseTime\": 0,\r\n \"resolutionTime\": 0,\r\n \"visibility\": 0\r\n },\r\n {\r\n \"ticketClassificationId\": \"21\",\r\n \"incidentSubTypeId\": \"28\",\r\n \"incidentSubType\": \"Replacement Device\",\r\n \"isDefault\": false,\r\n \"priority\": 0,\r\n \"responseTime\": 0,\r\n \"resolutionTime\": 0,\r\n \"visibility\": 0\r\n }\r\n ],\r\n \"partyRoleId\": \"2\"\r\n },\r\n {\r\n \"deptId\": \"5\",\r\n \"deptName\": \"Technical Support\",\r\n \"incidentTypeId\": \"29\",\r\n \"incidentType\": \"Product Issues\",\r\n \"incidentSubTypeList\": [\r\n {\r\n \"ticketClassificationId\": \"22\",\r\n \"incidentSubTypeId\": \"30\",\r\n \"incidentSubType\": \"Application Defect\",\r\n \"isDefault\": true,\r\n \"priority\": 0,\r\n \"responseTime\": 0,\r\n \"resolutionTime\": 0,\r\n \"visibility\": 0\r\n },\r\n {\r\n \"ticketClassificationId\": \"24\",\r\n \"incidentSubTypeId\": \"32\",\r\n \"incidentSubType\": \"Product Enhancement\",\r\n \"isDefault\": false,\r\n \"priority\": 0,\r\n \"responseTime\": 0,\r\n \"resolutionTime\": 0,\r\n \"visibility\": 0\r\n }\r\n ],\r\n \"partyRoleId\": \"2\"\r\n },\r\n {\r\n \"deptId\": \"5\",\r\n \"deptName\": \"Technical Support\",\r\n \"incidentTypeId\": \"33\",\r\n \"incidentType\": \"Shipping Issues\",\r\n \"incidentSubTypeList\": [\r\n {\r\n \"ticketClassificationId\": \"25\",\r\n \"incidentSubTypeId\": \"34\",\r\n \"incidentSubType\": \"Device Not Delivered\",\r\n \"isDefault\": true,\r\n \"priority\": 0,\r\n \"responseTime\": 0,\r\n \"resolutionTime\": 0,\r\n \"visibility\": 0\r\n },\r\n {\r\n \"ticketClassificationId\": \"26\",\r\n \"incidentSubTypeId\": \"35\",\r\n \"incidentSubType\": \"Request Replacement Device\",\r\n \"isDefault\": false,\r\n \"priority\": 0,\r\n \"responseTime\": 0,\r\n \"resolutionTime\": 0,\r\n \"visibility\": 0\r\n },\r\n {\r\n \"ticketClassificationId\": \"27\",\r\n \"incidentSubTypeId\": \"36\",\r\n \"incidentSubType\": \"Shipment Delay\",\r\n \"isDefault\": false,\r\n \"priority\": 0,\r\n \"responseTime\": 0,\r\n \"resolutionTime\": 0,\r\n \"visibility\": 0\r\n }\r\n ],\r\n \"partyRoleId\": \"2\"\r\n },\r\n {\r\n \"deptId\": \"5\",\r\n \"deptName\": \"Technical Support\",\r\n \"incidentTypeId\": \"37\",\r\n \"incidentType\": \"Service Outage\",\r\n \"incidentSubTypeList\": [\r\n {\r\n \"ticketClassificationId\": \"28\",\r\n \"incidentSubTypeId\": \"38\",\r\n \"incidentSubType\": \"System Down\",\r\n \"isDefault\": false,\r\n \"priority\": 0,\r\n \"responseTime\": 0,\r\n \"resolutionTime\": 0,\r\n \"visibility\": 0\r\n },\r\n {\r\n \"ticketClassificationId\": \"29\",\r\n \"incidentSubTypeId\": \"39\",\r\n \"incidentSubType\": \"Application Crash\",\r\n \"isDefault\": false,\r\n \"priority\": 0,\r\n \"responseTime\": 0,\r\n \"resolutionTime\": 0,\r\n \"visibility\": 0\r\n },\r\n {\r\n \"ticketClassificationId\": \"2646\",\r\n \"incidentSubTypeId\": \"1126\",\r\n \"incidentSubType\": \"Network Issue\",\r\n \"isDefault\": false,\r\n \"priority\": 4,\r\n \"responseTime\": 5760,\r\n \"resolutionTime\": 5760,\r\n \"visibility\": 0\r\n }\r\n ],\r\n \"partyRoleId\": \"2\"\r\n },\r\n {\r\n \"deptId\": \"5\",\r\n \"deptName\": \"Technical Support\",\r\n \"incidentTypeId\": \"40\",\r\n \"incidentType\": \"Service Request\",\r\n \"incidentSubTypeList\": [\r\n {\r\n \"ticketClassificationId\": \"30\",\r\n \"incidentSubTypeId\": \"41\",\r\n \"incidentSubType\": \"Cancel Service\",\r\n \"isDefault\": true,\r\n \"priority\": 0,\r\n \"responseTime\": 0,\r\n \"resolutionTime\": 0,\r\n \"visibility\": 0\r\n },\r\n {\r\n \"ticketClassificationId\": \"31\",\r\n \"incidentSubTypeId\": \"42\",\r\n \"incidentSubType\": \"Add Additional Service\",\r\n \"isDefault\": false,\r\n \"priority\": 0,\r\n \"responseTime\": 0,\r\n \"resolutionTime\": 0,\r\n \"visibility\": 0\r\n },\r\n {\r\n \"ticketClassificationId\": \"32\",\r\n \"incidentSubTypeId\": \"43\",\r\n \"incidentSubType\": \"Modify Existing Service\",\r\n \"isDefault\": false,\r\n \"priority\": 0,\r\n \"responseTime\": 0,\r\n \"resolutionTime\": 0,\r\n \"visibility\": 0\r\n }\r\n ],\r\n \"partyRoleId\": \"2\"\r\n },\r\n {\r\n \"deptId\": \"5\",\r\n \"deptName\": \"Technical Support\",\r\n \"incidentTypeId\": \"44\",\r\n \"incidentType\": \"Information Request\",\r\n \"incidentSubTypeList\": [\r\n {\r\n \"ticketClassificationId\": \"33\",\r\n \"incidentSubTypeId\": \"45\",\r\n \"incidentSubType\": \"Product Documentation\",\r\n \"isDefault\": true,\r\n \"priority\": 0,\r\n \"responseTime\": 0,\r\n \"resolutionTime\": 0,\r\n \"visibility\": 0\r\n },\r\n {\r\n \"ticketClassificationId\": \"34\",\r\n \"incidentSubTypeId\": \"46\",\r\n \"incidentSubType\": \"API Documentation\",\r\n \"isDefault\": false,\r\n \"priority\": 0,\r\n \"responseTime\": 0,\r\n \"resolutionTime\": 0,\r\n \"visibility\": 0\r\n },\r\n {\r\n \"ticketClassificationId\": \"35\",\r\n \"incidentSubTypeId\": \"47\",\r\n \"incidentSubType\": \"Request Training Videos\",\r\n \"isDefault\": false,\r\n \"priority\": 0,\r\n \"responseTime\": 0,\r\n \"resolutionTime\": 0,\r\n \"visibility\": 0\r\n }\r\n ],\r\n \"partyRoleId\": \"2\"\r\n },\r\n {\r\n \"deptId\": \"6\",\r\n \"deptName\": \"Finance\",\r\n \"incidentTypeId\": \"48\",\r\n \"incidentType\": \"Accounts Receivable\",\r\n \"incidentSubTypeList\": [\r\n {\r\n \"ticketClassificationId\": \"36\",\r\n \"incidentSubTypeId\": \"49\",\r\n \"incidentSubType\": \"Billing Issues\",\r\n \"isDefault\": true,\r\n \"priority\": 0,\r\n \"responseTime\": 0,\r\n \"resolutionTime\": 0,\r\n \"visibility\": 0\r\n },\r\n {\r\n \"ticketClassificationId\": \"37\",\r\n \"incidentSubTypeId\": \"50\",\r\n \"incidentSubType\": \"Request Credit\",\r\n \"isDefault\": false,\r\n \"priority\": 0,\r\n \"responseTime\": 0,\r\n \"resolutionTime\": 0,\r\n \"visibility\": 0\r\n },\r\n {\r\n \"ticketClassificationId\": \"38\",\r\n \"incidentSubTypeId\": \"51\",\r\n \"incidentSubType\": \"Open Dispute\",\r\n \"isDefault\": false,\r\n \"priority\": 0,\r\n \"responseTime\": 0,\r\n \"resolutionTime\": 0,\r\n \"visibility\": 0\r\n }\r\n ],\r\n \"partyRoleId\": \"2\"\r\n },\r\n {\r\n \"deptId\": \"6\",\r\n \"deptName\": \"Finance\",\r\n \"incidentTypeId\": \"52\",\r\n \"incidentType\": \"Accounts Payable\",\r\n \"incidentSubTypeList\": [\r\n {\r\n \"ticketClassificationId\": \"39\",\r\n \"incidentSubTypeId\": \"53\",\r\n \"incidentSubType\": \"Request Refund\",\r\n \"isDefault\": true,\r\n \"priority\": 0,\r\n \"responseTime\": 0,\r\n \"resolutionTime\": 0,\r\n \"visibility\": 0\r\n }\r\n ],\r\n \"partyRoleId\": \"2\"\r\n },\r\n {\r\n \"deptId\": \"7\",\r\n \"deptName\": \"Administration\",\r\n \"incidentTypeId\": \"54\",\r\n \"incidentType\": \"Application Access\",\r\n \"incidentSubTypeList\": [\r\n {\r\n \"ticketClassificationId\": \"40\",\r\n \"incidentSubTypeId\": \"55\",\r\n \"incidentSubType\": \"Request Credentials\",\r\n \"isDefault\": true,\r\n \"priority\": 0,\r\n \"responseTime\": 0,\r\n \"resolutionTime\": 0,\r\n \"visibility\": 0\r\n },\r\n {\r\n \"ticketClassificationId\": \"41\",\r\n \"incidentSubTypeId\": \"56\",\r\n \"incidentSubType\": \"Password Reset\",\r\n \"isDefault\": false,\r\n \"priority\": 0,\r\n \"responseTime\": 0,\r\n \"resolutionTime\": 0,\r\n \"visibility\": 0\r\n },\r\n {\r\n \"ticketClassificationId\": \"42\",\r\n \"incidentSubTypeId\": \"57\",\r\n \"incidentSubType\": \"Login Issues\",\r\n \"isDefault\": false,\r\n \"priority\": 0,\r\n \"responseTime\": 0,\r\n \"resolutionTime\": 0,\r\n \"visibility\": 0\r\n },\r\n {\r\n \"ticketClassificationId\": \"43\",\r\n \"incidentSubTypeId\": \"58\",\r\n \"incidentSubType\": \"Change Permissions\",\r\n \"isDefault\": false,\r\n \"priority\": 0,\r\n \"responseTime\": 0,\r\n \"resolutionTime\": 0,\r\n \"visibility\": 0\r\n }\r\n ],\r\n \"partyRoleId\": \"2\"\r\n },\r\n {\r\n \"deptId\": \"7\",\r\n \"deptName\": \"Administration\",\r\n \"incidentTypeId\": \"59\",\r\n \"incidentType\": \"General\",\r\n \"incidentSubTypeList\": [\r\n {\r\n \"ticketClassificationId\": \"44\",\r\n \"incidentSubTypeId\": \"60\",\r\n \"incidentSubType\": \"Add User(s)\",\r\n \"isDefault\": true,\r\n \"priority\": 0,\r\n \"responseTime\": 0,\r\n \"resolutionTime\": 0,\r\n \"visibility\": 0\r\n },\r\n {\r\n \"ticketClassificationId\": \"45\",\r\n \"incidentSubTypeId\": \"61\",\r\n \"incidentSubType\": \"Delete User(s)\",\r\n \"isDefault\": false,\r\n \"priority\": 0,\r\n \"responseTime\": 0,\r\n \"resolutionTime\": 0,\r\n \"visibility\": 0\r\n }\r\n ],\r\n \"partyRoleId\": \"2\"\r\n },\r\n {\r\n \"deptId\": \"8\",\r\n \"deptName\": \"Documentation\",\r\n \"incidentTypeId\": \"132\",\r\n \"incidentType\": \"Incorrect Documentation\",\r\n \"incidentSubTypeList\": [\r\n {\r\n \"ticketClassificationId\": \"48\",\r\n \"incidentSubTypeId\": \"134\",\r\n \"incidentSubType\": \"Missing Links\",\r\n \"isDefault\": true,\r\n \"priority\": 2,\r\n \"responseTime\": 1000,\r\n \"resolutionTime\": 2000,\r\n \"visibility\": 0\r\n }\r\n ],\r\n \"partyRoleId\": \"2\"\r\n },\r\n {\r\n \"deptId\": \"9\",\r\n \"deptName\": \"VOIP Devices\",\r\n \"incidentTypeId\": \"135\",\r\n \"incidentType\": \"Faulty Product\",\r\n \"incidentSubTypeList\": [\r\n {\r\n \"ticketClassificationId\": \"49\",\r\n \"incidentSubTypeId\": \"136\",\r\n \"incidentSubType\": \"Damaged good\",\r\n \"isDefault\": true,\r\n \"priority\": 2,\r\n \"responseTime\": 1,\r\n \"resolutionTime\": 3,\r\n \"visibility\": 0\r\n }\r\n ],\r\n \"partyRoleId\": \"2\"\r\n },\r\n {\r\n \"deptId\": \"408\",\r\n \"deptName\": \"Product Management\",\r\n \"incidentTypeId\": \"330\",\r\n \"incidentType\": \"Product New Requests\",\r\n \"incidentSubTypeList\": [\r\n {\r\n \"ticketClassificationId\": \"647\",\r\n \"incidentSubTypeId\": \"331\",\r\n \"incidentSubType\": \"Accounting Enhancements\",\r\n \"isDefault\": false,\r\n \"priority\": 1,\r\n \"responseTime\": 1440,\r\n \"resolutionTime\": 7200,\r\n \"visibility\": 0\r\n },\r\n {\r\n \"ticketClassificationId\": \"648\",\r\n \"incidentSubTypeId\": \"332\",\r\n \"incidentSubType\": \"SMTP Enhancements\",\r\n \"isDefault\": true,\r\n \"priority\": 1,\r\n \"responseTime\": 1440,\r\n \"resolutionTime\": 4320,\r\n \"visibility\": 0\r\n }\r\n ],\r\n \"partyRoleId\": \"2\"\r\n },\r\n {\r\n \"deptId\": \"508\",\r\n \"deptName\": \"Customer Support\",\r\n \"incidentTypeId\": \"426\",\r\n \"incidentType\": \"Network Problems\",\r\n \"incidentSubTypeList\": [\r\n {\r\n \"ticketClassificationId\": \"746\",\r\n \"incidentSubTypeId\": \"427\",\r\n \"incidentSubType\": \"No Internet\",\r\n \"isDefault\": true,\r\n \"priority\": 3,\r\n \"responseTime\": 1440,\r\n \"resolutionTime\": 7200,\r\n \"visibility\": 0\r\n },\r\n {\r\n \"ticketClassificationId\": \"747\",\r\n \"incidentSubTypeId\": \"428\",\r\n \"incidentSubType\": \"Slow Internet Connection\",\r\n \"isDefault\": false,\r\n \"priority\": 2,\r\n \"responseTime\": 1440,\r\n \"resolutionTime\": 10080,\r\n \"visibility\": 0\r\n },\r\n {\r\n \"ticketClassificationId\": \"748\",\r\n \"incidentSubTypeId\": \"429\",\r\n \"incidentSubType\": \"Router Not Working\",\r\n \"isDefault\": false,\r\n \"priority\": 4,\r\n \"responseTime\": 1440,\r\n \"resolutionTime\": 5760,\r\n \"visibility\": 0\r\n },\r\n {\r\n \"ticketClassificationId\": \"2546\",\r\n \"incidentSubTypeId\": \"1026\",\r\n \"incidentSubType\": \"Is your order not placed\",\r\n \"isDefault\": false,\r\n \"priority\": 1,\r\n \"responseTime\": 1440,\r\n \"resolutionTime\": 2880,\r\n \"visibility\": 0\r\n }\r\n ],\r\n \"partyRoleId\": \"2\"\r\n },\r\n {\r\n \"deptId\": \"808\",\r\n \"deptName\": \"DGI Training Dept\",\r\n \"incidentTypeId\": \"526\",\r\n \"incidentType\": \"hardware issues\",\r\n \"incidentSubTypeList\": [\r\n {\r\n \"ticketClassificationId\": \"1346\",\r\n \"incidentSubTypeId\": \"527\",\r\n \"incidentSubType\": \"technical defects\",\r\n \"isDefault\": false,\r\n \"priority\": 3,\r\n \"responseTime\": 2880,\r\n \"resolutionTime\": 5760,\r\n \"visibility\": 0\r\n },\r\n {\r\n \"ticketClassificationId\": \"1347\",\r\n \"incidentSubTypeId\": \"528\",\r\n \"incidentSubType\": \"broken items\",\r\n \"isDefault\": true,\r\n \"priority\": 1,\r\n \"responseTime\": 1440,\r\n \"resolutionTime\": 2880,\r\n \"visibility\": 0\r\n }\r\n ],\r\n \"partyRoleId\": \"2\"\r\n },\r\n {\r\n \"deptId\": \"908\",\r\n \"deptName\": \"Service Portal Dept\",\r\n \"incidentTypeId\": \"626\",\r\n \"incidentType\": \"Software Issues\",\r\n \"incidentSubTypeList\": [\r\n {\r\n \"ticketClassificationId\": \"1446\",\r\n \"incidentSubTypeId\": \"627\",\r\n \"incidentSubType\": \"UI Problem\",\r\n \"isDefault\": true,\r\n \"priority\": 2,\r\n \"responseTime\": 1440,\r\n \"resolutionTime\": 2880,\r\n \"visibility\": 0\r\n },\r\n {\r\n \"ticketClassificationId\": \"1447\",\r\n \"incidentSubTypeId\": \"628\",\r\n \"incidentSubType\": \"UX Problem\",\r\n \"isDefault\": false,\r\n \"priority\": 1,\r\n \"responseTime\": 5760,\r\n \"resolutionTime\": 10080,\r\n \"visibility\": 0\r\n }\r\n ],\r\n \"partyRoleId\": \"2\"\r\n },\r\n {\r\n \"deptId\": \"1508\",\r\n \"deptName\": \"CSE\",\r\n \"incidentTypeId\": \"726\",\r\n \"incidentType\": \"Car Defects\",\r\n \"incidentSubTypeList\": [\r\n {\r\n \"ticketClassificationId\": \"2149\",\r\n \"incidentSubTypeId\": \"730\",\r\n \"incidentSubType\": \"Others\",\r\n \"isDefault\": false,\r\n \"priority\": 1,\r\n \"responseTime\": 4320,\r\n \"resolutionTime\": 10080,\r\n \"visibility\": 0,\r\n \"customAttributes\": [\r\n {\r\n \"id\": \"3529\",\r\n \"displayLabel\": \"Car Model No\",\r\n \"status\": \"0\",\r\n \"showlabel\": \"1\",\r\n \"mandatory\": \"0\",\r\n \"type\": \"5\",\r\n \"applicableFor\": \"2\",\r\n \"configType\": \"String\",\r\n \"readOnly\": false,\r\n \"sequence\": \"0\",\r\n \"sortBy\": \"0\",\r\n \"multipleEntriesConfig\": 0\r\n },\r\n {}\r\n ]\r\n },\r\n {\r\n \"ticketClassificationId\": \"2146\",\r\n \"incidentSubTypeId\": \"727\",\r\n \"incidentSubType\": \"Seat Spoilt\",\r\n \"isDefault\": true,\r\n \"priority\": 2,\r\n \"responseTime\": 5760,\r\n \"resolutionTime\": 10080,\r\n \"visibility\": 0\r\n },\r\n {\r\n \"ticketClassificationId\": \"2147\",\r\n \"incidentSubTypeId\": \"728\",\r\n \"incidentSubType\": \"Steering Broken\",\r\n \"isDefault\": false,\r\n \"priority\": 3,\r\n \"responseTime\": 1440,\r\n \"resolutionTime\": 4320,\r\n \"visibility\": 0\r\n },\r\n {\r\n \"ticketClassificationId\": \"2148\",\r\n \"incidentSubTypeId\": \"729\",\r\n \"incidentSubType\": \"Engine not starting\",\r\n \"isDefault\": false,\r\n \"priority\": 4,\r\n \"responseTime\": 1440,\r\n \"resolutionTime\": 2880,\r\n \"visibility\": 0\r\n }\r\n ],\r\n \"partyRoleId\": \"2\"\r\n },\r\n {\r\n \"deptId\": \"1508\",\r\n \"deptName\": \"CSE\",\r\n \"incidentTypeId\": \"826\",\r\n \"incidentType\": \"UI Issue\",\r\n \"incidentSubTypeList\": [\r\n {\r\n \"ticketClassificationId\": \"2408\",\r\n \"incidentSubTypeId\": \"827\",\r\n \"incidentSubType\": \"Alignment Problem\",\r\n \"isDefault\": true,\r\n \"priority\": 1,\r\n \"responseTime\": 5760,\r\n \"resolutionTime\": 10080,\r\n \"visibility\": 0\r\n },\r\n {\r\n \"ticketClassificationId\": \"2409\",\r\n \"incidentSubTypeId\": \"828\",\r\n \"incidentSubType\": \"Font Issue\",\r\n \"isDefault\": false,\r\n \"priority\": 1,\r\n \"responseTime\": 5760,\r\n \"resolutionTime\": 10080,\r\n \"visibility\": 0\r\n }\r\n ],\r\n \"partyRoleId\": \"2\"\r\n },\r\n {\r\n \"deptId\": \"1908\",\r\n \"deptName\": \"Documentation Team\",\r\n \"incidentTypeId\": \"1128\",\r\n \"incidentType\": \"Request Information\",\r\n \"incidentSubTypeList\": [\r\n {\r\n \"ticketClassificationId\": \"2647\",\r\n \"incidentSubTypeId\": \"1129\",\r\n \"incidentSubType\": \"Product Info\",\r\n \"isDefault\": true,\r\n \"priority\": 2,\r\n \"responseTime\": 5760,\r\n \"resolutionTime\": 5760,\r\n \"visibility\": 0\r\n },\r\n {\r\n \"ticketClassificationId\": \"2846\",\r\n \"incidentSubTypeId\": \"1226\",\r\n \"incidentSubType\": \"Module Demo\",\r\n \"isDefault\": false,\r\n \"priority\": 3,\r\n \"responseTime\": 28800,\r\n \"resolutionTime\": 28800,\r\n \"visibility\": 0\r\n },\r\n {\r\n \"ticketClassificationId\": \"2847\",\r\n \"incidentSubTypeId\": \"1227\",\r\n \"incidentSubType\": \"Feature Demo\",\r\n \"isDefault\": false,\r\n \"priority\": 3,\r\n \"responseTime\": 28800,\r\n \"resolutionTime\": 28800,\r\n \"visibility\": 0\r\n }\r\n ],\r\n \"partyRoleId\": \"2\"\r\n },\r\n {\r\n \"deptId\": \"1909\",\r\n \"deptName\": \"Logistics\",\r\n \"incidentTypeId\": \"1130\",\r\n \"incidentType\": \"Delivery Problem\",\r\n \"incidentSubTypeList\": [\r\n {\r\n \"ticketClassificationId\": \"2648\",\r\n \"incidentSubTypeId\": \"1131\",\r\n \"incidentSubType\": \"Broken Item\",\r\n \"isDefault\": false,\r\n \"priority\": 3,\r\n \"responseTime\": 120,\r\n \"resolutionTime\": 1440,\r\n \"visibility\": 0\r\n },\r\n {\r\n \"ticketClassificationId\": \"2649\",\r\n \"incidentSubTypeId\": \"1132\",\r\n \"incidentSubType\": \"Seal Broken\",\r\n \"isDefault\": false,\r\n \"priority\": 1,\r\n \"responseTime\": 120,\r\n \"resolutionTime\": 1440,\r\n \"visibility\": 0\r\n }\r\n ],\r\n \"partyRoleId\": \"2\"\r\n },\r\n {\r\n \"deptId\": \"2408\",\r\n \"deptName\": \"30Mar22TestOrg\",\r\n \"incidentTypeId\": \"1234\",\r\n \"incidentType\": \"Check30Mar22\",\r\n \"incidentSubTypeList\": [\r\n {\r\n \"ticketClassificationId\": \"3246\",\r\n \"incidentSubTypeId\": \"1235\",\r\n \"incidentSubType\": \"Test30Mar22Subtype\",\r\n \"isDefault\": false,\r\n \"priority\": 2,\r\n \"responseTime\": 1440,\r\n \"resolutionTime\": 5760,\r\n \"visibility\": 0\r\n },\r\n {\r\n \"ticketClassificationId\": \"3247\",\r\n \"incidentSubTypeId\": \"1236\",\r\n \"incidentSubType\": \"Test30Mar22Subtype1\",\r\n \"isDefault\": true,\r\n \"priority\": 2,\r\n \"responseTime\": 2880,\r\n \"resolutionTime\": 7200,\r\n \"visibility\": 0\r\n },\r\n {\r\n \"ticketClassificationId\": \"3248\",\r\n \"incidentSubTypeId\": \"1237\",\r\n \"incidentSubType\": \"Test30Mar22Subtype2\",\r\n \"isDefault\": false,\r\n \"priority\": 2,\r\n \"responseTime\": 1440,\r\n \"resolutionTime\": 14400,\r\n \"visibility\": 4\r\n }\r\n ],\r\n \"partyRoleId\": \"2\"\r\n },\r\n {\r\n \"deptId\": \"2808\",\r\n \"deptName\": \"training team\",\r\n \"incidentTypeId\": \"1334\",\r\n \"incidentType\": \"training session below average\",\r\n \"incidentSubTypeList\": [\r\n {\r\n \"ticketClassificationId\": \"4346\",\r\n \"incidentSubTypeId\": \"1335\",\r\n \"incidentSubType\": \"trainer not clarifying doubts\",\r\n \"isDefault\": false,\r\n \"priority\": 4,\r\n \"responseTime\": 1440,\r\n \"resolutionTime\": 4320,\r\n \"visibility\": 0\r\n },\r\n {\r\n \"ticketClassificationId\": \"4347\",\r\n \"incidentSubTypeId\": \"1336\",\r\n \"incidentSubType\": \"training session too long \",\r\n \"isDefault\": true,\r\n \"priority\": 4,\r\n \"responseTime\": 1440,\r\n \"resolutionTime\": 4320,\r\n \"visibility\": 0\r\n }\r\n ],\r\n \"partyRoleId\": \"2\"\r\n }\r\n ],\r\n \"status\": \"OK\"\r\n}"}],"_postman_id":"93e9c356-141a-4849-b21d-007e3d7073be"},{"name":"Delete Department","id":"36abf420-1149-4c7e-b12f-3fe6b974a2c1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"DELETE","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"}],"url":"{{Host}}/rest/TicketManagementService/v1/departments/{Department_Id}","description":"This API is used to delete department from the application. If department have open tickets, it cannot be deleted.
\n","urlObject":{"path":["rest","TicketManagementService","v1","departments","{Department_Id}"],"host":["{{Host}}"],"query":[],"variable":[]}},"response":[{"id":"a8da5913-e981-486b-bdf7-c4b71cb5d623","name":"Delete Department","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"}],"url":"{{Host}}/rest/TicketManagementService/v1/departments/{Department_Id}"},"status":"OK","code":200,"_postman_previewlanguage":"JSON","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Tue, 25 Apr 2023 12:16:50 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"15"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"*, Content-Type, Pragma, Origin, Authorization, party, X-XSRF-TOKEN, X-Requested-With,Access-Control-Allow-Headers,Accept,Access-Control-Allow-Credentials,X-Auth-Token, version, cache"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST,OPTIONS,PUT,DELETE,GET"}],"cookie":[],"responseTime":null,"body":"{\"status\":\"OK\"}"}],"_postman_id":"36abf420-1149-4c7e-b12f-3fe6b974a2c1"},{"name":"Delete Ticket Classification","id":"035af867-646e-4bb0-baf5-8f5c8780afc4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"DELETE","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"}],"url":"{{Host}}/rest/TicketManagementService/v1/ticketClassifications/?{ticketClassificationId}","description":"This API is used to delete the ticket classification from the application.
\n","urlObject":{"path":["rest","TicketManagementService","v1","ticketClassifications",""],"host":["{{Host}}"],"query":[{"description":{"content":"Enter the ticket classification Id for deleting the ticket classification.
\n","type":"text/plain"},"key":"{ticketClassificationId}","value":null}],"variable":[]}},"response":[{"id":"5ed77473-ec78-4120-97ef-8abbcc997716","name":"Delete Ticket Classification","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"}],"url":{"raw":"{{Host}}/rest/TicketManagementService/v1/ticketClassifications/?{ticketClassificationId}","host":["{{Host}}"],"path":["rest","TicketManagementService","v1","ticketClassifications",""],"query":[{"key":"{ticketClassificationId}","value":null,"description":"Enter the ticket classification Id for deleting the ticket classification. "}]}},"status":"OK","code":200,"_postman_previewlanguage":"JSON","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Tue, 25 Apr 2023 13:09:44 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"15"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"*, Content-Type, Pragma, Origin, Authorization, party, X-XSRF-TOKEN, X-Requested-With,Access-Control-Allow-Headers,Accept,Access-Control-Allow-Credentials,X-Auth-Token, version, cache"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST,OPTIONS,PUT,DELETE,GET"}],"cookie":[],"responseTime":null,"body":"{\r\n \"status\":\"OK\"\r\n}"}],"_postman_id":"035af867-646e-4bb0-baf5-8f5c8780afc4"}],"id":"2bdf7f69-6e92-4738-8d3b-9569d8df3a3a","description":"This section will discuss the settings or the pre-requiste required to set-up a service desk ticketing feature.
\n","_postman_id":"2bdf7f69-6e92-4738-8d3b-9569d8df3a3a"}],"id":"625393ae-2e89-430a-8fd3-7a66e81413be","description":"Tickets or Service Requests can be used by a business to track any problems or requests from their cusotmers. APIs for ticket management would let the user create, view, edit a ticket. A ticket created / managed from API can be viewed from UI or vice versa.
\n","_postman_id":"625393ae-2e89-430a-8fd3-7a66e81413be"}],"id":"313b1afc-2870-477b-ab4f-03c67671ec76","description":"The Service Desk APIs lets a user create, view and manage tickets in the BSS application. The tickets created through APIs would be available in the UI and a ticket created via the UI can be managed from the APIs as well.
\n","_postman_id":"313b1afc-2870-477b-ab4f-03c67671ec76"},{"name":"Rules","item":[{"name":"Service Desk Rule","item":[{"name":"Update Service Desk Rule","item":[{"name":"Update Rule","id":"95ea991e-b36d-4fcb-a6bf-4bc6d942d054","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth1","oauth1":{"basicConfig":[],"advancedConfig":[{"key":"signatureMethod","value":"This API is used to modify the Service Desk Rule, as only one rule can be created for service desk, users have privilege to modify the details of the existing rule.
\n","urlObject":{"path":["rest","RuleService","v1","rules"],"host":["{{Host}}"],"query":[],"variable":[]}},"response":[{"id":"0ce10524-8b02-4827-8e36-4442c3b139c3","name":"New Request","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"bearer {{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"contextName\": \"ServiceDesk\",\r\n \"ruleCategory\": \"13\",\r\n \"ruleSetLst\": [\r\n {\r\n \"id\": \"1\",\r\n \"ruleSetConditions\": [\r\n {\r\n \"id\": \"1\",\r\n \"property\": \"Ticket\",\r\n \"attribute\": \"Department\",\r\n \"operator\": \"Equal To\",\r\n \"values\": [\r\n \"2,7\"\r\n ]\r\n }\r\n ],\r\n \"ruleSetActions\": [\r\n {\r\n \"id\": \"1\",\r\n \"attribute\": \"Assignee\",\r\n \"operator\": \"Is Set To\",\r\n \"values\": [\r\n \"7\"\r\n ]\r\n }\r\n ],\r\n \"isDefaultRuleSet\": false,\r\n \"sequence\": 1\r\n }\r\n ]\r\n}"},"url":"{{Host}}/rest/RuleService/v1/rules"},"status":"OK","code":200,"_postman_previewlanguage":"JSON","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Mon, 18 Apr 2022 10:16:44 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"49"},{"key":"Connection","value":"keep-alive"},{"key":"Set-Cookie","value":"JSESSIONID=7C98A8BAE5E539C184E407B0FCF9A347.worker4; Path=/; Secure; HttpOnly"},{"key":"Access-Control-Allow-Headers","value":"*, Content-Type, Pragma, Origin, Authorization, party, X-XSRF-TOKEN, X-Requested-With,Access-Control-Allow-Headers,Accept,Access-Control-Allow-Credentials,X-Auth-Token, version, cache"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST,OPTIONS,PUT,DELETE,GET"}],"cookie":[],"responseTime":null,"body":"{\"ruleName\":\"Ticket Creation Rule\",\"status\":\"OK\"}"}],"_postman_id":"95ea991e-b36d-4fcb-a6bf-4bc6d942d054"}],"id":"579ed07f-e593-443f-96c4-e3ab34cffd15","description":"Update Rule API can be used to update an existing rule. This can be used to make changes to an existing rule or add new rulesets(conditions) under an existing rule.
\n","_postman_id":"579ed07f-e593-443f-96c4-e3ab34cffd15"},{"name":"Delete Service Desk Rule","item":[{"name":"Delete Rule","id":"a85f78f5-f308-4005-b0fc-f286659360c7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":""},"url":"{{Host}}/RuleService/v1/rules/{contextName}/{ruleName}","description":"This API is used to delete the service desk rule. If the rule is associated to ticket already, it will not allow you to delete the rule.
\nURL Example:
\n{{Host}}/rest/RuleService/v1/rules/ServiceDesk/Ticket Creation Rule
\n","urlObject":{"path":["RuleService","v1","rules","{contextName}","{ruleName}"],"host":["{{Host}}"],"query":[],"variable":[]}},"response":[{"id":"91aeb2ee-987e-41f9-849b-01a9551e3758","name":"New Request","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{Host}}/rest/RuleService/v1/rules/ServiceDesk/Ticket Creation Rule"},"status":"OK","code":200,"_postman_previewlanguage":"JSON","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Mon, 18 Apr 2022 10:20:23 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"15"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"*, Content-Type, Pragma, Origin, Authorization, party, X-XSRF-TOKEN, X-Requested-With,Access-Control-Allow-Headers,Accept,Access-Control-Allow-Credentials,X-Auth-Token, version, cache"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST,OPTIONS,PUT,DELETE,GET"}],"cookie":[],"responseTime":null,"body":"{\"status\":\"OK\"}"}],"_postman_id":"a85f78f5-f308-4005-b0fc-f286659360c7"}],"id":"1f9543dc-8894-48a8-b16c-1e200f6dbe75","description":"Delete Rule API can be used to remove a service desk rule that is setup. Deletion of the rule from the API would remove the rule from the UI as well.
\n","_postman_id":"1f9543dc-8894-48a8-b16c-1e200f6dbe75"},{"name":"Search a Rule","item":[{"name":"Search ticket Rule","id":"dc1f2de0-0a4f-4cb9-bf0d-110a002bba7d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth1","oauth1":{"basicConfig":[],"advancedConfig":[{"key":"signatureMethod","value":"This API is used to fetch the details of the ticket rules abailable in the application.
\nURL Example- {{Host}}/rest/RuleService/v1/rules/ServiceDesk/Ticket Creation Rule
\n","urlObject":{"path":["RuleService","v1","rules","{contextName}","{ruleName}"],"host":["{{Host}}"],"query":[],"variable":[]}},"response":[{"id":"b9b79c94-fcbf-4329-a304-c6a8fb681b48","name":"New Request","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{Host}}/rest/RuleService/v1/rules/ServiceDesk/Ticket Creation Rule"},"status":"OK","code":200,"_postman_previewlanguage":"JSON","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Mon, 18 Apr 2022 09:58:29 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"1636"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"*, Content-Type, Pragma, Origin, Authorization, party, X-XSRF-TOKEN, X-Requested-With,Access-Control-Allow-Headers,Accept,Access-Control-Allow-Credentials,X-Auth-Token, version, cache"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST,OPTIONS,PUT,DELETE,GET"}],"cookie":[],"responseTime":null,"body":"{\"ruleInfo\":{\"ruleName\":\"Ticket Creation Rule\",\"contextName\":\"ServiceDesk\",\"ruleSets\":[{\"id\":\"1\",\"ruleSetConditions\":[{\"id\":\"1\",\"property\":\"Ticket\",\"attribute\":\"Department\",\"operator\":\"Equal To\",\"values\":[\"2,3\"]}],\"ruleSetActions\":[{\"id\":\"1\",\"attribute\":\"Assignee\",\"operator\":\"Is Set To\",\"values\":[\"2\"]}],\"isDefaultRuleSet\":false,\"sequence\":1},{\"id\":\"2\",\"ruleSetConditions\":[{\"id\":\"1\",\"property\":\"Ticket\",\"attribute\":\"Department\",\"operator\":\"Equal To\",\"values\":[\"2\"]},{\"id\":\"2\",\"property\":\"Ticket\",\"attribute\":\"Incident Type\",\"operator\":\"Equal To\",\"values\":[\"2\"]},{\"id\":\"3\",\"property\":\"Ticket\",\"attribute\":\"Incident Subtype\",\"operator\":\"Equal To\",\"values\":[\"3\"]}],\"ruleSetActions\":[{\"id\":\"1\",\"attribute\":\"Assignee\",\"operator\":\"Is Set To\",\"values\":[\"2\"]},{\"id\":\"2\",\"attribute\":\"Priority\",\"operator\":\"Is Set To\",\"values\":[\"4\"]},{\"id\":\"3\",\"attribute\":\"Watcher\",\"operator\":\"Is Set To\",\"values\":[\"{ \\\"userIds\\\" : [\\\"2\\\"], \\\"customEmailIds\\\": [\\\"302\\\"], \\\"emailIds\\\": [\\\"atc@gmail.com\\\"] }\"]},{\"id\":\"4\",\"attribute\":\"Tags\",\"operator\":\"Is Set To\",\"values\":[\"dept\"]}],\"isDefaultRuleSet\":false,\"sequence\":2},{\"id\":\"3\",\"ruleSetConditions\":[],\"ruleSetActions\":[{\"id\":\"1\",\"attribute\":\"Assignee\",\"operator\":\"Is Set To\",\"values\":[\"403\"]},{\"id\":\"2\",\"attribute\":\"Watcher\",\"operator\":\"Is Set To\",\"values\":[\"{ \\\"userIds\\\" : [\\\"5\\\"], \\\"customEmailIds\\\": [\\\"402\\\"], \\\"emailIds\\\": [\\\"operations@gmail.com\\\"]}\"]},{\"id\":\"3\",\"attribute\":\"Priority\",\"operator\":\"Is Set To\",\"values\":[\"2\"]},{\"id\":\"4\",\"attribute\":\"Tags\",\"operator\":\"Is Set To\",\"values\":[\"Ticket, tag default\"]}],\"isDefaultRuleSet\":true,\"sequence\":4}],\"isDefaultRuleSetDisabled\":false},\"status\":\"OK\"}"}],"_postman_id":"dc1f2de0-0a4f-4cb9-bf0d-110a002bba7d"}],"id":"2e77a0d7-03e6-49ba-8b2c-90c33f46b556","description":"Search Rule API can be used to find a rule alredy defined for Service Desk. This can be used by someone who wants to fetch an existing rule to make changes or see what is setup.
\n","_postman_id":"2e77a0d7-03e6-49ba-8b2c-90c33f46b556"},{"name":"Create Rule","item":[{"name":"Create ticket Rule","id":"83b3e837-ae12-4915-8b62-632d392f66d7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth1","oauth1":{"basicConfig":[],"advancedConfig":[{"key":"signatureMethod","value":"This API is used to create ticket rule with conditions and actions.
\n","urlObject":{"path":["rest","RuleService","v1","rules"],"host":["{{Host}}"],"query":[],"variable":[]}},"response":[{"id":"76245a7a-061a-4b7a-9ee2-35e1a5e26727","name":"New Request","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{token}}","type":"text"},{"key":"conten","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"contextName\": \"ServiceDesk\",\r\n \"ruleCategory\": \"13\",\r\n \"ruleSetLst\": [\r\n {\r\n \"id\": \"10000\",\r\n \"ruleSetConditions\": [\r\n {\r\n \"id\": \"128900\",\r\n \"property\": \"Ticket\",\r\n \"attribute\": \"Department\",\r\n \"operator\": \"Equal To\",\r\n \"values\": [\r\n \"2,3\"\r\n ]\r\n }\r\n ],\r\n \"ruleSetActions\": [\r\n {\r\n \"attribute\": \"Assignee\",\r\n \"operator\": \"Is Set To\",\r\n \"values\": [\r\n \"2\"\r\n ]\r\n }\r\n ],\r\n \"sequence\": 1\r\n },\r\n {\r\n \"ruleSetConditions\": [\r\n {\r\n \"property\": \"Ticket\",\r\n \"attribute\": \"Department\",\r\n \"operator\": \"Equal To\",\r\n \"values\": [\r\n \"2\"\r\n ]\r\n },\r\n {\r\n \"property\": \"Ticket\",\r\n \"attribute\": \"Incident Type\",\r\n \"operator\": \"Equal To\",\r\n \"values\": [\r\n \"2\"\r\n ]\r\n },\r\n {\r\n \"property\": \"Ticket\",\r\n \"attribute\": \"Incident Subtype\",\r\n \"operator\": \"Equal To\",\r\n \"values\": [\r\n \"3\"\r\n ]\r\n }\r\n ],\r\n \"ruleSetActions\": [\r\n {\r\n \"attribute\": \"Assignee\",\r\n \"operator\": \"Is Set To\",\r\n \"values\": [\r\n \"2\"\r\n ]\r\n },\r\n {\r\n \"attribute\": \"Priority\",\r\n \"operator\": \"Is Set To\",\r\n \"values\": [\r\n \"4\"\r\n ]\r\n },\r\n {\r\n \"attribute\": \"Watcher\",\r\n \"operator\": \"Is Set To\",\r\n \"values\": [\r\n \"{ \\\"userIds\\\" : [\\\"2\\\"], \\\"customEmailIds\\\": [\\\"302\\\"], \\\"emailIds\\\": [\\\"atc@gmail.com\\\"] }\"\r\n ]\r\n },\r\n {\r\n \"attribute\": \"Tags\",\r\n \"operator\": \"Is Set To\",\r\n \"values\": [\r\n \"dept\"\r\n ]\r\n }\r\n ],\r\n \"sequence\": 2\r\n },\r\n {\r\n \"isDefaultRuleSet\": true,\r\n \"ruleSetActions\": [\r\n {\r\n \"attribute\": \"Assignee\",\r\n \"operator\": \"Is Set To\",\r\n \"values\": [\r\n \"403\"\r\n ]\r\n },\r\n {\r\n \"attribute\": \"Watcher\",\r\n \"operator\": \"Is Set To\",\r\n \"values\": [\r\n \"{ \\\"userIds\\\" : [\\\"5\\\"], \\\"customEmailIds\\\": [\\\"402\\\"], \\\"emailIds\\\": [\\\"operations@gmail.com\\\"]}\"\r\n ]\r\n },\r\n {\r\n \"attribute\": \"Priority\",\r\n \"operator\": \"Is Set To\",\r\n \"values\": [\r\n \"2\"\r\n ]\r\n },\r\n {\r\n \"attribute\": \"Tags\",\r\n \"operator\": \"Is Set To\",\r\n \"values\": [\r\n \"Ticket, tag default\"\r\n ]\r\n }\r\n ]\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{Host}}/rest/RuleService/v1/rules"},"status":"OK","code":200,"_postman_previewlanguage":"JSON","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Mon, 18 Apr 2022 09:43:49 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"49"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"*, Content-Type, Pragma, Origin, Authorization, party, X-XSRF-TOKEN, X-Requested-With,Access-Control-Allow-Headers,Accept,Access-Control-Allow-Credentials,X-Auth-Token, version, cache"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST,OPTIONS,PUT,DELETE,GET"}],"cookie":[],"responseTime":null,"body":"{\"ruleName\":\"Ticket Creation Rule\",\"status\":\"OK\"}"}],"_postman_id":"83b3e837-ae12-4915-8b62-632d392f66d7"}],"id":"0ed47ac8-1778-481c-b8df-5c2a86b0d1a7","description":"Create rule API would be used to create a new rule for the Service Desk ticket assignment. A rule can have one or more rulesets of conditions, that can be defined as part of the create API. A service desk rule would be evaluated at the time of ticket creation to set specific fields on the ticket.
\n","_postman_id":"0ed47ac8-1778-481c-b8df-5c2a86b0d1a7"}],"id":"e47f8f97-12b8-4fa1-bb33-a5732f6ec9a3","description":"Service Desk rule API would be used to manage the rules that is used for ticket assignment. A user can manage a rule which would be evaluated at the time of ticket creation to set relevant properties in the ticket or assign them to the right departments and users.
\n","_postman_id":"e47f8f97-12b8-4fa1-bb33-a5732f6ec9a3"},{"name":"Discount Rule","item":[{"name":"Create Discount Rule","id":"6519ef2b-a760-4c52-80a1-dc292db88e7c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"contextName\": \"Voice Discount Rule\",\r\n \"ruleName\": \"VOIP_Rule\",\r\n \"ruleCategory\": 12,\r\n \"ruleSets\": [\r\n {\r\n \"ruleSetConditions\": [\r\n {\r\n \"property\": \"Product/Plan\",\r\n \"attribute\": \"Product Code\",\r\n \"operator\": \"Equal To\",\r\n \"values\": [\r\n \"2\"\r\n ]\r\n },\r\n {\r\n \"property\": \"Subscriber\",\r\n \"attribute\": \"Primary Currency\",\r\n \"operator\": \"Equal To\",\r\n \"values\": [\r\n \"US Dollar (USD)\"\r\n ]\r\n }\r\n ],\r\n \"ruleSetActions\": [\r\n {\r\n \"attribute\": \"Fixed Discount\",\r\n \"operator\": \"Is Set To\",\r\n \"values\": [\r\n \"10\"\r\n ]\r\n }\r\n ],\r\n \"isDefaultRuleSet\": false,\r\n \"sequence\": 1\r\n },\r\n {\r\n \"ruleSetConditions\": [],\r\n \"ruleSetActions\": [\r\n {\r\n \"attribute\": \"Fixed Discount\",\r\n \"operator\": \"Is Set To\",\r\n \"values\": [\r\n \"20\"\r\n ]\r\n }\r\n ],\r\n \"isDefaultRuleSet\": true,\r\n \"sequence\": 2\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{Host}}/rest/RuleService/v1/rules/Discount","description":"This API is used to create discount rule in the application.
\n","urlObject":{"path":["rest","RuleService","v1","rules","Discount"],"host":["{{Host}}"],"query":[],"variable":[]}},"response":[{"id":"8cd40f9c-0101-4fbd-9848-a950c1dee0c2","name":"Create Discount Rule","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"contextName\": \"Voice Discount Rule\",\r\n \"ruleName\": \"VOIP_Rule\",\r\n \"ruleCategory\": 12,\r\n \"ruleSets\": [\r\n {\r\n \"ruleSetConditions\": [\r\n {\r\n \"property\": \"Product/Plan\",\r\n \"attribute\": \"Product Code\",\r\n \"operator\": \"Equal To\",\r\n \"values\": [\r\n \"2\"\r\n ]\r\n },\r\n {\r\n \"property\": \"Subscriber\",\r\n \"attribute\": \"Primary Currency\",\r\n \"operator\": \"Equal To\",\r\n \"values\": [\r\n \"US Dollar (USD)\"\r\n ]\r\n }\r\n ],\r\n \"ruleSetActions\": [\r\n {\r\n \"attribute\": \"Fixed Discount\",\r\n \"operator\": \"Is Set To\",\r\n \"values\": [\r\n \"10\"\r\n ]\r\n }\r\n ],\r\n \"isDefaultRuleSet\": false,\r\n \"sequence\": 1\r\n },\r\n {\r\n \"ruleSetConditions\": [],\r\n \"ruleSetActions\": [\r\n {\r\n \"attribute\": \"Fixed Discount\",\r\n \"operator\": \"Is Set To\",\r\n \"values\": [\r\n \"20\"\r\n ]\r\n }\r\n ],\r\n \"isDefaultRuleSet\": true,\r\n \"sequence\": 2\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{Host}}/rest/RuleService/v1/rules/Discount"},"status":"OK","code":200,"_postman_previewlanguage":"JSON","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 26 Apr 2023 06:34:41 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"38"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"*, Content-Type, Pragma, Origin, Authorization, party, X-XSRF-TOKEN, X-Requested-With,Access-Control-Allow-Headers,Accept,Access-Control-Allow-Credentials,X-Auth-Token, version, cache"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST,OPTIONS,PUT,DELETE,GET"}],"cookie":[],"responseTime":null,"body":"{\r\n \"ruleName\":\"VOIP_Rule\",\r\n \"status\":\"OK\"\r\n}"}],"_postman_id":"6519ef2b-a760-4c52-80a1-dc292db88e7c"}],"id":"4c9a4e80-5af7-4583-bbb1-9550b3094e44","description":"This section will discuss about discount rule in the application. User can create, update, fetch and delete the discount rule.
\n","_postman_id":"4c9a4e80-5af7-4583-bbb1-9550b3094e44"},{"name":"Business Policy Rules","item":[{"name":"Subscription Purchase Rule","item":[{"name":"Subscription Purchase Rule","id":"3f8bc9d3-8490-420e-bc9e-868b6fd1555b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"contextName\": \"OrderValidation\",\r\n \"ruleCategory\": 1,\r\n \"ruleSetActions\": [\r\n {\r\n \"dataType\": \"String\",\r\n \"operators\": [\r\n \"Is Set To\"\r\n ],\r\n \"actionName\": \"Error Message\",\r\n \"inputFieldType\": 1,\r\n \"isMandatoryAction\": true\r\n }\r\n ],\r\n \"ruleSetConditions\": [\r\n {\r\n \"propertyName\": \"Orders\",\r\n \"ruleSetAttributes\": [\r\n {\r\n \"dataType\": \"String\",\r\n \"operators\": [\r\n \"Equal To\",\r\n \"Not Equal To\",\r\n \"Exactly\",\r\n \"Starts With\",\r\n \"Contains\",\r\n \"Equal To (Multi Select)\"\r\n ],\r\n \"attributeName\": \"Billing City\",\r\n \"inputFieldType\": 1\r\n },\r\n {\r\n \"dataType\": \"String\",\r\n \"operators\": [\r\n \"Equal To\",\r\n \"Not Equal To\",\r\n \"Exactly\",\r\n \"Starts With\",\r\n \"Contains\",\r\n \"Equal To (Multi Select)\"\r\n ],\r\n \"attributeName\": \"Billing Country\",\r\n \"inputFieldType\": 2\r\n },\r\n {\r\n \"dataType\": \"String\",\r\n \"operators\": [\r\n \"Equal To\",\r\n \"Not Equal To\",\r\n \"Exactly\",\r\n \"Starts With\",\r\n \"Contains\",\r\n \"Equal To (Multi Select)\"\r\n ],\r\n \"attributeName\": \"Billing State\",\r\n \"inputFieldType\": 1\r\n },\r\n {\r\n \"dataType\": \"String\",\r\n \"operators\": [\r\n \"Equal To\",\r\n \"Not Equal To\",\r\n \"Exactly\",\r\n \"Starts With\",\r\n \"Contains\",\r\n \"Equal To (Multi Select)\"\r\n ],\r\n \"attributeName\": \"Billing ZipCode\",\r\n \"inputFieldType\": 1\r\n }\r\n ]\r\n },\r\n {\r\n \"propertyName\": \"Subscriber\"\r\n },\r\n {\r\n \"propertyName\": \"Subscription\",\r\n \"ruleSetAttributes\": [\r\n {\r\n \"dataType\": \"BigDecimal\",\r\n \"operators\": [\r\n \"Between\",\r\n \"Equal To\",\r\n \"Not Equal To\",\r\n \"Less Than\",\r\n \"Greater Than\",\r\n \"Less Than Or Equal To\",\r\n \"Greater Than Or Equal To\",\r\n \"Equal To (Multi Select)\"\r\n ],\r\n \"attributeName\": \"Age\",\r\n \"inputFieldType\": 1\r\n },\r\n {\r\n \"dataType\": \"BigDecimal\",\r\n \"operators\": [\r\n \"Between\",\r\n \"Equal To\",\r\n \"Not Equal To\",\r\n \"Less Than\",\r\n \"Greater Than\",\r\n \"Less Than Or Equal To\",\r\n \"Greater Than Or Equal To\",\r\n \"Equal To (Multi Select)\"\r\n ],\r\n \"attributeName\": \"Amount\",\r\n \"inputFieldType\": 1\r\n },\r\n {\r\n \"dataType\": \"String\",\r\n \"operators\": [\r\n \"Equal To\",\r\n \"Not Equal To\",\r\n \"Exactly\",\r\n \"Starts With\",\r\n \"Contains\",\r\n \"Equal To (Multi Select)\"\r\n ],\r\n \"attributeName\": \"Product - Price Plan\",\r\n \"inputFieldType\": 3\r\n },\r\n {\r\n \"dataType\": \"BigDecimal\",\r\n \"operators\": [\r\n \"Between\",\r\n \"Equal To\",\r\n \"Not Equal To\",\r\n \"Less Than\",\r\n \"Greater Than\",\r\n \"Less Than Or Equal To\",\r\n \"Greater Than Or Equal To\",\r\n \"Equal To (Multi Select)\"\r\n ],\r\n \"attributeName\": \"Quantity( Existing )\",\r\n \"inputFieldType\": 1\r\n },\r\n {\r\n \"dataType\": \"BigDecimal\",\r\n \"operators\": [\r\n \"Between\",\r\n \"Equal To\",\r\n \"Not Equal To\",\r\n \"Less Than\",\r\n \"Greater Than\",\r\n \"Less Than Or Equal To\",\r\n \"Greater Than Or Equal To\",\r\n \"Equal To (Multi Select)\"\r\n ],\r\n \"attributeName\": \"Quantity( New )\",\r\n \"inputFieldType\": 1\r\n },\r\n {\r\n \"dataType\": \"String\",\r\n \"operators\": [\r\n \"Equal To\",\r\n \"Not Equal To\",\r\n \"Exactly\",\r\n \"Starts With\",\r\n \"Contains\",\r\n \"Equal To (Multi Select)\"\r\n ],\r\n \"attributeName\": \"Service/Ship To City\",\r\n \"inputFieldType\": 1\r\n },\r\n {\r\n \"dataType\": \"String\",\r\n \"operators\": [\r\n \"Equal To\",\r\n \"Not Equal To\",\r\n \"Exactly\",\r\n \"Starts With\",\r\n \"Contains\",\r\n \"Equal To (Multi Select)\"\r\n ],\r\n \"attributeName\": \"Service/Ship To Country\",\r\n \"inputFieldType\": 2\r\n },\r\n {\r\n \"dataType\": \"String\",\r\n \"operators\": [\r\n \"Equal To\",\r\n \"Not Equal To\",\r\n \"Exactly\",\r\n \"Starts With\",\r\n \"Contains\",\r\n \"Equal To (Multi Select)\"\r\n ],\r\n \"attributeName\": \"Service/Ship To State\",\r\n \"inputFieldType\": 1\r\n },\r\n {\r\n \"dataType\": \"String\",\r\n \"operators\": [\r\n \"Equal To\",\r\n \"Not Equal To\",\r\n \"Exactly\",\r\n \"Starts With\",\r\n \"Contains\",\r\n \"Equal To (Multi Select)\"\r\n ],\r\n \"attributeName\": \"Service/Ship To ZipCode\",\r\n \"inputFieldType\": 1\r\n },\r\n {\r\n \"dataType\": \"String\",\r\n \"operators\": [\r\n \"Equal To\",\r\n \"Not Equal To\",\r\n \"Exactly\",\r\n \"Starts With\",\r\n \"Contains\",\r\n \"Equal To (Multi Select)\"\r\n ],\r\n \"attributeName\": \"Status\",\r\n \"inputFieldType\": 2\r\n },\r\n {\r\n \"dataType\": \"BigDecimal\",\r\n \"operators\": [\r\n \"Between\",\r\n \"Equal To\",\r\n \"Not Equal To\",\r\n \"Less Than\",\r\n \"Greater Than\",\r\n \"Less Than Or Equal To\",\r\n \"Greater Than Or Equal To\",\r\n \"Equal To (Multi Select)\"\r\n ],\r\n \"attributeName\": \"Total Quantity( New )\",\r\n \"inputFieldType\": 1\r\n }\r\n ]\r\n }\r\n ],\r\n \"defaultRuleSetType\": \"NOT_NEEDED\",\r\n \"validActionValueNumber\": 1\r\n}\r\nGet Meta Data :\r\nMethod : GET\r\nURL - http: //localhost:8080/rest/RuleService/v1/rules/OrderValidation/metadata\r\n\r\nResponse: {\r\n \"ruleInfo\": {\r\n \"contextName\": \"OrderValidation\",\r\n \"ruleSetConditions\": [\r\n {\r\n \"propertyName\": \"Orders\",\r\n \"ruleSetAttributes\": [\r\n {\r\n \"attributeName\": \"Billing City\",\r\n \"operators\": [\r\n \"Equal To\",\r\n \"Not Equal To\",\r\n \"Exactly\",\r\n \"Starts With\",\r\n \"Contains\",\r\n \"Equal To (Multi Select)\"\r\n ],\r\n \"dataType\": \"String\",\r\n \"inputFieldType\": 1\r\n },\r\n {\r\n \"attributeName\": \"Billing Country\",\r\n \"operators\": [\r\n \"Equal To\",\r\n \"Not Equal To\",\r\n \"Exactly\",\r\n \"Starts With\",\r\n \"Contains\",\r\n \"Equal To (Multi Select)\"\r\n ],\r\n \"dataType\": \"String\",\r\n \"inputFieldType\": 2\r\n },\r\n {\r\n \"attributeName\": \"Billing State\",\r\n \"operators\": [\r\n \"Equal To\",\r\n \"Not Equal To\",\r\n \"Exactly\",\r\n \"Starts With\",\r\n \"Contains\",\r\n \"Equal To (Multi Select)\"\r\n ],\r\n \"dataType\": \"String\",\r\n \"inputFieldType\": 1\r\n },\r\n {\r\n \"attributeName\": \"Billing ZipCode\",\r\n \"operators\": [\r\n \"Equal To\",\r\n \"Not Equal To\",\r\n \"Exactly\",\r\n \"Starts With\",\r\n \"Contains\",\r\n \"Equal To (Multi Select)\"\r\n ],\r\n \"dataType\": \"String\",\r\n \"inputFieldType\": 1\r\n }\r\n ]\r\n },\r\n {\r\n \"propertyName\": \"Subscriber\",\r\n \"ruleSetAttributes\": [\r\n {\r\n \"attributeName\": \"Total Due Amount\",\r\n \"operators\": [\r\n \"Between\",\r\n \"Equal To\",\r\n \"Not Equal To\",\r\n \"Less Than\",\r\n \"Greater Than\",\r\n \"Less Than Or Equal To\",\r\n \"Greater Than Or Equal To\",\r\n \"Equal To (Multi Select)\"\r\n ],\r\n \"dataType\": \"BigDecimal\",\r\n \"inputFieldType\": 1\r\n },\r\n {\r\n \"attributeName\": \"Billing Profile Status\",\r\n \"operators\": [\r\n \"Equal To\",\r\n \"Not Equal To\",\r\n \"Exactly\",\r\n \"Starts With\",\r\n \"Contains\",\r\n \"Equal To (Multi Select)\"\r\n ],\r\n \"dataType\": \"String\",\r\n \"inputFieldType\": 2\r\n },\r\n {\r\n \"attributeName\": \"Account Name\",\r\n \"operators\": [\r\n \"Equal To\",\r\n \"Not Equal To\",\r\n \"Exactly\",\r\n \"Starts With\",\r\n \"Contains\",\r\n \"Equal To (Multi Select)\"\r\n ],\r\n \"dataType\": \"String\",\r\n \"inputFieldType\": 1\r\n },\r\n {\r\n \"attributeName\": \"Account Number\",\r\n \"operators\": [\r\n \"Equal To\",\r\n \"Not Equal To\",\r\n \"Exactly\",\r\n \"Starts With\",\r\n \"Contains\",\r\n \"Equal To (Multi Select)\"\r\n ],\r\n \"dataType\": \"String\",\r\n \"inputFieldType\": 1\r\n },\r\n {\r\n \"attributeName\": \"Primary Currency\",\r\n \"operators\": [\r\n \"Equal To\",\r\n \"Not Equal To\",\r\n \"Exactly\",\r\n \"Starts With\",\r\n \"Contains\",\r\n \"Equal To (Multi Select)\"\r\n ],\r\n \"dataType\": \"String\",\r\n \"inputFieldType\": 2\r\n },\r\n {\r\n \"attributeName\": \"Type\",\r\n \"operators\": [\r\n \"Equal To\",\r\n \"Not Equal To\",\r\n \"Exactly\",\r\n \"Starts With\",\r\n \"Contains\",\r\n \"Equal To (Multi Select)\"\r\n ],\r\n \"dataType\": \"String\",\r\n \"inputFieldType\": 1\r\n },\r\n {\r\n \"attributeName\": \"Payment Method\",\r\n \"operators\": [\r\n \"Equal To\",\r\n \"Not Equal To\",\r\n \"Exactly\",\r\n \"Starts With\",\r\n \"Contains\",\r\n \"Equal To (Multi Select)\"\r\n ],\r\n \"dataType\": \"String\",\r\n \"inputFieldType\": 1\r\n },\r\n {\r\n \"attributeName\": \"ACCOUNTING_NAME\",\r\n \"operators\": [\r\n \"Equal To\",\r\n \"Not Equal To\",\r\n \"Exactly\",\r\n \"Starts With\",\r\n \"Contains\",\r\n \"Equal To (Multi Select)\"\r\n ],\r\n \"dataType\": \"String\",\r\n \"inputFieldType\": 1\r\n },\r\n {\r\n \"attributeName\": \"account attr\",\r\n \"operators\": [\r\n \"Equal To\",\r\n \"Not Equal To\",\r\n \"Exactly\",\r\n \"Starts With\",\r\n \"Contains\",\r\n \"Equal To (Multi Select)\"\r\n ],\r\n \"dataType\": \"String\",\r\n \"inputFieldType\": 1\r\n }\r\n ]\r\n },\r\n {\r\n \"propertyName\": \"Subscription\",\r\n \"ruleSetAttributes\": [\r\n {\r\n \"attributeName\": \"Age\",\r\n \"operators\": [\r\n \"Between\",\r\n \"Equal To\",\r\n \"Not Equal To\",\r\n \"Less Than\",\r\n \"Greater Than\",\r\n \"Less Than Or Equal To\",\r\n \"Greater Than Or Equal To\",\r\n \"Equal To (Multi Select)\"\r\n ],\r\n \"dataType\": \"BigDecimal\",\r\n \"inputFieldType\": 1\r\n },\r\n {\r\n \"attributeName\": \"Amount\",\r\n \"operators\": [\r\n \"Between\",\r\n \"Equal To\",\r\n \"Not Equal To\",\r\n \"Less Than\",\r\n \"Greater Than\",\r\n \"Less Than Or Equal To\",\r\n \"Greater Than Or Equal To\",\r\n \"Equal To (Multi Select)\"\r\n ],\r\n \"dataType\": \"BigDecimal\",\r\n \"inputFieldType\": 1\r\n },\r\n {\r\n \"attributeName\": \"Product - Price Plan\",\r\n \"operators\": [\r\n \"Equal To\",\r\n \"Not Equal To\",\r\n \"Exactly\",\r\n \"Starts With\",\r\n \"Contains\",\r\n \"Equal To (Multi Select)\"\r\n ],\r\n \"dataType\": \"String\",\r\n \"inputFieldType\": 3\r\n },\r\n {\r\n \"attributeName\": \"Quantity( Existing )\",\r\n \"operators\": [\r\n \"Between\",\r\n \"Equal To\",\r\n \"Not Equal To\",\r\n \"Less Than\",\r\n \"Greater Than\",\r\n \"Less Than Or Equal To\",\r\n \"Greater Than Or Equal To\",\r\n \"Equal To (Multi Select)\"\r\n ],\r\n \"dataType\": \"BigDecimal\",\r\n \"inputFieldType\": 1\r\n },\r\n {\r\n \"attributeName\": \"Quantity( New )\",\r\n \"operators\": [\r\n \"Between\",\r\n \"Equal To\",\r\n \"Not Equal To\",\r\n \"Less Than\",\r\n \"Greater Than\",\r\n \"Less Than Or Equal To\",\r\n \"Greater Than Or Equal To\",\r\n \"Equal To (Multi Select)\"\r\n ],\r\n \"dataType\": \"BigDecimal\",\r\n \"inputFieldType\": 1\r\n },\r\n {\r\n \"attributeName\": \"Service/Ship To City\",\r\n \"operators\": [\r\n \"Equal To\",\r\n \"Not Equal To\",\r\n \"Exactly\",\r\n \"Starts With\",\r\n \"Contains\",\r\n \"Equal To (Multi Select)\"\r\n ],\r\n \"dataType\": \"String\",\r\n \"inputFieldType\": 1\r\n },\r\n {\r\n \"attributeName\": \"Service/Ship To Country\",\r\n \"operators\": [\r\n \"Equal To\",\r\n \"Not Equal To\",\r\n \"Exactly\",\r\n \"Starts With\",\r\n \"Contains\",\r\n \"Equal To (Multi Select)\"\r\n ],\r\n \"dataType\": \"String\",\r\n \"inputFieldType\": 2\r\n },\r\n {\r\n \"attributeName\": \"Service/Ship To State\",\r\n \"operators\": [\r\n \"Equal To\",\r\n \"Not Equal To\",\r\n \"Exactly\",\r\n \"Starts With\",\r\n \"Contains\",\r\n \"Equal To (Multi Select)\"\r\n ],\r\n \"dataType\": \"String\",\r\n \"inputFieldType\": 1\r\n },\r\n {\r\n \"attributeName\": \"Service/Ship To ZipCode\",\r\n \"operators\": [\r\n \"Equal To\",\r\n \"Not Equal To\",\r\n \"Exactly\",\r\n \"Starts With\",\r\n \"Contains\",\r\n \"Equal To (Multi Select)\"\r\n ],\r\n \"dataType\": \"String\",\r\n \"inputFieldType\": 1\r\n },\r\n {\r\n \"attributeName\": \"Status\",\r\n \"operators\": [\r\n \"Equal To\",\r\n \"Not Equal To\",\r\n \"Exactly\",\r\n \"Starts With\",\r\n \"Contains\",\r\n \"Equal To (Multi Select)\"\r\n ],\r\n \"dataType\": \"String\",\r\n \"inputFieldType\": 2\r\n },\r\n {\r\n \"attributeName\": \"Total Quantity( New )\",\r\n \"operators\": [\r\n \"Between\",\r\n \"Equal To\",\r\n \"Not Equal To\",\r\n \"Less Than\",\r\n \"Greater Than\",\r\n \"Less Than Or Equal To\",\r\n \"Greater Than Or Equal To\",\r\n \"Equal To (Multi Select)\"\r\n ],\r\n \"dataType\": \"BigDecimal\",\r\n \"inputFieldType\": 1\r\n },\r\n {\r\n \"attributeName\": \"address attr\",\r\n \"operators\": [\r\n \"Equal To\",\r\n \"Not Equal To\",\r\n \"Exactly\",\r\n \"Starts With\",\r\n \"Contains\",\r\n \"Equal To (Multi Select)\"\r\n ],\r\n \"dataType\": \"String\",\r\n \"inputFieldType\": 1\r\n }\r\n ]\r\n }\r\n ],\r\n \"ruleSetActions\": [\r\n {\r\n \"actionName\": \"Error Message\",\r\n \"operators\": [\r\n \"Is Set To\"\r\n ],\r\n \"dataType\": \"String\",\r\n \"inputFieldType\": 1,\r\n \"isMandatoryAction\": true\r\n }\r\n ],\r\n \"ruleCategory\": 1,\r\n \"defaultRuleSetType\": 3,\r\n \"validActionValueNumber\": 1\r\n },\r\n \"status\": \"OK\"\r\n}"},"url":"{{Host}}/rest/RuleService/v1/rules/OrderValidation","description":"This API is used to create a subscription pruchase rule using the request.
\n","urlObject":{"path":["rest","RuleService","v1","rules","OrderValidation"],"host":["{{Host}}"],"query":[],"variable":[]}},"response":[{"id":"52b2d40e-e817-4b42-b195-5447f53cf236","name":"Subscription Purchase Rule","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"contextName\": \"OrderValidation\",\r\n \"ruleName\": \"Subscription_Purchase\",\r\n \"ruleCategory\": 1,\r\n \"ruleSets\": [\r\n {\r\n \"ruleSetConditions\": [\r\n {\r\n \"property\": \"Orders\",\r\n \"attribute\": \"Billing City\",\r\n \"operator\": \"Equal To\",\r\n \"values\": [\r\n \"NY\"\r\n ]\r\n },\r\n {\r\n \"property\": \"Subscriber\",\r\n \"attribute\": \"Billing Profile Status\",\r\n \"operator\": \"Equal To\",\r\n \"values\": [\r\n \"Active\"\r\n ]\r\n },\r\n {\r\n \"property\": \"Subscription\",\r\n \"attribute\": \"Product - Price Plan\",\r\n \"operator\": \"Equal To\",\r\n \"values\": [\r\n \"2\"\r\n ]\r\n }\r\n ],\r\n \"ruleSetActions\": [\r\n {\r\n \"attribute\": \"Error Message\",\r\n \"operator\": \"Is Set To\",\r\n \"values\": [\r\n \"Error Message\"\r\n ]\r\n }\r\n ],\r\n \"sequence\": 1\r\n }\r\n ]\r\n}"},"url":"{{Host}}/rest/RuleService/v1/rules/OrderValidation"},"status":"OK","code":200,"_postman_previewlanguage":"JSON","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Mon, 05 Jun 2023 10:54:29 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"50"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"*, Content-Type, Pragma, Origin, Authorization, party, X-XSRF-TOKEN, X-Requested-With,Access-Control-Allow-Headers,Accept,Access-Control-Allow-Credentials,X-Auth-Token, version, cache"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST,OPTIONS,PUT,DELETE,GET"}],"cookie":[],"responseTime":null,"body":"{\r\n \"ruleName\":\"Subscription_Purchase\",\r\n \"status\":\"OK\"\r\n}"}],"_postman_id":"3f8bc9d3-8490-420e-bc9e-868b6fd1555b"},{"name":"Update Subscription Purchase Rule","id":"b578da0a-ac5e-4976-85e5-b79b42ac89d0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"PUT","header":[{"key":"Authorization","value":"Bearer {{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"contextName\": \"OrderValidation\",\r\n \"ruleName\": \"Subscription_Purchase\",\r\n \"ruleCategory\": 1,\r\n \"ruleSets\": [\r\n {\r\n \"id\": \"1\",\r\n \"ruleSetConditions\": [\r\n {\r\n \"id\": \"1\",\r\n \"property\": \"Orders\",\r\n \"attribute\": \"Billing City\",\r\n \"operator\": \"Equal To\",\r\n \"values\": [\"NewYork\"]\r\n },\r\n {\r\n \"id\": \"2\",\r\n \"property\": \"Subscriber\",\r\n \"attribute\": \"Billing Profile Status\",\r\n \"operator\": \"Equal To\",\r\n \"values\": [\"Suspended\"]\r\n },\r\n {\r\n \"id\": \"3\",\r\n \"property\": \"Subscription\",\r\n \"attribute\": \"Product - Price Plan\",\r\n \"operator\": \"Equal To\",\r\n \"values\": [\"2\"]\r\n }\r\n ],\r\n \"ruleSetActions\": [\r\n {\r\n \"id\": \"1\",\r\n \"attribute\": \"Error Message\",\r\n \"operator\": \"Is Set To\",\r\n \"values\": [\"Error Message\"]\r\n }\r\n ],\r\n \"sequence\": 1\r\n }\r\n ]\r\n}\r\n"},"url":"{{Host}}/rest/RuleService/v1/rules/OrderValidation/Subscription_Purchase","description":"This API is used to modify the subscription purchase rule details.
\n","urlObject":{"path":["rest","RuleService","v1","rules","OrderValidation","Subscription_Purchase"],"host":["{{Host}}"],"query":[],"variable":[]}},"response":[{"id":"cd670f5d-0543-4036-9926-f598632be9ad","name":"Update Subscription Purchase Rule","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer {{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"contextName\": \"OrderValidation\",\r\n \"ruleName\": \"Subscription_Purchase\",\r\n \"ruleCategory\": 1,\r\n \"ruleSets\": [\r\n {\r\n \"id\": \"1\",\r\n \"ruleSetConditions\": [\r\n {\r\n \"id\": \"1\",\r\n \"property\": \"Orders\",\r\n \"attribute\": \"Billing City\",\r\n \"operator\": \"Equal To\",\r\n \"values\": [\"NewYork\"]\r\n },\r\n {\r\n \"id\": \"2\",\r\n \"property\": \"Subscriber\",\r\n \"attribute\": \"Billing Profile Status\",\r\n \"operator\": \"Equal To\",\r\n \"values\": [\"Suspended\"]\r\n },\r\n {\r\n \"id\": \"3\",\r\n \"property\": \"Subscription\",\r\n \"attribute\": \"Product - Price Plan\",\r\n \"operator\": \"Equal To\",\r\n \"values\": [\"2\"]\r\n }\r\n ],\r\n \"ruleSetActions\": [\r\n {\r\n \"id\": \"1\",\r\n \"attribute\": \"Error Message\",\r\n \"operator\": \"Is Set To\",\r\n \"values\": [\"Error Message\"]\r\n }\r\n ],\r\n \"sequence\": 1\r\n }\r\n ]\r\n}\r\n"},"url":{"raw":"{{Host}}/rest/RuleService/v1/rules/OrderValidation/?{Rule_name}","host":["{{Host}}"],"path":["rest","RuleService","v1","rules","OrderValidation",""],"query":[{"key":"{Rule_name}","value":null,"description":"Enter the rule name which you want to update."}]}},"status":"OK","code":200,"_postman_previewlanguage":"JSON","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Mon, 05 Jun 2023 11:01:49 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"50"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"*, Content-Type, Pragma, Origin, Authorization, party, X-XSRF-TOKEN, X-Requested-With,Access-Control-Allow-Headers,Accept,Access-Control-Allow-Credentials,X-Auth-Token, version, cache"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST,OPTIONS,PUT,DELETE,GET"}],"cookie":[],"responseTime":null,"body":"{\r\n \"ruleName\":\"Subscription_Purchase\",\r\n \"status\":\"OK\"\r\n}"}],"_postman_id":"b578da0a-ac5e-4976-85e5-b79b42ac89d0"},{"name":"Get Subscription Purchase Rule","id":"a01d5d63-10ce-414b-83e2-4fd8ae5e76b6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{Host}}/rest/RuleService/v1/rules/OrderValidation/Subscription_Purchase","description":"This API is used to retrieve the subscriptions purchase rule details.
\n","urlObject":{"path":["rest","RuleService","v1","rules","OrderValidation","Subscription_Purchase"],"host":["{{Host}}"],"query":[],"variable":[]}},"response":[{"id":"74f6a7fc-0068-45f2-970d-1ed158e88dd5","name":"Get Subscription Purchase Rule","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{Host}}/rest/RuleService/v1/rules/OrderValidation/?{Rule_name}","host":["{{Host}}"],"path":["rest","RuleService","v1","rules","OrderValidation",""],"query":[{"key":"{Rule_name}","value":null,"description":"Enter the rule name which you want to search or fetch information. "}]}},"status":"OK","code":200,"_postman_previewlanguage":"JSON","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Mon, 05 Jun 2023 11:04:26 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"919"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"*, Content-Type, Pragma, Origin, Authorization, party, X-XSRF-TOKEN, X-Requested-With,Access-Control-Allow-Headers,Accept,Access-Control-Allow-Credentials,X-Auth-Token, version, cache"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST,OPTIONS,PUT,DELETE,GET"}],"cookie":[],"responseTime":null,"body":"{\r\n \"ruleInfo\": {\r\n \"ruleName\": \"Subscription_Purchase\",\r\n \"contextName\": \"OrderValidation\",\r\n \"ruleCategory\": 1,\r\n \"ruleSets\": [\r\n {\r\n \"id\": \"1\",\r\n \"ruleSetConditions\": [\r\n {\r\n \"id\": \"1\",\r\n \"property\": \"Orders\",\r\n \"attribute\": \"Billing City\",\r\n \"operator\": \"Equal To\",\r\n \"values\": [\r\n \"NewYork\"\r\n ],\r\n \"dataType\": \"String\",\r\n \"inputFieldType\": 1\r\n },\r\n {\r\n \"id\": \"2\",\r\n \"property\": \"Subscriber\",\r\n \"attribute\": \"Billing Profile Status\",\r\n \"operator\": \"Equal To\",\r\n \"values\": [\r\n \"Suspended\"\r\n ],\r\n \"dataType\": \"String\",\r\n \"inputFieldType\": 2\r\n },\r\n {\r\n \"id\": \"3\",\r\n \"property\": \"Subscription\",\r\n \"attribute\": \"Product - Price Plan\",\r\n \"operator\": \"Equal To\",\r\n \"values\": [\r\n \"2\"\r\n ],\r\n \"displayValues\": {\r\n \"2\": \"VOIP Polycom-VOIP Polycom PP\"\r\n },\r\n \"dataType\": \"String\",\r\n \"inputFieldType\": 3\r\n }\r\n ],\r\n \"ruleSetActions\": [\r\n {\r\n \"id\": \"1\",\r\n \"attribute\": \"Error Message\",\r\n \"operator\": \"Is Set To\",\r\n \"values\": [\r\n \"Error Message\"\r\n ],\r\n \"dataType\": \"String\",\r\n \"inputFieldType\": 1,\r\n \"isMandatoryAction\": true\r\n }\r\n ],\r\n \"isDefaultRuleSet\": false,\r\n \"sequence\": 1\r\n }\r\n ],\r\n \"isDefaultRuleSetDisabled\": false,\r\n \"isRetailRule\": false\r\n },\r\n \"status\": \"OK\"\r\n}"}],"_postman_id":"a01d5d63-10ce-414b-83e2-4fd8ae5e76b6"},{"name":"Delete Subscription Purchase Rule","id":"dbc87dc5-b833-4ef4-9013-8b3320ae30da","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"DELETE","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{Host}}/rest/RuleService/v1/rules/OrderValidation/Subscription_Purchase","description":"This API is used to delete the subscription purchase rule from the application.
\n","urlObject":{"path":["rest","RuleService","v1","rules","OrderValidation","Subscription_Purchase"],"host":["{{Host}}"],"query":[],"variable":[]}},"response":[{"id":"1090cac1-6f5a-4de2-825f-bfd38010ec5f","name":"Delete Subscription Purchase Rule","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"","value":"","type":"text"}],"url":{"raw":"{{Host}}/rest/RuleService/v1/rules/OrderValidation/?{Rule_name}","host":["{{Host}}"],"path":["rest","RuleService","v1","rules","OrderValidation",""],"query":[{"key":"{Rule_name}","value":null,"description":"Provide the name of the rule which you want to delete.\n"}]}},"status":"OK","code":200,"_postman_previewlanguage":"JSON","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Mon, 05 Jun 2023 11:08:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"15"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"*, Content-Type, Pragma, Origin, Authorization, party, X-XSRF-TOKEN, X-Requested-With,Access-Control-Allow-Headers,Accept,Access-Control-Allow-Credentials,X-Auth-Token, version, cache"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST,OPTIONS,PUT,DELETE,GET"}],"cookie":[],"responseTime":null,"body":"{\r\n \"status\":\"OK\"\r\n}"}],"_postman_id":"dbc87dc5-b833-4ef4-9013-8b3320ae30da"}],"id":"affec658-5091-4f5d-9397-d23da6192b6e","description":"This section will discuss about the purchase rule and various operations like creating, updating, retrieving, and deleting the rule.
\n","_postman_id":"affec658-5091-4f5d-9397-d23da6192b6e"},{"name":"Subscription Price Plan Change Rule","item":[{"name":"Subscription Price Plan Change Rule","id":"e70185b5-ee12-4031-9d73-ab74d38119c4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"contextName\": \"ChangePlanValidation\",\r\n \"ruleCategory\": 1,\r\n \"ruleSetActions\": [\r\n {\r\n \"dataType\": \"String\",\r\n \"operators\": [\"Is Set To\"],\r\n \"actionName\": \"Error Message\",\r\n \"inputFieldType\": 1,\r\n \"isMandatoryAction\": true\r\n }\r\n ],\r\n \"ruleSetConditions\": [\r\n {\r\n \"propertyName\": \"Orders\",\r\n \"ruleSetAttributes\": [\r\n {\r\n \"dataType\": \"String\",\r\n \"operators\": [\r\n \"Equal To\",\r\n \"Not Equal To\",\r\n \"Exactly\",\r\n \"Starts With\",\r\n \"Contains\",\r\n \"Equal To (Multi Select)\"\r\n ],\r\n \"attributeName\": \"Billing City\",\r\n \"inputFieldType\": 1\r\n },\r\n {\r\n \"dataType\": \"String\",\r\n \"operators\": [\r\n \"Equal To\",\r\n \"Not Equal To\",\r\n \"Exactly\",\r\n \"Starts With\",\r\n \"Contains\",\r\n \"Equal To (Multi Select)\"\r\n ],\r\n \"attributeName\": \"Billing State\",\r\n \"inputFieldType\": 1\r\n },\r\n {\r\n \"dataType\": \"String\",\r\n \"operators\": [\r\n \"Equal To\",\r\n \"Not Equal To\",\r\n \"Exactly\",\r\n \"Starts With\",\r\n \"Contains\",\r\n \"Equal To (Multi Select)\"\r\n ],\r\n \"attributeName\": \"Billing Country\",\r\n \"inputFieldType\": 2\r\n },\r\n {\r\n \"dataType\": \"String\",\r\n \"operators\": [\r\n \"Equal To\",\r\n \"Not Equal To\",\r\n \"Exactly\",\r\n \"Starts With\",\r\n \"Contains\",\r\n \"Equal To (Multi Select)\"\r\n ],\r\n \"attributeName\": \"Billing ZipCode\",\r\n \"inputFieldType\": 1\r\n },\r\n {\r\n \"dataType\": \"String\",\r\n \"operators\": [\r\n \"Equal To\",\r\n \"Not Equal To\",\r\n \"Exactly\",\r\n \"Starts With\",\r\n \"Contains\",\r\n \"Equal To (Multi Select)\"\r\n ],\r\n \"attributeName\": \"Service/Ship To City\",\r\n \"inputFieldType\": 1\r\n },\r\n {\r\n \"dataType\": \"String\",\r\n \"operators\": [\r\n \"Equal To\",\r\n \"Not Equal To\",\r\n \"Exactly\",\r\n \"Starts With\",\r\n \"Contains\",\r\n \"Equal To (Multi Select)\"\r\n ],\r\n \"attributeName\": \"Service/Ship To State\",\r\n \"inputFieldType\": 1\r\n },\r\n {\r\n \"dataType\": \"String\",\r\n \"operators\": [\r\n \"Equal To\",\r\n \"Not Equal To\",\r\n \"Exactly\",\r\n \"Starts With\",\r\n \"Contains\",\r\n \"Equal To (Multi Select)\"\r\n ],\r\n \"attributeName\": \"Service/Ship To Country\",\r\n \"inputFieldType\": 2\r\n },\r\n {\r\n \"dataType\": \"String\",\r\n \"operators\": [\r\n \"Equal To\",\r\n \"Not Equal To\",\r\n \"Exactly\",\r\n \"Starts With\",\r\n \"Contains\",\r\n \"Equal To (Multi Select)\"\r\n ],\r\n \"attributeName\": \"Service/Ship To ZipCode\",\r\n \"inputFieldType\": 1\r\n }\r\n ]\r\n },\r\n { \"propertyName\": \"Subscriber\" },\r\n {\r\n \"propertyName\": \"Subscription\",\r\n \"ruleSetAttributes\": [\r\n {\r\n \"dataType\": \"BigDecimal\",\r\n \"operators\": [\r\n \"Between\",\r\n \"Equal To\",\r\n \"Not Equal To\",\r\n \"Less Than\",\r\n \"Greater Than\",\r\n \"Less Than Or Equal To\",\r\n \"Greater Than Or Equal To\",\r\n \"Equal To (Multi Select)\"\r\n ],\r\n \"attributeName\": \"Age\",\r\n \"inputFieldType\": 1\r\n },\r\n {\r\n \"dataType\": \"BigDecimal\",\r\n \"operators\": [\r\n \"Between\",\r\n \"Equal To\",\r\n \"Not Equal To\",\r\n \"Less Than\",\r\n \"Greater Than\",\r\n \"Less Than Or Equal To\",\r\n \"Greater Than Or Equal To\",\r\n \"Equal To (Multi Select)\"\r\n ],\r\n \"attributeName\": \"Amount\",\r\n \"inputFieldType\": 1\r\n },\r\n {\r\n \"dataType\": \"String\",\r\n \"operators\": [\r\n \"Equal To\",\r\n \"Not Equal To\",\r\n \"Exactly\",\r\n \"Starts With\",\r\n \"Contains\",\r\n \"Equal To (Multi Select)\"\r\n ],\r\n \"attributeName\": \"New Product - Price Plan\",\r\n \"inputFieldType\": 3\r\n },\r\n {\r\n \"dataType\": \"String\",\r\n \"operators\": [\r\n \"Equal To\",\r\n \"Not Equal To\",\r\n \"Exactly\",\r\n \"Starts With\",\r\n \"Contains\",\r\n \"Equal To (Multi Select)\"\r\n ],\r\n \"attributeName\": \"Old Product - Price Plan\",\r\n \"inputFieldType\": 3\r\n },\r\n {\r\n \"dataType\": \"BigDecimal\",\r\n \"operators\": [\r\n \"Between\",\r\n \"Equal To\",\r\n \"Not Equal To\",\r\n \"Less Than\",\r\n \"Greater Than\",\r\n \"Less Than Or Equal To\",\r\n \"Greater Than Or Equal To\",\r\n \"Equal To (Multi Select)\"\r\n ],\r\n \"attributeName\": \"Quantity( Existing )\",\r\n \"inputFieldType\": 1\r\n },\r\n {\r\n \"dataType\": \"BigDecimal\",\r\n \"operators\": [\r\n \"Between\",\r\n \"Equal To\",\r\n \"Not Equal To\",\r\n \"Less Than\",\r\n \"Greater Than\",\r\n \"Less Than Or Equal To\",\r\n \"Greater Than Or Equal To\",\r\n \"Equal To (Multi Select)\"\r\n ],\r\n \"attributeName\": \"Quantity( New )\",\r\n \"inputFieldType\": 1\r\n },\r\n {\r\n \"dataType\": \"String\",\r\n \"operators\": [\r\n \"Equal To\",\r\n \"Not Equal To\",\r\n \"Exactly\",\r\n \"Starts With\",\r\n \"Contains\",\r\n \"Equal To (Multi Select)\"\r\n ],\r\n \"attributeName\": \"Status\",\r\n \"inputFieldType\": 2\r\n },\r\n {\r\n \"dataType\": \"BigDecimal\",\r\n \"operators\": [\r\n \"Between\",\r\n \"Equal To\",\r\n \"Not Equal To\",\r\n \"Less Than\",\r\n \"Greater Than\",\r\n \"Less Than Or Equal To\",\r\n \"Greater Than Or Equal To\",\r\n \"Equal To (Multi Select)\"\r\n ],\r\n \"attributeName\": \"Total Quantity( New )\",\r\n \"inputFieldType\": 1\r\n }\r\n ]\r\n }\r\n ],\r\n \"defaultRuleSetType\": \"NOT_NEEDED\",\r\n \"validActionValueNumber\": 1\r\n}\r\n"},"url":"{{Host}}/rest/RuleService/v1/rules/ChangePlanValidation","description":"This API is used to create subscription price plan change rule in the application.
\n","urlObject":{"path":["rest","RuleService","v1","rules","ChangePlanValidation"],"host":["{{Host}}"],"query":[],"variable":[]}},"response":[{"id":"3f172a0a-0225-4e79-b6ba-01c078ab6240","name":"Subscription Price Plan Change Rule","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"contextName\": \"ChangePlanValidation\",\r\n \"ruleCategory\": 1,\r\n \"ruleSets\": [\r\n {\r\n \"ruleSetConditions\": [\r\n {\r\n \"property\": \"Orders\",\r\n \"attribute\": \"Billing City\",\r\n \"operator\": \"Equal To\",\r\n \"values\": [\r\n \"NY\"\r\n ]\r\n },\r\n {\r\n \"property\": \"Subscriber\",\r\n \"attribute\": \"Billing Profile Status\",\r\n \"operator\": \"Equal To\",\r\n \"values\": [\r\n \"Active\"\r\n ]\r\n },\r\n {\r\n \"property\": \"Subscription\",\r\n \"attribute\": \"New Product - Price Plan\",\r\n \"operator\": \"Equal To\",\r\n \"values\": [\r\n \"2\"\r\n ]\r\n }\r\n ],\r\n \"ruleSetActions\": [\r\n {\r\n \"attribute\": \"Error Message\",\r\n \"operator\": \"Is Set To\",\r\n \"values\": [\r\n \"Error Message\"\r\n ]\r\n }\r\n ],\r\n \"sequence\": 1\r\n }\r\n ]\r\n}"},"url":"{{Host}}/rest/RuleService/v1/rules/ChangePlanValidation"},"status":"OK","code":200,"_postman_previewlanguage":"JSON","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Mon, 05 Jun 2023 11:21:46 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"59"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"*, Content-Type, Pragma, Origin, Authorization, party, X-XSRF-TOKEN, X-Requested-With,Access-Control-Allow-Headers,Accept,Access-Control-Allow-Credentials,X-Auth-Token, version, cache"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST,OPTIONS,PUT,DELETE,GET"}],"cookie":[],"responseTime":null,"body":"{\r\n \"ruleName\":\"Subscription_Price_Plan_Change\",\r\n \"status\":\"OK\"\r\n}"}],"_postman_id":"e70185b5-ee12-4031-9d73-ab74d38119c4"},{"name":"Update Subscription Price Plan Change Rule","id":"b4ceda6a-e14b-45a4-b9cc-98c1982e56f5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"PUT","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"contextName\": \"ChangePlanValidation\",\r\n \"ruleCategory\": 1,\r\n \"ruleSets\": [\r\n {\r\n \"id\": \"1\",\r\n \"ruleSetConditions\": [\r\n {\r\n \"id\": \"1\",\r\n \"property\": \"Orders\",\r\n \"attribute\": \"Billing City\",\r\n \"operator\": \"Equal To\",\r\n \"values\": [\r\n \"NewYork\"\r\n ]\r\n },\r\n {\r\n \"id\": \"2\",\r\n \"property\": \"Subscriber\",\r\n \"attribute\": \"Billing Profile Status\",\r\n \"operator\": \"Equal To\",\r\n \"values\": [\r\n \"Suspended\"\r\n ]\r\n },\r\n {\r\n \"id\": \"3\",\r\n \"property\": \"Subscription\",\r\n \"attribute\": \"New Product - Price Plan\",\r\n \"operator\": \"Equal To\",\r\n \"values\": [\r\n \"2\"\r\n ]\r\n }\r\n ],\r\n \"ruleSetActions\": [\r\n {\r\n \"id\": \"1\",\r\n \"attribute\": \"Error Message\",\r\n \"operator\": \"Is Set To\",\r\n \"values\": [\r\n \"Error Message\"\r\n ]\r\n }\r\n ],\r\n \"sequence\": 1\r\n }\r\n ]\r\n}"},"url":"{{Host}}/rest/RuleService/v1/rules/ChangePlanValidation/Subscription_Price_Plan_Change","description":"This API is used to modify the existing subscription price plan rule.
\n","urlObject":{"path":["rest","RuleService","v1","rules","ChangePlanValidation","Subscription_Price_Plan_Change"],"host":["{{Host}}"],"query":[],"variable":[]}},"response":[{"id":"274559a7-92d4-469c-b6bb-67516437049d","name":"Update Subscription Purchase Rule","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"contextName\": \"ChangePlanValidation\",\r\n \"ruleCategory\": 1,\r\n \"ruleSets\": [\r\n {\r\n \"id\": \"1\",\r\n \"ruleSetConditions\": [\r\n {\r\n \"id\": \"1\",\r\n \"property\": \"Orders\",\r\n \"attribute\": \"Billing City\",\r\n \"operator\": \"Equal To\",\r\n \"values\": [\r\n \"NewYork\"\r\n ]\r\n },\r\n {\r\n \"id\": \"2\",\r\n \"property\": \"Subscriber\",\r\n \"attribute\": \"Billing Profile Status\",\r\n \"operator\": \"Equal To\",\r\n \"values\": [\r\n \"Suspended\"\r\n ]\r\n },\r\n {\r\n \"id\": \"3\",\r\n \"property\": \"Subscription\",\r\n \"attribute\": \"New Product - Price Plan\",\r\n \"operator\": \"Equal To\",\r\n \"values\": [\r\n \"2\"\r\n ]\r\n }\r\n ],\r\n \"ruleSetActions\": [\r\n {\r\n \"id\": \"1\",\r\n \"attribute\": \"Error Message\",\r\n \"operator\": \"Is Set To\",\r\n \"values\": [\r\n \"Error Message\"\r\n ]\r\n }\r\n ],\r\n \"sequence\": 1\r\n }\r\n ]\r\n}"},"url":"{{Host}}/rest/RuleService/v1/rules/ChangePlanValidation/Subscription_Price_Plan_Change"},"status":"OK","code":200,"_postman_previewlanguage":"JSON","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Mon, 05 Jun 2023 11:34:56 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"59"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"*, Content-Type, Pragma, Origin, Authorization, party, X-XSRF-TOKEN, X-Requested-With,Access-Control-Allow-Headers,Accept,Access-Control-Allow-Credentials,X-Auth-Token, version, cache"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST,OPTIONS,PUT,DELETE,GET"}],"cookie":[],"responseTime":null,"body":"{\r\n \"ruleName\":\"Subscription_Price_Plan_Change\",\r\n \"status\":\"OK\"\r\n}"}],"_postman_id":"b4ceda6a-e14b-45a4-b9cc-98c1982e56f5"},{"name":"Get Subscription Price Plan Change Rule","id":"77bca33c-12ee-498a-891c-0bde5d30d9df","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"}],"url":"{{Host}}/rest/RuleService/v1/rules/ChangePlanValidation/Subscription_Price_Plan_Change","description":"This API is used to retrieve subscription price plan change rule available in the system.
\n","urlObject":{"path":["rest","RuleService","v1","rules","ChangePlanValidation","Subscription_Price_Plan_Change"],"host":["{{Host}}"],"query":[],"variable":[]}},"response":[{"id":"027b186e-9af6-4a0e-a101-9d14aa8a7305","name":"New Request","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"}],"url":"{{Host}}/rest/RuleService/v1/rules/ChangePlanValidation/Subscription_Price_Plan_Change"},"status":"OK","code":200,"_postman_previewlanguage":"JSON","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Mon, 05 Jun 2023 11:37:33 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"937"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"*, Content-Type, Pragma, Origin, Authorization, party, X-XSRF-TOKEN, X-Requested-With,Access-Control-Allow-Headers,Accept,Access-Control-Allow-Credentials,X-Auth-Token, version, cache"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST,OPTIONS,PUT,DELETE,GET"}],"cookie":[],"responseTime":null,"body":"{\r\n \"ruleInfo\": {\r\n \"ruleName\": \"Subscription_Price_Plan_Change\",\r\n \"contextName\": \"ChangePlanValidation\",\r\n \"ruleCategory\": 1,\r\n \"ruleSets\": [\r\n {\r\n \"id\": \"1\",\r\n \"ruleSetConditions\": [\r\n {\r\n \"id\": \"1\",\r\n \"property\": \"Orders\",\r\n \"attribute\": \"Billing City\",\r\n \"operator\": \"Equal To\",\r\n \"values\": [\r\n \"NewYork\"\r\n ],\r\n \"dataType\": \"String\",\r\n \"inputFieldType\": 1\r\n },\r\n {\r\n \"id\": \"2\",\r\n \"property\": \"Subscriber\",\r\n \"attribute\": \"Billing Profile Status\",\r\n \"operator\": \"Equal To\",\r\n \"values\": [\r\n \"Suspended\"\r\n ],\r\n \"dataType\": \"String\",\r\n \"inputFieldType\": 2\r\n },\r\n {\r\n \"id\": \"3\",\r\n \"property\": \"Subscription\",\r\n \"attribute\": \"New Product - Price Plan\",\r\n \"operator\": \"Equal To\",\r\n \"values\": [\r\n \"2\"\r\n ],\r\n \"displayValues\": {\r\n \"2\": \"VOIP Polycom-VOIP Polycom PP\"\r\n },\r\n \"dataType\": \"String\",\r\n \"inputFieldType\": 3\r\n }\r\n ],\r\n \"ruleSetActions\": [\r\n {\r\n \"id\": \"1\",\r\n \"attribute\": \"Error Message\",\r\n \"operator\": \"Is Set To\",\r\n \"values\": [\r\n \"Error Message\"\r\n ],\r\n \"dataType\": \"String\",\r\n \"inputFieldType\": 1,\r\n \"isMandatoryAction\": true\r\n }\r\n ],\r\n \"isDefaultRuleSet\": false,\r\n \"sequence\": 1\r\n }\r\n ],\r\n \"isDefaultRuleSetDisabled\": false,\r\n \"isRetailRule\": false\r\n },\r\n \"status\": \"OK\"\r\n}"}],"_postman_id":"77bca33c-12ee-498a-891c-0bde5d30d9df"},{"name":"Delete Subscription Price Plan Change Rule","id":"16fc583c-2d1f-4b4a-837d-3d8c27e8a938","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"DELETE","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{Host}}/rest/RuleService/v1/rules/ChangePlanValidation/Subscription_Price_Plan_Change","description":"This API is used to delete the subscription price plan change rule in the application.
\n","urlObject":{"path":["rest","RuleService","v1","rules","ChangePlanValidation","Subscription_Price_Plan_Change"],"host":["{{Host}}"],"query":[],"variable":[]}},"response":[{"id":"edad5e51-c8e8-4aea-a34f-bdfa51124136","name":"Delete Subscription Price Plan Change Rule","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{Host}}/rest/RuleService/v1/rules/ChangePlanValidation/Subscription_Price_Plan_Change"},"status":"OK","code":200,"_postman_previewlanguage":"JSON","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Mon, 05 Jun 2023 11:40:58 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"15"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"*, Content-Type, Pragma, Origin, Authorization, party, X-XSRF-TOKEN, X-Requested-With,Access-Control-Allow-Headers,Accept,Access-Control-Allow-Credentials,X-Auth-Token, version, cache"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST,OPTIONS,PUT,DELETE,GET"}],"cookie":[],"responseTime":null,"body":"{\r\n \"status\":\"OK\"\r\n}"}],"_postman_id":"16fc583c-2d1f-4b4a-837d-3d8c27e8a938"}],"id":"3bdd8f2e-aa3d-41fd-b651-daca974f7181","description":"This section will discuss about subscription price plan change rule and various operation such as creating, updating, fetching, and deleting.
\n","_postman_id":"3bdd8f2e-aa3d-41fd-b651-daca974f7181"},{"name":"Subscription Quantity Change Rule","item":[{"name":"Subscription Quantity Change Rule","id":"60c00c21-029f-4f5e-a2e9-90b0c772ec83","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Bearer {{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"ruleInfo\": {\r\n \"contextName\": \"OrderValidation\",\r\n \"ruleSetConditions\": [\r\n {\r\n \"propertyName\": \"Orders\",\r\n \"ruleSetAttributes\": [\r\n {\r\n \"attributeName\": \"Billing City\",\r\n \"operators\": [\r\n \"Equal To\",\r\n \"Not Equal To\",\r\n \"Exactly\",\r\n \"Starts With\",\r\n \"Contains\",\r\n \"Equal To (Multi Select)\"\r\n ],\r\n \"dataType\": \"String\",\r\n \"inputFieldType\": 1\r\n },\r\n {\r\n \"attributeName\": \"Billing Country\",\r\n \"operators\": [\r\n \"Equal To\",\r\n \"Not Equal To\",\r\n \"Exactly\",\r\n \"Starts With\",\r\n \"Contains\",\r\n \"Equal To (Multi Select)\"\r\n ],\r\n \"dataType\": \"String\",\r\n \"inputFieldType\": 2\r\n },\r\n {\r\n \"attributeName\": \"Billing State\",\r\n \"operators\": [\r\n \"Equal To\",\r\n \"Not Equal To\",\r\n \"Exactly\",\r\n \"Starts With\",\r\n \"Contains\",\r\n \"Equal To (Multi Select)\"\r\n ],\r\n \"dataType\": \"String\",\r\n \"inputFieldType\": 1\r\n },\r\n {\r\n \"attributeName\": \"Billing ZipCode\",\r\n \"operators\": [\r\n \"Equal To\",\r\n \"Not Equal To\",\r\n \"Exactly\",\r\n \"Starts With\",\r\n \"Contains\",\r\n \"Equal To (Multi Select)\"\r\n ],\r\n \"dataType\": \"String\",\r\n \"inputFieldType\": 1\r\n }\r\n ]\r\n },\r\n {\r\n \"propertyName\": \"Subscriber\",\r\n \"ruleSetAttributes\": [\r\n {\r\n \"attributeName\": \"Total Due Amount\",\r\n \"operators\": [\r\n \"Between\",\r\n \"Equal To\",\r\n \"Not Equal To\",\r\n \"Less Than\",\r\n \"Greater Than\",\r\n \"Less Than Or Equal To\",\r\n \"Greater Than Or Equal To\",\r\n \"Equal To (Multi Select)\"\r\n ],\r\n \"dataType\": \"BigDecimal\",\r\n \"inputFieldType\": 1\r\n },\r\n {\r\n \"attributeName\": \"Billing Profile Status\",\r\n \"operators\": [\r\n \"Equal To\",\r\n \"Not Equal To\",\r\n \"Exactly\",\r\n \"Starts With\",\r\n \"Contains\",\r\n \"Equal To (Multi Select)\"\r\n ],\r\n \"dataType\": \"String\",\r\n \"inputFieldType\": 2\r\n },\r\n {\r\n \"attributeName\": \"Account Name\",\r\n \"operators\": [\r\n \"Equal To\",\r\n \"Not Equal To\",\r\n \"Exactly\",\r\n \"Starts With\",\r\n \"Contains\",\r\n \"Equal To (Multi Select)\"\r\n ],\r\n \"dataType\": \"String\",\r\n \"inputFieldType\": 1\r\n },\r\n {\r\n \"attributeName\": \"Account Number\",\r\n \"operators\": [\r\n \"Equal To\",\r\n \"Not Equal To\",\r\n \"Exactly\",\r\n \"Starts With\",\r\n \"Contains\",\r\n \"Equal To (Multi Select)\"\r\n ],\r\n \"dataType\": \"String\",\r\n \"inputFieldType\": 1\r\n },\r\n {\r\n \"attributeName\": \"Primary Currency\",\r\n \"operators\": [\r\n \"Equal To\",\r\n \"Not Equal To\",\r\n \"Exactly\",\r\n \"Starts With\",\r\n \"Contains\",\r\n \"Equal To (Multi Select)\"\r\n ],\r\n \"dataType\": \"String\",\r\n \"inputFieldType\": 2\r\n },\r\n {\r\n \"attributeName\": \"Type\",\r\n \"operators\": [\r\n \"Equal To\",\r\n \"Not Equal To\",\r\n \"Exactly\",\r\n \"Starts With\",\r\n \"Contains\",\r\n \"Equal To (Multi Select)\"\r\n ],\r\n \"dataType\": \"String\",\r\n \"inputFieldType\": 1\r\n },\r\n {\r\n \"attributeName\": \"Payment Method\",\r\n \"operators\": [\r\n \"Equal To\",\r\n \"Not Equal To\",\r\n \"Exactly\",\r\n \"Starts With\",\r\n \"Contains\",\r\n \"Equal To (Multi Select)\"\r\n ],\r\n \"dataType\": \"String\",\r\n \"inputFieldType\": 1\r\n },\r\n {\r\n \"attributeName\": \"ACCOUNTING_NAME\",\r\n \"operators\": [\r\n \"Equal To\",\r\n \"Not Equal To\",\r\n \"Exactly\",\r\n \"Starts With\",\r\n \"Contains\",\r\n \"Equal To (Multi Select)\"\r\n ],\r\n \"dataType\": \"String\",\r\n \"inputFieldType\": 1\r\n },\r\n {\r\n \"attributeName\": \"account attr\",\r\n \"operators\": [\r\n \"Equal To\",\r\n \"Not Equal To\",\r\n \"Exactly\",\r\n \"Starts With\",\r\n \"Contains\",\r\n \"Equal To (Multi Select)\"\r\n ],\r\n \"dataType\": \"String\",\r\n \"inputFieldType\": 1\r\n }\r\n ]\r\n },\r\n {\r\n \"propertyName\": \"Subscription\",\r\n \"ruleSetAttributes\": [\r\n {\r\n \"attributeName\": \"Age\",\r\n \"operators\": [\r\n \"Between\",\r\n \"Equal To\",\r\n \"Not Equal To\",\r\n \"Less Than\",\r\n \"Greater Than\",\r\n \"Less Than Or Equal To\",\r\n \"Greater Than Or Equal To\",\r\n \"Equal To (Multi Select)\"\r\n ],\r\n \"dataType\": \"BigDecimal\",\r\n \"inputFieldType\": 1\r\n },\r\n {\r\n \"attributeName\": \"Amount\",\r\n \"operators\": [\r\n \"Between\",\r\n \"Equal To\",\r\n \"Not Equal To\",\r\n \"Less Than\",\r\n \"Greater Than\",\r\n \"Less Than Or Equal To\",\r\n \"Greater Than Or Equal To\",\r\n \"Equal To (Multi Select)\"\r\n ],\r\n \"dataType\": \"BigDecimal\",\r\n \"inputFieldType\": 1\r\n },\r\n {\r\n \"attributeName\": \"Product - Price Plan\",\r\n \"operators\": [\r\n \"Equal To\",\r\n \"Not Equal To\",\r\n \"Exactly\",\r\n \"Starts With\",\r\n \"Contains\",\r\n \"Equal To (Multi Select)\"\r\n ],\r\n \"dataType\": \"String\",\r\n \"inputFieldType\": 3\r\n },\r\n {\r\n \"attributeName\": \"Quantity( Existing )\",\r\n \"operators\": [\r\n \"Between\",\r\n \"Equal To\",\r\n \"Not Equal To\",\r\n \"Less Than\",\r\n \"Greater Than\",\r\n \"Less Than Or Equal To\",\r\n \"Greater Than Or Equal To\",\r\n \"Equal To (Multi Select)\"\r\n ],\r\n \"dataType\": \"BigDecimal\",\r\n \"inputFieldType\": 1\r\n },\r\n {\r\n \"attributeName\": \"Quantity( New )\",\r\n \"operators\": [\r\n \"Between\",\r\n \"Equal To\",\r\n \"Not Equal To\",\r\n \"Less Than\",\r\n \"Greater Than\",\r\n \"Less Than Or Equal To\",\r\n \"Greater Than Or Equal To\",\r\n \"Equal To (Multi Select)\"\r\n ],\r\n \"dataType\": \"BigDecimal\",\r\n \"inputFieldType\": 1\r\n },\r\n {\r\n \"attributeName\": \"Service/Ship To City\",\r\n \"operators\": [\r\n \"Equal To\",\r\n \"Not Equal To\",\r\n \"Exactly\",\r\n \"Starts With\",\r\n \"Contains\",\r\n \"Equal To (Multi Select)\"\r\n ],\r\n \"dataType\": \"String\",\r\n \"inputFieldType\": 1\r\n },\r\n {\r\n \"attributeName\": \"Service/Ship To Country\",\r\n \"operators\": [\r\n \"Equal To\",\r\n \"Not Equal To\",\r\n \"Exactly\",\r\n \"Starts With\",\r\n \"Contains\",\r\n \"Equal To (Multi Select)\"\r\n ],\r\n \"dataType\": \"String\",\r\n \"inputFieldType\": 2\r\n },\r\n {\r\n \"attributeName\": \"Service/Ship To State\",\r\n \"operators\": [\r\n \"Equal To\",\r\n \"Not Equal To\",\r\n \"Exactly\",\r\n \"Starts With\",\r\n \"Contains\",\r\n \"Equal To (Multi Select)\"\r\n ],\r\n \"dataType\": \"String\",\r\n \"inputFieldType\": 1\r\n },\r\n {\r\n \"attributeName\": \"Service/Ship To ZipCode\",\r\n \"operators\": [\r\n \"Equal To\",\r\n \"Not Equal To\",\r\n \"Exactly\",\r\n \"Starts With\",\r\n \"Contains\",\r\n \"Equal To (Multi Select)\"\r\n ],\r\n \"dataType\": \"String\",\r\n \"inputFieldType\": 1\r\n },\r\n {\r\n \"attributeName\": \"Status\",\r\n \"operators\": [\r\n \"Equal To\",\r\n \"Not Equal To\",\r\n \"Exactly\",\r\n \"Starts With\",\r\n \"Contains\",\r\n \"Equal To (Multi Select)\"\r\n ],\r\n \"dataType\": \"String\",\r\n \"inputFieldType\": 2\r\n },\r\n {\r\n \"attributeName\": \"Total Quantity( New )\",\r\n \"operators\": [\r\n \"Between\",\r\n \"Equal To\",\r\n \"Not Equal To\",\r\n \"Less Than\",\r\n \"Greater Than\",\r\n \"Less Than Or Equal To\",\r\n \"Greater Than Or Equal To\",\r\n \"Equal To (Multi Select)\"\r\n ],\r\n \"dataType\": \"BigDecimal\",\r\n \"inputFieldType\": 1\r\n },\r\n {\r\n \"attributeName\": \"address attr\",\r\n \"operators\": [\r\n \"Equal To\",\r\n \"Not Equal To\",\r\n \"Exactly\",\r\n \"Starts With\",\r\n \"Contains\",\r\n \"Equal To (Multi Select)\"\r\n ],\r\n \"dataType\": \"String\",\r\n \"inputFieldType\": 1\r\n }\r\n ]\r\n }\r\n ],\r\n \"ruleSetActions\": [\r\n {\r\n \"actionName\": \"Error Message\",\r\n \"operators\": [\r\n \"Is Set To\"\r\n ],\r\n \"dataType\": \"String\",\r\n \"inputFieldType\": 1,\r\n \"isMandatoryAction\": true\r\n }\r\n ],\r\n \"ruleCategory\": 1,\r\n \"defaultRuleSetType\": 3,\r\n \"validActionValueNumber\": 1\r\n },\r\n \"status\": \"OK\"\r\n}"},"url":"{{Host}}/rest/RuleService/v1/rules/OrderValidation","description":"This API is used to create subscription quantity change rule in the application.
\n","urlObject":{"path":["rest","RuleService","v1","rules","OrderValidation"],"host":["{{Host}}"],"query":[],"variable":[]}},"response":[{"id":"ea5872d7-0072-4dc3-b7cb-699bf4e90b8c","name":"Subscription Quantity Change","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"contextName\": \"OrderValidation\",\r\n \"ruleName\": \"Subscription_Quantity_Change\",\r\n \"ruleCategory\": 1,\r\n \"ruleSets\": [\r\n {\r\n \"ruleSetConditions\": [\r\n {\r\n \"property\": \"Orders\",\r\n \"attribute\": \"Billing City\",\r\n \"operator\": \"Equal To\",\r\n \"values\": [\r\n \"NY\"\r\n ]\r\n },\r\n {\r\n \"property\": \"Subscriber\",\r\n \"attribute\": \"Billing Profile Status\",\r\n \"operator\": \"Equal To\",\r\n \"values\": [\r\n \"Active\"\r\n ]\r\n },\r\n {\r\n \"property\": \"Subscription\",\r\n \"attribute\": \"Product - Price Plan\",\r\n \"operator\": \"Equal To\",\r\n \"values\": [\r\n \"2\"\r\n ]\r\n }\r\n ],\r\n \"ruleSetActions\": [\r\n {\r\n \"attribute\": \"Error Message\",\r\n \"operator\": \"Is Set To\",\r\n \"values\": [\r\n \"Error Message\"\r\n ]\r\n }\r\n ],\r\n \"sequence\": 1\r\n }\r\n ]\r\n}"},"url":"{{Host}}/rest/RuleService/v1/rules/OrderValidation"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 07 Jun 2023 12:33:30 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"57"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"*, Content-Type, Pragma, Origin, Authorization, party, X-XSRF-TOKEN, X-Requested-With,Access-Control-Allow-Headers,Accept,Access-Control-Allow-Credentials,X-Auth-Token, version, cache"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST,OPTIONS,PUT,DELETE,GET"}],"cookie":[],"responseTime":null,"body":"{\n \"ruleName\": \"Subscription_Quantity_Change\",\n \"status\": \"OK\"\n}"}],"_postman_id":"60c00c21-029f-4f5e-a2e9-90b0c772ec83"},{"name":"Update Subscription Quantity Change Rule","id":"73e50fce-5f68-4e39-bbf4-f0e1f5bc0736","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"PUT","header":[{"key":"Authorization","value":"Bearer{{Token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"ruleName\": \"Subscription_Quantity_Change\",\r\n \"contextName\": \"OrderValidation\",\r\n \"ruleCategory\": 1,\r\n \"ruleSets\": [\r\n {\r\n \"id\": \"1\",\r\n \"ruleSetConditions\": [\r\n {\r\n \"id\": \"1\",\r\n \"property\": \"Orders\",\r\n \"attribute\": \"Billing City\",\r\n \"operator\": \"Equal To\",\r\n \"values\": [\r\n \"LA\"\r\n ],\r\n \"dataType\": \"String\",\r\n \"inputFieldType\": 1\r\n },\r\n {\r\n \"id\": \"2\",\r\n \"property\": \"Subscriber\",\r\n \"attribute\": \"Billing Profile Status\",\r\n \"operator\": \"Equal To\",\r\n \"values\": [\r\n \"Suspended\"\r\n ],\r\n \"dataType\": \"String\",\r\n \"inputFieldType\": 2\r\n },\r\n {\r\n \"id\": \"3\",\r\n \"property\": \"Subscription\",\r\n \"attribute\": \"Product - Price Plan\",\r\n \"operator\": \"Equal To\",\r\n \"values\": [\r\n \"2\"\r\n ],\r\n \"displayValues\": {\r\n \"2\": \"VOIP Polycom-VOIP Polycom PP\"\r\n },\r\n \"dataType\": \"String\",\r\n \"inputFieldType\": 3\r\n }\r\n ],\r\n \"ruleSetActions\": [\r\n {\r\n \"id\": \"1\",\r\n \"attribute\": \"Error Message\",\r\n \"operator\": \"Is Set To\",\r\n \"values\": [\r\n \"Error Message\"\r\n ],\r\n \"dataType\": \"String\",\r\n \"inputFieldType\": 1,\r\n \"isMandatoryAction\": true\r\n }\r\n ],\r\n \"isDefaultRuleSet\": false,\r\n \"sequence\": 1\r\n }\r\n ],\r\n \"isDefaultRuleSetDisabled\": false,\r\n \"isRetailRule\": false\r\n}"},"url":"{{Host}}/rest/RuleService/v1/rules/OrderValidation/Subscription_Quantity_Change","description":"This API is used to modify the existing subscription quantity change rule in the application.
\n","urlObject":{"path":["rest","RuleService","v1","rules","OrderValidation","Subscription_Quantity_Change"],"host":["{{Host}}"],"query":[],"variable":[]}},"response":[{"id":"3990d715-7c2c-4ef6-8e5d-438cf98c182a","name":"Update Subscription Quantity Change","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer{{Token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"ruleName\": \"Subscription_Quantity_Change\",\r\n \"contextName\": \"OrderValidation\",\r\n \"ruleCategory\": 1,\r\n \"ruleSets\": [\r\n {\r\n \"id\": \"1\",\r\n \"ruleSetConditions\": [\r\n {\r\n \"id\": \"1\",\r\n \"property\": \"Orders\",\r\n \"attribute\": \"Billing City\",\r\n \"operator\": \"Equal To\",\r\n \"values\": [\r\n \"LA\"\r\n ],\r\n \"dataType\": \"String\",\r\n \"inputFieldType\": 1\r\n },\r\n {\r\n \"id\": \"2\",\r\n \"property\": \"Subscriber\",\r\n \"attribute\": \"Billing Profile Status\",\r\n \"operator\": \"Equal To\",\r\n \"values\": [\r\n \"Suspended\"\r\n ],\r\n \"dataType\": \"String\",\r\n \"inputFieldType\": 2\r\n },\r\n {\r\n \"id\": \"3\",\r\n \"property\": \"Subscription\",\r\n \"attribute\": \"Product - Price Plan\",\r\n \"operator\": \"Equal To\",\r\n \"values\": [\r\n \"2\"\r\n ],\r\n \"displayValues\": {\r\n \"2\": \"VOIP Polycom-VOIP Polycom PP\"\r\n },\r\n \"dataType\": \"String\",\r\n \"inputFieldType\": 3\r\n }\r\n ],\r\n \"ruleSetActions\": [\r\n {\r\n \"id\": \"1\",\r\n \"attribute\": \"Error Message\",\r\n \"operator\": \"Is Set To\",\r\n \"values\": [\r\n \"Error Message\"\r\n ],\r\n \"dataType\": \"String\",\r\n \"inputFieldType\": 1,\r\n \"isMandatoryAction\": true\r\n }\r\n ],\r\n \"isDefaultRuleSet\": false,\r\n \"sequence\": 1\r\n }\r\n ],\r\n \"isDefaultRuleSetDisabled\": false,\r\n \"isRetailRule\": false\r\n}"},"url":"{{Host}}/rest/RuleService/v1/rules/OrderValidation/Subscription_Quantity_Change"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 07 Jun 2023 12:51:30 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"57"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"*, Content-Type, Pragma, Origin, Authorization, party, X-XSRF-TOKEN, X-Requested-With,Access-Control-Allow-Headers,Accept,Access-Control-Allow-Credentials,X-Auth-Token, version, cache"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST,OPTIONS,PUT,DELETE,GET"}],"cookie":[],"responseTime":null,"body":"{\n \"ruleName\": \"Subscription_Quantity_Change\",\n \"status\": \"OK\"\n}\n"}],"_postman_id":"73e50fce-5f68-4e39-bbf4-f0e1f5bc0736"},{"name":"Get Subscription Quantity Change Rule","id":"3509c88d-df2d-47af-906d-7de69e905152","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Bearer{{Token}}","type":"text"}],"url":"{{Host}}/rest/RuleService/v1/rules/OrderValidation/Subscription_Quantity_Change","description":"This API is used to retrieve subscription quantity change rule from the application.
\n","urlObject":{"path":["rest","RuleService","v1","rules","OrderValidation","Subscription_Quantity_Change"],"host":["{{Host}}"],"query":[],"variable":[]}},"response":[{"id":"35028021-3b36-4dc3-8d42-a5ade08591e6","name":"Get Subscription Quantity Change","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer{{Token}}","type":"text"}],"url":"{{Host}}/rest/RuleService/v1/rules/OrderValidation/Subscription_Quantity_Change"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 07 Jun 2023 12:45:49 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"918"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"*, Content-Type, Pragma, Origin, Authorization, party, X-XSRF-TOKEN, X-Requested-With,Access-Control-Allow-Headers,Accept,Access-Control-Allow-Credentials,X-Auth-Token, version, cache"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST,OPTIONS,PUT,DELETE,GET"}],"cookie":[],"responseTime":null,"body":"{\n \"ruleInfo\": {\n \"ruleName\": \"Subscription_Quantity_Change\",\n \"contextName\": \"OrderValidation\",\n \"ruleCategory\": 1,\n \"ruleSets\": [\n {\n \"id\": \"1\",\n \"ruleSetConditions\": [\n {\n \"id\": \"1\",\n \"property\": \"Orders\",\n \"attribute\": \"Billing City\",\n \"operator\": \"Equal To\",\n \"values\": [\n \"NY\"\n ],\n \"dataType\": \"String\",\n \"inputFieldType\": 1\n },\n {\n \"id\": \"2\",\n \"property\": \"Subscriber\",\n \"attribute\": \"Billing Profile Status\",\n \"operator\": \"Equal To\",\n \"values\": [\n \"Active\"\n ],\n \"dataType\": \"String\",\n \"inputFieldType\": 2\n },\n {\n \"id\": \"3\",\n \"property\": \"Subscription\",\n \"attribute\": \"Product - Price Plan\",\n \"operator\": \"Equal To\",\n \"values\": [\n \"2\"\n ],\n \"displayValues\": {\n \"2\": \"VOIP Polycom-VOIP Polycom PP\"\n },\n \"dataType\": \"String\",\n \"inputFieldType\": 3\n }\n ],\n \"ruleSetActions\": [\n {\n \"id\": \"1\",\n \"attribute\": \"Error Message\",\n \"operator\": \"Is Set To\",\n \"values\": [\n \"Error Message\"\n ],\n \"dataType\": \"String\",\n \"inputFieldType\": 1,\n \"isMandatoryAction\": true\n }\n ],\n \"isDefaultRuleSet\": false,\n \"sequence\": 1\n }\n ],\n \"isDefaultRuleSetDisabled\": false,\n \"isRetailRule\": false\n },\n \"status\": \"OK\"\n}"}],"_postman_id":"3509c88d-df2d-47af-906d-7de69e905152"},{"name":"Delete Subscription Quantity Change Rule","id":"70a7d404-1ef0-4076-a475-481e7f05e854","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"DELETE","header":[{"key":"Authorization","value":"Bearer{{Token}}","type":"text"}],"url":"{{Host}}/rest/RuleService/v1/rules/OrderValidation/Subscription_Quantity_Change","description":"This API is used to delete subscription Quantity Change Rule from the application.
\n","urlObject":{"path":["rest","RuleService","v1","rules","OrderValidation","Subscription_Quantity_Change"],"host":["{{Host}}"],"query":[],"variable":[]}},"response":[{"id":"df85dcf9-a455-4bdd-aa9f-ccad05975fef","name":"Delete Subscription Quantity Change","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer{{Token}}","type":"text"}],"url":"{{Host}}/rest/RuleService/v1/rules/OrderValidation/Subscription_Quantity_Change"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 07 Jun 2023 12:59:54 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"15"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"*, Content-Type, Pragma, Origin, Authorization, party, X-XSRF-TOKEN, X-Requested-With,Access-Control-Allow-Headers,Accept,Access-Control-Allow-Credentials,X-Auth-Token, version, cache"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST,OPTIONS,PUT,DELETE,GET"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"OK\"\n}"}],"_postman_id":"70a7d404-1ef0-4076-a475-481e7f05e854"}],"id":"06ad6e06-e5e0-4e3e-adae-eb5f2a571728","description":"This section will discuss subscription quantity change rule. Using example we will see how create, update, get, and delete the rule.
\n","_postman_id":"06ad6e06-e5e0-4e3e-adae-eb5f2a571728"},{"name":"Subscription Cancellation Rule","item":[{"name":"Subscription Cancellation Rule","id":"38d16ad2-e6c2-44ef-b66f-eb6af2158fe1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Bearer {{Token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"contextName\": \"OrderValidation\",\r\n \"ruleName\": \"Subscription_Cancellation\",\r\n \"ruleCategory\": 1,\r\n \"ruleSets\": [\r\n {\r\n \"ruleSetConditions\": [\r\n {\r\n \"property\": \"Orders\",\r\n \"attribute\": \"Billing City\",\r\n \"operator\": \"Equal To\",\r\n \"values\": [\r\n \"NY\"\r\n ]\r\n },\r\n {\r\n \"property\": \"Subscriber\",\r\n \"attribute\": \"Billing Profile Status\",\r\n \"operator\": \"Equal To\",\r\n \"values\": [\r\n \"Active\"\r\n ]\r\n },\r\n {\r\n \"property\": \"Subscription\",\r\n \"attribute\": \"Product - Price Plan\",\r\n \"operator\": \"Equal To\",\r\n \"values\": [\r\n \"2\"\r\n ]\r\n }\r\n ],\r\n \"ruleSetActions\": [\r\n {\r\n \"attribute\": \"Error Message\",\r\n \"operator\": \"Is Set To\",\r\n \"values\": [\r\n \"Error Message\"\r\n ]\r\n }\r\n ],\r\n \"sequence\": 1\r\n }\r\n ]\r\n}"},"url":"{{Host}}/rest/RuleService/v1/rules/OrderValidation","description":"This API is used to create subscription cancellation rule on the applicaton. Refer the example.
\n","urlObject":{"path":["rest","RuleService","v1","rules","OrderValidation"],"host":["{{Host}}"],"query":[],"variable":[]}},"response":[{"id":"a2ea918d-01d2-4663-ac95-cf637e5b8692","name":"Subscription Cancellation","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{Token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"contextName\": \"OrderValidation\",\r\n \"ruleName\": \"Subscription_Cancellation\",\r\n \"ruleCategory\": 1,\r\n \"ruleSets\": [\r\n {\r\n \"ruleSetConditions\": [\r\n {\r\n \"property\": \"Orders\",\r\n \"attribute\": \"Billing City\",\r\n \"operator\": \"Equal To\",\r\n \"values\": [\r\n \"NY\"\r\n ]\r\n },\r\n {\r\n \"property\": \"Subscriber\",\r\n \"attribute\": \"Billing Profile Status\",\r\n \"operator\": \"Equal To\",\r\n \"values\": [\r\n \"Active\"\r\n ]\r\n },\r\n {\r\n \"property\": \"Subscription\",\r\n \"attribute\": \"Product - Price Plan\",\r\n \"operator\": \"Equal To\",\r\n \"values\": [\r\n \"2\"\r\n ]\r\n }\r\n ],\r\n \"ruleSetActions\": [\r\n {\r\n \"attribute\": \"Error Message\",\r\n \"operator\": \"Is Set To\",\r\n \"values\": [\r\n \"Error Message\"\r\n ]\r\n }\r\n ],\r\n \"sequence\": 1\r\n }\r\n ]\r\n}"},"url":"{{Host}}/rest/RuleService/v1/rules/OrderValidation"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 07 Jun 2023 13:11:15 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"54"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"*, Content-Type, Pragma, Origin, Authorization, party, X-XSRF-TOKEN, X-Requested-With,Access-Control-Allow-Headers,Accept,Access-Control-Allow-Credentials,X-Auth-Token, version, cache"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST,OPTIONS,PUT,DELETE,GET"}],"cookie":[],"responseTime":null,"body":"{\n \"ruleName\": \"Subscription_Cancellation\",\n \"status\": \"OK\"\n}"}],"_postman_id":"38d16ad2-e6c2-44ef-b66f-eb6af2158fe1"},{"name":"Update Subscription Cancellation Rule","id":"e579fff8-30e8-4277-ad9f-abf0cac75ef9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"PUT","header":[{"key":"Authorization","value":"Bearer{{Token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"contextName\": \"OrderValidation\",\r\n \"ruleName\": \"Subscription_Cancellation\",\r\n \"ruleCategory\": 1,\r\n \"ruleSets\": [\r\n {\r\n \"id\": \"1\",\r\n \"ruleSetConditions\": [\r\n {\r\n \"id\": \"1\",\r\n \"property\": \"Orders\",\r\n \"attribute\": \"Billing City\",\r\n \"operator\": \"Equal To\",\r\n \"values\": [\r\n \"NewYork\"\r\n ]\r\n },\r\n {\r\n \"id\": \"2\",\r\n \"property\": \"Subscriber\",\r\n \"attribute\": \"Billing Profile Status\",\r\n \"operator\": \"Equal To\",\r\n \"values\": [\r\n \"Suspended\"\r\n ]\r\n },\r\n {\r\n \"id\": \"3\",\r\n \"property\": \"Subscription\",\r\n \"attribute\": \"Product - Price Plan\",\r\n \"operator\": \"Equal To\",\r\n \"values\": [\r\n \"2\"\r\n ]\r\n }\r\n ],\r\n \"ruleSetActions\": [\r\n {\r\n \"id\": \"1\",\r\n \"attribute\": \"Error Message\",\r\n \"operator\": \"Is Set To\",\r\n \"values\": [\r\n \"Error Message\"\r\n ]\r\n }\r\n ],\r\n \"sequence\": 1\r\n }\r\n ]\r\n}"},"url":"{{Host}}/rest/RuleService/v1/rules/OrderValidation/Subscription_Cancellation","description":"This API is used to modify the existing subscription cancellation rule in the application.
\n","urlObject":{"path":["rest","RuleService","v1","rules","OrderValidation","Subscription_Cancellation"],"host":["{{Host}}"],"query":[],"variable":[]}},"response":[{"id":"42a27929-c163-468c-a80b-3ae1bcb9a003","name":"Update Subscription Cancellation","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer{{Token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"contextName\": \"OrderValidation\",\r\n \"ruleName\": \"Subscription_Cancellation\",\r\n \"ruleCategory\": 1,\r\n \"ruleSets\": [\r\n {\r\n \"id\": \"1\",\r\n \"ruleSetConditions\": [\r\n {\r\n \"id\": \"1\",\r\n \"property\": \"Orders\",\r\n \"attribute\": \"Billing City\",\r\n \"operator\": \"Equal To\",\r\n \"values\": [\r\n \"NewYork\"\r\n ]\r\n },\r\n {\r\n \"id\": \"2\",\r\n \"property\": \"Subscriber\",\r\n \"attribute\": \"Billing Profile Status\",\r\n \"operator\": \"Equal To\",\r\n \"values\": [\r\n \"Suspended\"\r\n ]\r\n },\r\n {\r\n \"id\": \"3\",\r\n \"property\": \"Subscription\",\r\n \"attribute\": \"Product - Price Plan\",\r\n \"operator\": \"Equal To\",\r\n \"values\": [\r\n \"2\"\r\n ]\r\n }\r\n ],\r\n \"ruleSetActions\": [\r\n {\r\n \"id\": \"1\",\r\n \"attribute\": \"Error Message\",\r\n \"operator\": \"Is Set To\",\r\n \"values\": [\r\n \"Error Message\"\r\n ]\r\n }\r\n ],\r\n \"sequence\": 1\r\n }\r\n ]\r\n}"},"url":"{{Host}}/rest/RuleService/v1/rules/OrderValidation/Subscription_Cancellation"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 07 Jun 2023 13:13:32 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"54"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"*, Content-Type, Pragma, Origin, Authorization, party, X-XSRF-TOKEN, X-Requested-With,Access-Control-Allow-Headers,Accept,Access-Control-Allow-Credentials,X-Auth-Token, version, cache"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST,OPTIONS,PUT,DELETE,GET"}],"cookie":[],"responseTime":null,"body":"{\n \"ruleName\": \"Subscription_Cancellation\",\n \"status\": \"OK\"\n}"}],"_postman_id":"e579fff8-30e8-4277-ad9f-abf0cac75ef9"},{"name":"Get Subscription Cancellation Rule","id":"8160264b-0a3a-4983-8784-1e5a30423b5b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Bearer {{Token}}","type":"text"}],"url":"{{Host}}/rest/RuleService/v1/rules/OrderValidation/Subscription_Cancellation","description":"This API is used to retrieve subscription cancellation rule in the application.
\n","urlObject":{"path":["rest","RuleService","v1","rules","OrderValidation","Subscription_Cancellation"],"host":["{{Host}}"],"query":[],"variable":[]}},"response":[{"id":"1781a933-a129-4afa-8a55-61422fc872a0","name":"Get Subscription Cancellation Rule","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{Token}}","type":"text"}],"url":"{{Host}}/rest/RuleService/v1/rules/OrderValidation/Subscription_Cancellation"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 07 Jun 2023 13:14:42 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"923"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"*, Content-Type, Pragma, Origin, Authorization, party, X-XSRF-TOKEN, X-Requested-With,Access-Control-Allow-Headers,Accept,Access-Control-Allow-Credentials,X-Auth-Token, version, cache"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST,OPTIONS,PUT,DELETE,GET"}],"cookie":[],"responseTime":null,"body":"{\n \"ruleInfo\": {\n \"ruleName\": \"Subscription_Cancellation\",\n \"contextName\": \"OrderValidation\",\n \"ruleCategory\": 1,\n \"ruleSets\": [\n {\n \"id\": \"1\",\n \"ruleSetConditions\": [\n {\n \"id\": \"1\",\n \"property\": \"Orders\",\n \"attribute\": \"Billing City\",\n \"operator\": \"Equal To\",\n \"values\": [\n \"NewYork\"\n ],\n \"dataType\": \"String\",\n \"inputFieldType\": 1\n },\n {\n \"id\": \"2\",\n \"property\": \"Subscriber\",\n \"attribute\": \"Billing Profile Status\",\n \"operator\": \"Equal To\",\n \"values\": [\n \"Suspended\"\n ],\n \"dataType\": \"String\",\n \"inputFieldType\": 2\n },\n {\n \"id\": \"3\",\n \"property\": \"Subscription\",\n \"attribute\": \"Product - Price Plan\",\n \"operator\": \"Equal To\",\n \"values\": [\n \"2\"\n ],\n \"displayValues\": {\n \"2\": \"VOIP Polycom-VOIP Polycom PP\"\n },\n \"dataType\": \"String\",\n \"inputFieldType\": 3\n }\n ],\n \"ruleSetActions\": [\n {\n \"id\": \"1\",\n \"attribute\": \"Error Message\",\n \"operator\": \"Is Set To\",\n \"values\": [\n \"Error Message\"\n ],\n \"dataType\": \"String\",\n \"inputFieldType\": 1,\n \"isMandatoryAction\": true\n }\n ],\n \"isDefaultRuleSet\": false,\n \"sequence\": 1\n }\n ],\n \"isDefaultRuleSetDisabled\": false,\n \"isRetailRule\": false\n },\n \"status\": \"OK\"\n}"}],"_postman_id":"8160264b-0a3a-4983-8784-1e5a30423b5b"},{"name":"Delete Subscription Cancellation Rule","id":"072314ef-a5b6-4af5-bfea-ffabff764efe","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"DELETE","header":[{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"url":"{{Host}}/rest/RuleService/v1/rules/OrderValidation/Subscription_Cancellation","description":"This API is used to delete subscription cancellation rule in the application.
\n","urlObject":{"path":["rest","RuleService","v1","rules","OrderValidation","Subscription_Cancellation"],"host":["{{Host}}"],"query":[],"variable":[]}},"response":[{"id":"03771c4f-885c-4dc2-ae28-650b692ea94b","name":"Delete Subscription Cancellation Rule","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"url":"{{Host}}/rest/RuleService/v1/rules/OrderValidation/Subscription_Cancellation"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 07 Jun 2023 13:20:29 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"15"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"*, Content-Type, Pragma, Origin, Authorization, party, X-XSRF-TOKEN, X-Requested-With,Access-Control-Allow-Headers,Accept,Access-Control-Allow-Credentials,X-Auth-Token, version, cache"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST,OPTIONS,PUT,DELETE,GET"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"OK\"\n}"}],"_postman_id":"072314ef-a5b6-4af5-bfea-ffabff764efe"}],"id":"beeb0a3d-d039-4e66-870c-e9581509e427","description":"This API is used to subscription cancellation rule inn the application. Refer the following example for creating, updating, fetching and deleting the rule.
\n","_postman_id":"beeb0a3d-d039-4e66-870c-e9581509e427"},{"name":"Suspend Subscription Rule","item":[{"name":"Suspend Subscription Rule","id":"9249a771-4188-40d8-a907-0007ecc3d13e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"contextName\": \"OrderValidation\",\r\n \"ruleName\": \"Suspend_Subscription\",\r\n \"ruleCategory\": 1,\r\n \"ruleSets\": [\r\n {\r\n \"ruleSetConditions\": [\r\n {\r\n \"property\": \"Orders\",\r\n \"attribute\": \"Billing City\",\r\n \"operator\": \"Equal To\",\r\n \"values\": [\r\n \"NY\"\r\n ]\r\n },\r\n {\r\n \"property\": \"Subscriber\",\r\n \"attribute\": \"Billing Profile Status\",\r\n \"operator\": \"Equal To\",\r\n \"values\": [\r\n \"Active\"\r\n ]\r\n },\r\n {\r\n \"property\": \"Subscription\",\r\n \"attribute\": \"Product - Price Plan\",\r\n \"operator\": \"Equal To\",\r\n \"values\": [\r\n \"2\"\r\n ]\r\n }\r\n ],\r\n \"ruleSetActions\": [\r\n {\r\n \"attribute\": \"Error Message\",\r\n \"operator\": \"Is Set To\",\r\n \"values\": [\r\n \"Error Message\"\r\n ]\r\n }\r\n ],\r\n \"sequence\": 1\r\n }\r\n ]\r\n}"},"url":"{{Host}}/rest/RuleService/v1/rules/OrderValidation","description":"This API is used to create a Rule for suspend subscription rule, it will drive a criteria based suspending subscription.
\n","urlObject":{"path":["rest","RuleService","v1","rules","OrderValidation"],"host":["{{Host}}"],"query":[],"variable":[]}},"response":[{"id":"ecf26cb9-a304-45f5-9ddd-042a04c5c978","name":"Create Suspend Subscription Rule","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"contextName\": \"OrderValidation\",\r\n \"ruleName\": \"Suspend_Subscription\",\r\n \"ruleCategory\": 1,\r\n \"ruleSets\": [\r\n {\r\n \"ruleSetConditions\": [\r\n {\r\n \"property\": \"Orders\",\r\n \"attribute\": \"Billing City\",\r\n \"operator\": \"Equal To\",\r\n \"values\": [\r\n \"NY\"\r\n ]\r\n },\r\n {\r\n \"property\": \"Subscriber\",\r\n \"attribute\": \"Billing Profile Status\",\r\n \"operator\": \"Equal To\",\r\n \"values\": [\r\n \"Active\"\r\n ]\r\n },\r\n {\r\n \"property\": \"Subscription\",\r\n \"attribute\": \"Product - Price Plan\",\r\n \"operator\": \"Equal To\",\r\n \"values\": [\r\n \"2\"\r\n ]\r\n }\r\n ],\r\n \"ruleSetActions\": [\r\n {\r\n \"attribute\": \"Error Message\",\r\n \"operator\": \"Is Set To\",\r\n \"values\": [\r\n \"Error Message\"\r\n ]\r\n }\r\n ],\r\n \"sequence\": 1\r\n }\r\n ]\r\n}"},"url":"{{Host}}/rest/RuleService/v1/rules/OrderValidation"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 20 Sep 2023 07:52:17 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"49"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"*, Content-Type, Pragma, Origin, Authorization, party, X-XSRF-TOKEN, X-Requested-With,Access-Control-Allow-Headers,Accept,Access-Control-Allow-Credentials,X-Auth-Token, version, cache"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST,OPTIONS,PUT,DELETE,GET"}],"cookie":[],"responseTime":null,"body":"{\n \"ruleName\": \"Suspend_Subscription\",\n \"status\": \"OK\"\n}"}],"_postman_id":"9249a771-4188-40d8-a907-0007ecc3d13e"},{"name":"Update the Suspend Subscription Rule","id":"03960f13-528b-45d4-b4b3-5958456a42ff","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"PUT","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"contextName\": \"OrderValidation\",\r\n \"ruleName\": \"Suspend_Subscription\",\r\n \"ruleCategory\": 1,\r\n \"ruleSets\": [\r\n {\r\n \"id\": \"1\",\r\n \"ruleSetConditions\": [\r\n {\r\n \"id\": \"1\",\r\n \"property\": \"Orders\",\r\n \"attribute\": \"Billing City\",\r\n \"operator\": \"Equal To\",\r\n \"values\": [\r\n \"NewYork\"\r\n ]\r\n },\r\n {\r\n \"id\": \"2\",\r\n \"property\": \"Subscriber\",\r\n \"attribute\": \"Billing Profile Status\",\r\n \"operator\": \"Equal To\",\r\n \"values\": [\r\n \"Suspended\"\r\n ]\r\n },\r\n {\r\n \"id\": \"3\",\r\n \"property\": \"Subscription\",\r\n \"attribute\": \"Product - Price Plan\",\r\n \"operator\": \"Equal To\",\r\n \"values\": [\r\n \"2\"\r\n ]\r\n }\r\n ],\r\n \"ruleSetActions\": [\r\n {\r\n \"id\": \"1\",\r\n \"attribute\": \"Error Message\",\r\n \"operator\": \"Is Set To\",\r\n \"values\": [\r\n \"Error Message\"\r\n ]\r\n }\r\n ],\r\n \"sequence\": 1\r\n }\r\n ]\r\n}"},"url":"{{Host}}/rest/RuleService/v1/rules/OrderValidation/Suspend_Subscription","description":"This API is used to update the Suspend subscription rule available in the system. Using the request provided example you can update the rule.
\n","urlObject":{"path":["rest","RuleService","v1","rules","OrderValidation","Suspend_Subscription"],"host":["{{Host}}"],"query":[],"variable":[]}},"response":[{"id":"23696d76-973b-4198-a94b-f8799df44af3","name":"Update the Suspend Subscription","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"contextName\": \"OrderValidation\",\r\n \"ruleName\": \"Suspend_Subscription\",\r\n \"ruleCategory\": 1,\r\n \"ruleSets\": [\r\n {\r\n \"id\": \"1\",\r\n \"ruleSetConditions\": [\r\n {\r\n \"id\": \"1\",\r\n \"property\": \"Orders\",\r\n \"attribute\": \"Billing City\",\r\n \"operator\": \"Equal To\",\r\n \"values\": [\r\n \"NewYork\"\r\n ]\r\n },\r\n {\r\n \"id\": \"2\",\r\n \"property\": \"Subscriber\",\r\n \"attribute\": \"Billing Profile Status\",\r\n \"operator\": \"Equal To\",\r\n \"values\": [\r\n \"Suspended\"\r\n ]\r\n },\r\n {\r\n \"id\": \"3\",\r\n \"property\": \"Subscription\",\r\n \"attribute\": \"Product - Price Plan\",\r\n \"operator\": \"Equal To\",\r\n \"values\": [\r\n \"2\"\r\n ]\r\n }\r\n ],\r\n \"ruleSetActions\": [\r\n {\r\n \"id\": \"1\",\r\n \"attribute\": \"Error Message\",\r\n \"operator\": \"Is Set To\",\r\n \"values\": [\r\n \"Error Message\"\r\n ]\r\n }\r\n ],\r\n \"sequence\": 1\r\n }\r\n ]\r\n}"},"url":"{{Host}}/rest/RuleService/v1/rules/OrderValidation/Suspend_Subscription"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 20 Sep 2023 07:58:26 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"49"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"*, Content-Type, Pragma, Origin, Authorization, party, X-XSRF-TOKEN, X-Requested-With,Access-Control-Allow-Headers,Accept,Access-Control-Allow-Credentials,X-Auth-Token, version, cache"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST,OPTIONS,PUT,DELETE,GET"}],"cookie":[],"responseTime":null,"body":"{\n \"ruleName\": \"Suspend_Subscription\",\n \"status\": \"OK\"\n}"}],"_postman_id":"03960f13-528b-45d4-b4b3-5958456a42ff"},{"name":"Get Suspend subscription Rule","id":"187dafdf-41ca-47c4-b65d-c1aaa2299eab","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"}],"url":"{{Host}}/rest/RuleService/v1/rules/OrderValidation/{Rule_name}","description":"This API is used to fetch the suspend subscription rule available in the application.
\n","urlObject":{"path":["rest","RuleService","v1","rules","OrderValidation","{Rule_name}"],"host":["{{Host}}"],"query":[],"variable":[]}},"response":[{"id":"4c7fda35-c616-4612-a211-e5b1e6eaa8be","name":"Get Suspend Subscription Rule","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"}],"url":"{{Host}}/rest/RuleService/v1/rules/OrderValidation/{Rule_name}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 20 Sep 2023 08:01:42 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"918"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"*, Content-Type, Pragma, Origin, Authorization, party, X-XSRF-TOKEN, X-Requested-With,Access-Control-Allow-Headers,Accept,Access-Control-Allow-Credentials,X-Auth-Token, version, cache"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST,OPTIONS,PUT,DELETE,GET"}],"cookie":[],"responseTime":null,"body":"{\n \"ruleInfo\": {\n \"ruleName\": \"Suspend_Subscription\",\n \"contextName\": \"OrderValidation\",\n \"ruleCategory\": 1,\n \"ruleSets\": [\n {\n \"id\": \"1\",\n \"ruleSetConditions\": [\n {\n \"id\": \"1\",\n \"property\": \"Orders\",\n \"attribute\": \"Billing City\",\n \"operator\": \"Equal To\",\n \"values\": [\n \"NewYork\"\n ],\n \"dataType\": \"String\",\n \"inputFieldType\": 1\n },\n {\n \"id\": \"2\",\n \"property\": \"Subscriber\",\n \"attribute\": \"Billing Profile Status\",\n \"operator\": \"Equal To\",\n \"values\": [\n \"Suspended\"\n ],\n \"dataType\": \"String\",\n \"inputFieldType\": 2\n },\n {\n \"id\": \"3\",\n \"property\": \"Subscription\",\n \"attribute\": \"Product - Price Plan\",\n \"operator\": \"Equal To\",\n \"values\": [\n \"2\"\n ],\n \"displayValues\": {\n \"2\": \"VOIP Polycom-VOIP Polycom PP\"\n },\n \"dataType\": \"String\",\n \"inputFieldType\": 3\n }\n ],\n \"ruleSetActions\": [\n {\n \"id\": \"1\",\n \"attribute\": \"Error Message\",\n \"operator\": \"Is Set To\",\n \"values\": [\n \"Error Message\"\n ],\n \"dataType\": \"String\",\n \"inputFieldType\": 1,\n \"isMandatoryAction\": true\n }\n ],\n \"isDefaultRuleSet\": false,\n \"sequence\": 1\n }\n ],\n \"isDefaultRuleSetDisabled\": false,\n \"isRetailRule\": false\n },\n \"status\": \"OK\"\n}"}],"_postman_id":"187dafdf-41ca-47c4-b65d-c1aaa2299eab"},{"name":"Delete Suspend Subscription Rule","id":"b15e657c-a2ee-41e5-ad6d-b31dded490d2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"DELETE","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"}],"url":"{{Host}}/rest/RuleService/v1/rules/OrderValidation/Suspend_Subscription","description":"This API is used to delete the suspend subscription rule.
\n","urlObject":{"path":["rest","RuleService","v1","rules","OrderValidation","Suspend_Subscription"],"host":["{{Host}}"],"query":[],"variable":[]}},"response":[{"id":"969a7a0d-d982-480b-933c-04f38deafb29","name":"Delete Suspend Subscription Rule","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"}],"url":"{{Host}}/rest/RuleService/v1/rules/OrderValidation/{Rule_Name}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 20 Sep 2023 09:23:20 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"15"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"*, Content-Type, Pragma, Origin, Authorization, party, X-XSRF-TOKEN, X-Requested-With,Access-Control-Allow-Headers,Accept,Access-Control-Allow-Credentials,X-Auth-Token, version, cache"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST,OPTIONS,PUT,DELETE,GET"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"OK\"\n}"}],"_postman_id":"b15e657c-a2ee-41e5-ad6d-b31dded490d2"}],"id":"b5881441-0da2-40a4-a63f-4c8648ba36fe","description":"In this section will discuss about suspending the subscription driven based on the rule. This will allow users to define a criteria for suspending the subscription.
Here examples are added for respective operation such as creation, updation, fetching, and deleting.
This API is used to create the resume subscription rule in the application.
\n","urlObject":{"path":["rest","RuleService","v1","rules","OrderValidation"],"host":["{{Host}}"],"query":[],"variable":[]}},"response":[{"id":"91c821fc-5ff8-4c04-803b-d33dbe41b53c","name":"Create Resume Subscription Rule","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"contextName\": \"OrderValidation\",\r\n \"ruleName\": \"Resume_Subscription\",\r\n \"ruleCategory\": 1,\r\n \"ruleSets\": [\r\n {\r\n \"ruleSetConditions\": [\r\n {\r\n \"property\": \"Orders\",\r\n \"attribute\": \"Billing City\",\r\n \"operator\": \"Equal To\",\r\n \"values\": [\r\n \"NY\"\r\n ]\r\n },\r\n {\r\n \"property\": \"Subscriber\",\r\n \"attribute\": \"Billing Profile Status\",\r\n \"operator\": \"Equal To\",\r\n \"values\": [\r\n \"Active\"\r\n ]\r\n },\r\n {\r\n \"property\": \"Subscription\",\r\n \"attribute\": \"Product - Price Plan\",\r\n \"operator\": \"Equal To\",\r\n \"values\": [\r\n \"2\"\r\n ]\r\n }\r\n ],\r\n \"ruleSetActions\": [\r\n {\r\n \"attribute\": \"Error Message\",\r\n \"operator\": \"Is Set To\",\r\n \"values\": [\r\n \"Error Message\"\r\n ]\r\n }\r\n ],\r\n \"sequence\": 1\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{Host}}/rest/RuleService/v1/rules/OrderValidation"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 20 Sep 2023 09:46:34 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"48"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"*, Content-Type, Pragma, Origin, Authorization, party, X-XSRF-TOKEN, X-Requested-With,Access-Control-Allow-Headers,Accept,Access-Control-Allow-Credentials,X-Auth-Token, version, cache"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST,OPTIONS,PUT,DELETE,GET"}],"cookie":[],"responseTime":null,"body":"{\n \"ruleName\": \"Resume_Subscription\",\n \"status\": \"OK\"\n}"}],"_postman_id":"d632f81d-5f64-4d1d-b4d7-dd821f75f995"},{"name":"Update the Resume Subscription Rule","id":"212448a5-7889-4486-994b-4b092fede05e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"PUT","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"contextName\": \"OrderValidation\",\r\n \"ruleName\": \"Resume_Subscription\",\r\n \"ruleCategory\": 1,\r\n \"ruleSets\": [\r\n {\r\n \"id\": \"1\",\r\n \"ruleSetConditions\": [\r\n {\r\n \"id\": \"1\",\r\n \"property\": \"Orders\",\r\n \"attribute\": \"Billing City\",\r\n \"operator\": \"Equal To\",\r\n \"values\": [\r\n \"NewYork\"\r\n ]\r\n },\r\n {\r\n \"id\": \"2\",\r\n \"property\": \"Subscriber\",\r\n \"attribute\": \"Billing Profile Status\",\r\n \"operator\": \"Equal To\",\r\n \"values\": [\r\n \"Suspended\"\r\n ]\r\n },\r\n {\r\n \"id\": \"3\",\r\n \"property\": \"Subscription\",\r\n \"attribute\": \"Product - Price Plan\",\r\n \"operator\": \"Equal To\",\r\n \"values\": [\r\n \"2\"\r\n ]\r\n }\r\n ],\r\n \"ruleSetActions\": [\r\n {\r\n \"id\": \"1\",\r\n \"attribute\": \"Error Message\",\r\n \"operator\": \"Is Set To\",\r\n \"values\": [\r\n \"Error Message\"\r\n ]\r\n }\r\n ],\r\n \"sequence\": 1\r\n }\r\n ]\r\n}"},"url":"{{Host}}/rest/RuleService/v1/rules/OrderValidation/Resume_Subscription","description":"This API is used update the resume subscription rule, it will allow to modify the details of the existing resume subscription rule.
\n","urlObject":{"path":["rest","RuleService","v1","rules","OrderValidation","Resume_Subscription"],"host":["{{Host}}"],"query":[],"variable":[]}},"response":[{"id":"ec728f2c-a1b5-41e7-99aa-f9729ecbc514","name":"New Request","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"contextName\": \"OrderValidation\",\r\n \"ruleName\": \"Resume_Subscription\",\r\n \"ruleCategory\": 1,\r\n \"ruleSets\": [\r\n {\r\n \"id\": \"1\",\r\n \"ruleSetConditions\": [\r\n {\r\n \"id\": \"1\",\r\n \"property\": \"Orders\",\r\n \"attribute\": \"Billing City\",\r\n \"operator\": \"Equal To\",\r\n \"values\": [\r\n \"NewYork\"\r\n ]\r\n },\r\n {\r\n \"id\": \"2\",\r\n \"property\": \"Subscriber\",\r\n \"attribute\": \"Billing Profile Status\",\r\n \"operator\": \"Equal To\",\r\n \"values\": [\r\n \"Suspended\"\r\n ]\r\n },\r\n {\r\n \"id\": \"3\",\r\n \"property\": \"Subscription\",\r\n \"attribute\": \"Product - Price Plan\",\r\n \"operator\": \"Equal To\",\r\n \"values\": [\r\n \"2\"\r\n ]\r\n }\r\n ],\r\n \"ruleSetActions\": [\r\n {\r\n \"id\": \"1\",\r\n \"attribute\": \"Error Message\",\r\n \"operator\": \"Is Set To\",\r\n \"values\": [\r\n \"Error Message\"\r\n ]\r\n }\r\n ],\r\n \"sequence\": 1\r\n }\r\n ]\r\n}"},"url":"{{Host}}/rest/RuleService/v1/rules/OrderValidation/Resume_Subscription"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 20 Sep 2023 09:58:00 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"48"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"*, Content-Type, Pragma, Origin, Authorization, party, X-XSRF-TOKEN, X-Requested-With,Access-Control-Allow-Headers,Accept,Access-Control-Allow-Credentials,X-Auth-Token, version, cache"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST,OPTIONS,PUT,DELETE,GET"}],"cookie":[],"responseTime":null,"body":"{\n \"ruleName\": \"Resume_Subscription\",\n \"status\": \"OK\"\n}"}],"_postman_id":"212448a5-7889-4486-994b-4b092fede05e"},{"name":"Fetch Resume Subscription Rule","id":"0141e0df-b982-4371-ba0d-bbfb1df2934f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"}],"url":"{{Host}}/rest/RuleService/v1/rules/OrderValidation/Resume_Subscription","description":"This API is used to fetch the subscription rule available in the application.
\n","urlObject":{"path":["rest","RuleService","v1","rules","OrderValidation","Resume_Subscription"],"host":["{{Host}}"],"query":[],"variable":[]}},"response":[{"id":"8cbf35a5-fe75-42c3-bbca-5804fafd5222","name":"Get Subscription Rule","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"}],"url":"{{Host}}/rest/RuleService/v1/rules/OrderValidation/Resume_Subscription"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 20 Sep 2023 10:09:57 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"917"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"*, Content-Type, Pragma, Origin, Authorization, party, X-XSRF-TOKEN, X-Requested-With,Access-Control-Allow-Headers,Accept,Access-Control-Allow-Credentials,X-Auth-Token, version, cache"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST,OPTIONS,PUT,DELETE,GET"}],"cookie":[],"responseTime":null,"body":"{\n \"ruleInfo\": {\n \"ruleName\": \"Resume_Subscription\",\n \"contextName\": \"OrderValidation\",\n \"ruleCategory\": 1,\n \"ruleSets\": [\n {\n \"id\": \"1\",\n \"ruleSetConditions\": [\n {\n \"id\": \"1\",\n \"property\": \"Orders\",\n \"attribute\": \"Billing City\",\n \"operator\": \"Equal To\",\n \"values\": [\n \"NewYork\"\n ],\n \"dataType\": \"String\",\n \"inputFieldType\": 1\n },\n {\n \"id\": \"2\",\n \"property\": \"Subscriber\",\n \"attribute\": \"Billing Profile Status\",\n \"operator\": \"Equal To\",\n \"values\": [\n \"Suspended\"\n ],\n \"dataType\": \"String\",\n \"inputFieldType\": 2\n },\n {\n \"id\": \"3\",\n \"property\": \"Subscription\",\n \"attribute\": \"Product - Price Plan\",\n \"operator\": \"Equal To\",\n \"values\": [\n \"2\"\n ],\n \"displayValues\": {\n \"2\": \"VOIP Polycom-VOIP Polycom PP\"\n },\n \"dataType\": \"String\",\n \"inputFieldType\": 3\n }\n ],\n \"ruleSetActions\": [\n {\n \"id\": \"1\",\n \"attribute\": \"Error Message\",\n \"operator\": \"Is Set To\",\n \"values\": [\n \"Error Message\"\n ],\n \"dataType\": \"String\",\n \"inputFieldType\": 1,\n \"isMandatoryAction\": true\n }\n ],\n \"isDefaultRuleSet\": false,\n \"sequence\": 1\n }\n ],\n \"isDefaultRuleSetDisabled\": false,\n \"isRetailRule\": false\n },\n \"status\": \"OK\"\n}"}],"_postman_id":"0141e0df-b982-4371-ba0d-bbfb1df2934f"},{"name":"Delete Resume Subscription Rule","id":"e437fc60-c627-4019-8b3d-8f48be6fd984","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"DELETE","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"}],"url":"{{Host}}/rest/RuleService/v1/rules/OrderValidation/Resume_Subscription","description":"This API is used to delete the resume subscription rule from the application.
\n","urlObject":{"path":["rest","RuleService","v1","rules","OrderValidation","Resume_Subscription"],"host":["{{Host}}"],"query":[],"variable":[]}},"response":[{"id":"5c7f7ead-5a18-4902-925d-695ec3e4848d","name":"Delete Resume Subscription Rule","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"}],"url":"{{Host}}/rest/RuleService/v1/rules/OrderValidation/Resume_Subscription"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 20 Sep 2023 10:16:13 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"15"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"*, Content-Type, Pragma, Origin, Authorization, party, X-XSRF-TOKEN, X-Requested-With,Access-Control-Allow-Headers,Accept,Access-Control-Allow-Credentials,X-Auth-Token, version, cache"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST,OPTIONS,PUT,DELETE,GET"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"OK\"\n}"}],"_postman_id":"e437fc60-c627-4019-8b3d-8f48be6fd984"}],"id":"f2def17b-0aa4-473c-b02f-6df08f7b30a6","description":"In this section will discuss about the Resume Subscription Rule. This rule or criteria defines when a subscription should be resumed based on the criteria defined.
\n","_postman_id":"f2def17b-0aa4-473c-b02f-6df08f7b30a6"},{"name":"Late Fee Rule","item":[{"name":"Late Fee Rule","id":"3d9398a3-11f1-4584-aef9-8b82b8924cb2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"contextName\": \"LateFee\",\r\n \"ruleCategory\": 1,\r\n \"ruleSets\": [\r\n {\r\n \"ruleSetConditions\": [\r\n {\r\n \"property\": \"Bill\",\r\n \"attribute\": \"Billing City\",\r\n \"operator\": \"Equal To\",\r\n \"values\": [\r\n \"NY\"\r\n ]\r\n },\r\n {\r\n \"property\": \"Subscriber\",\r\n \"attribute\": \"Billing Profile Status\",\r\n \"operator\": \"Equal To\",\r\n \"values\": [\r\n \"Active\"\r\n ]\r\n },\r\n {\r\n \"property\": \"Subscriber\",\r\n \"attribute\": \"Payment Method\",\r\n \"operator\": \"Equal To\",\r\n \"values\": [\r\n \"CC\"\r\n ]\r\n }\r\n ],\r\n \"ruleSetActions\": [\r\n {\r\n \"attribute\": \"Fixed Late Fee\",\r\n \"operator\": \"Is Set To\",\r\n \"values\": [\r\n \"10\"\r\n ]\r\n },\r\n {\r\n \"attribute\": \"Percentage of Due Amount\",\r\n \"operator\": \"Is Set To\",\r\n \"values\": [\r\n \"10\"\r\n ]\r\n }\r\n ],\r\n \"sequence\": 1\r\n }\r\n ]\r\n}"},"url":"{{Host}}/rest/RuleService/v1/rules/LateFee","description":"This API is used to create the Late Fee Rules in the application.
\n","urlObject":{"path":["rest","RuleService","v1","rules","LateFee"],"host":["{{Host}}"],"query":[],"variable":[]}},"response":[{"id":"cf965378-59c6-4acd-a1da-42afa2092ea6","name":"Create a Late Fee Rule","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"contextName\": \"LateFee\",\r\n \"ruleCategory\": 1,\r\n \"ruleSets\": [\r\n {\r\n \"ruleSetConditions\": [\r\n {\r\n \"property\": \"Bill\",\r\n \"attribute\": \"Billing City\",\r\n \"operator\": \"Equal To\",\r\n \"values\": [\r\n \"NY\"\r\n ]\r\n },\r\n {\r\n \"property\": \"Subscriber\",\r\n \"attribute\": \"Billing Profile Status\",\r\n \"operator\": \"Equal To\",\r\n \"values\": [\r\n \"Active\"\r\n ]\r\n },\r\n {\r\n \"property\": \"Subscriber\",\r\n \"attribute\": \"Payment Method\",\r\n \"operator\": \"Equal To\",\r\n \"values\": [\r\n \"CC\"\r\n ]\r\n }\r\n ],\r\n \"ruleSetActions\": [\r\n {\r\n \"attribute\": \"Fixed Late Fee\",\r\n \"operator\": \"Is Set To\",\r\n \"values\": [\r\n \"10\"\r\n ]\r\n },\r\n {\r\n \"attribute\": \"Percentage of Due Amount\",\r\n \"operator\": \"Is Set To\",\r\n \"values\": [\r\n \"10\"\r\n ]\r\n }\r\n ],\r\n \"sequence\": 1\r\n }\r\n ]\r\n}"},"url":"{{Host}}/rest/RuleService/v1/rules/LateFee"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 20 Sep 2023 10:30:19 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"37"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"*, Content-Type, Pragma, Origin, Authorization, party, X-XSRF-TOKEN, X-Requested-With,Access-Control-Allow-Headers,Accept,Access-Control-Allow-Credentials,X-Auth-Token, version, cache"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST,OPTIONS,PUT,DELETE,GET"}],"cookie":[],"responseTime":null,"body":"{\n \"ruleName\": \"Late_Fee\",\n \"status\": \"OK\"\n}"}],"_postman_id":"3d9398a3-11f1-4584-aef9-8b82b8924cb2"},{"name":"Update the Late Fee Rules","id":"860cfdab-3c13-41bc-a29d-90593dc93cb9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"PUT","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"contextName\": \"LateFee\",\r\n \"ruleCategory\": 1,\r\n \"ruleSets\": [\r\n {\r\n \"id\": \"1\",\r\n \"ruleSetConditions\": [\r\n {\r\n \"id\": \"1\",\r\n \"property\": \"Bill\",\r\n \"attribute\": \"Billing City\",\r\n \"operator\": \"Equal To\",\r\n \"values\": [\r\n \"NewYork\"\r\n ]\r\n },\r\n {\r\n \"id\": \"2\",\r\n \"property\": \"Subscriber\",\r\n \"attribute\": \"Billing Profile Status\",\r\n \"operator\": \"Equal To\",\r\n \"values\": [\r\n \"Closed\"\r\n ]\r\n },\r\n {\r\n \"id\": \"3\",\r\n \"property\": \"Subscriber\",\r\n \"attribute\": \"Payment Method\",\r\n \"operator\": \"Equal To\",\r\n \"values\": [\r\n \"CC\"\r\n ]\r\n }\r\n ],\r\n \"ruleSetActions\": [\r\n {\r\n \"id\": \"1\",\r\n \"attribute\": \"Fixed Late Fee\",\r\n \"operator\": \"Is Set To\",\r\n \"values\": [\r\n \"30\"\r\n ]\r\n },\r\n {\r\n \"id\": \"2\",\r\n \"attribute\": \"Percentage of Due Amount\",\r\n \"operator\": \"Is Set To\",\r\n \"values\": [\r\n \"10\"\r\n ]\r\n }\r\n ],\r\n \"isDefaultRuleSet\": false,\r\n \"sequence\": 1\r\n }\r\n ]\r\n}"},"url":"{{Host}}/rest/RuleService/v1/rules/LateFee/Late_Fee","description":"This API is used to update the existing Late Fee Rule in the application.
\n","urlObject":{"path":["rest","RuleService","v1","rules","LateFee","Late_Fee"],"host":["{{Host}}"],"query":[],"variable":[]}},"response":[{"id":"8ef2f395-935f-437a-b1a9-05418cfd18e7","name":"Update the Late Fee Rule","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"contextName\": \"LateFee\",\r\n \"ruleCategory\": 1,\r\n \"ruleSets\": [\r\n {\r\n \"id\": \"1\",\r\n \"ruleSetConditions\": [\r\n {\r\n \"id\": \"1\",\r\n \"property\": \"Bill\",\r\n \"attribute\": \"Billing City\",\r\n \"operator\": \"Equal To\",\r\n \"values\": [\r\n \"NewYork\"\r\n ]\r\n },\r\n {\r\n \"id\": \"2\",\r\n \"property\": \"Subscriber\",\r\n \"attribute\": \"Billing Profile Status\",\r\n \"operator\": \"Equal To\",\r\n \"values\": [\r\n \"Closed\"\r\n ]\r\n },\r\n {\r\n \"id\": \"3\",\r\n \"property\": \"Subscriber\",\r\n \"attribute\": \"Payment Method\",\r\n \"operator\": \"Equal To\",\r\n \"values\": [\r\n \"CC\"\r\n ]\r\n }\r\n ],\r\n \"ruleSetActions\": [\r\n {\r\n \"id\": \"1\",\r\n \"attribute\": \"Fixed Late Fee\",\r\n \"operator\": \"Is Set To\",\r\n \"values\": [\r\n \"30\"\r\n ]\r\n },\r\n {\r\n \"id\": \"2\",\r\n \"attribute\": \"Percentage of Due Amount\",\r\n \"operator\": \"Is Set To\",\r\n \"values\": [\r\n \"10\"\r\n ]\r\n }\r\n ],\r\n \"isDefaultRuleSet\": false,\r\n \"sequence\": 1\r\n }\r\n ]\r\n}"},"url":"{{Host}}/rest/RuleService/v1/rules/LateFee/Late_Fee"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 20 Sep 2023 10:38:05 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"37"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"*, Content-Type, Pragma, Origin, Authorization, party, X-XSRF-TOKEN, X-Requested-With,Access-Control-Allow-Headers,Accept,Access-Control-Allow-Credentials,X-Auth-Token, version, cache"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST,OPTIONS,PUT,DELETE,GET"}],"cookie":[],"responseTime":null,"body":"{\n \"ruleName\": \"Late_Fee\",\n \"status\": \"OK\"\n}"}],"_postman_id":"860cfdab-3c13-41bc-a29d-90593dc93cb9"},{"name":"Get the Late Fee Rule","id":"225de1ef-9110-4435-a7e5-be0430ca604d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"}],"url":"{{Host}}/rest/RuleService/v1/rules/LateFee/Late_Fee","description":"This API is used to fetch the list of Late Fee Rule in the application. The list of Late Fee Rules available will be fetched.
\n","urlObject":{"path":["rest","RuleService","v1","rules","LateFee","Late_Fee"],"host":["{{Host}}"],"query":[],"variable":[]}},"response":[{"id":"770a1064-f789-41c8-8bbc-b5b5ce024ba9","name":"Get the Late Fee Rule","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"}],"url":"{{Host}}/rest/RuleService/v1/rules/LateFee/Late_Fee"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 20 Sep 2023 10:40:30 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"986"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"*, Content-Type, Pragma, Origin, Authorization, party, X-XSRF-TOKEN, X-Requested-With,Access-Control-Allow-Headers,Accept,Access-Control-Allow-Credentials,X-Auth-Token, version, cache"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST,OPTIONS,PUT,DELETE,GET"}],"cookie":[],"responseTime":null,"body":"{\n \"ruleInfo\": {\n \"ruleName\": \"Late_Fee\",\n \"contextName\": \"LateFee\",\n \"ruleCategory\": 1,\n \"ruleSets\": [\n {\n \"id\": \"1\",\n \"ruleSetConditions\": [\n {\n \"id\": \"1\",\n \"property\": \"Bill\",\n \"attribute\": \"Billing City\",\n \"operator\": \"Equal To\",\n \"values\": [\n \"NewYork\"\n ],\n \"dataType\": \"String\",\n \"inputFieldType\": 1\n },\n {\n \"id\": \"2\",\n \"property\": \"Subscriber\",\n \"attribute\": \"Billing Profile Status\",\n \"operator\": \"Equal To\",\n \"values\": [\n \"Closed\"\n ],\n \"dataType\": \"String\",\n \"inputFieldType\": 2\n },\n {\n \"id\": \"3\",\n \"property\": \"Subscriber\",\n \"attribute\": \"Payment Method\",\n \"operator\": \"Equal To\",\n \"values\": [\n \"CC\"\n ],\n \"dataType\": \"String\",\n \"inputFieldType\": 1\n }\n ],\n \"ruleSetActions\": [\n {\n \"id\": \"1\",\n \"attribute\": \"Fixed Late Fee\",\n \"operator\": \"Is Set To\",\n \"values\": [\n \"30\"\n ],\n \"dataType\": \"BigDecimal\",\n \"inputFieldType\": 1,\n \"isMandatoryAction\": false\n },\n {\n \"id\": \"2\",\n \"attribute\": \"Percentage of Due Amount\",\n \"operator\": \"Is Set To\",\n \"values\": [\n \"10\"\n ],\n \"dataType\": \"BigDecimal\",\n \"inputFieldType\": 1,\n \"isMandatoryAction\": false\n }\n ],\n \"isDefaultRuleSet\": false,\n \"sequence\": 1\n }\n ],\n \"isDefaultRuleSetDisabled\": false,\n \"isRetailRule\": false\n },\n \"status\": \"OK\"\n}"}],"_postman_id":"225de1ef-9110-4435-a7e5-be0430ca604d"},{"name":"Delete the Late Fee Rule","id":"4938270c-1acf-4ef0-b1cc-c8de472f4f0a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"DELETE","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"}],"url":"{{Host}}/rest/RuleService/v1/rules/LateFee/Late_Fee","description":"This API is used to delete the Late Fee Rule in the application. This process cannot be undo, be caution.
\n","urlObject":{"path":["rest","RuleService","v1","rules","LateFee","Late_Fee"],"host":["{{Host}}"],"query":[],"variable":[]}},"response":[{"id":"18e7a723-8e79-4e5b-a150-672422150310","name":"Delete the Late Fee Rule","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"}],"url":"{{Host}}/rest/RuleService/v1/rules/LateFee/Late_Fee"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 20 Sep 2023 10:29:38 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"15"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"*, Content-Type, Pragma, Origin, Authorization, party, X-XSRF-TOKEN, X-Requested-With,Access-Control-Allow-Headers,Accept,Access-Control-Allow-Credentials,X-Auth-Token, version, cache"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST,OPTIONS,PUT,DELETE,GET"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"OK\"\n}"}],"_postman_id":"4938270c-1acf-4ef0-b1cc-c8de472f4f0a"}],"id":"b6cc7895-e3ae-47ea-b0da-d48feabe2e06","description":"In this section will discuss about Late Fee and there operations, such as creation, updation, fetching and deletion.
\n","_postman_id":"b6cc7895-e3ae-47ea-b0da-d48feabe2e06"},{"name":"Partner Late Fee Rule","item":[{"name":"Partner Late Fee","id":"9b4a96ee-c466-4b57-bdd7-b185824ab8d1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"contextName\": \"PartnerLateFee\",\r\n \"ruleCategory\": 1,\r\n \"ruleSets\": [\r\n {\r\n \"ruleSetConditions\": [\r\n {\r\n \"property\": \"Bill\",\r\n \"attribute\": \"Billing City\",\r\n \"operator\": \"Equal To\",\r\n \"values\": [\r\n \"NY\"\r\n ]\r\n },\r\n {\r\n \"property\": \"Partner\",\r\n \"attribute\": \"Billing Profile Status\",\r\n \"operator\": \"Equal To\",\r\n \"values\": [\r\n \"Active\"\r\n ]\r\n },\r\n {\r\n \"property\": \"Partner\",\r\n \"attribute\": \"Payment Method\",\r\n \"operator\": \"Equal To\",\r\n \"values\": [\r\n \"CC\"\r\n ]\r\n }\r\n ],\r\n \"ruleSetActions\": [\r\n {\r\n \"attribute\": \"Fixed Late Fee\",\r\n \"operator\": \"Is Set To\",\r\n \"values\": [\r\n \"10\"\r\n ]\r\n },\r\n {\r\n \"attribute\": \"Percentage of Due Amount\",\r\n \"operator\": \"Is Set To\",\r\n \"values\": [\r\n \"10\"\r\n ]\r\n }\r\n ],\r\n \"sequence\": 1\r\n }\r\n ]\r\n}"},"url":"{{Host}}/rest/RuleService/v1/rules/PartnerLateFee","description":"This API is used to create a Partner's Late Fee rule in the application. Using the request you can create the Partner's Late fee.
\n","urlObject":{"path":["rest","RuleService","v1","rules","PartnerLateFee"],"host":["{{Host}}"],"query":[],"variable":[]}},"response":[{"id":"74d3be2a-7fb8-4538-a118-b82986a5d14a","name":"Create Partner Late Fee Rule","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"contextName\": \"PartnerLateFee\",\r\n \"ruleCategory\": 1,\r\n \"ruleSets\": [\r\n {\r\n \"ruleSetConditions\": [\r\n {\r\n \"property\": \"Bill\",\r\n \"attribute\": \"Billing City\",\r\n \"operator\": \"Equal To\",\r\n \"values\": [\r\n \"NY\"\r\n ]\r\n },\r\n {\r\n \"property\": \"Partner\",\r\n \"attribute\": \"Billing Profile Status\",\r\n \"operator\": \"Equal To\",\r\n \"values\": [\r\n \"Active\"\r\n ]\r\n },\r\n {\r\n \"property\": \"Partner\",\r\n \"attribute\": \"Payment Method\",\r\n \"operator\": \"Equal To\",\r\n \"values\": [\r\n \"CC\"\r\n ]\r\n }\r\n ],\r\n \"ruleSetActions\": [\r\n {\r\n \"attribute\": \"Fixed Late Fee\",\r\n \"operator\": \"Is Set To\",\r\n \"values\": [\r\n \"10\"\r\n ]\r\n },\r\n {\r\n \"attribute\": \"Percentage of Due Amount\",\r\n \"operator\": \"Is Set To\",\r\n \"values\": [\r\n \"10\"\r\n ]\r\n }\r\n ],\r\n \"sequence\": 1\r\n }\r\n ]\r\n}"},"url":"{{Host}}/rest/RuleService/v1/rules/PartnerLateFee"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 20 Sep 2023 10:49:04 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"45"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"*, Content-Type, Pragma, Origin, Authorization, party, X-XSRF-TOKEN, X-Requested-With,Access-Control-Allow-Headers,Accept,Access-Control-Allow-Credentials,X-Auth-Token, version, cache"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST,OPTIONS,PUT,DELETE,GET"}],"cookie":[],"responseTime":null,"body":"{\n \"ruleName\": \"Partner_Late_Fee\",\n \"status\": \"OK\"\n}"}],"_postman_id":"9b4a96ee-c466-4b57-bdd7-b185824ab8d1"},{"name":"Update the Partner Late Fee Rule","id":"a1f0b90a-63c7-4f00-b057-8a091690cdef","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"PUT","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"contextName\": \"PartnerLateFee\",\r\n \"ruleCategory\": 1,\r\n \"ruleSets\": [\r\n {\r\n \"id\": \"1\",\r\n \"ruleSetConditions\": [\r\n {\r\n \"id\": \"1\",\r\n \"property\": \"Bill\",\r\n \"attribute\": \"Billing City\",\r\n \"operator\": \"Equal To\",\r\n \"values\": [\r\n \"NewYork\"\r\n ]\r\n },\r\n {\r\n \"id\": \"2\",\r\n \"property\": \"Partner\",\r\n \"attribute\": \"Billing Profile Status\",\r\n \"operator\": \"Equal To\",\r\n \"values\": [\r\n \"Closed\"\r\n ]\r\n },\r\n {\r\n \"id\": \"3\",\r\n \"property\": \"Partner\",\r\n \"attribute\": \"Payment Method\",\r\n \"operator\": \"Equal To\",\r\n \"values\": [\r\n \"CC\"\r\n ]\r\n }\r\n ],\r\n \"ruleSetActions\": [\r\n {\r\n \"id\": \"1\",\r\n \"attribute\": \"Fixed Late Fee\",\r\n \"operator\": \"Is Set To\",\r\n \"values\": [\r\n \"30\"\r\n ]\r\n },\r\n {\r\n \"id\": \"2\",\r\n \"attribute\": \"Percentage of Due Amount\",\r\n \"operator\": \"Is Set To\",\r\n \"values\": [\r\n \"10\"\r\n ]\r\n }\r\n ],\r\n \"isDefaultRuleSet\": false,\r\n \"sequence\": 1\r\n }\r\n ]\r\n}"},"url":"{{Host}}/rest/RuleService/v1/rules/PartnerLateFee/Partner_Late_Fee","description":"This API is used the modify the Partner Late Fee Rule. This will help you to modify the existing Partner's Late Fee Rule.
\n","urlObject":{"path":["rest","RuleService","v1","rules","PartnerLateFee","Partner_Late_Fee"],"host":["{{Host}}"],"query":[],"variable":[]}},"response":[{"id":"5f8b0ce6-3525-4255-9330-fe32f25e0483","name":"Update the Partner Late Fee Rule","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"contextName\": \"PartnerLateFee\",\r\n \"ruleCategory\": 1,\r\n \"ruleSets\": [\r\n {\r\n \"id\": \"1\",\r\n \"ruleSetConditions\": [\r\n {\r\n \"id\": \"1\",\r\n \"property\": \"Bill\",\r\n \"attribute\": \"Billing City\",\r\n \"operator\": \"Equal To\",\r\n \"values\": [\r\n \"NewYork\"\r\n ]\r\n },\r\n {\r\n \"id\": \"2\",\r\n \"property\": \"Partner\",\r\n \"attribute\": \"Billing Profile Status\",\r\n \"operator\": \"Equal To\",\r\n \"values\": [\r\n \"Closed\"\r\n ]\r\n },\r\n {\r\n \"id\": \"3\",\r\n \"property\": \"Partner\",\r\n \"attribute\": \"Payment Method\",\r\n \"operator\": \"Equal To\",\r\n \"values\": [\r\n \"CC\"\r\n ]\r\n }\r\n ],\r\n \"ruleSetActions\": [\r\n {\r\n \"id\": \"1\",\r\n \"attribute\": \"Fixed Late Fee\",\r\n \"operator\": \"Is Set To\",\r\n \"values\": [\r\n \"30\"\r\n ]\r\n },\r\n {\r\n \"id\": \"2\",\r\n \"attribute\": \"Percentage of Due Amount\",\r\n \"operator\": \"Is Set To\",\r\n \"values\": [\r\n \"10\"\r\n ]\r\n }\r\n ],\r\n \"isDefaultRuleSet\": false,\r\n \"sequence\": 1\r\n }\r\n ]\r\n}"},"url":"{{Host}}/rest/RuleService/v1/rules/PartnerLateFee/Partner_Late_Fee"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 20 Sep 2023 10:53:26 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"45"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"*, Content-Type, Pragma, Origin, Authorization, party, X-XSRF-TOKEN, X-Requested-With,Access-Control-Allow-Headers,Accept,Access-Control-Allow-Credentials,X-Auth-Token, version, cache"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST,OPTIONS,PUT,DELETE,GET"}],"cookie":[],"responseTime":null,"body":"{\n \"ruleName\": \"Partner_Late_Fee\",\n \"status\": \"OK\"\n}"}],"_postman_id":"a1f0b90a-63c7-4f00-b057-8a091690cdef"},{"name":"Get the Partner Late Fee Rule","id":"54fa3ee9-ef16-4c08-adea-84138b196c55","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"}],"url":"{{Host}}/rest/RuleService/v1/rules/PartnerLateFee/Partner_Late_Fee","description":"This API is used to fetch the Partner's late fee details from the application.
\n","urlObject":{"path":["rest","RuleService","v1","rules","PartnerLateFee","Partner_Late_Fee"],"host":["{{Host}}"],"query":[],"variable":[]}},"response":[{"id":"eb8654e1-d22e-422e-b3ba-8c71b4ebd0fe","name":"Get the Partner Late Fee Rule","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"}],"url":"{{Host}}/rest/RuleService/v1/rules/PartnerLateFee/Partner_Late_Fee"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 20 Sep 2023 10:56:30 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"995"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"*, Content-Type, Pragma, Origin, Authorization, party, X-XSRF-TOKEN, X-Requested-With,Access-Control-Allow-Headers,Accept,Access-Control-Allow-Credentials,X-Auth-Token, version, cache"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST,OPTIONS,PUT,DELETE,GET"}],"cookie":[],"responseTime":null,"body":"{\n \"ruleInfo\": {\n \"ruleName\": \"Partner_Late_Fee\",\n \"contextName\": \"PartnerLateFee\",\n \"ruleCategory\": 1,\n \"ruleSets\": [\n {\n \"id\": \"1\",\n \"ruleSetConditions\": [\n {\n \"id\": \"1\",\n \"property\": \"Bill\",\n \"attribute\": \"Billing City\",\n \"operator\": \"Equal To\",\n \"values\": [\n \"NewYork\"\n ],\n \"dataType\": \"String\",\n \"inputFieldType\": 1\n },\n {\n \"id\": \"2\",\n \"property\": \"Partner\",\n \"attribute\": \"Billing Profile Status\",\n \"operator\": \"Equal To\",\n \"values\": [\n \"Closed\"\n ],\n \"dataType\": \"String\",\n \"inputFieldType\": 2\n },\n {\n \"id\": \"3\",\n \"property\": \"Partner\",\n \"attribute\": \"Payment Method\",\n \"operator\": \"Equal To\",\n \"values\": [\n \"CC\"\n ],\n \"dataType\": \"String\",\n \"inputFieldType\": 1\n }\n ],\n \"ruleSetActions\": [\n {\n \"id\": \"1\",\n \"attribute\": \"Fixed Late Fee\",\n \"operator\": \"Is Set To\",\n \"values\": [\n \"30\"\n ],\n \"dataType\": \"BigDecimal\",\n \"inputFieldType\": 1,\n \"isMandatoryAction\": false\n },\n {\n \"id\": \"2\",\n \"attribute\": \"Percentage of Due Amount\",\n \"operator\": \"Is Set To\",\n \"values\": [\n \"10\"\n ],\n \"dataType\": \"BigDecimal\",\n \"inputFieldType\": 1,\n \"isMandatoryAction\": false\n }\n ],\n \"isDefaultRuleSet\": false,\n \"sequence\": 1\n }\n ],\n \"isDefaultRuleSetDisabled\": false,\n \"isRetailRule\": false\n },\n \"status\": \"OK\"\n}"}],"_postman_id":"54fa3ee9-ef16-4c08-adea-84138b196c55"},{"name":"Delete the Partner Late Fee Rule","id":"1897a4b2-2771-499c-930f-80350e3fd0a4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"DELETE","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"}],"url":"{{Host}}/rest/RuleService/v1/rules/PartnerLateFee/Partner_Late_Fee","description":"This API is used to Delete the Partner's Late Fee Rule from the application.
\n","urlObject":{"path":["rest","RuleService","v1","rules","PartnerLateFee","Partner_Late_Fee"],"host":["{{Host}}"],"query":[],"variable":[]}},"response":[{"id":"3e97aabd-7f9c-48b0-94bb-15aa58eb1f9a","name":"Delete the Partner Late Fee Rule","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"}],"url":"{{Host}}/rest/RuleService/v1/rules/PartnerLateFee/Partner_Late_Fee"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 20 Sep 2023 10:59:34 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"15"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"*, Content-Type, Pragma, Origin, Authorization, party, X-XSRF-TOKEN, X-Requested-With,Access-Control-Allow-Headers,Accept,Access-Control-Allow-Credentials,X-Auth-Token, version, cache"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST,OPTIONS,PUT,DELETE,GET"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"OK\"\n}"}],"_postman_id":"1897a4b2-2771-499c-930f-80350e3fd0a4"}],"id":"0ad30f7c-1cf5-42ef-afa9-1cf51ef1b27a","description":"In this section, we will discuss about Partner's late fee and there operations such as creation, modification, fetching, and deletion.
\n","_postman_id":"0ad30f7c-1cf5-42ef-afa9-1cf51ef1b27a"},{"name":"Collection Entry Criteria Rule","item":[{"name":"Collection Entry Criteria Rule","id":"86b5981e-9f34-44eb-bc76-14138db2973a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"contextName\": \"Collection\",\r\n \"ruleCategory\": 1,\r\n \"ruleSets\": [\r\n {\r\n \"ruleSetConditions\": [\r\n {\r\n \"property\": \"Subscriber\",\r\n \"attribute\": \"Total Due Amount\",\r\n \"operator\": \"Between\",\r\n \"values\": [\r\n \"10\",\r\n \"50\"\r\n ]\r\n },\r\n {\r\n \"property\": \"Subscriber\",\r\n \"attribute\": \"Billing Profile Status\",\r\n \"operator\": \"Equal To\",\r\n \"values\": [\r\n \"Active\"\r\n ]\r\n },\r\n {\r\n \"property\": \"Subscriber\",\r\n \"attribute\": \"Primary Currency\",\r\n \"operator\": \"Equal To\",\r\n \"values\": [\r\n \"US Dollar (USD)\"\r\n ]\r\n }\r\n ],\r\n \"ruleSetActions\": [\r\n {\r\n \"attribute\": \"Workflow\",\r\n \"operator\": \"Is Set To\",\r\n \"values\": [\r\n \"Default\"\r\n ]\r\n }\r\n ],\r\n \"sequence\": 1\r\n }\r\n ]\r\n}"},"url":"{{Host}}/rest/RuleService/v1/rules/Collection","description":"This API is used to create a rule for collection entry. This will be define the criteria to enter into the collection/dunning process.
\n","urlObject":{"path":["rest","RuleService","v1","rules","Collection"],"host":["{{Host}}"],"query":[],"variable":[]}},"response":[{"id":"5a7a6439-8a1c-4624-ba8b-4212b4e8a62b","name":"Create Collection Entry Criteria Rule","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"contextName\": \"Collection\",\r\n \"ruleCategory\": 1,\r\n \"ruleSets\": [\r\n {\r\n \"ruleSetConditions\": [\r\n {\r\n \"property\": \"Subscriber\",\r\n \"attribute\": \"Total Due Amount\",\r\n \"operator\": \"Between\",\r\n \"values\": [\r\n \"10\",\r\n \"50\"\r\n ]\r\n },\r\n {\r\n \"property\": \"Subscriber\",\r\n \"attribute\": \"Billing Profile Status\",\r\n \"operator\": \"Equal To\",\r\n \"values\": [\r\n \"Active\"\r\n ]\r\n },\r\n {\r\n \"property\": \"Subscriber\",\r\n \"attribute\": \"Primary Currency\",\r\n \"operator\": \"Equal To\",\r\n \"values\": [\r\n \"US Dollar (USD)\"\r\n ]\r\n }\r\n ],\r\n \"ruleSetActions\": [\r\n {\r\n \"attribute\": \"Workflow\",\r\n \"operator\": \"Is Set To\",\r\n \"values\": [\r\n \"Default\"\r\n ]\r\n }\r\n ],\r\n \"sequence\": 1\r\n }\r\n ]\r\n}"},"url":"{{Host}}/rest/RuleService/v1/rules/Collection"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 20 Sep 2023 11:16:41 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"54"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"*, Content-Type, Pragma, Origin, Authorization, party, X-XSRF-TOKEN, X-Requested-With,Access-Control-Allow-Headers,Accept,Access-Control-Allow-Credentials,X-Auth-Token, version, cache"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST,OPTIONS,PUT,DELETE,GET"}],"cookie":[],"responseTime":null,"body":"{\n \"ruleName\": \"Collection_Entry_Criteria\",\n \"status\": \"OK\"\n}"}],"_postman_id":"86b5981e-9f34-44eb-bc76-14138db2973a"},{"name":"Update Collection Entry Criteria Rule","id":"d2c5d547-1ffa-4778-9e62-dba2e0e74950","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"PUT","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"contextName\": \"Collection\",\r\n \"ruleCategory\": 1,\r\n \"ruleSets\": [\r\n {\r\n \"id\": \"1\",\r\n \"ruleSetConditions\": [\r\n {\r\n \"id\": \"1\",\r\n \"property\": \"Subscriber\",\r\n \"attribute\": \"Total Due Amount\",\r\n \"operator\": \"Between\",\r\n \"values\": [\r\n \"20\",\r\n \"100\"\r\n ]\r\n },\r\n {\r\n \"id\": \"2\",\r\n \"property\": \"Subscriber\",\r\n \"attribute\": \"Billing Profile Status\",\r\n \"operator\": \"Equal To\",\r\n \"values\": [\r\n \"Active\"\r\n ]\r\n },\r\n {\r\n \"id\": \"3\",\r\n \"property\": \"Subscriber\",\r\n \"attribute\": \"Primary Currency\",\r\n \"operator\": \"Equal To\",\r\n \"values\": [\r\n \"Indian Rupee (INR)\"\r\n ]\r\n }\r\n ],\r\n \"ruleSetActions\": [\r\n {\r\n \"id\": \"1\",\r\n \"attribute\": \"Workflow\",\r\n \"operator\": \"Is Set To\",\r\n \"values\": [\r\n \"Default\"\r\n ]\r\n }\r\n ],\r\n \"sequence\": 1\r\n }\r\n ]\r\n}"},"url":"{{Host}}/rest/RuleService/v1/rules/Collection/Collection_Entry_Criteria","description":"This API is used to modify a rule for collection entry. This will help to update the existing collection entry criteria rule.
\n","urlObject":{"path":["rest","RuleService","v1","rules","Collection","Collection_Entry_Criteria"],"host":["{{Host}}"],"query":[],"variable":[]}},"response":[{"id":"0a4e0a75-06cb-4a4d-99c1-b0619160a48c","name":"Update Collection Entry Criteria Rule","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"contextName\": \"Collection\",\r\n \"ruleCategory\": 1,\r\n \"ruleSets\": [\r\n {\r\n \"id\": \"1\",\r\n \"ruleSetConditions\": [\r\n {\r\n \"id\": \"1\",\r\n \"property\": \"Subscriber\",\r\n \"attribute\": \"Total Due Amount\",\r\n \"operator\": \"Between\",\r\n \"values\": [\r\n \"20\",\r\n \"100\"\r\n ]\r\n },\r\n {\r\n \"id\": \"2\",\r\n \"property\": \"Subscriber\",\r\n \"attribute\": \"Billing Profile Status\",\r\n \"operator\": \"Equal To\",\r\n \"values\": [\r\n \"Active\"\r\n ]\r\n },\r\n {\r\n \"id\": \"3\",\r\n \"property\": \"Subscriber\",\r\n \"attribute\": \"Primary Currency\",\r\n \"operator\": \"Equal To\",\r\n \"values\": [\r\n \"Indian Rupee (INR)\"\r\n ]\r\n }\r\n ],\r\n \"ruleSetActions\": [\r\n {\r\n \"id\": \"1\",\r\n \"attribute\": \"Workflow\",\r\n \"operator\": \"Is Set To\",\r\n \"values\": [\r\n \"Default\"\r\n ]\r\n }\r\n ],\r\n \"sequence\": 1\r\n }\r\n ]\r\n}"},"url":"{{Host}}/rest/RuleService/v1/rules/Collection/Collection_Entry_Criteria"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 20 Sep 2023 11:21:36 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"54"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"*, Content-Type, Pragma, Origin, Authorization, party, X-XSRF-TOKEN, X-Requested-With,Access-Control-Allow-Headers,Accept,Access-Control-Allow-Credentials,X-Auth-Token, version, cache"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST,OPTIONS,PUT,DELETE,GET"}],"cookie":[],"responseTime":null,"body":"{\n \"ruleName\": \"Collection_Entry_Criteria\",\n \"status\": \"OK\"\n}"}],"_postman_id":"d2c5d547-1ffa-4778-9e62-dba2e0e74950"},{"name":"Get Collection Entry Criteria Rule","id":"6f19d22b-75dc-48e7-853b-a0d22abb3de3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"}],"url":"{{Host}}/rest/RuleService/v1/rules/Collection/Collection_Entry_Criteria","description":"This API is used to fetch the details for collection entry criteria rule. This will fetch the list of rules.
\n","urlObject":{"path":["rest","RuleService","v1","rules","Collection","Collection_Entry_Criteria"],"host":["{{Host}}"],"query":[],"variable":[]}},"response":[{"id":"a9dfd9f8-114b-4727-ac6c-84d7b1200a0c","name":"Get Collection Entry Criteria Rule","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"}],"url":"{{Host}}/rest/RuleService/v1/rules/Collection/Collection_Entry_Criteria"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 20 Sep 2023 11:23:57 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"874"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"*, Content-Type, Pragma, Origin, Authorization, party, X-XSRF-TOKEN, X-Requested-With,Access-Control-Allow-Headers,Accept,Access-Control-Allow-Credentials,X-Auth-Token, version, cache"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST,OPTIONS,PUT,DELETE,GET"}],"cookie":[],"responseTime":null,"body":"{\n \"ruleInfo\": {\n \"ruleName\": \"Collection_Entry_Criteria\",\n \"contextName\": \"Collection\",\n \"ruleCategory\": 1,\n \"ruleSets\": [\n {\n \"id\": \"1\",\n \"ruleSetConditions\": [\n {\n \"id\": \"1\",\n \"property\": \"Subscriber\",\n \"attribute\": \"Total Due Amount\",\n \"operator\": \"Between\",\n \"values\": [\n \"20\",\n \"100\"\n ],\n \"dataType\": \"BigDecimal\",\n \"inputFieldType\": 1\n },\n {\n \"id\": \"2\",\n \"property\": \"Subscriber\",\n \"attribute\": \"Billing Profile Status\",\n \"operator\": \"Equal To\",\n \"values\": [\n \"Active\"\n ],\n \"dataType\": \"String\",\n \"inputFieldType\": 2\n },\n {\n \"id\": \"3\",\n \"property\": \"Subscriber\",\n \"attribute\": \"Primary Currency\",\n \"operator\": \"Equal To\",\n \"values\": [\n \"Indian Rupee (INR)\"\n ],\n \"dataType\": \"String\",\n \"inputFieldType\": 2\n }\n ],\n \"ruleSetActions\": [\n {\n \"id\": \"1\",\n \"attribute\": \"Workflow\",\n \"operator\": \"Is Set To\",\n \"values\": [\n \"Default\"\n ],\n \"dataType\": \"String\",\n \"inputFieldType\": 1,\n \"isMandatoryAction\": true\n }\n ],\n \"isDefaultRuleSet\": false,\n \"sequence\": 1\n }\n ],\n \"isDefaultRuleSetDisabled\": false,\n \"isRetailRule\": false\n },\n \"status\": \"OK\"\n}"}],"_postman_id":"6f19d22b-75dc-48e7-853b-a0d22abb3de3"},{"name":"Delete Collection Entry Criteria Rule","id":"84cdb0ee-a0f7-4608-ab92-aaa68c6ac6c6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"DELETE","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"}],"url":"{{Host}}/rest/RuleService/v1/rules/Collection/Collection_Entry_Criteria","description":"This API is used to delete the collection entry criteria rule. This process cannot be undo.
\n","urlObject":{"path":["rest","RuleService","v1","rules","Collection","Collection_Entry_Criteria"],"host":["{{Host}}"],"query":[],"variable":[]}},"response":[{"id":"b3ff930b-3202-4208-a0a0-c28a4907863b","name":"Delete Collection Entry Criteria Rule","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"}],"url":"{{Host}}/rest/RuleService/v1/rules/Collection/Collection_Entry_Criteria"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 20 Sep 2023 11:27:07 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"15"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"*, Content-Type, Pragma, Origin, Authorization, party, X-XSRF-TOKEN, X-Requested-With,Access-Control-Allow-Headers,Accept,Access-Control-Allow-Credentials,X-Auth-Token, version, cache"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST,OPTIONS,PUT,DELETE,GET"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"OK\"\n}"}],"_postman_id":"84cdb0ee-a0f7-4608-ab92-aaa68c6ac6c6"}],"id":"078b33aa-5f68-42e7-a88f-6dd8cdc6e211","description":"In this section, will discuss about the collection entery criteria rule and their operations such as creating, modifying, fetching and deleting. Refer to the APIs below for more information.
\n","_postman_id":"078b33aa-5f68-42e7-a88f-6dd8cdc6e211"},{"name":"Collection Exit Criteria Rule","item":[{"name":"Collection Exit Criteria Rule","id":"5712cbe1-9baf-4bb0-b7c0-19be76a562f2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"contextName\": \"CollectionExit\",\r\n \"ruleCategory\": 1,\r\n \"ruleSets\": [\r\n {\r\n \"ruleSetConditions\": [\r\n {\r\n \"property\": \"Subscriber\",\r\n \"attribute\": \"Total Due Amount\",\r\n \"operator\": \"Between\",\r\n \"values\": [\r\n \"10\",\r\n \"50\"\r\n ]\r\n },\r\n {\r\n \"property\": \"Subscriber\",\r\n \"attribute\": \"Billing Profile Status\",\r\n \"operator\": \"Equal To\",\r\n \"values\": [\r\n \"Active\"\r\n ]\r\n },\r\n {\r\n \"property\": \"Subscriber\",\r\n \"attribute\": \"Primary Currency\",\r\n \"operator\": \"Equal To\",\r\n \"values\": [\r\n \"US Dollar (USD)\"\r\n ]\r\n }\r\n ],\r\n \"ruleSetActions\": [\r\n {\r\n \"attribute\": \"Workflow\",\r\n \"operator\": \"Is Set To\",\r\n \"values\": [\r\n \"Default\"\r\n ]\r\n }\r\n ],\r\n \"sequence\": 1\r\n }\r\n ]\r\n}"},"url":"{{Host}}/rest/RuleService/v1/rules/CollectionExit","description":"This API is used to create a collection exit criteria rule. Refer to the request below to create a collection exit criteria.
\n","urlObject":{"path":["rest","RuleService","v1","rules","CollectionExit"],"host":["{{Host}}"],"query":[],"variable":[]}},"response":[{"id":"93a2ea60-215c-4a32-8394-e074b58be395","name":"Create Collection Exit Criteria Rule","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"contextName\": \"CollectionExit\",\r\n \"ruleCategory\": 1,\r\n \"ruleSets\": [\r\n {\r\n \"ruleSetConditions\": [\r\n {\r\n \"property\": \"Subscriber\",\r\n \"attribute\": \"Total Due Amount\",\r\n \"operator\": \"Between\",\r\n \"values\": [\r\n \"10\",\r\n \"50\"\r\n ]\r\n },\r\n {\r\n \"property\": \"Subscriber\",\r\n \"attribute\": \"Billing Profile Status\",\r\n \"operator\": \"Equal To\",\r\n \"values\": [\r\n \"Active\"\r\n ]\r\n },\r\n {\r\n \"property\": \"Subscriber\",\r\n \"attribute\": \"Primary Currency\",\r\n \"operator\": \"Equal To\",\r\n \"values\": [\r\n \"US Dollar (USD)\"\r\n ]\r\n }\r\n ],\r\n \"ruleSetActions\": [\r\n {\r\n \"attribute\": \"Workflow\",\r\n \"operator\": \"Is Set To\",\r\n \"values\": [\r\n \"Default\"\r\n ]\r\n }\r\n ],\r\n \"sequence\": 1\r\n }\r\n ]\r\n}"},"url":"{{Host}}/rest/RuleService/v1/rules/CollectionExit"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 20 Sep 2023 11:33:59 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"53"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"*, Content-Type, Pragma, Origin, Authorization, party, X-XSRF-TOKEN, X-Requested-With,Access-Control-Allow-Headers,Accept,Access-Control-Allow-Credentials,X-Auth-Token, version, cache"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST,OPTIONS,PUT,DELETE,GET"}],"cookie":[],"responseTime":null,"body":"{\n \"ruleName\": \"Collection_Exit_Criteria\",\n \"status\": \"OK\"\n}"}],"_postman_id":"5712cbe1-9baf-4bb0-b7c0-19be76a562f2"},{"name":"Update the Collection Exit Criteria Rule","id":"b08b1f9a-d8c8-481d-8e0a-06581fd99d27","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"PUT","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"contextName\": \"CollectionExit\",\r\n \"ruleCategory\": 1,\r\n \"ruleSets\": [\r\n {\r\n \"id\": \"1\",\r\n \"ruleSetConditions\": [\r\n {\r\n \"id\": \"1\",\r\n \"property\": \"Subscriber\",\r\n \"attribute\": \"Total Due Amount\",\r\n \"operator\": \"Between\",\r\n \"values\": [\r\n \"20\",\r\n \"100\"\r\n ]\r\n },\r\n {\r\n \"id\": \"2\",\r\n \"property\": \"Subscriber\",\r\n \"attribute\": \"Billing Profile Status\",\r\n \"operator\": \"Equal To\",\r\n \"values\": [\r\n \"Active\"\r\n ]\r\n }\r\n ],\r\n \"ruleSetActions\": [\r\n {\r\n \"id\": \"1\",\r\n \"attribute\": \"Workflow\",\r\n \"operator\": \"Is Set To\",\r\n \"values\": [\r\n \"Default\"\r\n ]\r\n }\r\n ],\r\n \"sequence\": 1\r\n }\r\n ]\r\n}"},"url":"{{Host}}/RuleService/v1/rules/CollectionExit/Collection_Exit_Criteria","description":"This API is used to update the collection exit criteria rule. This will be helpful to modify the existing collection exit criteria rule.
\n","urlObject":{"path":["RuleService","v1","rules","CollectionExit","Collection_Exit_Criteria"],"host":["{{Host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"b08b1f9a-d8c8-481d-8e0a-06581fd99d27"},{"name":"Get Collection Exit Criteria Rule","id":"3212f8b5-d13a-443b-bc95-81adf2d9f480","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"}],"url":"{{Host}}/rest/RuleService/v1/rules/CollectionExit/Collection_Exit_Criteria","description":"This API is used to fetch the list of collection exit criteria rule present in the application.
\n","urlObject":{"path":["rest","RuleService","v1","rules","CollectionExit","Collection_Exit_Criteria"],"host":["{{Host}}"],"query":[],"variable":[]}},"response":[{"id":"fd4b399f-d82f-4288-ac2e-8b59cf3049b2","name":"Get Collection Exit Criteria Rule","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"}],"url":"{{Host}}/rest/RuleService/v1/rules/CollectionExit/Collection_Exit_Criteria"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Thu, 21 Sep 2023 07:25:14 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"873"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"*, Content-Type, Pragma, Origin, Authorization, party, X-XSRF-TOKEN, X-Requested-With,Access-Control-Allow-Headers,Accept,Access-Control-Allow-Credentials,X-Auth-Token, version, cache"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST,OPTIONS,PUT,DELETE,GET"}],"cookie":[],"responseTime":null,"body":"{\n \"ruleInfo\": {\n \"ruleName\": \"Collection_Exit_Criteria\",\n \"contextName\": \"CollectionExit\",\n \"ruleCategory\": 1,\n \"ruleSets\": [\n {\n \"id\": \"1\",\n \"ruleSetConditions\": [\n {\n \"id\": \"1\",\n \"property\": \"Subscriber\",\n \"attribute\": \"Total Due Amount\",\n \"operator\": \"Between\",\n \"values\": [\n \"10\",\n \"50\"\n ],\n \"dataType\": \"BigDecimal\",\n \"inputFieldType\": 1\n },\n {\n \"id\": \"2\",\n \"property\": \"Subscriber\",\n \"attribute\": \"Billing Profile Status\",\n \"operator\": \"Equal To\",\n \"values\": [\n \"Active\"\n ],\n \"dataType\": \"String\",\n \"inputFieldType\": 2\n },\n {\n \"id\": \"3\",\n \"property\": \"Subscriber\",\n \"attribute\": \"Primary Currency\",\n \"operator\": \"Equal To\",\n \"values\": [\n \"US Dollar (USD)\"\n ],\n \"dataType\": \"String\",\n \"inputFieldType\": 2\n }\n ],\n \"ruleSetActions\": [\n {\n \"id\": \"1\",\n \"attribute\": \"Workflow\",\n \"operator\": \"Is Set To\",\n \"values\": [\n \"Default\"\n ],\n \"dataType\": \"String\",\n \"inputFieldType\": 1,\n \"isMandatoryAction\": true\n }\n ],\n \"isDefaultRuleSet\": false,\n \"sequence\": 1\n }\n ],\n \"isDefaultRuleSetDisabled\": false,\n \"isRetailRule\": false\n },\n \"status\": \"OK\"\n}"}],"_postman_id":"3212f8b5-d13a-443b-bc95-81adf2d9f480"},{"name":"Delete Collection Exit Criteria Rule","id":"8bdfdb90-10f2-4f8b-a1bc-e1f9718876eb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"DELETE","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"}],"url":"{{Host}}/rest/RuleService/v1/rules/CollectionExit/Collection_Exit_Criteria","description":"This API is used to delete the collection exit criteria rule, this will remove the rule from the application.
\n","urlObject":{"path":["rest","RuleService","v1","rules","CollectionExit","Collection_Exit_Criteria"],"host":["{{Host}}"],"query":[],"variable":[]}},"response":[{"id":"5d3953f4-ff25-434e-b204-fe84bcee41cd","name":"Delete Collection Exit Criteria Rule","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"}],"url":"{{Host}}/rest/RuleService/v1/rules/CollectionExit/Collection_Exit_Criteria"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Thu, 21 Sep 2023 07:20:58 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"15"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"*, Content-Type, Pragma, Origin, Authorization, party, X-XSRF-TOKEN, X-Requested-With,Access-Control-Allow-Headers,Accept,Access-Control-Allow-Credentials,X-Auth-Token, version, cache"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST,OPTIONS,PUT,DELETE,GET"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"OK\"\n}"}],"_postman_id":"8bdfdb90-10f2-4f8b-a1bc-e1f9718876eb"}],"id":"3d61285d-e673-499b-a55b-1d8ee25c9a1d","description":"In this section will discuss about the collection exit rule and there operations such as creating, updating, fetching data and deleting.
\n","_postman_id":"3d61285d-e673-499b-a55b-1d8ee25c9a1d"},{"name":"Payment Fee Rule","item":[{"name":"Payment Fee Rule","id":"44d667e8-3bd4-4e4d-9bd6-58d2e1903a4d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"contextName\": \"Payment\",\r\n \"ruleCategory\": 1,\r\n \"ruleSets\": [\r\n {\r\n \"ruleSetConditions\": [\r\n {\r\n \"property\": \"Payment\",\r\n \"attribute\": \"Payment Amount\",\r\n \"operator\": \"Between\",\r\n \"values\": [\r\n \"10\",\r\n \"30\"\r\n ]\r\n },\r\n {\r\n \"property\": \"Payment\",\r\n \"attribute\": \"Payment Date\",\r\n \"operator\": \"Between\",\r\n \"values\": [\r\n \"12/01/2022\",\r\n \"12/02/2022\"\r\n ]\r\n },\r\n {\r\n \"property\": \"Payment\",\r\n \"attribute\": \"Payment Type\",\r\n \"operator\": \"Equal To\",\r\n \"values\": [\r\n \"CC\"\r\n ]\r\n },\r\n {\r\n \"property\": \"Subscriber\",\r\n \"attribute\": \"Account Number\",\r\n \"operator\": \"Equal To\",\r\n \"values\": [\r\n \"SR1234\"\r\n ]\r\n },\r\n {\r\n \"property\": \"Subscriber\",\r\n \"attribute\": \"Primary Currency\",\r\n \"operator\": \"Equal To\",\r\n \"values\": [\r\n \"US Dollar (USD)\"\r\n ]\r\n }\r\n ],\r\n \"ruleSetActions\": [\r\n {\r\n \"attribute\": \"Fixed Payment Amount\",\r\n \"operator\": \"Is Set To\",\r\n \"values\": [\r\n \"10\"\r\n ]\r\n },\r\n {\r\n \"attribute\": \"Percentage of Payment Amount\",\r\n \"operator\": \"Is Set To\",\r\n \"values\": [\r\n \"10\"\r\n ]\r\n }\r\n ],\r\n \"sequence\": 1\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{Host}}/rest/RuleService/v1/rules/Payment","description":"This API is used to create a payment fee rule in the application, this will help to create the payment below using the below example.
\n","urlObject":{"path":["rest","RuleService","v1","rules","Payment"],"host":["{{Host}}"],"query":[],"variable":[]}},"response":[{"id":"c2203e6f-256e-4600-ba78-99ef70139a18","name":"Create Payment Fee Rule","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"contextName\": \"Payment\",\r\n \"ruleCategory\": 1,\r\n \"ruleSets\": [\r\n {\r\n \"ruleSetConditions\": [\r\n {\r\n \"property\": \"Payment\",\r\n \"attribute\": \"Payment Amount\",\r\n \"operator\": \"Between\",\r\n \"values\": [\r\n \"10\",\r\n \"30\"\r\n ]\r\n },\r\n {\r\n \"property\": \"Payment\",\r\n \"attribute\": \"Payment Date\",\r\n \"operator\": \"Between\",\r\n \"values\": [\r\n \"12/01/2022\",\r\n \"12/02/2022\"\r\n ]\r\n },\r\n {\r\n \"property\": \"Payment\",\r\n \"attribute\": \"Payment Type\",\r\n \"operator\": \"Equal To\",\r\n \"values\": [\r\n \"CC\"\r\n ]\r\n },\r\n {\r\n \"property\": \"Subscriber\",\r\n \"attribute\": \"Account Number\",\r\n \"operator\": \"Equal To\",\r\n \"values\": [\r\n \"SR1234\"\r\n ]\r\n },\r\n {\r\n \"property\": \"Subscriber\",\r\n \"attribute\": \"Primary Currency\",\r\n \"operator\": \"Equal To\",\r\n \"values\": [\r\n \"US Dollar (USD)\"\r\n ]\r\n }\r\n ],\r\n \"ruleSetActions\": [\r\n {\r\n \"attribute\": \"Fixed Payment Amount\",\r\n \"operator\": \"Is Set To\",\r\n \"values\": [\r\n \"10\"\r\n ]\r\n },\r\n {\r\n \"attribute\": \"Percentage of Payment Amount\",\r\n \"operator\": \"Is Set To\",\r\n \"values\": [\r\n \"10\"\r\n ]\r\n }\r\n ],\r\n \"sequence\": 1\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{Host}}/rest/RuleService/v1/rules/Payment"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Thu, 21 Sep 2023 07:39:58 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"40"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"*, Content-Type, Pragma, Origin, Authorization, party, X-XSRF-TOKEN, X-Requested-With,Access-Control-Allow-Headers,Accept,Access-Control-Allow-Credentials,X-Auth-Token, version, cache"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST,OPTIONS,PUT,DELETE,GET"}],"cookie":[],"responseTime":null,"body":"{\n \"ruleName\": \"Payment_Fee\",\n \"status\": \"OK\"\n}"}],"_postman_id":"44d667e8-3bd4-4e4d-9bd6-58d2e1903a4d"},{"name":"Update the Payment Fee Rule","id":"21dfacfd-f81e-40cd-a80c-581ae0cb9335","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"PUT","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"contextName\": \"Payment\",\r\n \"ruleName\": \"Payment_Fee\",\r\n \"ruleCategory\": 1,\r\n \"ruleSets\": [\r\n {\r\n \"id\": \"1\",\r\n \"ruleSetConditions\": [\r\n {\r\n \"id\": \"1\",\r\n \"property\": \"Payment\",\r\n \"attribute\": \"Payment Amount\",\r\n \"operator\": \"Between\",\r\n \"values\": [\r\n \"30\",\r\n \"60\"\r\n ]\r\n },\r\n {\r\n \"id\": \"3\",\r\n \"property\": \"Payment\",\r\n \"attribute\": \"Payment Type\",\r\n \"operator\": \"Equal To\",\r\n \"values\": [\r\n \"CC\"\r\n ]\r\n },\r\n {\r\n \"id\": \"4\",\r\n \"property\": \"Subscriber\",\r\n \"attribute\": \"Account Number\",\r\n \"operator\": \"Equal To\",\r\n \"values\": [\r\n \"SR1101\"\r\n ]\r\n },\r\n {\r\n \"id\": \"5\",\r\n \"property\": \"Subscriber\",\r\n \"attribute\": \"Primary Currency\",\r\n \"operator\": \"Equal To\",\r\n \"values\": [\r\n \"Indian Rupee (INR)\"\r\n ]\r\n }\r\n ],\r\n \"ruleSetActions\": [\r\n {\r\n \"id\": \"1\",\r\n \"attribute\": \"Fixed Payment Amount\",\r\n \"operator\": \"Is Set To\",\r\n \"values\": [\r\n \"30\"\r\n ]\r\n },\r\n {\r\n \"id\": \"2\",\r\n \"attribute\": \"Percentage of Payment Amount\",\r\n \"operator\": \"Is Set To\",\r\n \"values\": [\r\n \"10\"\r\n ]\r\n }\r\n ],\r\n \"sequence\": 1\r\n }\r\n ]\r\n}"},"url":"{{Host}}/rest/RuleService/v1/rules/Payment/Payment_Fee","description":"This API is used to update the details of existing payment fee rule in the application.
\n","urlObject":{"path":["rest","RuleService","v1","rules","Payment","Payment_Fee"],"host":["{{Host}}"],"query":[],"variable":[]}},"response":[{"id":"1fa9bc8a-00ea-4112-b1d1-50da1b69c516","name":"Update the Payment Fee Rule","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"contextName\": \"Payment\",\r\n \"ruleName\": \"Payment_Fee\",\r\n \"ruleCategory\": 1,\r\n \"ruleSets\": [\r\n {\r\n \"id\": \"1\",\r\n \"ruleSetConditions\": [\r\n {\r\n \"id\": \"1\",\r\n \"property\": \"Payment\",\r\n \"attribute\": \"Payment Amount\",\r\n \"operator\": \"Between\",\r\n \"values\": [\r\n \"30\",\r\n \"60\"\r\n ]\r\n },\r\n {\r\n \"id\": \"3\",\r\n \"property\": \"Payment\",\r\n \"attribute\": \"Payment Type\",\r\n \"operator\": \"Equal To\",\r\n \"values\": [\r\n \"CC\"\r\n ]\r\n },\r\n {\r\n \"id\": \"4\",\r\n \"property\": \"Subscriber\",\r\n \"attribute\": \"Account Number\",\r\n \"operator\": \"Equal To\",\r\n \"values\": [\r\n \"SR1101\"\r\n ]\r\n },\r\n {\r\n \"id\": \"5\",\r\n \"property\": \"Subscriber\",\r\n \"attribute\": \"Primary Currency\",\r\n \"operator\": \"Equal To\",\r\n \"values\": [\r\n \"Indian Rupee (INR)\"\r\n ]\r\n }\r\n ],\r\n \"ruleSetActions\": [\r\n {\r\n \"id\": \"1\",\r\n \"attribute\": \"Fixed Payment Amount\",\r\n \"operator\": \"Is Set To\",\r\n \"values\": [\r\n \"30\"\r\n ]\r\n },\r\n {\r\n \"id\": \"2\",\r\n \"attribute\": \"Percentage of Payment Amount\",\r\n \"operator\": \"Is Set To\",\r\n \"values\": [\r\n \"10\"\r\n ]\r\n }\r\n ],\r\n \"sequence\": 1\r\n }\r\n ]\r\n}"},"url":"{{Host}}/rest/RuleService/v1/rules/Payment/Payment_Fee"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Thu, 21 Sep 2023 07:41:53 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"40"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"*, Content-Type, Pragma, Origin, Authorization, party, X-XSRF-TOKEN, X-Requested-With,Access-Control-Allow-Headers,Accept,Access-Control-Allow-Credentials,X-Auth-Token, version, cache"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST,OPTIONS,PUT,DELETE,GET"}],"cookie":[],"responseTime":null,"body":"{\n \"ruleName\": \"Payment_Fee\",\n \"status\": \"OK\"\n}"}],"_postman_id":"21dfacfd-f81e-40cd-a80c-581ae0cb9335"},{"name":"Get the Payment Fee Rule","id":"e421bf3b-f952-42d2-8200-c161a2765d3c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"}],"url":"{{Host}}/rest/RuleService/v1/rules/Payment/Payment_Fee","description":"This API is used to create payment fee rule in the application. A request is added below for your reference.
\n","urlObject":{"path":["rest","RuleService","v1","rules","Payment","Payment_Fee"],"host":["{{Host}}"],"query":[],"variable":[]}},"response":[{"id":"5bee9eae-d7a4-4c18-bfe2-a63fa2bda9dc","name":"Get the Payment Fee Rules","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"}],"url":"{{Host}}/rest/RuleService/v1/rules/Payment/Payment_Fee"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Thu, 21 Sep 2023 07:47:19 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"1153"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"*, Content-Type, Pragma, Origin, Authorization, party, X-XSRF-TOKEN, X-Requested-With,Access-Control-Allow-Headers,Accept,Access-Control-Allow-Credentials,X-Auth-Token, version, cache"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST,OPTIONS,PUT,DELETE,GET"}],"cookie":[],"responseTime":null,"body":"{\n \"ruleInfo\": {\n \"ruleName\": \"Payment_Fee\",\n \"contextName\": \"Payment\",\n \"ruleCategory\": 1,\n \"ruleSets\": [\n {\n \"id\": \"1\",\n \"ruleSetConditions\": [\n {\n \"id\": \"1\",\n \"property\": \"Payment\",\n \"attribute\": \"Payment Amount\",\n \"operator\": \"Between\",\n \"values\": [\n \"30\",\n \"60\"\n ],\n \"dataType\": \"BigDecimal\",\n \"inputFieldType\": 1\n },\n {\n \"id\": \"2\",\n \"property\": \"Payment\",\n \"attribute\": \"Payment Type\",\n \"operator\": \"Equal To\",\n \"values\": [\n \"CC\"\n ],\n \"dataType\": \"String\",\n \"inputFieldType\": 1\n },\n {\n \"id\": \"3\",\n \"property\": \"Subscriber\",\n \"attribute\": \"Account Number\",\n \"operator\": \"Equal To\",\n \"values\": [\n \"SR1101\"\n ],\n \"dataType\": \"String\",\n \"inputFieldType\": 2\n },\n {\n \"id\": \"4\",\n \"property\": \"Subscriber\",\n \"attribute\": \"Primary Currency\",\n \"operator\": \"Equal To\",\n \"values\": [\n \"Indian Rupee (INR)\"\n ],\n \"dataType\": \"String\",\n \"inputFieldType\": 2\n }\n ],\n \"ruleSetActions\": [\n {\n \"id\": \"1\",\n \"attribute\": \"Fixed Payment Amount\",\n \"operator\": \"Is Set To\",\n \"values\": [\n \"30\"\n ],\n \"dataType\": \"BigDecimal\",\n \"inputFieldType\": 1,\n \"isMandatoryAction\": false\n },\n {\n \"id\": \"2\",\n \"attribute\": \"Percentage of Payment Amount\",\n \"operator\": \"Is Set To\",\n \"values\": [\n \"10\"\n ],\n \"dataType\": \"BigDecimal\",\n \"inputFieldType\": 1,\n \"isMandatoryAction\": false\n }\n ],\n \"isDefaultRuleSet\": false,\n \"sequence\": 1\n }\n ],\n \"isDefaultRuleSetDisabled\": false,\n \"isRetailRule\": false\n },\n \"status\": \"OK\"\n}"}],"_postman_id":"e421bf3b-f952-42d2-8200-c161a2765d3c"},{"name":"Delete Payment Fee Rule","id":"d909be78-c813-4595-84fa-033de086dcc3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"DELETE","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"}],"url":"{{Host}}/rest/RuleService/v1/rules/Payment/Payment_Fee","description":"This API is used to delete the payment fee rule in the application. This will help to remove the payment fee rule in the application.
\n","urlObject":{"path":["rest","RuleService","v1","rules","Payment","Payment_Fee"],"host":["{{Host}}"],"query":[],"variable":[]}},"response":[{"id":"6febd466-5978-4fe8-a7a3-477f7bd8d058","name":"Delete Payment Fee Rule","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"}],"url":"{{Host}}/rest/RuleService/v1/rules/Payment/Payment_Fee"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Thu, 21 Sep 2023 07:56:31 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"15"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"*, Content-Type, Pragma, Origin, Authorization, party, X-XSRF-TOKEN, X-Requested-With,Access-Control-Allow-Headers,Accept,Access-Control-Allow-Credentials,X-Auth-Token, version, cache"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST,OPTIONS,PUT,DELETE,GET"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"OK\"\n}"}],"_postman_id":"d909be78-c813-4595-84fa-033de086dcc3"}],"id":"220c7ee2-cc48-4546-86ef-f9593566a577","description":"In this section, will discuss about the payment fee rules and their operations such as creating, updating, modifying, and deleting.
\n","_postman_id":"220c7ee2-cc48-4546-86ef-f9593566a577"},{"name":"Bill Time Charge","item":[{"name":"Create a Bill Time Charge","id":"22e372b1-74f0-41a5-9a14-1cd5def3108a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"contextName\": \"BillCharge\",\r\n \"ruleName\": \"Bill_Time_Charge\",\r\n \"ruleCategory\": 1,\r\n \"ruleSets\": [\r\n {\r\n \"ruleSetConditions\": [\r\n {\r\n \"property\": \"Bill\",\r\n \"attribute\": \"Bill Amount\",\r\n \"operator\": \"Equal To\",\r\n \"values\": [\r\n \"100\"\r\n ]\r\n }\r\n ],\r\n \"ruleSetActions\": [\r\n {\r\n \"attribute\": \"Charge Description\",\r\n \"operator\": \"Is Set To\",\r\n \"values\": [\r\n \"low amount Fine\"\r\n ]\r\n },\r\n {\r\n \"attribute\": \"Fixed Charge\",\r\n \"operator\": \"Is Set To\",\r\n \"values\": [\r\n \"20\"\r\n ]\r\n }\r\n ],\r\n \"sequence\": 1\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{Host}}/rest/RuleService/v1/rules/BillCharge","description":"This API is used to create Bill time charge in the application. It will help you to apply additional charges to your subscribers.
\n","urlObject":{"path":["rest","RuleService","v1","rules","BillCharge"],"host":["{{Host}}"],"query":[],"variable":[]}},"response":[{"id":"39be625e-8690-4961-9c0e-125e10b184de","name":"Create a Bill Time Charge","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"contextName\": \"BillCharge\",\r\n \"ruleName\": \"Bill_Time_Charge\",\r\n \"ruleCategory\": 1,\r\n \"ruleSets\": [\r\n {\r\n \"ruleSetConditions\": [\r\n {\r\n \"property\": \"Bill\",\r\n \"attribute\": \"Bill Amount\",\r\n \"operator\": \"Equal To\",\r\n \"values\": [\r\n \"100\"\r\n ]\r\n }\r\n ],\r\n \"ruleSetActions\": [\r\n {\r\n \"attribute\": \"Charge Description\",\r\n \"operator\": \"Is Set To\",\r\n \"values\": [\r\n \"low amount Fine\"\r\n ]\r\n },\r\n {\r\n \"attribute\": \"Fixed Charge\",\r\n \"operator\": \"Is Set To\",\r\n \"values\": [\r\n \"20\"\r\n ]\r\n }\r\n ],\r\n \"sequence\": 1\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{Host}}/rest/RuleService/v1/rules/BillCharge"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Fri, 16 Feb 2024 11:27:36 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"45"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"*, Content-Type, Pragma, Origin, Authorization, party, X-XSRF-TOKEN, X-Requested-With,Access-Control-Allow-Headers,Accept,Access-Control-Allow-Credentials,X-Auth-Token, version, cache"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST,OPTIONS,PUT,DELETE,GET"}],"cookie":[],"responseTime":null,"body":"{\n \"ruleName\": \"Bill_Time_Charge\",\n \"status\": \"OK\"\n}\n"}],"_postman_id":"22e372b1-74f0-41a5-9a14-1cd5def3108a"},{"name":"Update the Bill time Charge","id":"cf14ebea-d05c-4192-bbe9-ad089d580ac4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"PUT","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"contextName\": \"BillCharge\",\r\n \"ruleName\": \"Bill_Time_Charge\",\r\n \"ruleCategory\": 1,\r\n \"ruleSets\": [\r\n {\r\n \"ruleSetConditions\": [\r\n {\r\n \"property\": \"Bill\",\r\n \"attribute\": \"Bill Amount\",\r\n \"operator\": \"Equal To\",\r\n \"values\": [\r\n \"100\"\r\n ]\r\n }\r\n ],\r\n \"ruleSetActions\": [\r\n {\r\n \"attribute\": \"Charge Description\",\r\n \"operator\": \"Is Set To\",\r\n \"values\": [\r\n \"low amount Fine\"\r\n ]\r\n },\r\n {\r\n \"attribute\": \"Fixed Charge\",\r\n \"operator\": \"Is Set To\",\r\n \"values\": [\r\n \"20\"\r\n ]\r\n }\r\n ],\r\n \"sequence\": 1\r\n }\r\n ]\r\n }","options":{"raw":{"language":"json"}}},"url":"{{Host}}/rest/RuleService/v1/rules/BillCharge/Bill_Time_Charge","description":"This API is used to update the details of your Bill time charge. It will modify the details of existing bill time charge.
\n","urlObject":{"path":["rest","RuleService","v1","rules","BillCharge","Bill_Time_Charge"],"host":["{{Host}}"],"query":[],"variable":[]}},"response":[{"id":"d1b4f499-dc20-4727-bbea-99b7b320010e","name":"Update the Bill time Charge","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"contextName\": \"BillCharge\",\r\n \"ruleName\": \"Bill_Time_Charge\",\r\n \"ruleCategory\": 1,\r\n \"ruleSets\": [\r\n {\r\n \"ruleSetConditions\": [\r\n {\r\n \"property\": \"Bill\",\r\n \"attribute\": \"Bill Amount\",\r\n \"operator\": \"Equal To\",\r\n \"values\": [\r\n \"100\"\r\n ]\r\n }\r\n ],\r\n \"ruleSetActions\": [\r\n {\r\n \"attribute\": \"Charge Description\",\r\n \"operator\": \"Is Set To\",\r\n \"values\": [\r\n \"low amount Fine\"\r\n ]\r\n },\r\n {\r\n \"attribute\": \"Fixed Charge\",\r\n \"operator\": \"Is Set To\",\r\n \"values\": [\r\n \"20\"\r\n ]\r\n }\r\n ],\r\n \"sequence\": 1\r\n }\r\n ]\r\n }","options":{"raw":{"language":"json"}}},"url":"{{Host}}/rest/RuleService/v1/rules/BillCharge/Bill_Time_Charge"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Fri, 16 Feb 2024 11:34:41 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"45"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"*, Content-Type, Pragma, Origin, Authorization, party, X-XSRF-TOKEN, X-Requested-With,Access-Control-Allow-Headers,Accept,Access-Control-Allow-Credentials,X-Auth-Token, version, cache"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST,OPTIONS,PUT,DELETE,GET"}],"cookie":[],"responseTime":null,"body":"{\n \"ruleName\": \"Bill_Time_Charge\",\n \"status\": \"OK\"\n}\n"}],"_postman_id":"cf14ebea-d05c-4192-bbe9-ad089d580ac4"},{"name":"Delete the Bill Time Charge","id":"feeffeff-b321-47c2-82ad-420e6c85e432","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"DELETE","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"}],"url":"{{Host}}/rest/RuleService/v1/rules/BillCharge/Bill_Time_Charge","description":"This API is used to delete the bill time charge available in the application. If it is deleted no additional charges will be applied.
\n","urlObject":{"path":["rest","RuleService","v1","rules","BillCharge","Bill_Time_Charge"],"host":["{{Host}}"],"query":[],"variable":[]}},"response":[{"id":"2c1ffda9-ff0f-4c95-899c-13b8d8ba5248","name":"Delete the Bill Time Charge","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"}],"url":"{{Host}}/rest/RuleService/v1/rules/BillCharge/Bill_Time_Charge"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Fri, 16 Feb 2024 11:27:19 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"15"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"*, Content-Type, Pragma, Origin, Authorization, party, X-XSRF-TOKEN, X-Requested-With,Access-Control-Allow-Headers,Accept,Access-Control-Allow-Credentials,X-Auth-Token, version, cache"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST,OPTIONS,PUT,DELETE,GET"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"OK\"\n}\n"}],"_postman_id":"feeffeff-b321-47c2-82ad-420e6c85e432"},{"name":"Get Bill Time Charge","id":"89309181-c09a-40ab-bca8-c37ae71dbecf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"}],"url":"{{Host}}/rest/RuleService/v1/rules/BillCharge/Bill_Time_Charge","description":"This API is used to fetch the details of the Bill time charge.
\n","urlObject":{"path":["rest","RuleService","v1","rules","BillCharge","Bill_Time_Charge"],"host":["{{Host}}"],"query":[],"variable":[]}},"response":[{"id":"d5f47558-abb1-4122-8fa1-52d54858c383","name":"Get Bill Time Charge","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"}],"url":"{{Host}}/rest/RuleService/v1/rules/BillCharge/Bill_Time_Charge"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Fri, 16 Feb 2024 11:36:33 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"702"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"*, Content-Type, Pragma, Origin, Authorization, party, X-XSRF-TOKEN, X-Requested-With,Access-Control-Allow-Headers,Accept,Access-Control-Allow-Credentials,X-Auth-Token, version, cache"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST,OPTIONS,PUT,DELETE,GET"}],"cookie":[],"responseTime":null,"body":"{\n \"ruleInfo\": {\n \"ruleName\": \"Bill_Time_Charge\",\n \"contextName\": \"BillCharge\",\n \"ruleCategory\": 1,\n \"ruleSets\": [\n {\n \"id\": \"1\",\n \"ruleSetConditions\": [\n {\n \"id\": \"1\",\n \"property\": \"Bill\",\n \"attribute\": \"Bill Amount\",\n \"operator\": \"Equal To\",\n \"values\": [\n \"100\"\n ],\n \"dataType\": \"BigDecimal\",\n \"inputFieldType\": 1\n }\n ],\n \"ruleSetActions\": [\n {\n \"id\": \"1\",\n \"attribute\": \"Charge Description\",\n \"operator\": \"Is Set To\",\n \"values\": [\n \"low amount Fine\"\n ],\n \"dataType\": \"String\",\n \"inputFieldType\": 1,\n \"isMandatoryAction\": true\n },\n {\n \"id\": \"2\",\n \"attribute\": \"Fixed Charge\",\n \"operator\": \"Is Set To\",\n \"values\": [\n \"20\"\n ],\n \"dataType\": \"BigDecimal\",\n \"inputFieldType\": 1,\n \"isMandatoryAction\": false\n }\n ],\n \"isDefaultRuleSet\": false,\n \"sequence\": 1\n }\n ],\n \"isDefaultRuleSetDisabled\": false,\n \"isRetailRule\": false\n },\n \"status\": \"OK\"\n}\n"}],"_postman_id":"89309181-c09a-40ab-bca8-c37ae71dbecf"}],"id":"b18b5882-9c4c-4941-8578-6ced1d0a4829","description":"In this section will discuss bill time charges, it will allow the businesses to collect additional charge from the subscribers.
\n","_postman_id":"b18b5882-9c4c-4941-8578-6ced1d0a4829"},{"name":"Bill Time Discount","item":[{"name":"Create a Bill Time Discount","id":"3ce789d8-adf8-46fe-8f63-c16f2384c67c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"contextName\": \"Bill\",\r\n \"ruleName\": \"BillTimeDiscount\",\r\n \"ruleCategory\": 1,\r\n \"ruleSets\": [\r\n {\r\n \"ruleSetConditions\": [\r\n {\r\n \"property\": \"Bill\",\r\n \"attribute\": \"Bill Amount\",\r\n \"operator\": \"Equal To\",\r\n \"values\": [\r\n 100\r\n ]\r\n }\r\n ],\r\n \"ruleSetActions\": [\r\n {\r\n \"attribute\": \"Discount Description\",\r\n \"operator\": \"Is Set To\",\r\n \"values\": [\r\n \"Bill Amount 100\"\r\n ]\r\n },\r\n {\r\n \"attribute\": \"Discount Percentage\",\r\n \"operator\": \"Is Set To\",\r\n \"values\": [\r\n 20\r\n ]\r\n }\r\n ],\r\n \"sequence\": 1\r\n }\r\n ]\r\n }","options":{"raw":{"language":"json"}}},"url":"{{Host}}/rest/RuleService/v1/rules/Bill","description":"This API is used to create bill time discount in the application. It will help you to apply discount for your subscriber invoices.
\n","urlObject":{"path":["rest","RuleService","v1","rules","Bill"],"host":["{{Host}}"],"query":[],"variable":[]}},"response":[{"id":"b63f2a8c-a698-4e57-80f3-a5ee6decc83e","name":"Create a Bill Time Discount","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"contextName\": \"Bill\",\r\n \"ruleName\": \"BillTimeDiscount\",\r\n \"ruleCategory\": 1,\r\n \"ruleSets\": [\r\n {\r\n \"ruleSetConditions\": [\r\n {\r\n \"property\": \"Bill\",\r\n \"attribute\": \"Bill Amount\",\r\n \"operator\": \"Equal To\",\r\n \"values\": [\r\n 100\r\n ]\r\n }\r\n ],\r\n \"ruleSetActions\": [\r\n {\r\n \"attribute\": \"Discount Description\",\r\n \"operator\": \"Is Set To\",\r\n \"values\": [\r\n \"Bill Amount 100\"\r\n ]\r\n },\r\n {\r\n \"attribute\": \"Discount Percentage\",\r\n \"operator\": \"Is Set To\",\r\n \"values\": [\r\n 20\r\n ]\r\n }\r\n ],\r\n \"sequence\": 1\r\n }\r\n ]\r\n }","options":{"raw":{"language":"json"}}},"url":"{{Host}}/rest/RuleService/v1/rules/Bill"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Fri, 16 Feb 2024 11:45:40 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"47"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"*, Content-Type, Pragma, Origin, Authorization, party, X-XSRF-TOKEN, X-Requested-With,Access-Control-Allow-Headers,Accept,Access-Control-Allow-Credentials,X-Auth-Token, version, cache"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST,OPTIONS,PUT,DELETE,GET"}],"cookie":[],"responseTime":null,"body":"{\n \"ruleName\": \"Bill_Time_Discount\",\n \"status\": \"OK\"\n}"}],"_postman_id":"3ce789d8-adf8-46fe-8f63-c16f2384c67c"},{"name":"Update Bill Time Discount","id":"624f54e3-28e8-4cd8-bd4f-6d9d51e0454d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"PUT","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"contextName\": \"Bill\",\r\n \"ruleName\": \"BillTimeDiscount\",\r\n \"ruleCategory\": 1,\r\n \"ruleSets\": [\r\n {\r\n \"ruleSetConditions\": [\r\n {\r\n \"property\": \"Bill\",\r\n \"attribute\": \"Bill Amount\",\r\n \"operator\": \"Equal To\",\r\n \"values\": [\r\n 100\r\n ]\r\n }\r\n ],\r\n \"ruleSetActions\": [\r\n {\r\n \"attribute\": \"Discount Description\",\r\n \"operator\": \"Is Set To\",\r\n \"values\": [\r\n \"Bill Amount 100\"\r\n ]\r\n },\r\n {\r\n \"attribute\": \"Discount Percentage\",\r\n \"operator\": \"Is Set To\",\r\n \"values\": [\r\n 20\r\n ]\r\n }\r\n ],\r\n \"sequence\": 1\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{Host}}/rest/RuleService/v1/rules/Bill/Bill_Time_Discount","description":"This API is used to update the details of your Bill time discount. It will modify the details of existing bill time discount.
\n","urlObject":{"path":["rest","RuleService","v1","rules","Bill","Bill_Time_Discount"],"host":["{{Host}}"],"query":[],"variable":[]}},"response":[{"id":"f07ca56c-29d4-43ea-957c-8ee4105a0f44","name":"Update Bill Time Discount","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"contextName\": \"Bill\",\r\n \"ruleName\": \"BillTimeDiscount\",\r\n \"ruleCategory\": 1,\r\n \"ruleSets\": [\r\n {\r\n \"ruleSetConditions\": [\r\n {\r\n \"property\": \"Bill\",\r\n \"attribute\": \"Bill Amount\",\r\n \"operator\": \"Equal To\",\r\n \"values\": [\r\n 100\r\n ]\r\n }\r\n ],\r\n \"ruleSetActions\": [\r\n {\r\n \"attribute\": \"Discount Description\",\r\n \"operator\": \"Is Set To\",\r\n \"values\": [\r\n \"Bill Amount 100\"\r\n ]\r\n },\r\n {\r\n \"attribute\": \"Discount Percentage\",\r\n \"operator\": \"Is Set To\",\r\n \"values\": [\r\n 20\r\n ]\r\n }\r\n ],\r\n \"sequence\": 1\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{Host}}/rest/RuleService/v1/rules/Bill/Bill_Time_Discount"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Fri, 16 Feb 2024 11:48:39 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"47"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"*, Content-Type, Pragma, Origin, Authorization, party, X-XSRF-TOKEN, X-Requested-With,Access-Control-Allow-Headers,Accept,Access-Control-Allow-Credentials,X-Auth-Token, version, cache"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST,OPTIONS,PUT,DELETE,GET"}],"cookie":[],"responseTime":null,"body":"{\n \"ruleName\": \"Bill_Time_Discount\",\n \"status\": \"OK\"\n}\n"}],"_postman_id":"624f54e3-28e8-4cd8-bd4f-6d9d51e0454d"},{"name":"Get Bill Time Discount","id":"5cb7d8a0-7803-44ba-98e3-ad2643bd34bf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"}],"url":"{{Host}}/rest/RuleService/v1/rules/Bill/Bill_Time_Discount","description":"This API is used to fetch the details of the Bill time discount.
\n","urlObject":{"path":["rest","RuleService","v1","rules","Bill","Bill_Time_Discount"],"host":["{{Host}}"],"query":[],"variable":[]}},"response":[{"id":"4b5f0022-9dbc-4714-94dd-b0ff836a786a","name":"Get Bill Time Discount","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"}],"url":"{{Host}}/rest/RuleService/v1/rules/Bill/Bill_Time_Discount"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Fri, 16 Feb 2024 11:50:19 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"707"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"*, Content-Type, Pragma, Origin, Authorization, party, X-XSRF-TOKEN, X-Requested-With,Access-Control-Allow-Headers,Accept,Access-Control-Allow-Credentials,X-Auth-Token, version, cache"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST,OPTIONS,PUT,DELETE,GET"}],"cookie":[],"responseTime":null,"body":"{\n \"ruleInfo\": {\n \"ruleName\": \"Bill_Time_Discount\",\n \"contextName\": \"Bill\",\n \"ruleCategory\": 1,\n \"ruleSets\": [\n {\n \"id\": \"1\",\n \"ruleSetConditions\": [\n {\n \"id\": \"1\",\n \"property\": \"Bill\",\n \"attribute\": \"Bill Amount\",\n \"operator\": \"Equal To\",\n \"values\": [\n \"100\"\n ],\n \"dataType\": \"BigDecimal\",\n \"inputFieldType\": 1\n }\n ],\n \"ruleSetActions\": [\n {\n \"id\": \"1\",\n \"attribute\": \"Discount Description\",\n \"operator\": \"Is Set To\",\n \"values\": [\n \"Bill Amount 100\"\n ],\n \"dataType\": \"String\",\n \"inputFieldType\": 1,\n \"isMandatoryAction\": true\n },\n {\n \"id\": \"2\",\n \"attribute\": \"Discount Percentage\",\n \"operator\": \"Is Set To\",\n \"values\": [\n \"20\"\n ],\n \"dataType\": \"BigDecimal\",\n \"inputFieldType\": 1,\n \"isMandatoryAction\": false\n }\n ],\n \"isDefaultRuleSet\": false,\n \"sequence\": 1\n }\n ],\n \"isDefaultRuleSetDisabled\": false,\n \"isRetailRule\": false\n },\n \"status\": \"OK\"\n}\n"}],"_postman_id":"5cb7d8a0-7803-44ba-98e3-ad2643bd34bf"},{"name":"Delete Bill Time Discount","id":"79d027a8-e6ad-4aeb-9c2c-e31866e2b4e6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"DELETE","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"}],"url":"{{Host}}/rest/RuleService/v1/rules/Bill/Bill_Time_Discount","description":"This API is used to delete the bill time discount available in the application.
\n","urlObject":{"path":["rest","RuleService","v1","rules","Bill","Bill_Time_Discount"],"host":["{{Host}}"],"query":[],"variable":[]}},"response":[{"id":"558acb6c-4696-4f06-afa1-9c8b35e3ee51","name":"Delete Bill Time Discount","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"}],"url":"{{Host}}/rest/RuleService/v1/rules/Bill/Bill_Time_Discount"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Fri, 16 Feb 2024 11:45:21 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"15"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"*, Content-Type, Pragma, Origin, Authorization, party, X-XSRF-TOKEN, X-Requested-With,Access-Control-Allow-Headers,Accept,Access-Control-Allow-Credentials,X-Auth-Token, version, cache"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST,OPTIONS,PUT,DELETE,GET"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"OK\"\n}\n"}],"_postman_id":"79d027a8-e6ad-4aeb-9c2c-e31866e2b4e6"}],"id":"7369ddfe-d40a-4034-b2ab-7afaab0ce4ad","description":"In this section will discuss bill time discount, it will allow the businesses to apply discount for the subscriber invoices.
\n","_postman_id":"7369ddfe-d40a-4034-b2ab-7afaab0ce4ad"},{"name":"Partner Bill Time Charge","item":[{"name":"Partner Bill Time Charge","id":"939a74ac-e770-436a-8a56-5d6e544c2ca6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"contextName\": \"PartnerBillCharge\",\r\n \"ruleName\": \"Bill_Time_Charge_Partner\",\r\n \"ruleCategory\": 1,\r\n \"ruleSets\": [\r\n {\r\n \"ruleSetConditions\": [\r\n {\r\n \"property\": \"Bill\",\r\n \"attribute\": \"Bill Amount\",\r\n \"operator\": \"Equal To\",\r\n \"values\": [\r\n \"100\"\r\n ]\r\n }\r\n ],\r\n \"ruleSetActions\": [\r\n {\r\n \"attribute\": \"Charge Description\",\r\n \"operator\": \"Is Set To\",\r\n \"values\": [\r\n \"Bill Amount Equal To 100\"\r\n ]\r\n }\r\n ],\r\n \"attribute\": \"Fixed Charge\",\r\n \"operator\": \"Is Set To\",\r\n \"values\": [\r\n \"20\"\r\n ]\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{Host}}/rest/RuleService/v1/rules/PartnerBillCharge","description":"This API is used to create Bill Time charge in the application. It will help you to apply additional charges to your subscribers.
\n","urlObject":{"path":["rest","RuleService","v1","rules","PartnerBillCharge"],"host":["{{Host}}"],"query":[],"variable":[]}},"response":[{"id":"5fa0efaf-78a2-478a-a090-5256396f86f7","name":"Partner Bill Time Charge","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"contextName\": \"PartnerBillCharge\",\r\n \"ruleName\": \"Bill_Time_Charge_Partner\",\r\n \"ruleCategory\": 1,\r\n \"ruleSets\": [\r\n {\r\n \"ruleSetConditions\": [\r\n {\r\n \"property\": \"Bill\",\r\n \"attribute\": \"Bill Amount\",\r\n \"operator\": \"Equal To\",\r\n \"values\": [\r\n \"100\"\r\n ]\r\n }\r\n ],\r\n \"ruleSetActions\": [\r\n {\r\n \"attribute\": \"Charge Description\",\r\n \"operator\": \"Is Set To\",\r\n \"values\": [\r\n \"Bill Amount Equal To 100\"\r\n ]\r\n }\r\n ],\r\n \"attribute\": \"Fixed Charge\",\r\n \"operator\": \"Is Set To\",\r\n \"values\": [\r\n \"20\"\r\n ]\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{Host}}/rest/RuleService/v1/rules/PartnerBillCharge"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Fri, 16 Feb 2024 12:06:22 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"53"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"*, Content-Type, Pragma, Origin, Authorization, party, X-XSRF-TOKEN, X-Requested-With,Access-Control-Allow-Headers,Accept,Access-Control-Allow-Credentials,X-Auth-Token, version, cache"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST,OPTIONS,PUT,DELETE,GET"}],"cookie":[],"responseTime":null,"body":"{\n \"ruleName\": \"Bill_Time_Charge_Partner\",\n \"status\": \"OK\"\n}\n"}],"_postman_id":"939a74ac-e770-436a-8a56-5d6e544c2ca6"},{"name":"Update Partner Bill Time Charge","id":"f36e4237-fd40-4168-a691-05d0b854f12b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"PUT","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"contextName\": \"PartnerBillCharge\",\r\n \"ruleName\": \"Bill_Time_Charge_Partner\",\r\n \"ruleCategory\": 1,\r\n \"ruleSets\": [\r\n {\r\n \"ruleSetConditions\": [\r\n {\r\n \"property\": \"Bill\",\r\n \"attribute\": \"Bill Amount\",\r\n \"operator\": \"Equal To\",\r\n \"values\": [\r\n \"100\"\r\n ]\r\n }\r\n ],\r\n \"ruleSetActions\": [\r\n {\r\n \"attribute\": \"Charge Description\",\r\n \"operator\": \"Is Set To\",\r\n \"values\": [\r\n \"Bill Amount Equal To 100\"\r\n ]\r\n }\r\n ],\r\n \"attribute\": \"Fixed Charge\",\r\n \"operator\": \"Is Set To\",\r\n \"values\": [\r\n \"20\"\r\n ]\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{Host}}/rest/RuleService/v1/rules/PartnerBillCharge/Bill_Time_Charge_Partner","description":"This API is used to update the details of your bill tiem charge> It will modify the details of existing bill time charge.
\n","urlObject":{"path":["rest","RuleService","v1","rules","PartnerBillCharge","Bill_Time_Charge_Partner"],"host":["{{Host}}"],"query":[],"variable":[]}},"response":[{"id":"f04a3a40-56e8-4c16-a665-ed6d577d4f22","name":"Update Partner Bill Time Charge","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"contextName\": \"PartnerBillCharge\",\r\n \"ruleName\": \"Bill_Time_Charge_Partner\",\r\n \"ruleCategory\": 1,\r\n \"ruleSets\": [\r\n {\r\n \"ruleSetConditions\": [\r\n {\r\n \"property\": \"Bill\",\r\n \"attribute\": \"Bill Amount\",\r\n \"operator\": \"Equal To\",\r\n \"values\": [\r\n \"100\"\r\n ]\r\n }\r\n ],\r\n \"ruleSetActions\": [\r\n {\r\n \"attribute\": \"Charge Description\",\r\n \"operator\": \"Is Set To\",\r\n \"values\": [\r\n \"Bill Amount Equal To 100\"\r\n ]\r\n }\r\n ],\r\n \"attribute\": \"Fixed Charge\",\r\n \"operator\": \"Is Set To\",\r\n \"values\": [\r\n \"20\"\r\n ]\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{Host}}/rest/RuleService/v1/rules/PartnerBillCharge/Bill_Time_Charge_Partner"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Fri, 16 Feb 2024 12:11:32 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"53"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"*, Content-Type, Pragma, Origin, Authorization, party, X-XSRF-TOKEN, X-Requested-With,Access-Control-Allow-Headers,Accept,Access-Control-Allow-Credentials,X-Auth-Token, version, cache"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST,OPTIONS,PUT,DELETE,GET"}],"cookie":[],"responseTime":null,"body":"{\n \"ruleName\": \"Bill_Time_Charge_Partner\",\n \"status\": \"OK\"\n}\n"}],"_postman_id":"f36e4237-fd40-4168-a691-05d0b854f12b"},{"name":"Get Partner Bill Time Charge","id":"9e1b38b6-3b7e-4ffb-b3fe-ce5ea18b7b8d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"}],"url":"{{Host}}/rest/RuleService/v1/rules/PartnerBillCharge/Bill_Time_Charge_Partner","description":"This API is used to fetch the details of the Bill time charge available in the application.
\n","urlObject":{"path":["rest","RuleService","v1","rules","PartnerBillCharge","Bill_Time_Charge_Partner"],"host":["{{Host}}"],"query":[],"variable":[]}},"response":[{"id":"03d1ac65-b619-454f-8355-b34e5cadd6fc","name":"Get Partner Bill Time Charge","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"}],"url":"{{Host}}/rest/RuleService/v1/rules/PartnerBillCharge/Bill_Time_Charge_Partner"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Fri, 16 Feb 2024 12:12:39 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"580"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"*, Content-Type, Pragma, Origin, Authorization, party, X-XSRF-TOKEN, X-Requested-With,Access-Control-Allow-Headers,Accept,Access-Control-Allow-Credentials,X-Auth-Token, version, cache"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST,OPTIONS,PUT,DELETE,GET"}],"cookie":[],"responseTime":null,"body":"{\n \"ruleInfo\": {\n \"ruleName\": \"Bill_Time_Charge_Partner\",\n \"contextName\": \"PartnerBillCharge\",\n \"ruleCategory\": 1,\n \"ruleSets\": [\n {\n \"id\": \"1\",\n \"ruleSetConditions\": [\n {\n \"id\": \"1\",\n \"property\": \"Bill\",\n \"attribute\": \"Bill Amount\",\n \"operator\": \"Equal To\",\n \"values\": [\n \"100\"\n ],\n \"dataType\": \"BigDecimal\",\n \"inputFieldType\": 1\n }\n ],\n \"ruleSetActions\": [\n {\n \"id\": \"1\",\n \"attribute\": \"Charge Description\",\n \"operator\": \"Is Set To\",\n \"values\": [\n \"Bill Amount Equal To 100\"\n ],\n \"dataType\": \"String\",\n \"inputFieldType\": 1,\n \"isMandatoryAction\": true\n }\n ],\n \"isDefaultRuleSet\": false,\n \"sequence\": 1\n }\n ],\n \"isDefaultRuleSetDisabled\": false,\n \"isRetailRule\": false\n },\n \"status\": \"OK\"\n}\n"}],"_postman_id":"9e1b38b6-3b7e-4ffb-b3fe-ce5ea18b7b8d"},{"name":"Delete Partner Bill Time Charge","id":"888c244a-4e70-4e6c-9c1e-346acbb06186","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"DELETE","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"}],"url":"{{Host}}/rest/RuleService/v1/rules/PartnerBillCharge/Bill_Time_Charge_Partner","description":"This API is used to delete the bill time charge available in the application. If it is deleted no additional charges will be applied.
\n","urlObject":{"path":["rest","RuleService","v1","rules","PartnerBillCharge","Bill_Time_Charge_Partner"],"host":["{{Host}}"],"query":[],"variable":[]}},"response":[{"id":"ad822755-2653-40ee-b8e0-4a0813ce36a7","name":"Delete Partner Bill Time Charge","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"}],"url":"{{Host}}/rest/RuleService/v1/rules/PartnerBillCharge/Bill_Time_Charge_Partner"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Fri, 16 Feb 2024 12:13:42 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"15"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"*, Content-Type, Pragma, Origin, Authorization, party, X-XSRF-TOKEN, X-Requested-With,Access-Control-Allow-Headers,Accept,Access-Control-Allow-Credentials,X-Auth-Token, version, cache"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST,OPTIONS,PUT,DELETE,GET"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"OK\"\n}\n"}],"_postman_id":"888c244a-4e70-4e6c-9c1e-346acbb06186"}],"id":"3213cc87-916f-4174-8988-224c9f651c7c","description":"In this section will discuss Partner's Bill time chag=rge, it will allow the businesses to collect additional charges from the Partners.
\n","_postman_id":"3213cc87-916f-4174-8988-224c9f651c7c"},{"name":"Partner Bill Time Discount","item":[{"name":"Create Partner Bill Time Discount","id":"9b36000a-da54-4cb5-afb5-943777a0662b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"contextName\": \"PartnerBillDiscount\",\r\n \"ruleName\": \"BillTimeDiscount\",\r\n \"ruleCategory\": 1,\r\n \"ruleSets\": [\r\n {\r\n \"ruleSetConditions\": [\r\n {\r\n \"property\": \"Bill\",\r\n \"attribute\": \"Bill Amount\",\r\n \"operator\": \"Equal To\",\r\n \"values\": [\r\n 100\r\n ]\r\n }\r\n ],\r\n \"ruleSetActions\": [\r\n {\r\n \"attribute\": \"Discount Description\",\r\n \"operator\": \"Is Set To\",\r\n \"values\": [\r\n \"Bill Amount 100\"\r\n ]\r\n },\r\n {\r\n \"attribute\": \"Discount Percentage\",\r\n \"operator\": \"Is Set To\",\r\n \"values\": [\r\n 20\r\n ]\r\n }\r\n ],\r\n \"sequence\": 1\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{Host}}/rest/RuleService/v1/rules/PartnerBillDiscount","description":"This API is used to create bill time discount in the application. It will help you to apply discount for your subscriber invoices.
\n","urlObject":{"path":["rest","RuleService","v1","rules","PartnerBillDiscount"],"host":["{{Host}}"],"query":[],"variable":[]}},"response":[{"id":"c14ea6f0-9f83-49b7-bd08-d01e9a2d71eb","name":"Create Partner Bill Time Discount","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"contextName\": \"PartnerBillDiscount\",\r\n \"ruleName\": \"BillTimeDiscount\",\r\n \"ruleCategory\": 1,\r\n \"ruleSets\": [\r\n {\r\n \"ruleSetConditions\": [\r\n {\r\n \"property\": \"Bill\",\r\n \"attribute\": \"Bill Amount\",\r\n \"operator\": \"Equal To\",\r\n \"values\": [\r\n 100\r\n ]\r\n }\r\n ],\r\n \"ruleSetActions\": [\r\n {\r\n \"attribute\": \"Discount Description\",\r\n \"operator\": \"Is Set To\",\r\n \"values\": [\r\n \"Bill Amount 100\"\r\n ]\r\n },\r\n {\r\n \"attribute\": \"Discount Percentage\",\r\n \"operator\": \"Is Set To\",\r\n \"values\": [\r\n 20\r\n ]\r\n }\r\n ],\r\n \"sequence\": 1\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{Host}}/rest/RuleService/v1/rules/PartnerBillDiscount"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Fri, 16 Feb 2024 12:17:23 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"55"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"*, Content-Type, Pragma, Origin, Authorization, party, X-XSRF-TOKEN, X-Requested-With,Access-Control-Allow-Headers,Accept,Access-Control-Allow-Credentials,X-Auth-Token, version, cache"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST,OPTIONS,PUT,DELETE,GET"}],"cookie":[],"responseTime":null,"body":"{\n \"ruleName\": \"Bill_Time_Discount_Partner\",\n \"status\": \"OK\"\n}\n"}],"_postman_id":"9b36000a-da54-4cb5-afb5-943777a0662b"},{"name":"Update the Partner Bill Time Discount","id":"b6aa9659-53c5-4989-8aad-3802250e70b8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"PUT","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"contextName\": \"PartnerBillDiscount\",\r\n \"ruleName\": \"BillTimeDiscount\",\r\n \"ruleCategory\": 1,\r\n \"ruleSets\": [\r\n {\r\n \"ruleSetConditions\": [\r\n {\r\n \"property\": \"Bill\",\r\n \"attribute\": \"Bill Amount\",\r\n \"operator\": \"Equal To\",\r\n \"values\": [\r\n 100\r\n ]\r\n }\r\n ],\r\n \"ruleSetActions\": [\r\n {\r\n \"attribute\": \"Discount Description\",\r\n \"operator\": \"Is Set To\",\r\n \"values\": [\r\n \"Bill Amount 100\"\r\n ]\r\n },\r\n {\r\n \"attribute\": \"Discount Percentage\",\r\n \"operator\": \"Is Set To\",\r\n \"values\": [\r\n 20\r\n ]\r\n }\r\n ],\r\n \"sequence\": 1\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{Host}}/rest/RuleService/v1/rules/PartnerBillDiscount/Bill_Time_Discount_Partner","description":"This API is used to update the details of Partner Bill Time Discount. It will modify the details of existing bill time discount.
\n","urlObject":{"path":["rest","RuleService","v1","rules","PartnerBillDiscount","Bill_Time_Discount_Partner"],"host":["{{Host}}"],"query":[],"variable":[]}},"response":[{"id":"375161fd-5645-47f5-ac7c-4f9b953fee17","name":"Update the Partner Bill Time Discount","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"contextName\": \"PartnerBillDiscount\",\r\n \"ruleName\": \"BillTimeDiscount\",\r\n \"ruleCategory\": 1,\r\n \"ruleSets\": [\r\n {\r\n \"ruleSetConditions\": [\r\n {\r\n \"property\": \"Bill\",\r\n \"attribute\": \"Bill Amount\",\r\n \"operator\": \"Equal To\",\r\n \"values\": [\r\n 100\r\n ]\r\n }\r\n ],\r\n \"ruleSetActions\": [\r\n {\r\n \"attribute\": \"Discount Description\",\r\n \"operator\": \"Is Set To\",\r\n \"values\": [\r\n \"Bill Amount 100\"\r\n ]\r\n },\r\n {\r\n \"attribute\": \"Discount Percentage\",\r\n \"operator\": \"Is Set To\",\r\n \"values\": [\r\n 20\r\n ]\r\n }\r\n ],\r\n \"sequence\": 1\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{Host}}/rest/RuleService/v1/rules/PartnerBillDiscount/Bill_Time_Discount_Partner"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Fri, 16 Feb 2024 12:19:47 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"55"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"*, Content-Type, Pragma, Origin, Authorization, party, X-XSRF-TOKEN, X-Requested-With,Access-Control-Allow-Headers,Accept,Access-Control-Allow-Credentials,X-Auth-Token, version, cache"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST,OPTIONS,PUT,DELETE,GET"}],"cookie":[],"responseTime":null,"body":"{\n \"ruleName\": \"Bill_Time_Discount_Partner\",\n \"status\": \"OK\"\n}"}],"_postman_id":"b6aa9659-53c5-4989-8aad-3802250e70b8"},{"name":"Get Partner Bill Time Discount","id":"5643bb07-72d4-48f2-8df4-954adafaeaed","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"}],"url":"{{Host}}/rest/RuleService/v1/rules/PartnerBillDiscount/Bill_Time_Discount_Partner","description":"This API is used to fetch the details of the Partner's Bill time discount.
\n","urlObject":{"path":["rest","RuleService","v1","rules","PartnerBillDiscount","Bill_Time_Discount_Partner"],"host":["{{Host}}"],"query":[],"variable":[]}},"response":[{"id":"9d237b24-8b6b-41d6-ae1a-16b692934031","name":"Get Partner Bill Time Discount","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"}],"url":"{{Host}}/rest/RuleService/v1/rules/PartnerBillDiscount/Bill_Time_Discount_Partner"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Fri, 16 Feb 2024 12:22:01 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"730"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"*, Content-Type, Pragma, Origin, Authorization, party, X-XSRF-TOKEN, X-Requested-With,Access-Control-Allow-Headers,Accept,Access-Control-Allow-Credentials,X-Auth-Token, version, cache"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST,OPTIONS,PUT,DELETE,GET"}],"cookie":[],"responseTime":null,"body":"{\n \"ruleInfo\": {\n \"ruleName\": \"Bill_Time_Discount_Partner\",\n \"contextName\": \"PartnerBillDiscount\",\n \"ruleCategory\": 1,\n \"ruleSets\": [\n {\n \"id\": \"1\",\n \"ruleSetConditions\": [\n {\n \"id\": \"1\",\n \"property\": \"Bill\",\n \"attribute\": \"Bill Amount\",\n \"operator\": \"Equal To\",\n \"values\": [\n \"100\"\n ],\n \"dataType\": \"BigDecimal\",\n \"inputFieldType\": 1\n }\n ],\n \"ruleSetActions\": [\n {\n \"id\": \"1\",\n \"attribute\": \"Discount Description\",\n \"operator\": \"Is Set To\",\n \"values\": [\n \"Bill Amount 100\"\n ],\n \"dataType\": \"String\",\n \"inputFieldType\": 1,\n \"isMandatoryAction\": true\n },\n {\n \"id\": \"2\",\n \"attribute\": \"Discount Percentage\",\n \"operator\": \"Is Set To\",\n \"values\": [\n \"20\"\n ],\n \"dataType\": \"BigDecimal\",\n \"inputFieldType\": 1,\n \"isMandatoryAction\": false\n }\n ],\n \"isDefaultRuleSet\": false,\n \"sequence\": 1\n }\n ],\n \"isDefaultRuleSetDisabled\": false,\n \"isRetailRule\": false\n },\n \"status\": \"OK\"\n}\n"}],"_postman_id":"5643bb07-72d4-48f2-8df4-954adafaeaed"},{"name":"Delete Partner Bill Time Discount","id":"ac1f346d-c814-4104-a658-b8ba01f23da4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"DELETE","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"}],"url":"{{Host}}/rest/RuleService/v1/rules/PartnerBillDiscount/Bill_Time_Discount_Partner","description":"This API is used to delete the bill time discount available in the application.
\n","urlObject":{"path":["rest","RuleService","v1","rules","PartnerBillDiscount","Bill_Time_Discount_Partner"],"host":["{{Host}}"],"query":[],"variable":[]}},"response":[{"id":"bfef8e46-361a-4c65-a118-0609e3255bc8","name":"Delete Partner Bill Time Discount","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer{{token}}","type":"text"}],"url":"{{Host}}/rest/RuleService/v1/rules/PartnerBillDiscount/Bill_Time_Discount_Partner"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Fri, 16 Feb 2024 12:24:32 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"15"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"*, Content-Type, Pragma, Origin, Authorization, party, X-XSRF-TOKEN, X-Requested-With,Access-Control-Allow-Headers,Accept,Access-Control-Allow-Credentials,X-Auth-Token, version, cache"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST,OPTIONS,PUT,DELETE,GET"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"OK\"\n}\n"}],"_postman_id":"ac1f346d-c814-4104-a658-b8ba01f23da4"}],"id":"6944f250-4ccc-4891-81ca-2c27f499224d","description":"In this section will discuss bill time discount, it will allow the businesses to apply discount for the Partner's invoices.
\n","_postman_id":"6944f250-4ccc-4891-81ca-2c27f499224d"}],"id":"fadd0d8d-d530-4a5e-9b88-19ca583c631b","description":"This section will discuss Business Policy Rule. This consist of various business policy rule.
\n","_postman_id":"fadd0d8d-d530-4a5e-9b88-19ca583c631b"}],"id":"a4bab545-f121-43f1-8175-29ee5ae99628","description":"This section will discuss about rules and their operation like creating, updating, retreiving and deleting.
\n","_postman_id":"a4bab545-f121-43f1-8175-29ee5ae99628"},{"name":"User Management","item":[{"name":"Create a User","item":[{"name":"Create a User - Parameter Info","id":"76eebf9f-632b-4484-9043-a03a14210e53","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"POST","header":[{"description":"Provide the generated access token in this field.
\n","key":"Authorization","type":"text","value":"BearerThis section lists and explains the various URL and data parameters which are present in this API.
\nURL Parameters
\nnone
\nData Parameters
\nCheck out the field descriptions for each data parameter in the link provided below.
Request Data Parameters
Provide the generated access token in this field.
\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"email\": \"jdoe@gmail.com\",\n \"phoneNumber\": \"7838580485\",\n \"userName\": \"j.doe\",\n \"userRole\": \"ROLE_CSR_USER\"\n}"},"url":"{{host}}/rest/UserService/v1/user","description":"This API will be used to create a user in the application.
\n","urlObject":{"path":["rest","UserService","v1","user"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"7cbaa10e-2d27-4014-97a1-14373d7afb6d","name":"Create a new user","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"BearerThis API is used to create a new user in the system.
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"4047046e-2036-47bf-bc89-f019173fe665"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"42ee92ae-c5c6-468b-aed5-32ef514a1b13"}}],"_postman_id":"3e5c5558-f2fb-402d-a59c-379a21ff0a23"},{"name":"Fetch User Details","item":[{"name":"Fetch User Details - Parameter Info","id":"3acf81f4-9799-4906-886f-42762d4b465f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"GET","header":[{"description":"Provide the generated access token in this field.
\n","key":"Authorization","type":"text","value":"BearerThis section lists and explains the various URL and data parameters which are present in this API.
\nURL Parameters
\n","urlObject":{"path":["rest","UserService","v1","users","{userName}"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"3acf81f4-9799-4906-886f-42762d4b465f"},{"name":"Fetch User Details","id":"1b1ff71f-374e-42ec-8781-870e357a21f0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"GET","header":[{"description":"Provide the generated access token in this field.
\n","key":"Authorization","type":"text","value":"BearerFetch the details of a user that is already present in the system.
\n","urlObject":{"path":["rest","UserService","v1","users","j.doe"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"6ed373aa-38e3-457e-a400-bb07a41ddaec","name":"Fetch User Details","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"BearerThis API is used to fetch the details of an already existing user from the system.
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"92dd283e-a16e-4d97-973a-b6600bf78f8b"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"da2a5035-6742-46fd-9fc3-0cce7b803eaa"}}],"_postman_id":"4af19637-3e3f-4b60-a946-68bc88d24272"},{"name":"Update User Details","item":[{"name":"Update User Details - Parameter Info","id":"1ad81b04-fc94-4c1c-bda0-22c18b53c0bd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"PUT","header":[{"description":"Provide the generated access token in this field.
\n","key":"Authorization","type":"text","value":"BearerThis section lists and explains the various URL and data parameters which are present in this API.\n
URL Parameters
\nnone
\n\n\n
Request Data Parameters
\nCheck out the field descriptions for each data parameter in the link provided below.\n
\nRequest Data Parameters
Provide the generated access token in this field.
\n","key":"Authorization","type":"text","value":"BearerUpdate the phone number of the user with username j.doe.
This API is used to update the details of an already existing user in the system.
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"0be1acc2-8605-4ff6-a9c5-395415656830"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"3ef76039-cb5b-431c-b2ce-12acfe9fe58f"}}],"_postman_id":"77c45f4d-694e-4ee0-be84-9947abda6f20"},{"name":"Search a User","item":[{"name":"Search a User - Parameter Info","id":"8b8aeb55-8f32-42a0-813d-b387cae5906b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"GET","header":[{"description":"Provide the generated access token in this field.
\n","key":"Authorization","type":"text","value":"BearerThis section lists and explains the various URL and data parameters which are present in this API.\n
URL Parameters
\n\n\n
Data Parameters
\nnone
\n","urlObject":{"path":["rest","UserService","v1","users"],"host":["{{host}}"],"query":[{"key":"searchBy","value":"{userParameters}"},{"key":"searchString","value":"{userParameterValue}"}],"variable":[]}},"response":[],"_postman_id":"8b8aeb55-8f32-42a0-813d-b387cae5906b"},{"name":"Search a User","id":"30b9ca96-3fd5-4e05-b9af-ffd7db16d341","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"GET","header":[{"description":"Provide the generated access token in this field.
\n","key":"Authorization","type":"text","value":"BearerSearch for all the users with the role of a CSR user into the application.
\n","urlObject":{"path":["rest","UserService","v1","users"],"host":["{{host}}"],"query":[{"key":"searchBy","value":"userRole"},{"key":"searchString","value":"ROLE_CSR_USER"}],"variable":[]}},"response":[{"id":"82134ab4-b5b3-4092-98b1-73aed9346e22","name":"Search a User","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"BearerThis API is used to search for a certain user by passing the necessary parameters. It returns the details of the searched user.
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"c0c795ed-5850-44ad-8d6c-94c3abecb6bb"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"1e6a1cf9-a958-4d00-91c8-8ce4fd696477"}}],"_postman_id":"4b1ba8dc-4c49-459a-a294-2438e83834a5"},{"name":"Fetch List of Users","item":[{"name":"Fetch List of Users - Parameter Info","id":"6ba55930-26d5-4b69-9592-d246d5818d5a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"GET","header":[{"description":"Provide the generated access token in this field.
\n","key":"Authorization","type":"text","value":"BearerThis section lists and explains the various URL and data parameters which are present in this API.
\nURL Parameters
\nnone
\n","urlObject":{"path":["rest","UserService","v1","users"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"6ba55930-26d5-4b69-9592-d246d5818d5a"},{"name":"Fetch List of Users","id":"ddefb233-3321-4b00-a798-37d59886cd70","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"GET","header":[{"description":"Provide the generated access token in this field.
\n","key":"Authorization","type":"text","value":"BearerFetch the list of all users that are present in the system.
\n","urlObject":{"path":["rest","UserService","v1","users"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"812ea8a9-fc1a-4ee4-a0d3-3aa946948820","name":"Fetch List of Users","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"BearerThis API is used to fetch the details of an already existing user from the system.
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"06bc5547-6566-437d-8012-2af12560965b"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"7c574aa8-2b8c-4299-98c0-6d5531eab7d0"}}],"_postman_id":"2a2c340f-82b8-44f7-a8cd-3561ef1dca52"},{"name":"Fetch List of User Roles","item":[{"name":"Fetch List of User Roles - Parameter Info","id":"85f86ac0-ca21-4205-96a1-2f8b02f11302","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"Provide the generated access token in this field.
\n","key":"Authorization","type":"text","value":"BearerThis section lists and explains the various URL and data parameters which are present in this API.
\nURL Parameters
\nnone
\n","urlObject":{"path":["rest","UserService","v1","users","roles"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"85f86ac0-ca21-4205-96a1-2f8b02f11302"},{"name":"Fetch List of User Roles","id":"ca194b9a-a0c4-4dc4-92c9-210c7bea25d4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"Provide the generated access token in this field.
\n","key":"Authorization","type":"text","value":"BearerFetch the list of all user roles that are defined and configured in the system.
\n","urlObject":{"path":["rest","UserService","v1","users","roles"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"2e314698-319f-45e7-8376-9675a9755575","name":"Fetch List of User Roles","originalRequest":{"method":"GET","header":[{"description":"Provide the generated access token in this field.","key":"Authorization","type":"text","value":"BearerThis API is used to fetch the list of user roles already existing in the system.
\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"a359eab4-7e1c-4060-afae-e101ce14b8cd"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"f8e12f64-5a72-47c0-95f3-1bd9114614af"}}],"_postman_id":"3728afed-5dce-48a0-afc7-c56a578fa5da"}],"id":"aacf617a-4511-4c9d-bc5a-d016ceb4e548","description":"This section deals with the various APIs required to manage user information in the application.
\n","_postman_id":"aacf617a-4511-4c9d-bc5a-d016ceb4e548"}],"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"9ee74d30-ba43-47c1-b0ca-45b8aa1f5854"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"f8d5453a-f2ce-4d20-9190-03b42479d1ee"}}]}