{"openapi":"3.0.0","info":{"version":"5.4.0","title":"6D API","description":"This document describes the API specification 6d Customer Order Management."},"servers":[{"url":"http://10.0.14.19:9000/OM"}],"tags":[{"name":"Onboarding","description":"This API can be used to Onboard a new customer in to 6d BSS"},{"name":"ChangePlan","description":"This API can be used to Change the tariff plan of an existing customer in 6d BSS"},{"name":"MakePayment","description":"This API can be used to capture any paymet for an existing customer in 6d BSS"},{"name":"CustomerProfileSearch","description":"This API can be used get the basic details of a customer by his/her id in 6d BSS"},{"name":"CustomerAccountSearch","description":"This API can be used get the basic details of a customer billing account by its id"},{"name":"CustomerServiceSearch","description":"This API can be used get the basic details of a customer service by its id"},{"name":"QueryPlan","description":"This API can be used get the subscription details for a customer service"},{"name":"AddSubscription","description":"This API can be used to purchase a new addon subscription for an existing customer in 6d BSS"},{"name":"CancelSubscription","description":"This API can be used to remove an addon subscription for an existing customer in 6d BSS"},{"name":"SuspendService","description":"This API can be used to suspend an active customer service in 6d BSS"},{"name":"ResumeService","description":"The ResumeService Order API can be used to resume a suspended customer service in 6d BSS"},{"name":"TerminateService","description":"This API can be used to terminate customer service from 6d BSS"},{"name":"ViewOrder","description":"This API can be used to list all customer orders in 6d Customer Order Management System"},{"name":"ViewSubOrder","description":"This API can be used to list all order line items of a customer order in 6d Customer Order Management System"},{"name":"ViewSubOrderStages","description":"This API can be used to list all order tasks items of a sub order in 6d Customer Order Management System"},{"name":"AddService","description":"This API can be used add a new service for an existing customer"},{"name":"ChangeEquipment","description":"This API can be used to change/replace and equipment owned by the customer"},{"name":"ChangeSim","description":"This API can be used to change the sim card of a subscriber"},{"name":"ChangeMsisdn","description":"This API can be used to change the msisdn of a subscriber"},{"name":"SafeCustody","description":"This API can be used to raise a vacation suspension order"},{"name":"CancelSafeCustody","description":"This API can be used to cancel an ongoing vacation suspension"},{"name":"UpdateSafeCustody","description":"This API can be used to update an ongoing vacation suspension"},{"name":"UpdateCPEDetails","description":"This API can be used to update the details of an equipment"},{"name":"UpdateProfileBasicDetails","description":"This API can be used to basic details of a customer"},{"name":"UpdateAccountBasicDetails","description":"This API can be used to basic details of a billing account"},{"name":"TerminateAccount","description":"This API can be used to terminate a billing account"},{"name":"GetPaymentDetails","description":"This API can be used to get the payment history of a billing account"},{"name":"GetInvoiceDetails","description":"This API can be used to get the invoice details of a billing account"},{"name":"ManageHlrServices","description":"This API can be used to manage the HLR services for a customer"}],"paths":{"/orders/onboarding":{"post":{"tags":["Onboarding"],"summary":"Onboarding","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["order_information"],"properties":{"order_information":{"type":"object","required":["order_type","customer_name","contact_number","profile","installation_details","access_details","payment_details","dataset"],"properties":{"order_type":{"type":"string","example":"Onboarding","description":"unique order type that defines the operation"},"customer_name":{"type":"string","example":"Harryson Jerico","description":"Customers Name"},"contact_number":{"type":"string","example":"(555) 555-1234","description":"Customers Telephone Number"},"profile":{"type":"object","required":["profile_id","profile_type","first_name","last_name","date_of_birth","gender","contact_email_id","contact_number_1","language_id","nationality","title","pin","ssn","subscriber_category","subscriber_sub_category","identification_details","addresses","payment_preferences","param_list","account"],"properties":{"profile_id":{"type":"string","example":"","description":"unique ID Profile that gets generated in Billing. Should be empty for fresh customer"},"profile_type":{"type":"string","example":"0","description":"Type that differentiates between Residential and Commercial Customer"},"first_name":{"type":"string","example":"JONAS","description":"Customer's First Name"},"last_name":{"type":"string","example":"WATSON","description":"Customer's Last Name"},"date_of_birth":{"type":"string","example":"05/21/1997","description":"Customer's date of Birth"},"gender":{"type":"string","example":"0","description":"Gender of the customer"},"contact_email_id":{"type":"string","example":"jonas@hotmail.com","description":"Email id of the customer"},"contact_number_1":{"type":"string","example":"(555) 555-1234","description":"Contact number of the customer"},"language_id":{"type":"string","example":"1","description":"Language Id"},"nationality":{"type":"string","example":"1","description":"Nationality that defines the customer"},"title":{"type":"string","example":"Mr.","description":"Title associated with the customer"},"pin":{"type":"string","example":"5566","description":"unique 4 digit pin used in self care"},"ssn":{"type":"string","example":"485652202","description":"Customer's unique customer identifier"},"subscriber_category":{"type":"string","example":"1","description":"Subscriber category"},"subscriber_sub_category":{"type":"string","example":"3","description":"Subscriber Sub category"},"identification_details":{"type":"array","items":{"type":"object","required":["identification_type","identification_number","id_issue_date","id_expiry_date","file_details"],"properties":{"identification_type":{"type":"string","example":"2","description":"identification type"},"identification_number":{"type":"string","example":"1765676170","description":"unique identification number"},"id_issue_date":{"type":"string","example":"11/29/2016","description":"id number issue date"},"id_expiry_date":{"type":"string","example":"11/29/2029","description":"id expiry date"},"file_details":{"type":"array","items":{"type":"object","required":["ftp_id","file_name","file_description","file_path"],"properties":{"ftp_id":{"type":"string","example":"1","description":"unique id"},"file_name":{"type":"string","example":"abc.jpg","description":"file name"},"file_description":{"type":"string","example":"image file","description":"description of the file being attached"},"file_path":{"type":"string","example":"/opt/mars/uploadedDoc/image/","description":"ftp location of the file"}}}}}}},"addresses":{"type":"array","items":{"type":"object","required":["language_id","address_type","addr_line1","addr_line2","addr_line3","addr_line4","addr_line5","geo_code"],"properties":{"language_id":{"type":"string","example":"1","description":"language id"},"address_type":{"type":"string","example":"1","description":"address type that differentiates between profile/account/service"},"addr_line1":{"type":"string","example":"21 LACULIS ST ","description":"address line 1"},"addr_line2":{"type":"string","example":"","description":"address line 2"},"addr_line3":{"type":"string","example":"WOODRUFF","description":"address line 3"},"addr_line4":{"type":"string","example":"SC","description":"address line 4"},"addr_line5":{"type":"string","example":"49854","description":"address line 5"},"geo_code":{"type":"string","example":"140433840","description":"Geo Code"}}}},"payment_preferences":{"type":"array","items":{"type":"object","required":["payment_preference","payment_preferences_desc"],"properties":{"payment_preference":{"type":"string","example":"1","description":"Preferred payment"},"payment_preferences_desc":{"type":"string","example":"CC","description":"Description for the preferred payment"}}}},"param_list":{"type":"array","description":"An array of key value pairs used to pass additional details","items":{"type":"object","required":["id","value"],"properties":{"id":{"type":"string","example":"Q001","description":""},"value":{"type":"string","example":"Answer to Q001","description":""}}}},"account":{"type":"object","required":["billing_title","billing_name","last_name","risk_category","email_notification","notification_email_id","sms_notification","sms_numbers","ivr_notification","dunning_enabled","tax_code","tax_plan_group","ivr_number","itemized_required","dunning_schedule","dispatch_mode","bill_type","hard_limit","soft_limit","late_payment_fee","auto_pay","iptv_deposit","addresses","auto_payment_details","notification_details","service_groups"],"properties":{"billing_title":{"type":"string","example":"Mr.","description":"Title for the customer"},"billing_name":{"type":"string","example":"JONAS WATSON","description":"Billing Name"},"last_name":{"type":"string","example":"WATSON","description":"Billing Last Name"},"risk_category":{"type":"string","example":"3","description":"risk category associated with the Billing account"},"email_notification":{"type":"string","example":"1","description":"Email Notification 0/1"},"notification_email_id":{"type":"string","example":"jonas@hotmail.com","description":"Valid Email id"},"sms_notification":{"type":"string","example":"0","description":"SMS Notification 0/1"},"sms_numbers":{"type":"string","example":"1234567890","description":"Number to which SMS's should be sent"},"ivr_notification":{"type":"string","example":"0","description":"IVR Notification 0/1"},"dunning_enabled":{"type":"string","example":"1","description":"flag to define if dunning is enabled"},"tax_code":{"type":"string","example":"1","description":"tax code"},"tax_plan_group":{"type":"string","example":"24","description":"tax plan group"},"ivr_number":{"type":"string","example":"","description":"Number to which IVR calls should be done"},"itemized_required":{"type":"string","example":"1","description":"If itemized bills are required"},"dunning_schedule":{"type":"string","example":"99","description":"dunning scheduled"},"dispatch_mode":{"type":"string","example":"1","description":"dispatch mode"},"bill_type":{"type":"string","example":"1","description":"Bill type"},"hard_limit":{"type":"string","example":"","description":"hard limit"},"soft_limit":{"type":"string","example":"soft limit","description":""},"late_payment_fee":{"type":"string","example":"1","description":"late payment fee associated with the customer"},"auto_pay":{"type":"string","example":"1","description":"auto pay 0/1"},"iptv_deposit":{"type":"string","example":"500.00","description":"deposit associated if the service is IPTV"},"addresses":{"type":"array","items":{"type":"object","required":["language_id","address_type","addr_line1","addr_line2","addr_line3","addr_line4","addr_line5","geo_code"],"properties":{"language_id":{"type":"string","example":"1","description":"language id"},"address_type":{"type":"string","example":"1","description":"address type that differentiates between profile/account/service"},"addr_line1":{"type":"string","example":"21 LACULIS ST ","description":"address line 1"},"addr_line2":{"type":"string","example":"","description":"address line 2"},"addr_line3":{"type":"string","example":"WOODRUFF","description":"address line 3"},"addr_line4":{"type":"string","example":"SC","description":"address line 4"},"addr_line5":{"type":"string","example":"49854","description":"address line 5"},"geo_code":{"type":"string","example":"140433840","description":"Geo Code"}}}},"auto_payment_details":{"type":"array","items":{"type":"object","required":["autopay_type","account_name","token","card_number","expiry_date"],"properties":{"autopay_type":{"type":"string","example":"1","description":"auto pay"},"account_name":{"type":"string","example":"Harryson Jerico","description":"account name"},"token":{"type":"string","example":"108594","description":"unique token ref number associated with a card payment"},"card_number":{"type":"string","example":"5883","description":"Last 4 digits of the card used for payment"},"expiry_date":{"type":"string","example":"072020000000","description":"Expiry date of the card"}}}},"notification_details":{"type":"array","items":{"type":"object","required":["notification_id"],"properties":{"notification_id":{"type":"string","example":"1","description":"notification's enabled for the customer"}}}},"service_groups":{"type":"array","items":{"type":"object","required":["services"],"properties":{"services":{"type":"array","items":{"type":"object","required":["status","credit_limit","currency_id","service_class","network_type","connection_type","activation_date","registration_date","network_activation_date","tnc_date","service_code","service_name","sales_rep_id","sales_rep_name","service_code_value","service_id","access_type","icc_id","imsi_number","deposit_amount","rate_plan_name","first_name","last_name","language_id","dependant_devices","param_list","addresses","subscriptions","paired_sim","deposit"],"properties":{"status":{"type":"string","example":"0","description":"status of the service as defined by BIL system"},"credit_limit":{"type":"string","example":"0","description":"credit limit associated with the service"},"currency_id":{"type":"string","example":"89","description":"currency_id associated with the service"},"service_class":{"type":"string","example":"1","description":"service_class associated with the service"},"network_type":{"type":"string","example":"1","description":"service_class associated with the service"},"imsi_number":{"type":"string","example":"1234567","description":"imsi_number associated with the service"},"connection_type":{"type":"string","example":"1","description":"connection type"},"activation_date":{"type":"string","example":"06/22/2020","description":"activation date"},"registration_date":{"type":"string","example":"06/21/2020","description":"registration date"},"network_activation_date":{"type":"string","example":"06/21/2020","description":"network activation date"},"tnc_date":{"type":"string","example":"03/02/2020","description":"tnc date"},"service_code":{"type":"string","example":"3","description":"service code"},"service_name":{"type":"string","example":"Internet","description":"service name"},"sales_rep_id":{"type":"string","example":"","description":"id of the sales rep associated with the sale"},"sales_rep_name":{"type":"string","example":"","description":"name of the sales rep associated with the sale"},"service_code_value":{"type":"string","example":"INTERNET","description":"service code value"},"service_id":{"type":"string","example":"9999990012","description":"unique service id generated in BIL"},"access_type":{"type":"string","example":"0","description":"access type"},"icc_id":{"type":"string","example":"128739","description":"icc id"},"deposit_amount":{"type":"string","example":"500.00","description":"deposit amount collected for the service"},"rate_plan_name":{"type":"string","example":"FAMILY PLAN","description":"Marketing Rate Plan name defined in UPC"},"first_name":{"type":"string","example":"JONAS","description":"First name of the customer"},"last_name":{"type":"string","example":"WATSON","description":"Last Name of the customer"},"language_id":{"type":"string","example":"1","description":"language id"},"dependant_devices":{"type":"array","items":{"type":"string","example":"10002","description":"the access device to which the service should be linked"}},"paired_sim":{"type":"string","example":"true","description":"the associated SIM is paired or not"},"param_list":{"type":"array","description":"array of key value pairs","items":{"type":"object","required":["id","value"],"properties":{"id":{"type":"string","example":"business_office","description":""},"value":{"type":"string","example":"RDSV","description":""}}}},"addresses":{"type":"array","items":{"type":"object","required":["language_id","address_type","addr_line1","addr_line2","addr_line3","addr_line4","addr_line5","addr_line6","geo_code"],"properties":{"language_id":{"type":"string","example":"1","description":"language id"},"address_type":{"type":"string","example":"1","description":"address type that differentiates between profile/account/service"},"addr_line1":{"type":"string","example":"21 LACULIS ST ","description":"address line 1"},"addr_line2":{"type":"string","example":"","description":"address line 2"},"addr_line3":{"type":"string","example":"WOODRUFF","description":"address line 3"},"addr_line4":{"type":"string","example":"SC","description":"address line 4"},"addr_line5":{"type":"string","example":"49854","description":"address line 5"},"addr_line6":{"type":"string","example":"site id","description":"address line 6"},"geo_code":{"type":"string","example":"140433840","description":"Geo Code"}}}},"contract_details":{"type":"object","required":["contract_desc","contract_type","contract_name","activation_date","expiry_date"],"properties":{"contract_desc":{"type":"string","example":"Service Agreement","description":"Contract description"},"contract_type":{"type":"string","example":"2","description":"Type of contract"},"contract_name":{"type":"string","example":"Service Agreement","description":"Name of contract"},"activation_date":{"type":"string","example":"20102020133939","description":"Contract start date"},"expiry_date":{"type":"string","example":"30102020133937","description":"Contract end date"}}},"subscriptions":{"type":"array","items":{"type":"object","required":["plan_id","plan_name","status","is_base_plan","plan_desc","effective_date","expiry_date","subscription_type","product_id","product_name","instance_id","version","is_prorata","subscription_charges","cfss"],"properties":{"plan_id":{"type":"string","example":"332","description":"plan id defined in UPC"},"plan_name":{"type":"string","example":"Internet 200 Mbps","description":"Marketing plan name defined in UPC"},"status":{"type":"string","example":"0","description":"Status of the service"},"is_base_plan":{"type":"string","example":"1","description":"Identifier to define if Base Plan"},"plan_desc":{"type":"string","example":"Internet 200 mbps","description":"Marketing plan name defined in UPC"},"effective_date":{"type":"string","example":"11032020000000","description":"date associated with the plan"},"expiry_date":{"type":"string","example":"26032020120153","description":"expiry date associated with the plan"},"subscription_type":{"type":"string","example":"0","description":"subscription type"},"product_id":{"type":"string","example":"83","description":"product id defined in UPC"},"product_name":{"type":"string","example":"Internet","description":"Marketing product name defined in UPC"},"instance_id":{"type":"string","example":"10001","description":"unique instance id"},"version":{"type":"string","example":"1","description":"version of the UPC offer"},"is_prorata":{"type":"string","example":"1","description":"identifier that defines if the charges are pro rated"},"subscription_charges":{"type":"array","items":{"type":"object","required":["charge_type","charge_name","charge_desc","original_charge_amount","charge_amount","start_date","end_date","charge_tax","total_charge","charge_category","quantity_based","charge_amount_type","charge_frequency","charge_factor","is_prorata","prorata_flags","charge_code","version"],"properties":{"charge_type":{"type":"string","example":"2","description":"charge type defined in BIL"},"charge_name":{"type":"string","example":"HSI200_POP","description":"Charge Name defined in UPC"},"charge_desc":{"type":"string","example":"Charge description","description":""},"original_charge_amount":{"type":"string","example":"90.00","description":"Original Charge amount"},"charge_amount":{"type":"string","example":"90","description":"Over ridden charge amount"},"start_date":{"type":"string","example":"26032020120153","description":"start date"},"end_date":{"type":"string","example":"26032020120153","description":"end date"},"charge_tax":{"type":"string","example":"","description":"charge tax"},"total_charge":{"type":"string","example":"90","description":"Total charge"},"charge_category":{"type":"string","example":"0","description":"Charge Category"},"quantity_based":{"type":"string","example":"N","description":"quantity based"},"charge_amount_type":{"type":"string","example":"Fixed","description":"Charge amount type"},"charge_frequency":{"type":"string","example":"2","description":"Charge Frequency"},"charge_factor":{"type":"string","example":"1","description":"Charge Factor"},"is_prorata":{"type":"string","example":"0","description":"Is pro rated"},"prorata_flags":{"type":"string","example":"","description":"Pro rata flags"},"charge_code":{"type":"string","example":"65","description":"Charge Code"},"version":{"type":"string","example":"1","description":"Version"}}}},"cfss":{"type":"array","items":{"type":"object","required":["id","name","family","type","service_type","service_class","transport_type","service_category","characteristics"],"properties":{"id":{"type":"string","example":"2788","description":"id associated with the cfss"},"name":{"type":"string","example":"CFSS_DATA","description":"name associated with the cfss"},"family":{"type":"string","example":"","description":"family"},"type":{"type":"string","example":"1","description":"Type"},"service_type":{"type":"string","example":"1","description":"service type"},"service_class":{"type":"string","example":"2","description":"service class"},"transport_type":{"type":"string","example":"6","description":"transport type"},"service_category":{"type":"string","example":"1","description":"service category"},"characteristics":{"type":"array","description":"array of characterestics","items":{"type":"object","required":["id","name","value"],"properties":{"id":{"type":"string","example":"30","description":""},"name":{"type":"string","example":"SPEEDCODE","description":""},"value":{"type":"string","example":"100X10","description":""}}}}}}}}}},"deposit":{"type":"object","required":["comment","currency_code","booking_id","status","actual_amount","deposit_amount","deposit_details"],"properties":{"comment":{"type":"string","example":"deposit","description":"free text field to capture comments"},"currency_code":{"type":"string","example":"USD","description":"currency associated with the payment"},"booking_id":{"type":"string","example":"1","description":"unique generated booking id"},"status":{"type":"string","example":"1","description":"status"},"actual_amount":{"type":"string","example":"50.00","description":"actual amount paid"},"deposit_amount":{"type":"string","example":"30.00","description":"deposit amount"},"deposit_details":{"type":"array","items":{"type":"object","required":["payment_details"],"properties":{"payment_details":{"type":"array","items":{"type":"object","required":["payment_mode","deposit_amount","charge_code"],"properties":{"payment_mode":{"type":"string","example":"3","description":"payment mode associated with the payment"},"deposit_amount":{"type":"string","example":"30.00","description":"deposit amount"},"charge_code":{"type":"string","example":"55","description":"charge code"}}}}}}}}}}}}}}}}}}},"installation_details":{"type":"object","required":["installation_type","installation_charges","appointment_details"],"properties":{"installation_type":{"type":"string","example":"Tech","description":"installation type"},"installation_charges":{"type":"array","items":{"type":"object","required":["charge_type","charge_name","charge_desc","original_charge_amount","charge_amount","start_date","end_date","charge_tax","total_charge","charge_category","quantity_based","charge_amount_type","charge_frequency","charge_factor","is_prorata","prorata_flags","charge_code","version"],"properties":{"charge_type":{"type":"string","example":"2","description":"charge type"},"charge_name":{"type":"string","example":"HD Equipment Monthly Fee","description":"charge name"},"charge_desc":{"type":"string","example":"","description":"charge description"},"original_charge_amount":{"type":"string","example":"10.00","description":"original charge amount"},"charge_amount":{"type":"string","example":"10.00","description":"overridden charge amount"},"start_date":{"type":"string","example":"26032020120153","description":"start date"},"end_date":{"type":"string","example":"26032020120153","description":"end date"},"charge_tax":{"type":"string","example":"","description":"tax charges"},"total_charge":{"type":"string","example":"10.00","description":"total charges"},"charge_category":{"type":"string","example":"0","description":"Billing Charge Category"},"quantity_based":{"type":"string","example":"N","description":"quantity based"},"charge_amount_type":{"type":"string","example":"Fixed","description":"charge amount type"},"charge_frequency":{"type":"string","example":"2","description":"billing charge frequency"},"charge_factor":{"type":"string","example":"1","description":"charge factor"},"is_prorata":{"type":"string","example":"0","description":"is prorata"},"prorata_flags":{"type":"string","example":"","description":"prorata flag"},"charge_code":{"type":"string","example":"65","description":"billing charge code"},"version":{"type":"string","example":"1","description":"version"}}}},"appointment_details":{"type":"object","required":["pawId","promised_arrival_window","work_order_type","ONT_reqired","is_drop_installed","is_wiring_required","construction_type","access_po","service_po","action"],"properties":{"pawId":{"type":"string","example":"2571","description":"promissed arrival window"},"promised_arrival_window":{"type":"object","required":["date","slot"],"properties":{"date":{"type":"string","example":"08/21/2020","description":"paw date"},"slot":{"type":"object","description":"Details about the slot","required":["id","start_time","end_time","start_time_12hr_format","end_time_12hr_format"],"properties":{"id":{"type":"number","example":"5","description":"WFM defined slot id"},"start_time":{"type":"string","example":"08:00:00","description":"Tech install start time"},"end_time":{"type":"string","example":"10:00:00","description":"Tech install end time"},"start_time_12hr_format":{"type":"string","example":"8:00:00 AM","description":"start time in 12 hour format"},"end_time_12hr_format":{"type":"string","example":"10:00:00 AM","description":"end time in 12 hour format"}}}}},"work_order_type":{"type":"string","example":"FTTH","description":"Work Order Type"},"ONT_reqired":{"type":"string","example":"yes","description":"ONT required"},"is_drop_installed":{"type":"string","example":"false","description":"is drop required"},"is_wiring_required":{"type":"string","example":"true","description":"is wiring required"},"construction_type":{"type":"string","example":"Buried","description":"defined construction type"},"access_po":{"type":"string","example":"101","description":"access po as defined in UPC"},"service_po":{"type":"string","example":"201","description":"service po as defined in UPC"},"action":{"type":"string","example":"301","description":"action as defined in UPC"}}}}},"access_details":{"type":"object","required":["access_cfss","access_prss"],"properties":{"access_cfss":{"type":"array","items":{"type":"object","required":["id","name","provisioning_status","transport_type","service_type","service_class","service_category","access_type","plan_id","plan_name","characteristics","instance_id"],"properties":{"id":{"type":"string","example":"2808","description":"cffs id"},"name":{"type":"string","example":"CFSS_PON","description":"CFSS name"},"provisioning_status":{"type":"string","example":"PENDING","description":"Provisioning status"},"transport_type":{"type":"string","example":"6","description":"transport type"},"service_type":{"type":"string","example":"1","description":"service type"},"service_class":{"type":"string","example":"1","description":"service class"},"service_category":{"type":"string","example":"1","description":"service category"},"access_type":{"type":"string","example":"FIBER","description":"access type"},"plan_id":{"type":"string","example":"453","description":"UPC plan id"},"plan_name":{"type":"string","example":"ACCESS_PON","description":"UPC plan name"},"characteristics":{"type":"array","items":{"type":"object"}},"instance_id":{"type":"string","example":"10001","description":"unique instance id"}}}},"access_prss":{"type":"array","items":{"type":"object","description":"access device details","required":["id","name","provisioning_status","transport_type","service_type","service_class","service_category","instance_id","characteristics","subscription_details"],"properties":{"id":{"type":"string","example":"2808","description":"id as defined in UPC"},"name":{"type":"string","example":"PRS_RG","description":"device name"},"provisioning_status":{"type":"string","example":"PENDING","description":"provisioning status of the device"},"transport_type":{"type":"string","example":"6","description":"transport type"},"service_type":{"type":"string","example":"1","description":"service type"},"service_class":{"type":"string","example":"1","description":"service class"},"service_category":{"type":"string","example":"1","description":"service category"},"instance_id":{"type":"string","example":"10002","description":"unique instance id"},"characteristics":{"type":"array","items":{"type":"object","required":["id","name","value"],"properties":{"id":{"type":"string","example":"43","description":"characterestics id"},"name":{"type":"string","example":"SerialNumber","description":"name of the property"},"value":{"type":"string","example":"","description":"value associated for the property"}}}},"subscription_details":{"type":"object","required":["plan_id","plan_name","plan_desc","product_id","product_name","subscription_type","subscription_charges"],"properties":{"plan_id":{"type":"string","example":"395","description":"plan id as defined in UPC"},"plan_name":{"type":"string","example":"PO_RG","description":"plan name"},"plan_desc":{"type":"string","example":"RG_PLAN","description":"plan description"},"product_id":{"type":"string","example":"765","description":"product id"},"product_name":{"type":"string","example":"ACCESS","description":"product name"},"subscription_type":{"type":"string","example":"1","description":"suscription type"},"subscription_charges":{"type":"array","items":{"type":"object","required":["charge_type","charge_name","charge_desc","original_charge_amount","charge_amount","start_date","end_date","charge_tax","total_charge","charge_validity","charge_category","charge_id","quantity_based","charge_classification","charge_amount_type","charge_frequency","charge_factor","is_prorata","prorata_flags","charge_code","version","linked_service_instance_id"],"properties":{"charge_type":{"type":"string","example":"2","description":"charge type"},"charge_name":{"type":"string","example":"RG_PRICE","description":"charge name"},"charge_desc":{"type":"string","example":"","description":"charge description"},"original_charge_amount":{"type":"string","example":"0.00","description":"original charge amount"},"charge_amount":{"type":"string","example":"0.00","description":"overridden charge amount"},"start_date":{"type":"string","example":"26032020120153","description":"plan start date"},"end_date":{"type":"string","example":"26032020120153","description":"plan end date"},"charge_tax":{"type":"string","example":"","description":"charge tax"},"total_charge":{"type":"string","example":"0.00","description":"total charge"},"charge_validity":{"type":"string","example":"","description":"charge validity"},"charge_category":{"type":"string","example":"0","description":"charge category"},"charge_id":{"type":"string","example":"464","description":"charge id"},"quantity_based":{"type":"string","example":"N","description":"quantity based"},"charge_classification":{"type":"string","example":"0","description":"charge classification"},"charge_amount_type":{"type":"string","example":"Fixed","description":"charge amount type"},"charge_frequency":{"type":"string","example":"2","description":"charge frequency"},"charge_factor":{"type":"string","example":"1","description":"charge factor"},"is_prorata":{"type":"string","example":"0","description":"is prorata"},"prorata_flags":{"type":"string","example":"","description":"prorata flag"},"charge_code":{"type":"string","example":"65","description":"charge code"},"version":{"type":"string","example":"1","description":"version of the plan"},"linked_service_instance_id":{"type":"string","example":"10003","description":"linked service id"}}}}}}}}}}},"payment_details":{"type":"object","required":["upfront_payment","payment_received","amount","collection_source_type","collection_id","comment","currency_code","total_amount","payment_detail"],"properties":{"upfront_payment":{"type":"string","example":"true","description":"upfront payment"},"payment_received":{"type":"string","example":"true","description":"payment received"},"amount":{"type":"string","example":"22.0","description":"amount"},"collection_source_type":{"type":"string","example":"NORMAL","description":"collection source type"},"collection_id":{"type":"string","example":"12","description":"collection id"},"comment":{"type":"string","example":"order payment","description":"comment"},"currency_code":{"type":"string","example":"USD","description":"currency code"},"total_amount":{"type":"string","example":"22.00","description":"total amount"},"payment_detail":{"type":"array","items":{"type":"object","required":["payment_mode","reference_external_id","amount_paid","mode_detail"],"properties":{"payment_mode":{"type":"string","example":"1","description":"payment mode"},"reference_external_id":{"type":"string","example":"4604","description":"reference external id"},"amount_paid":{"type":"string","example":"11.0","description":"amount paid"},"mode_detail":{"type":"array","description":"payment mode specific details","items":{"type":"object","description":"key value details","required":["key","value"],"properties":{"key":{"type":"string","example":"token","description":""},"value":{"type":"string","example":"cus_Dw3ki2DzVqciKV","description":""}}}}}}}}},"dataset":{"type":"object","description":"additional data in key value pair","required":["param"],"properties":{"param":{"type":"array","items":{"type":"object","required":["id","value"],"properties":{"id":{"type":"string","example":"","description":"key"},"value":{"type":"string","example":"","description":"value"}}}}}}}}}}}}},"parameters":[{"in":"header","name":"sourcenode","example":"SCM,POS,CRM","schema":{"type":"string"},"required":true,"description":"pass the channel id from the request is being raised."},{"in":"header","name":"userid","example":"1,2,3","schema":{"type":"string"},"required":true,"description":"pass the user id from whom the request is being raised."},{"in":"header","name":"username","example":"Admin,SuperAdmin","schema":{"type":"string"},"required":true,"description":"pass the user name from whom the request is being raised."}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","required":["request_id","source_node","result_code","result_desc"],"properties":{"request_id":{"type":"string","example":"8691932461","description":"A unique identifier for  each request"},"request_timestamp":{"type":"string","example":"2020-10-30 12:32:01","description":"Timestamp of the current request"},"source_node":{"type":"string","example":"CRM","description":"source of system"},"result_code":{"type":"string","example":"0","description":"0 for success, non zero failure"},"result_desc":{"type":"string","example":"Success","description":"Description of the status."},"action":{"type":"string","example":"CreateOrder","description":""},"message":{"type":"string","example":"The order was created successfully","description":"message provided upon successfull order creation"},"dataset":{"type":"object","required":["param"],"properties":{"param":{"type":"array","items":{"type":"object","required":["id","value"],"properties":{"id":{"type":"string","example":"order_id","description":"order id created for the request"},"value":{"type":"string","example":"11315203660545","description":"generated order id"}}}}}}}}}}},"400":{"description":"bad request","content":{"application/json":{"schema":{"type":"object","required":["request_id","source_node","result_code","result_desc"],"properties":{"request_id":{"type":"string","example":"8729871123","description":"Unique id generated by system for purticular request"},"source_node":{"type":"string","example":"CRM","description":"Requested Channel id"},"result_code":{"type":"string","example":"400","description":"Result Code"},"result_desc":{"type":"string","example":"Request validation failed","description":"Result Description"},"message":{"type":"string","example":"Required fields username are missing in Header","description":"Message provided upon missing the values in header"}}}}}},"405":{"description":"Invalid input"},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"type":"object","required":["request_id","source_node","result_code","result_desc"],"properties":{"request_id":{"type":"string","example":"8729871123","description":"Unique id generated by system for purticular request"},"source_node":{"type":"string","example":"CRM","description":"Requested Channel id"},"result_code":{"type":"string","example":"500","description":"Result Code"},"result_desc":{"type":"string","example":"Failure","description":"Result Description"},"message":{"type":"string","example":"Internal Server Error","description":"Message provided upon internal Error"}}}}}}}}},"/orders/makePayment":{"post":{"tags":["MakePayment"],"summary":"Register a payment","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["order_information"],"properties":{"order_information":{"type":"object","required":["order_type","customer_name","contact_number","payment","dataset"],"properties":{"order_type":{"type":"string","example":"MakePayment","description":"unique order type that defines the operation"},"customer_name":{"type":"string","example":"Bernad Daniel","description":"Customers Name"},"contact_number":{"type":"string","example":"865) 765-4635","description":"Customers Telephone Number"},"payment":{"type":"object","required":["account_id","profile_id","amount","collection_source_type","collection_id","comment","currency_code","invoice_ids","invoice_amounts","transaction_id","payment_detail"],"properties":{"account_id":{"type":"string","example":"1000108785","description":"Customer's account id"},"profile_id":{"type":"string","example":"5001629873","description":"Customer's profile id"},"amount":{"type":"string","example":"25","description":"Amount paid to be booked for the billing account"},"collection_source_type":{"type":"string","example":"NORMAL","description":"Source collector if any."},"collection_id":{"type":"string","example":"12","description":"Source collector user id"},"comment":{"type":"string","example":"order payment","description":"comment"},"currency_code":{"type":"string","example":"USD","description":"Currency code in which the payment was registered. Eg:USD, INR etc."},"invoice_ids":{"type":"string","example":"","description":"The invoice ID for which the payment should be registered. Multiple comma-separated invoice Id’s can be given if the payment is done for multiple invoices."},"invoice_amounts":{"type":"string","example":"","description":"The invoice amount to be considered for payment adjusting from the total paid amount. "},"transaction_id":{"type":"string","example":"12323553434","description":"transaction id"},"payment_detail":{"type":"array","items":{"type":"object","required":["payment_mode","amount_paid","reference_external_id","card_holder_name","mode_detail"],"properties":{"payment_mode":{"type":"string","example":"1","description":"Mode in which the payment is done. For example, 1-CC,2-DC,3-Cheque,4-DD,6-Cash"},"amount_paid":{"type":"string","example":"5","description":"Actual amount paid by the subscriber."},"reference_external_id":{"type":"string","example":"4520941365","description":"Transaction Reference Number"},"card_holder_name":{"type":"string","example":"Patrisa","description":"name of the card holder"},"mode_detail":{"type":"array","items":{"type":"object","required":["key","value"],"properties":{"key":{"type":"string","example":"token","description":"Name of the property"},"value":{"type":"string","example":"vsE0aZWzPq02376","description":"value associated with the property"}}}}}}}}},"dataset":{"type":"object","required":["param"],"properties":{"param":{"type":"array","items":{"type":"object","required":["id","value"],"properties":{"id":{"type":"string","example":"","description":"Name of the property"},"value":{"type":"string","example":"","description":"Value associated with the property"}}}}}}}}}}}}},"parameters":[{"in":"header","name":"sourcenode","example":"SCM,POS,CRM","schema":{"type":"string"},"required":true,"description":"pass the channel id from the request is being raised."},{"in":"header","name":"userid","example":"1,2,3","schema":{"type":"string"},"required":true,"description":"pass the user id from whom the request is being raised."},{"in":"header","name":"username","example":"Admin,SuperAdmin","schema":{"type":"string"},"required":true,"description":"pass the user name from whom the request is being raised."}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","required":["request_id","source_node","result_code","result_desc"],"properties":{"request_id":{"type":"string","example":"1213213213","description":"Unique id generated by system for purticular request"},"source_node":{"type":"string","example":"POS","description":"Requested Channel id"},"result_code":{"type":"string","example":"0","description":"Result code"},"result_desc":{"type":"string","example":"Success","description":"Result description"},"message":{"type":"string","example":"The order was created successfully","description":"Message provided upon successfull order submission"},"dataset":{"type":"object","required":["param"],"properties":{"param":{"type":"array","items":{"type":"object","required":["id","value"],"properties":{"id":{"type":"string","example":"order_id","description":"order and suborder created for the purticular order"},"value":{"type":"string","example":"2866731323","description":"Unique value for the order and suborder created"}}}}}}}}}}},"400":{"description":"bad request","content":{"application/json":{"schema":{"type":"object","required":["request_id","source_node","result_code","result_desc"],"properties":{"request_id":{"type":"string","example":"8729871123","description":"Unique id generated by system for purticular request"},"source_node":{"type":"string","example":"CRM","description":"Requested Channel id"},"result_code":{"type":"string","example":"400","description":"Result Code"},"result_desc":{"type":"string","example":"Request validation failed","description":"Result Description"},"message":{"type":"string","example":"Required fields username are missing in Header","description":"Message provided upon missing the values in header"}}}}}},"405":{"description":"Invalid input"},"500":{"description":"internal server error","content":{"application/json":{"schema":{"type":"object","required":["request_id","source_node","result_code","result_desc"],"properties":{"request_id":{"type":"string","example":"8729871123","description":"Unique id generated by system for purticular request"},"source_node":{"type":"string","example":"CRM","description":"Requested Channel id"},"result_code":{"type":"string","example":"500","description":"Result Code"},"result_desc":{"type":"string","example":"Failure","description":"Result Description"},"message":{"type":"string","example":"Internal Server Error","description":"Message provided upon internal Error"}}}}}}}}},"/orders/changePlan":{"post":{"tags":["ChangePlan"],"summary":"ChangePlan","parameters":[{"in":"header","name":"requestid","example":"11284722194081","schema":{"type":"string"},"required":false,"description":"unique id of for the request"},{"in":"header","name":"requesttimestamp","example":"Configurable format","schema":{"type":"string"},"description":"timestamp by which the request is initiated from the source","required":false},{"in":"header","name":"sourcenode","example":"CRM","schema":{"type":"string"},"description":"source identifier from where the request is originated","required":true},{"in":"header","name":"userid","example":"1","schema":{"type":"string"},"description":"id of the user initating the request","required":true},{"in":"header","name":"username","example":"Admin","schema":{"type":"string"},"description":"name of user initating the request","required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["order_information"],"properties":{"order_information":{"type":"object","required":["order_type","customer_name","contact_number","service_management","dataset"],"properties":{"order_type":{"type":"string","example":"ChangePlan","description":""},"customer_name":{"type":"string","example":"bernard","description":""},"contact_number":{"type":"string","example":"121324435","description":""},"service_management":{"type":"object","required":["service_id","profile_id","account_id","service_code","service_name","new_cart_details","old_cart_details","service_address"],"properties":{"service_id":{"type":"string","example":"IPT300074","description":""},"profile_id":{"type":"string","example":"100149","description":""},"account_id":{"type":"string","example":"200126","description":""},"service_code":{"type":"string","example":"6","description":""},"service_name":{"type":"string","example":"IPTV","description":""},"new_cart_details":{"type":"object","required":["subscriptions","contract_details"],"properties":{"subscriptions":{"type":"array","items":{"type":"object","required":["product_id","product_name","plan_id","plan_name","plan_desc","short_plan_desc","offer_service_id","receipt_no","deposit_amount","offer_service_name","activation_date","effective_date","expiry_date","is_base_plan","external_plan_id","status","subscription_type","isInternationalRoaming","subscription_charges","prss","cfss"],"properties":{"product_id":{"type":"string","example":"83","description":""},"product_name":{"type":"string","example":"IPTV","description":""},"plan_id":{"type":"string","example":"332","description":""},"plan_name":{"type":"string","example":"HBO","description":""},"plan_desc":{"type":"string","example":"HBO","description":""},"short_plan_desc":{"type":"string","example":"PO1004","description":""},"offer_service_id":{"type":"string","example":"12","description":""},"receipt_no":{"type":"string","example":"123","description":""},"deposit_amount":{"type":"string","example":"20","description":""},"offer_service_name":{"type":"string","example":"","description":""},"activation_date":{"type":"string","example":"Configurable format","description":""},"effective_date":{"type":"string","example":"Configurable format","description":""},"expiry_date":{"type":"string","example":"Configurable format","description":""},"is_base_plan":{"type":"string","example":"1","description":""},"external_plan_id":{"type":"string","example":"1004","description":""},"status":{"type":"string","example":"1","description":""},"subscription_type":{"type":"string","example":"0","description":""},"isInternationalRoaming":{"type":"string","example":"false","description":""},"subscription_charges":{"type":"array","items":{"type":"object","required":["charge_code","charge_name","charge_desc","charge_category","charge_amount","charge_frequency","charge_factor","start_date","end_date","charge_tax","total_charge","charge_validity","is_prorata","charge_type","prorata_flags"],"properties":{"charge_code":{"type":"string","example":"28","description":""},"charge_name":{"type":"string","example":"HSI200_POP","description":""},"charge_desc":{"type":"string","example":"HSI200_POP","description":""},"charge_category":{"type":"string","example":"1","description":""},"charge_amount":{"type":"string","example":"1000.0","description":""},"charge_frequency":{"type":"string","example":"2","description":""},"charge_factor":{"type":"string","example":"1","description":""},"start_date":{"type":"string","example":"Configurable format","description":""},"end_date":{"type":"string","example":"Configurable format","description":""},"charge_tax":{"type":"string","example":"0.0","description":""},"total_charge":{"type":"string","example":"1000.0","description":""},"charge_validity":{"type":"string","example":"180","description":""},"is_prorata":{"type":"string","example":"0","description":""},"charge_type":{"type":"string","example":"10","description":""},"prorata_flags":{"type":"string","example":"0000","description":""}}}},"prss":{"type":"array","items":{"type":"object","required":["id","name","family","type","service_type","service_class","transport_type","service_category","characteristics"],"properties":{"id":{"type":"string","example":"2901","description":""},"name":{"type":"string","example":"PRS_DVR_STB","description":""},"family":{"type":"string","example":"","description":""},"type":{"type":"string","example":"1","description":""},"service_type":{"type":"string","example":"3","description":""},"service_class":{"type":"string","example":"2","description":""},"transport_type":{"type":"string","example":"4","description":""},"service_category":{"type":"string","example":"3","description":""},"characteristics":{"type":"array","items":{"type":"object"}}}}},"cfss":{"type":"array","items":{"type":"object","required":["id","name","family","type","service_type","service_class","transport_type","service_category","characteristics"],"properties":{"id":{"type":"string","example":"2788","description":""},"name":{"type":"string","example":"CFSS_CHANNEL_GROUP_BASE","description":""},"family":{"type":"string","example":"","description":""},"type":{"type":"string","example":"1","description":""},"service_type":{"type":"string","example":"1","description":""},"service_class":{"type":"string","example":"3","description":""},"transport_type":{"type":"string","example":"3","description":""},"service_category":{"type":"string","example":"2","description":""},"characteristics":{"type":"array","items":{"type":"object","required":["id","name","value"],"properties":{"id":{"type":"string","example":"30","description":""},"name":{"type":"string","example":"GROUPID","description":""},"value":{"type":"string","example":"CINEMAX","description":""}}}}}}}}}}}},"old_cart_details":{"type":"object","required":["current_base_plan_id","current_base_plan_name","contract_details"],"properties":{}},"service_address":{"type":"object","required":["addr_line1","addr_line2","addr_line3","addr_line4","addr_line5"],"properties":{}}}},"dataset":{"type":"object","required":["param"],"properties":{"param":{"type":"array","items":{"type":"object","required":["id","value"],"properties":{"id":{"type":"string","example":"entity_id","description":""},"value":{"type":"string","example":"200","description":""}}}}}}}}}}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","required":["request_id","source_node","result_code","result_desc"],"properties":{"request_id":{"type":"string","example":"3205387163","description":"A unique identifier from  each request"},"source_node":{"type":"string","example":"CRM","description":"source of system"},"result_code":{"type":"string","example":"0","description":"0 for success, non zero failure"},"result_desc":{"type":"string","example":"Success","description":"Description of the status."},"message":{"type":"string","example":"The order was created successfully","description":"message"},"dataset":{"type":"object","properties":{"param":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"order_id","description":"key"},"value":{"type":"string","example":"11298609938851","description":"value"}}}}}}}}}}},"400":{"description":"bad request","content":{"application/json":{"schema":{"type":"object","required":["request_id","source_node","result_code","result_desc"],"properties":{"request_id":{"type":"string","example":"8729871123","description":"Unique id generated by system for purticular request"},"source_node":{"type":"string","example":"CRM","description":"Requested Channel id"},"result_code":{"type":"string","example":"400","description":"Result Code"},"result_desc":{"type":"string","example":"Request validation failed","description":"Result Description"},"message":{"type":"string","example":"Required fields username are missing in Header","description":"Message provided upon missing values in header"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"type":"object","required":["request_id","source_node","result_code","result_desc"],"properties":{"request_id":{"type":"string","example":"8729871123","description":"Unique id generated by system for purticular request"},"source_node":{"type":"string","example":"CRM","description":"Requested Channel id"},"result_code":{"type":"string","example":"500","description":"Result Code"},"result_desc":{"type":"string","example":"Failure","description":"Result Description"},"message":{"type":"string","example":"Internal Server Error","description":"Message provided upon internal Error"}}}}}}}}},"/orders/addSubscription":{"post":{"tags":["AddSubscription"],"summary":"AddSubscription","parameters":[{"in":"header","name":"requestid","example":"11284722194081","schema":{"type":"string"},"required":false,"description":"unique id of for the request"},{"in":"header","name":"requesttimestamp","example":"Configurable format","schema":{"type":"string"},"description":"timestamp by which the request is initiated from the source","required":false},{"in":"header","name":"sourcenode","example":"CRM","schema":{"type":"string"},"description":"source identifier from where the request is originated","required":true},{"in":"header","name":"userid","example":"1","schema":{"type":"string"},"description":"id of the user initating the request","required":true},{"in":"header","name":"username","example":"Admin","schema":{"type":"string"},"description":"name of user initating the request","required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["order_information"],"properties":{"order_information":{"type":"object","required":["order_type","customer_name","contact_number","installation_details","service_management","dataset"],"properties":{"order_type":{"type":"string","example":"AddSubscription","description":""},"customer_name":{"type":"string","example":"bernard","description":""},"contact_number":{"type":"string","example":"121324435","description":""},"installation_details":{"type":"object","required":["installation_type","appointment_details"],"properties":{"installation_type":{"type":"string","example":"Tech","description":""},"appointment_details":{"type":"object","required":["pawId","work_order_type","promised_arrival_window","ONT_reqired","is_drop_installed","is_wiring_required","construction_type","access_po","service_po","action"],"properties":{"pawId":{"type":"string","example":"2571","description":""},"work_order_type":{"type":"string","example":"FTTH","description":""},"promised_arrival_window":{"type":"object","required":["date","slot"],"properties":{"date":{"type":"string","example":"Configurable format","description":""},"slot":{"type":"object","required":["id","start_time","end_time","start_time_12hr_format","end_time_12hr_format"],"properties":{"id":{"type":"number","example":"5","description":""},"start_time":{"type":"string","example":"08:00:00","description":""},"end_time":{"type":"string","example":"10:00:00","description":""},"start_time_12hr_format":{"type":"string","example":"8:00:00 AM","description":""},"end_time_12hr_format":{"type":"string","example":"10:00:00 AM","description":""}}}}},"ONT_reqired":{"type":"string","example":"yes","description":""},"is_drop_installed":{"type":"string","example":"false","description":""},"is_wiring_required":{"type":"string","example":"true","description":""},"construction_type":{"type":"string","example":"Buried","description":""},"access_po":{"type":"string","example":"101","description":""},"service_po":{"type":"string","example":"201","description":""},"action":{"type":"string","example":"301","description":""}}}}},"service_management":{"type":"object","required":["service_id","profile_id","account_id","service_code","service_name","subscriptions"],"properties":{"service_id":{"type":"string","example":"IPT300074","description":""},"profile_id":{"type":"string","example":"100149","description":""},"account_id":{"type":"string","example":"200126","description":""},"service_code":{"type":"string","example":"6","description":""},"service_name":{"type":"string","example":"IPTV","description":""},"subscriptions":{"type":"array","items":{"type":"object","required":["product_id","product_name","plan_id","plan_name","plan_desc","short_plan_desc","offer_service_id","receipt_no","deposit_amount","offer_service_name","activation_date","effective_date","expiry_date","is_base_plan","external_plan_id","status","subscription_type","isInternationalRoaming","subscription_charges","prss","cfss"],"properties":{"product_id":{"type":"string","example":"83","description":""},"product_name":{"type":"string","example":"IPTV","description":""},"plan_id":{"type":"string","example":"332","description":""},"plan_name":{"type":"string","example":"HBO","description":""},"plan_desc":{"type":"string","example":"HBO","description":""},"short_plan_desc":{"type":"string","example":"PO1004","description":""},"offer_service_id":{"type":"string","example":"12","description":""},"receipt_no":{"type":"string","example":"123","description":""},"deposit_amount":{"type":"string","example":"20","description":""},"offer_service_name":{"type":"string","example":"","description":""},"activation_date":{"type":"string","example":"Configurable format","description":""},"effective_date":{"type":"string","example":"Configurable format","description":""},"expiry_date":{"type":"string","example":"Configurable format","description":""},"is_base_plan":{"type":"string","example":"1","description":""},"external_plan_id":{"type":"string","example":"1004","description":""},"status":{"type":"string","example":"1","description":""},"subscription_type":{"type":"string","example":"0","description":""},"isInternationalRoaming":{"type":"string","example":"false","description":""},"subscription_charges":{"type":"array","items":{"type":"object","required":["charge_code","charge_name","charge_desc","charge_category","charge_amount","charge_frequency","charge_factor","start_date","end_date","charge_tax","total_charge","charge_validity","is_prorata","charge_type","prorata_flags"],"properties":{"charge_code":{"type":"string","example":"28","description":""},"charge_name":{"type":"string","example":"HSI200_POP","description":""},"charge_desc":{"type":"string","example":"HSI200_POP","description":""},"charge_category":{"type":"string","example":"1","description":""},"charge_amount":{"type":"string","example":"1000.0","description":""},"charge_frequency":{"type":"string","example":"2","description":""},"charge_factor":{"type":"string","example":"1","description":""},"start_date":{"type":"string","example":"Configurable format","description":""},"end_date":{"type":"string","example":"Configurable format","description":""},"charge_tax":{"type":"string","example":"0.0","description":""},"total_charge":{"type":"string","example":"1000.0","description":""},"charge_validity":{"type":"string","example":"180","description":""},"is_prorata":{"type":"string","example":"0","description":""},"charge_type":{"type":"string","example":"10","description":""},"prorata_flags":{"type":"string","example":"0000","description":""}}}},"prss":{"type":"array","items":{"type":"object","required":["id","name","family","type","service_type","service_class","transport_type","service_category","characteristics"],"properties":{"id":{"type":"string","example":"2901","description":""},"name":{"type":"string","example":"PRS_DVR_STB","description":""},"family":{"type":"string","example":"","description":""},"type":{"type":"string","example":"1","description":""},"service_type":{"type":"string","example":"3","description":""},"service_class":{"type":"string","example":"2","description":""},"transport_type":{"type":"string","example":"4","description":""},"service_category":{"type":"string","example":"3","description":""},"characteristics":{"type":"array","items":{"type":"object"}}}}},"cfss":{"type":"array","items":{"type":"object","required":["id","name","family","type","service_type","service_class","transport_type","service_category","characteristics"],"properties":{"id":{"type":"string","example":"2788","description":""},"name":{"type":"string","example":"CFSS_CHANNEL_GROUP_BASE","description":""},"family":{"type":"string","example":"","description":""},"type":{"type":"string","example":"1","description":""},"service_type":{"type":"string","example":"1","description":""},"service_class":{"type":"string","example":"3","description":""},"transport_type":{"type":"string","example":"3","description":""},"service_category":{"type":"string","example":"2","description":""},"characteristics":{"type":"array","items":{"type":"object","required":["id","name","value"],"properties":{"id":{"type":"string","example":"30","description":""},"name":{"type":"string","example":"GROUPID","description":""},"value":{"type":"string","example":"CINEMAX","description":""}}}}}}}}}}}},"dataset":{"type":"object","required":["param"],"properties":{"param":{"type":"array","items":{"type":"object","required":["id","value"],"properties":{"id":{"type":"string","example":"entity_id","description":""},"value":{"type":"string","example":"200","description":""}}}}}}}}}}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","required":["request_id","source_node","result_code","result_desc"],"properties":{"request_id":{"type":"string","example":"3205387163","description":"A unique identifier from  each request"},"source_node":{"type":"string","example":"CRM","description":"source of system"},"result_code":{"type":"string","example":"0","description":"0 for success, non zero failure"},"result_desc":{"type":"string","example":"Success","description":"Description of the status."},"message":{"type":"string","example":"The order was created successfully","description":"message"},"dataset":{"type":"object","properties":{"param":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"order_id","description":"key"},"value":{"type":"string","example":"11298609938851","description":"value"}}}}}}}}}}},"400":{"description":"bad request","content":{"application/json":{"schema":{"type":"object","required":["request_id","source_node","result_code","result_desc"],"properties":{"request_id":{"type":"string","example":"8729871123","description":"Unique id generated by system for purticular request"},"source_node":{"type":"string","example":"CRM","description":"Requested Channel id"},"result_code":{"type":"string","example":"400","description":"Result Code"},"result_desc":{"type":"string","example":"Request validation failed","description":"Result Description"},"message":{"type":"string","example":"Required fields username are missing in Header","description":"Message provided upon missing values in header"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"type":"object","required":["request_id","source_node","result_code","result_desc"],"properties":{"request_id":{"type":"string","example":"8729871123","description":"Unique id generated by system for purticular request"},"source_node":{"type":"string","example":"CRM","description":"Requested Channel id"},"result_code":{"type":"string","example":"500","description":"Result Code"},"result_desc":{"type":"string","example":"Failure","description":"Result Description"},"message":{"type":"string","example":"Internal Server Error","description":"Message provided upon internal Error"}}}}}}}}},"/orders/cancelSubscription":{"post":{"tags":["CancelSubscription"],"summary":"CancelSubscription","parameters":[{"in":"header","name":"requestid","example":"11284722194081","schema":{"type":"string"},"required":false,"description":"unique id of for the request"},{"in":"header","name":"requesttimestamp","example":"Configurable format","schema":{"type":"string"},"description":"timestamp by which the request is initiated from the source","required":false},{"in":"header","name":"sourcenode","example":"CRM","schema":{"type":"string"},"description":"source identifier from where the request is originated","required":true},{"in":"header","name":"userid","example":"1","schema":{"type":"string"},"description":"id of the user initating the request","required":true},{"in":"header","name":"username","example":"Admin","schema":{"type":"string"},"description":"name of user initating the request","required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["order_information"],"properties":{"order_information":{"type":"object","required":["order_type","customer_name","contact_number","service_management"],"properties":{"order_type":{"type":"string","example":"CancelSubscription","description":""},"customer_name":{"type":"string","example":"bernard","description":""},"contact_number":{"type":"string","example":"1234567890","description":""},"payment_details":{"type":"object","required":["amount","collection_source_type","collection_id","comment","currency_code","total_amount","transaction_id","payment_detail"],"properties":{"upfront_payment":{"type":"string","example":"true","description":""},"payment_received":{"type":"string","example":"true","description":""},"amount":{"type":"string","example":"22.0","description":""},"collection_source_type":{"type":"string","example":"NORMAL","description":""},"collection_id":{"type":"string","example":"12","description":""},"comment":{"type":"string","example":"order payment","description":""},"currency_code":{"type":"string","example":"USD","description":""},"total_amount":{"type":"string","example":"22.00","description":""},"transaction_id":{"type":"string","example":"13213234234","description":""},"payment_detail":{"type":"array","items":{"type":"object","required":["payment_mode","reference_external_id","amount_paid","mode_detail"],"properties":{"payment_mode":{"type":"string","example":"1","description":""},"reference_external_id":{"type":"string","example":"4604","description":""},"amount_paid":{"type":"string","example":"11.0","description":""},"mode_detail":{"type":"array","items":{"type":"object","required":["key","value"],"properties":{"key":{"type":"string","example":"token","description":""},"value":{"type":"string","example":"cus_Dw3ki2DzVqciKV","description":""}}}}}}}}},"service_management":{"type":"object","required":["service_id","profile_id","account_id","subscriptions"],"properties":{"service_id":{"type":"string","example":"IPT300074","description":""},"profile_id":{"type":"string","example":"100149","description":""},"account_id":{"type":"string","example":"200126","description":""},"service_code":{"type":"string","example":"6","description":""},"service_name":{"type":"string","example":"IPTV","description":""},"subscriptions":{"type":"array","items":{"type":"object","required":["plan_id","subscription_id"],"properties":{"plan_id":{"type":"string","example":"332","description":""},"subscription_id":{"type":"string","example":"401987","description":""}}}}}},"dataset":{"type":"object","required":["param"],"properties":{"param":{"type":"array","items":{"type":"object","required":["id","value"],"properties":{"id":{"type":"string","example":"entity_id","description":""},"value":{"type":"string","example":"200","description":""}}}}}}}}}}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","required":["request_id","source_node","result_code","result_desc"],"properties":{"request_id":{"type":"string","example":"3205387163","description":"A unique identifier from  each request"},"source_node":{"type":"string","example":"CRM","description":"source of system"},"result_code":{"type":"string","example":"0","description":"0 for success, non zero failure"},"result_desc":{"type":"string","example":"Success","description":"Description of the status."},"message":{"type":"string","example":"The order was created successfully","description":"message"},"dataset":{"type":"object","properties":{"param":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"order_id","description":"key"},"value":{"type":"string","example":"11298609938851","description":"value"}}}}}}}}}}},"400":{"description":"bad request","content":{"application/json":{"schema":{"type":"object","required":["request_id","source_node","result_code","result_desc"],"properties":{"request_id":{"type":"string","example":"8729871123","description":"Unique id generated by system for purticular request"},"source_node":{"type":"string","example":"CRM","description":"Requested Channel id"},"result_code":{"type":"string","example":"400","description":"Result Code"},"result_desc":{"type":"string","example":"Request validation failed","description":"Result Description"},"message":{"type":"string","example":"Required fields username are missing in Header","description":"Message provided upon missing the values in header"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"type":"object","required":["request_id","source_node","result_code","result_desc"],"properties":{"request_id":{"type":"string","example":"8729871123","description":"Unique id generated by system for purticular request"},"source_node":{"type":"string","example":"CRM","description":"Requested Channel id"},"result_code":{"type":"string","example":"500","description":"Result Code"},"result_desc":{"type":"string","example":"Failure","description":"Result Description"},"message":{"type":"string","example":"Internal Server Error","description":"Message provided upon internal Error"}}}}}}}}},"/subscriber-info/profiles/{profile_id}":{"get":{"tags":["CustomerProfileSearch"],"summary":"Get basic details about a purticular profile.","parameters":[{"in":"path","name":"profile_id","schema":{"type":"string"},"required":true,"description":"ID of the profile that need to fetch.","example":125001},{"in":"header","name":"sourcenode","example":"SCM,POS,CRM","schema":{"type":"string"},"required":true,"description":"pass the channel id from the request is being raised."},{"in":"header","name":"userid","example":"1,2,3","schema":{"type":"string"},"required":true,"description":"pass the user id from whom the request is being raised."},{"in":"header","name":"username","example":"Admin,SuperAdmin","schema":{"type":"string"},"required":true,"description":"pass the user name from whom the request is being raised."}],"responses":{"200":{"description":"successfull operation","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["request_id","source_node","result_code","result_desc","profile_info"],"properties":{"request_id":{"type":"string","example":"1159196035","description":"Unique id generated by system for purticular request"},"source_node":{"type":"string","example":"CRM,SCM,POS","description":"Requested Channel id"},"result_code":{"type":"string","example":"0","description":"Result Code"},"result_desc":{"type":"string","example":"Success","description":"Result Description"},"profile_info":{"type":"object","required":["basic_details"],"properties":{"basic_details":{"type":"array","items":{"type":"object","required":["id","value"],"properties":{"id":{"type":"string","example":"profile_type","description":"name of the property; Examples - profile_name, date_of_birth, profile_type, subscriber_category"},"value":{"type":"string","example":"individual","description":"value associated for the property"}}}}}}}}]}}}},"400":{"description":"bad request","content":{"application/json":{"schema":{"type":"object","required":["request_id","source_node","result_code","result_desc"],"properties":{"request_id":{"type":"string","example":"8729871123","description":"Unique id generated by system for purticular request"},"source_node":{"type":"string","example":"CRM","description":"Requested Channel id"},"result_code":{"type":"string","example":"400","description":"Result Code"},"result_desc":{"type":"string","example":"Request validation failed","description":"Result Description"},"message":{"type":"string","example":"Required fields username are missing in Header","description":"Message provided upon missing the values in header"}}}}}},"405":{"description":"Invalid input"},"500":{"description":"bad request","content":{"application/json":{"schema":{"type":"object","required":["request_id","source_node","result_code","result_desc"],"properties":{"request_id":{"type":"string","example":"8729871123","description":"Unique id generated by system for purticular request"},"source_node":{"type":"string","example":"CRM","description":"Requested Channel id"},"result_code":{"type":"string","example":"500","description":"Result Code"},"result_desc":{"type":"string","example":"Failure","description":"Result Description"},"message":{"type":"string","example":"Internal Server Error","description":"Message provided upon internal Error"}}}}}}}}},"/subscriber-info/accounts/{account_id}":{"get":{"tags":["CustomerAccountSearch"],"summary":"Get basic details about a purticular account.","parameters":[{"in":"path","name":"account_id","schema":{"type":"string"},"required":true,"description":"ID of the account that need to fetch.","example":125001},{"in":"query","name":"filter","schema":{"type":"string"},"required":false,"allowReserved":true,"description":"pass in the query parameters if profile details associated with the account also need to be fetched.","example":"profile"},{"in":"header","name":"sourcenode","example":"SCM,POS,CRM","schema":{"type":"string"},"required":true,"description":"pass the channel id from the request is being raised."},{"in":"header","name":"userid","example":"1,2,3","schema":{"type":"string"},"required":true,"description":"pass the user id from whom the request is being raised."},{"in":"header","name":"username","example":"Admin,SuperAdmin","schema":{"type":"string"},"required":true,"description":"pass the user name from whom the request is being raised."}],"responses":{"200":{"description":"successfull operation","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["request_id","source_node","result_code","result_desc","account_info"],"properties":{"request_id":{"type":"string","example":"1159196035","description":"Unique id generated by system for purticular request"},"source_node":{"type":"string","example":"CRM,SCM,POS","description":"Requested Channel id"},"result_code":{"type":"string","example":"0","description":"Result Code"},"result_desc":{"type":"string","example":"Success","description":"Result Description"},"account_info":{"type":"object","required":["basic_details"],"properties":{"basic_details":{"type":"array","items":{"type":"object","required":["id","value"],"properties":{"id":{"type":"string","example":"dunning_enabled","description":"name of the property; Examples - billing_name, bill_cycle_id, itemized_required, dunning_scheduled, risk category"},"value":{"type":"string","example":"0","description":"value associated for the property"}}}}}}}}]}}}},"400":{"description":"bad request","content":{"application/json":{"schema":{"type":"object","required":["request_id","source_node","result_code","result_desc"],"properties":{"request_id":{"type":"string","example":"8729871123","description":"Unique id generated by system for purticular request"},"source_node":{"type":"string","example":"CRM","description":"Requested Channel id"},"result_code":{"type":"string","example":"400","description":"Result Code"},"result_desc":{"type":"string","example":"Request validation failed","description":"Result Description"},"message":{"type":"string","example":"Required fields username are missing in Header","description":"Message provided upon missing the values in header"}}}}}},"405":{"description":"Invalid input"},"500":{"description":"internal server error","content":{"application/json":{"schema":{"type":"object","required":["request_id","source_node","result_code","result_desc"],"properties":{"request_id":{"type":"string","example":"8729871123","description":"Unique id generated by system for purticular request"},"source_node":{"type":"string","example":"CRM","description":"Requested Channel id"},"result_code":{"type":"string","example":"500","description":"Result Code"},"result_desc":{"type":"string","example":"Failure","description":"Result Description"},"message":{"type":"string","example":"Internal Server Error","description":"Message provided upon internal Error"}}}}}}}}},"/subscriber-info/services/{service_id}":{"get":{"tags":["CustomerServiceSearch"],"summary":"Get basic details about a purticular service.","parameters":[{"in":"path","name":"service_id","schema":{"type":"string"},"required":true,"description":"ID of the service that need to fetch.","example":"NET0013"},{"in":"query","name":"filter","schema":{"type":"string"},"required":false,"allowReserved":true,"description":"pass in the query parameters if profile and account details associated with the service also need to be fetched.","example":"profile,account"},{"in":"header","name":"sourcenode","example":"SCM,POS,CRM","schema":{"type":"string"},"required":true,"description":"pass the channel id from the request is being raised."},{"in":"header","name":"userid","example":"1,2,3","schema":{"type":"string"},"required":true,"description":"pass the user id from whom the request is being raised."},{"in":"header","name":"username","example":"Admin,SuperAdmin","schema":{"type":"string"},"required":true,"description":"pass the user name from whom the request is being raised."}],"responses":{"200":{"description":"successfull operation","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["request_id","source_node","result_code","result_desc","service_info"],"properties":{"request_id":{"type":"string","example":"1159196035","description":"Unique id generated by system for purticular request"},"source_node":{"type":"string","example":"CRM,SCM,POS","description":"Requested Channel id"},"result_code":{"type":"string","example":"0","description":"Result Code"},"result_desc":{"type":"string","example":"Success","description":"Result Description"},"service_info":{"type":"object","required":["basic_details"],"properties":{"basic_details":{"type":"array","items":{"type":"object","required":["id","value"],"properties":{"id":{"type":"string","example":"status","description":"name of the property; Examples - connection_type, status, credit_limit, balance, base_plan_name, activation_date, crbt_status"},"value":{"type":"string","example":"active","description":"value associated for the property"}}}}}}}}]}}}},"400":{"description":"bad request","content":{"application/json":{"schema":{"type":"object","required":["request_id","source_node","result_code","result_desc"],"properties":{"request_id":{"type":"string","example":"8729871123","description":"Unique id generated by system for purticular request"},"source_node":{"type":"string","example":"CRM","description":"Requested Channel id"},"result_code":{"type":"string","example":"400","description":"Result Code"},"result_desc":{"type":"string","example":"Request validation failed","description":"Result Description"},"message":{"type":"string","example":"Required fields username are missing in Header","description":"Message provided upon missing the values in header"}}}}}},"405":{"description":"Invalid input"},"500":{"description":"internal server error","content":{"application/json":{"schema":{"type":"object","required":["request_id","source_node","result_code","result_desc"],"properties":{"request_id":{"type":"string","example":"8729871123","description":"Unique id generated by system for purticular request"},"source_node":{"type":"string","example":"CRM","description":"Requested Channel id"},"result_code":{"type":"string","example":"500","description":"Result Code"},"result_desc":{"type":"string","example":"Failure","description":"Result Description"},"message":{"type":"string","example":"Internal Server Error","description":"Message provided upon internal Error"}}}}}}}}},"/subscriber-info/subscriptions/{service_id}":{"get":{"tags":["QueryPlan"],"summary":"The API returns the order details associated with the customer","parameters":[{"in":"path","name":"service_id","schema":{"type":"string"},"required":true,"description":"Subscriber ID.","example":9876543210},{"in":"query","name":"subscription_type","schema":{"type":"string"},"required":true,"allowReserved":true,"description":"Subscription type - base_plan or addon.","example":"base_plan"},{"in":"header","name":"sourcenode","example":"SCM,POS,CRM","schema":{"type":"string"},"required":true,"description":"pass the channel id from the request is being raised."},{"in":"header","name":"userid","example":"1,2,3","schema":{"type":"string"},"required":true,"description":"pass the user id from whom the request is being raised."},{"in":"header","name":"username","example":"Admin,SuperAdmin","schema":{"type":"string"},"required":true,"description":"pass the user name from whom the request is being raised."}],"responses":{"200":{"description":"successfull operation","content":{"application/json":{"schema":{"type":"object","required":["request_id","source_node","result_code","result_desc","subscriptions"],"properties":{"request_id":{"type":"string","example":"4016861172","description":"unique id generated by system for purticular request"},"source_node":{"type":"string","example":"CRM","description":"Requested Channel id"},"result_code":{"type":"string","example":"0","description":"Result Code"},"result_desc":{"type":"string","example":"Success","description":"Result Description"},"subscriptions":{"type":"array","items":{"type":"object","required":["product_id","product_name","plan_id","plan_name","plan_desc","short_plan_desc","offer_service_id","receipt_no","deposit_amount","offer_service_name","activation_date","effective_date","expiry_date","is_base_plan","external_plan_id","status","subscription_type","isInternationalRoaming","subscription_charges","prss","cfss"],"properties":{"product_id":{"type":"string","example":"83","description":""},"product_name":{"type":"string","example":"IPTV","description":""},"plan_id":{"type":"string","example":"332","description":""},"plan_name":{"type":"string","example":"HBO","description":""},"plan_desc":{"type":"string","example":"HBO","description":""},"short_plan_desc":{"type":"string","example":"PO1004","description":""},"offer_service_id":{"type":"string","example":"12","description":""},"receipt_no":{"type":"string","example":"123","description":""},"deposit_amount":{"type":"string","example":"20","description":""},"offer_service_name":{"type":"string","example":"","description":""},"activation_date":{"type":"string","example":"Configurable format","description":""},"effective_date":{"type":"string","example":"Configurable format","description":""},"expiry_date":{"type":"string","example":"Configurable format","description":""},"is_base_plan":{"type":"string","example":"1","description":""},"external_plan_id":{"type":"string","example":"1004","description":""},"status":{"type":"string","example":"1","description":""},"subscription_type":{"type":"string","example":"0","description":""},"isInternationalRoaming":{"type":"string","example":"false","description":""},"subscription_charges":{"type":"array","items":{"type":"object","required":["charge_code","charge_name","charge_desc","charge_category","charge_amount","charge_frequency","charge_factor","start_date","end_date","charge_tax","total_charge","charge_validity","is_prorata","charge_type","prorata_flags"],"properties":{"charge_code":{"type":"string","example":"28","description":""},"charge_name":{"type":"string","example":"HSI200_POP","description":""},"charge_desc":{"type":"string","example":"HSI200_POP","description":""},"charge_category":{"type":"string","example":"1","description":""},"charge_amount":{"type":"string","example":"1000.0","description":""},"charge_frequency":{"type":"string","example":"2","description":""},"charge_factor":{"type":"string","example":"1","description":""},"start_date":{"type":"string","example":"Configurable format","description":""},"end_date":{"type":"string","example":"Configurable format","description":""},"charge_tax":{"type":"string","example":"0.0","description":""},"total_charge":{"type":"string","example":"1000.0","description":""},"charge_validity":{"type":"string","example":"180","description":""},"is_prorata":{"type":"string","example":"0","description":""},"charge_type":{"type":"string","example":"10","description":""},"prorata_flags":{"type":"string","example":"0000","description":""}}}},"prss":{"type":"array","items":{"type":"object","required":["id","name","family","type","service_type","service_class","transport_type","service_category","characteristics"],"properties":{"id":{"type":"string","example":"2901","description":""},"name":{"type":"string","example":"PRS_DVR_STB","description":""},"family":{"type":"string","example":"","description":""},"type":{"type":"string","example":"1","description":""},"service_type":{"type":"string","example":"3","description":""},"service_class":{"type":"string","example":"2","description":""},"transport_type":{"type":"string","example":"4","description":""},"service_category":{"type":"string","example":"3","description":""},"characteristics":{"type":"array","items":{"type":"object"}}}}},"cfss":{"type":"array","items":{"type":"object","required":["id","name","family","type","service_type","service_class","transport_type","service_category","characteristics"],"properties":{"id":{"type":"string","example":"2788","description":""},"name":{"type":"string","example":"CFSS_CHANNEL_GROUP_BASE","description":""},"family":{"type":"string","example":"","description":""},"type":{"type":"string","example":"1","description":""},"service_type":{"type":"string","example":"1","description":""},"service_class":{"type":"string","example":"3","description":""},"transport_type":{"type":"string","example":"3","description":""},"service_category":{"type":"string","example":"2","description":""},"characteristics":{"type":"array","items":{"type":"object","required":["id","name","value"],"properties":{"id":{"type":"string","example":"30","description":""},"name":{"type":"string","example":"GROUPID","description":""},"value":{"type":"string","example":"CINEMAX","description":""}}}}}}}}}}}}}}},"400":{"description":"bad request","content":{"application/json":{"schema":{"type":"object","required":["request_id","source_node","result_code","result_desc"],"properties":{"request_id":{"type":"string","example":"8729871123","description":"Unique id generated by system for purticular request"},"source_node":{"type":"string","example":"CRM","description":"Requested Channel id"},"result_code":{"type":"string","example":"400","description":"Result Code"},"result_desc":{"type":"string","example":"Request validation failed","description":"Result Description"},"message":{"type":"string","example":"Required fields username are missing in Header","description":"Message provided upon missing the values in header"}}}}}},"404":{"description":"not found","content":{"application/json":{"schema":{"type":"object","required":["request_id","source_node","result_code","result_desc"],"properties":{"request_id":{"type":"string","example":"1623970840","description":"Unique id generated by system for purticular request"},"source_node":{"type":"string","example":"CRM","description":"Requested Channel id"},"result_code":{"type":"string","example":"404","description":"Result Code"},"result_desc":{"type":"string","example":"Failure","description":"Result Description"},"message":{"type":"string","example":"No data found for the seach query orderId 12317276351908s","description":"Message provided upon no data found"},"dataset":{"type":"object","required":["param"],"properties":{"param":{"type":"array","items":{"type":"object","required":["id","value"],"properties":{"id":{"type":"string","example":"order_id","description":"order_id"},"value":{"type":"string","example":"12317276351908s","description":"order_id value"}}}}}}}}}}},"405":{"description":"Invalid input"},"500":{"description":"bad request","content":{"application/json":{"schema":{"type":"object","required":["request_id","source_node","result_code","result_desc"],"properties":{"request_id":{"type":"string","example":"8729871123","description":"Unique id generated by system for purticular request"},"source_node":{"type":"string","example":"CRM","description":"Requested Channel id"},"result_code":{"type":"string","example":"500","description":"Result Code"},"result_desc":{"type":"string","example":"Failure","description":"Result Description"},"message":{"type":"string","example":"Internal Server Error","description":"Message provided upon internal Error"}}}}}}}}},"/orders/suspend":{"post":{"tags":["SuspendService"],"summary":"Suspend a purticular service","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["order_information"],"properties":{"order_information":{"type":"object","required":["customer_name","contact_number","order_type","dataset"],"properties":{"customer_name":{"type":"string","example":"John Honai","description":"Customers Name"},"contact_number":{"type":"string","example":"(865) 765-4635","description":"Customers Telephone Number"},"order_type":{"type":"string","example":"Suspend","description":"unique order type that defines the operation"},"dataset":{"type":"object","required":["param"],"properties":{"param":{"type":"array","items":{"type":"object","required":["id","value"],"properties":{"id":{"type":"string","example":"service_id","description":"name of the property, Mandatory properties are profile_id,service_id,account_id,current_status,new_status,reason_code,reason_desc,service_code"},"value":{"type":"string","example":"9876543210","description":"value associated for the property"}}}}}}}}}}}}},"parameters":[{"in":"header","name":"sourcenode","example":"SCM,POS,CRM","schema":{"type":"string"},"required":true,"description":"pass the channel id from the request is being raised."},{"in":"header","name":"userid","example":"1,2,3","schema":{"type":"string"},"required":true,"description":"pass the user id from whom the request is being raised."},{"in":"header","name":"username","example":"Admin,SuperAdmin","schema":{"type":"string"},"required":true,"description":"pass the user name from whom the request is being raised."}],"responses":{"200":{"description":"successfull operation","content":{"application/json":{"schema":{"type":"object","required":["request_id","request_timestamp","source_node","result_code","result_desc","dataset"],"properties":{"request_id":{"type":"string","example":"1435163396","description":"Unique id generated by system for purticular request"},"request_timestamp":{"type":"string","example":"2020-09-18 17:22:28","description":"Timestamp of the current response received"},"source_node":{"type":"string","example":"SCM,CRM,POS","description":"Requested Channel id"},"result_code":{"type":"string","example":"0","description":"Result Code"},"result_desc":{"type":"string","example":"Success","description":"Result Description"},"action":{"type":"string","example":"CreateOrder","description":""},"message":{"type":"string","example":"The order was created successfully","description":"Message provided upon successfull order submission"},"dataset":{"type":"object","required":["param"],"properties":{"param":{"type":"array","items":{"type":"object","required":["id","value"],"properties":{"id":{"type":"string","example":"order_id","description":"order and suborder created for the purticular order"},"value":{"type":"string","example":"12311594974509","description":"Unique value for the order and suborder created"}}}}}}}}}}},"400":{"description":"bad request","content":{"application/json":{"schema":{"type":"object","required":["request_id","source_node","result_code","result_desc"],"properties":{"request_id":{"type":"string","example":"8729871123","description":"Unique id generated by system for purticular request"},"source_node":{"type":"string","example":"CRM","description":"Requested Channel id"},"result_code":{"type":"string","example":"400","description":"Result Code"},"result_desc":{"type":"string","example":"Request validation failed","description":"Result Description"},"message":{"type":"string","example":"Required fields username are missing in Header","description":"Message provided upon missing the values in header"}}}}}},"405":{"description":"Invalid input"},"500":{"description":"internal server error","content":{"application/json":{"schema":{"type":"object","required":["request_id","source_node","result_code","result_desc"],"properties":{"request_id":{"type":"string","example":"8729871123","description":"Unique id generated by system for purticular request"},"source_node":{"type":"string","example":"CRM","description":"Requested Channel id"},"result_code":{"type":"string","example":"500","description":"Result Code"},"result_desc":{"type":"string","example":"Failure","description":"Result Description"},"message":{"type":"string","example":"Internal Server Error","description":"Message provided upon internal Error"}}}}}}}}},"/orders/resume":{"post":{"tags":["ResumeService"],"summary":"Resume a purticular service","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["order_information"],"properties":{"order_information":{"type":"object","required":["customer_name","contact_number","order_type","dataset"],"properties":{"customer_name":{"type":"string","example":"John Honai","description":"Customers Name"},"contact_number":{"type":"string","example":"(865) 765-4635","description":"Customers Telephone Number"},"order_type":{"type":"string","example":"Resume","description":"unique order type that defines the operation"},"dataset":{"type":"object","required":["param"],"properties":{"param":{"type":"array","items":{"type":"object","required":["id","value"],"properties":{"id":{"type":"string","example":"service_id","description":"name of the property, Mandatory properties are profile_id,service_id,account_id,current_status,new_status,reason_code,reason_desc,service_code"},"value":{"type":"string","example":"9876543210","description":"value associated for the property"}}}}}}}}}}}}},"parameters":[{"in":"header","name":"sourcenode","example":"SCM,POS,CRM","schema":{"type":"string"},"required":true,"description":"pass the channel id from the request is being raised."},{"in":"header","name":"userid","example":"1,2,3","schema":{"type":"string"},"required":true,"description":"pass the user id from whom the request is being raised."},{"in":"header","name":"username","example":"Admin,SuperAdmin","schema":{"type":"string"},"required":true,"description":"pass the user name from whom the request is being raised."}],"responses":{"200":{"description":"successfull operation","content":{"application/json":{"schema":{"type":"object","required":["request_id","request_timestamp","source_node","result_code","result_desc","dataset"],"properties":{"request_id":{"type":"string","example":"1435163396","description":"Unique id generated by system for purticular request"},"request_timestamp":{"type":"string","example":"2020-09-18 17:22:28","description":"Timestamp of the current response received"},"source_node":{"type":"string","example":"SCM,CRM,POS","description":"Requested Channel id"},"result_code":{"type":"string","example":"0","description":"Result Code"},"result_desc":{"type":"string","example":"Success","description":"Result Description"},"action":{"type":"string","example":"CreateOrder","description":""},"message":{"type":"string","example":"The order was created successfully","description":"Message provided upon successfull order submission"},"dataset":{"type":"object","required":["param"],"properties":{"param":{"type":"array","items":{"type":"object","required":["id","value"],"properties":{"id":{"type":"string","example":"order_id,sub_order_id","description":"order and suborder created for the purticular order"},"value":{"type":"string","example":"12311594974509,12311594974510","description":"Unique value for the order and suborder created"}}}}}}}}}}},"400":{"description":"bad request","content":{"application/json":{"schema":{"type":"object","required":["request_id","source_node","result_code","result_desc"],"properties":{"request_id":{"type":"string","example":"8729871123","description":"Unique id generated by system for purticular request"},"source_node":{"type":"string","example":"CRM","description":"Requested Channel id"},"result_code":{"type":"string","example":"400","description":"Result Code"},"result_desc":{"type":"string","example":"Request validation failed","description":"Result Description"},"message":{"type":"string","example":"Required fields username are missing in Header","description":"Message provided upon missing the values in header"}}}}}},"405":{"description":"Invalid input"},"500":{"description":"internal server error","content":{"application/json":{"schema":{"type":"object","required":["request_id","source_node","result_code","result_desc"],"properties":{"request_id":{"type":"string","example":"8729871123","description":"Unique id generated by system for purticular request"},"source_node":{"type":"string","example":"CRM","description":"Requested Channel id"},"result_code":{"type":"string","example":"500","description":"Result Code"},"result_desc":{"type":"string","example":"Failure","description":"Result Description"},"message":{"type":"string","example":"Internal Server Error","description":"Message provided upon internal Error"}}}}}}}}},"/orders/terminate":{"post":{"tags":["TerminateService"],"summary":"TerminateService","parameters":[{"in":"header","name":"requestid","example":"11284722194081","schema":{"type":"string"},"required":false,"description":"unique id of for the request"},{"in":"header","name":"requesttimestamp","example":"Configurable format","schema":{"type":"string"},"description":"timestamp by which the request is initiated from the source","required":false},{"in":"header","name":"sourcenode","example":"CRM","schema":{"type":"string"},"description":"source identifier from where the request is originated","required":true},{"in":"header","name":"userid","example":"1","schema":{"type":"string"},"description":"id of the user initating the request","required":true},{"in":"header","name":"username","example":"Admin","schema":{"type":"string"},"description":"name of user initating the request","required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["order_information"],"properties":{"order_information":{"type":"object","required":["order_type","customer_name","contact_number","service_management"],"properties":{"order_type":{"type":"string","example":"TerminateService","description":""},"customer_name":{"type":"string","example":"Harryson Jerico","description":""},"contact_number":{"type":"string","example":"(555) 555-1234","description":""},"payment_details":{"type":"object","required":["amount","collection_source_type","collection_id","comment","currency_code","total_amount","transaction_id","payment_detail"],"properties":{"upfront_payment":{"type":"string","example":"true","description":""},"payment_received":{"type":"string","example":"true","description":""},"amount":{"type":"string","example":"100.0","description":""},"collection_source_type":{"type":"string","example":"NORMAL","description":""},"collection_id":{"type":"string","example":"12","description":""},"comment":{"type":"string","example":"order payment","description":""},"currency_code":{"type":"string","example":"USD","description":""},"total_amount":{"type":"string","example":"22.00","description":""},"transaction_id":{"type":"string","example":"13213234234","description":""},"payment_detail":{"type":"array","items":{"type":"object","required":["payment_mode","reference_external_id","amount_paid","mode_detail"],"properties":{"payment_mode":{"type":"string","example":"1","description":""},"reference_external_id":{"type":"string","example":"4604","description":""},"amount_paid":{"type":"string","example":"11.0","description":""},"mode_detail":{"type":"array","items":{"type":"object","required":["key","value"],"properties":{"key":{"type":"string","example":"token","description":""},"value":{"type":"string","example":"cus_Dw3ki2DzVqciKV","description":""}}}}}}}}},"service_management":{"type":"object","required":["service_id","profile_id","account_id","service_status","service_code","reason_code","reason_desc"],"properties":{"service_id":{"type":"string","example":"NET300098","description":""},"profile_id":{"type":"string","example":"100149","description":""},"account_id":{"type":"string","example":"200126","description":""},"service_status":{"type":"string","example":"Active","description":""},"service_code":{"type":"string","example":"3","description":""},"reason_code":{"type":"string","example":"1","description":""},"reason_desc":{"type":"string","example":"termination","description":""},"service_address":{"type":"object","required":["addr_line1","addr_line2","addr_line3","addr_line4","addr_line5"],"properties":{"addr_line1":{"type":"string","example":"5 DAVIS DR","description":"address line 1"},"addr_line2":{"type":"string","example":"Savannah Apartments","description":"address line 2"},"addr_line3":{"type":"string","example":"WARNER ROBINS","description":"address line 3"},"addr_line4":{"type":"string","example":"SC","description":"address line 4"},"addr_line5":{"type":"string","example":"29926","description":"address line 5"}}},"subscriptions":{"type":"array","items":{"type":"object","required":["expiry_date","effective_date","product_name","plan_desc","version","plan_name","is_base_plan","external_plan_id","product_id","plan_type","subscription_type","plan_id","status","subscription_charges"],"properties":{"expiry_date":{"type":"string","example":"21102020154811","description":"expiry_date"},"effective_date":{"type":"string","example":"21102020154811","description":"effective_date"},"product_name":{"type":"string","example":"Termination Charges","description":"product_name"},"plan_desc":{"type":"string","example":"plan_desc","description":""},"version":{"type":"string","example":"3","description":"version"},"plan_name":{"type":"string","example":"Termination Charges","description":"plan_name"},"is_base_plan":{"type":"string","example":"0","description":"is_base_plan"},"external_plan_id":{"type":"string","example":"24","description":"external_plan_id"},"product_id":{"type":"string","example":"24","description":"product_id"},"plan_type":{"type":"string","example":"2","description":"plan_type"},"subscription_type":{"type":"string","example":"0","description":"subscription_type"},"plan_id":{"type":"string","example":"24","description":"plan_id"},"status":{"type":"string","example":"1","description":"status"},"subscription_charges":{"type":"array","items":{"type":"object","required":["end_date","quantity_based","charge_type","charge_amount_type","charge_frequency","charge_code","epc_enabled","charge_tax","total_charge","discount_type","charge_factor","version","charge_name","charge_category","is_prorata","charge_id","charge_classification","prorata_flags","charge_desc","charge_validity","charge_category_upc","charge_amount","start_date"],"properties":{"end_date":{"type":"string","example":"21102020154811","description":"end_date"},"quantity_based":{"type":"string","example":"quantity_based","description":""},"charge_type":{"type":"string","example":"1","description":"charge_type"},"charge_amount_type":{"type":"string","example":"Fixed","description":"charge_amount_type"},"charge_frequency":{"type":"string","example":"charge_frequency","description":""},"charge_code":{"type":"string","example":"6","description":"charge_code"},"epc_enabled":{"type":"string","example":"1","description":"epc_enabled"},"charge_tax":{"type":"string","example":"","description":"charge_tax"},"total_charge":{"type":"string","example":"55.00","description":"total_charge"},"discount_type":{"type":"string","example":"","description":"charge_factor"},"charge_factor":{"type":"string","example":"","description":"charge_factor"},"version":{"type":"string","example":"3","description":"version"},"charge_name":{"type":"string","example":"Termination Charges","description":"charge_name"},"charge_category":{"type":"string","example":"3","description":"charge_category"},"is_prorata":{"type":"string","example":"0","description":"is_prorata"},"charge_id":{"type":"string","example":"24","description":"charge_id"},"charge_classification":{"type":"string","example":"","description":"charge_classification"},"prorata_flags":{"type":"string","example":"0000","description":"prorata_flags"},"charge_desc":{"type":"string","example":"","description":"charge_desc"},"charge_validity":{"type":"string","example":"","description":"charge_validity"},"charge_category_upc":{"type":"string","example":"6","description":"charge_category_upc"},"charge_amount":{"type":"string","example":"55.00","description":"charge_amount"},"start_date":{"type":"string","example":"21102020154811","description":"start_date"}}}}}}},"prss":{"type":"array","items":{"type":"object","required":["name","service_type","service_class","transport_type","service_category"],"properties":{"name":{"type":"string","example":"PRS_STB","description":""},"service_type":{"type":"string","example":"3","description":""},"service_class":{"type":"string","example":"2","description":""},"transport_type":{"type":"string","example":"3","description":""},"service_category":{"type":"string","example":"2","description":""},"characteristics":{"type":"array","items":{"type":"object","required":["name","value"],"properties":{"name":{"type":"string","example":"SERIAL_NUMBER","description":""},"value":{"type":"string","example":"1213213213","description":""}}}}}}}}}}}}}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","required":["request_id","source_node","result_code","result_desc"],"properties":{"request_id":{"type":"string","example":"3205387163","description":"A unique identifier from  each request"},"source_node":{"type":"string","example":"CRM","description":"source of system"},"result_code":{"type":"string","example":"0","description":"0 for success, non zero failure"},"result_desc":{"type":"string","example":"Success","description":"Description of the status."},"message":{"type":"string","example":"The order was created successfully","description":"message"},"dataset":{"type":"object","properties":{"param":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"order_id","description":"key"},"value":{"type":"string","example":"11298609938851","description":"value"}}}}}}}}}}},"400":{"description":"bad request","content":{"application/json":{"schema":{"type":"object","required":["request_id","source_node","result_code","result_desc"],"properties":{"request_id":{"type":"string","example":"8729871123","description":"Unique id generated by system for purticular request"},"source_node":{"type":"string","example":"CRM","description":"Requested Channel id"},"result_code":{"type":"string","example":"400","description":"Result Code"},"result_desc":{"type":"string","example":"Request validation failed","description":"Result Description"},"message":{"type":"string","example":"Required fields username are missing in Header","description":"Message provided upon missing of values in header"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"type":"object","required":["request_id","source_node","result_code","result_desc"],"properties":{"request_id":{"type":"string","example":"8729871123","description":"Unique id generated by system for purticular request"},"source_node":{"type":"string","example":"CRM","description":"Requested Channel id"},"result_code":{"type":"string","example":"500","description":"Result Code"},"result_desc":{"type":"string","example":"Failure","description":"Result Description"},"message":{"type":"string","example":"Internal Server Error","description":"Message provided upon internal Error"}}}}}}}}},"/orders/{order_id}":{"get":{"tags":["ViewOrder"],"summary":"The API returns the order details associated with the customer","parameters":[{"in":"path","name":"order_id","schema":{"type":"string"},"required":true,"description":"ID of the order that need to fetch.","example":125001},{"in":"query","name":"order_status","schema":{"type":"string"},"required":false,"allowReserved":true,"description":"pass in the query parameters if the search need to be based on order status, eg. Completed,Pending."},{"in":"query","name":"customer_name","schema":{"type":"string"},"required":false,"allowReserved":true,"description":"pass in the query parameters if the search need to be based on customer_name, eg. Nithin,Akhil."},{"in":"query","name":"contact_number","schema":{"type":"string"},"required":false,"allowReserved":true,"description":"pass in the query parameters if the search need to be based on contact_number, eg. (555) 566-1234."},{"in":"query","name":"order_type","schema":{"type":"string"},"required":false,"allowReserved":true,"description":"pass in the query parameters if the search need to be based on order_type, eg. Suspend."},{"in":"query","name":"from_date","schema":{"type":"string"},"required":false,"allowReserved":true,"description":"pass in the query parameters if the search need to be based on from_date, eg. pass date in the form of configured date format."},{"in":"query","name":"to_date","schema":{"type":"string"},"required":false,"allowReserved":true,"description":"pass in the query parameters if the search need to be based on to_date, eg. pass date in the form of configured date format. "},{"in":"header","name":"sourcenode","example":"SCM,POS,CRM","schema":{"type":"string"},"required":true,"description":"pass the channel id from the request is being raised."},{"in":"header","name":"userid","example":"1,2,3","schema":{"type":"string"},"required":true,"description":"pass the user id from whom the request is being raised."},{"in":"header","name":"username","example":"Admin,SuperAdmin","schema":{"type":"string"},"required":true,"description":"pass the user name from whom the request is being raised."}],"responses":{"200":{"description":"successfull operation","content":{"application/json":{"schema":{"type":"object","required":["request_id","source_node","result_code","result_desc","total_record_count","record_count","orders"],"properties":{"request_id":{"type":"string","example":"4016861172","description":"unique id generated by system for purticular request"},"source_node":{"type":"string","example":"CRM","description":"Requested Channel id"},"result_code":{"type":"string","example":"0","description":"Result Code"},"result_desc":{"type":"string","example":"Success","description":"Result Description"},"total_record_count":{"type":"string","example":"1","description":"Total number of records found"},"record_count":{"type":"string","example":"1","description":"Number of records retrived"},"orders":{"type":"array","items":{"type":"object","required":["order_id","order_type","order_description","source_node","create_date","create_user","order_status"],"properties":{"order_id":{"type":"string","example":"12317276351908","description":"order_id"},"order_type":{"type":"string","example":"SafeCustody","description":"order_type"},"order_name":{"type":"string","example":"Safe Custody Order","description":"order_name"},"order_description":{"type":"string","example":"Safe Custody Order Code","description":"order_description"},"source_node":{"type":"string","example":"CRM","description":"Channel from which order is generated"},"create_date":{"type":"string","example":"Configurable format","description":"Order crate date"},"create_user":{"type":"string","example":"SuperAdmin","description":"User who created the order"},"order_status":{"type":"string","example":"Failed","description":"order_status"},"status_reason":{"type":"string","example":"Create Safecustody in Billing : Invalid Operation:Service is already under Suspension","description":"status_reason"},"customer_name":{"type":"string","example":"BERNARD","description":"customer_name"},"contact_number":{"type":"string","example":"5643546374","description":"customer contact number"},"profile_id":{"type":"string","example":"100149","description":"profile_id associated with the customer"}}}}}}}}},"400":{"description":"bad request","content":{"application/json":{"schema":{"type":"object","required":["request_id","source_node","result_code","result_desc"],"properties":{"request_id":{"type":"string","example":"8729871123","description":"Unique id generated by system for purticular request"},"source_node":{"type":"string","example":"CRM","description":"Requested Channel id"},"result_code":{"type":"string","example":"400","description":"Result Code"},"result_desc":{"type":"string","example":"Request validation failed","description":"Result Description"},"message":{"type":"string","example":"Required fields username are missing in Header","description":"Message provided upon missing the values in header"}}}}}},"404":{"description":"not found","content":{"application/json":{"schema":{"type":"object","required":["request_id","source_node","result_code","result_desc"],"properties":{"request_id":{"type":"string","example":"1623970840","description":"Unique id generated by system for purticular request"},"source_node":{"type":"string","example":"CRM","description":"Requested Channel id"},"result_code":{"type":"string","example":"404","description":"Result Code"},"result_desc":{"type":"string","example":"Failure","description":"Result Description"},"message":{"type":"string","example":"No data found for the seach query orderId 12317276351908s","description":"Message provided upon no data found"},"dataset":{"type":"object","required":["param"],"properties":{"param":{"type":"array","items":{"type":"object","required":["id","value"],"properties":{"id":{"type":"string","example":"order_id","description":"order_id"},"value":{"type":"string","example":"12317276351908s","description":"order_id value"}}}}}}}}}}},"405":{"description":"Invalid input"},"500":{"description":"bad request","content":{"application/json":{"schema":{"type":"object","required":["request_id","source_node","result_code","result_desc"],"properties":{"request_id":{"type":"string","example":"8729871123","description":"Unique id generated by system for purticular request"},"source_node":{"type":"string","example":"CRM","description":"Requested Channel id"},"result_code":{"type":"string","example":"500","description":"Result Code"},"result_desc":{"type":"string","example":"Failure","description":"Result Description"},"message":{"type":"string","example":"Internal Server Error","description":"Message provided upon internal Error"}}}}}}}}},"/orders/{order_id}/sub-orders":{"get":{"tags":["ViewSubOrder"],"summary":"The API returns all the sub order details associated with an order","parameters":[{"in":"path","name":"order_id","schema":{"type":"string"},"required":true,"description":"ID of the order that need to fetch.","example":125001},{"in":"query","name":"sub_order_status","schema":{"type":"string"},"required":false,"allowReserved":true,"description":"pass in the query parameters if the search need to be based on sub_order_status, eg. Completed,Pending."},{"in":"query","name":"create_user","schema":{"type":"string"},"required":false,"allowReserved":true,"description":"pass in the query parameters if the search need to be based on create_user, eg. Nithin,Akhil."},{"in":"header","name":"sourcenode","example":"SCM,POS,CRM","schema":{"type":"string"},"required":true,"description":"pass the channel id from the request is being raised."},{"in":"header","name":"userid","example":"1,2,3","schema":{"type":"string"},"required":true,"description":"pass the user id from whom the request is being raised."},{"in":"header","name":"username","example":"Admin,SuperAdmin","schema":{"type":"string"},"required":true,"description":"pass the user name from whom the request is being raised."}],"responses":{"200":{"description":"successfull operation","content":{"application/json":{"schema":{"type":"object","required":["request_id","source_node","result_code","result_desc","record_count","sub_orders"],"properties":{"request_id":{"type":"string","example":"2262736059","description":"Unique id generated by system for purticular request"},"source_node":{"type":"string","example":"CRM","description":"Requested Channel id"},"result_code":{"type":"string","example":"0","description":"Result Code"},"result_desc":{"type":"string","example":"Success","description":"Result Description"},"record_count":{"type":"string","example":"1","description":"number of records found"},"sub_orders":{"type":"array","items":{"type":"object","required":["sub_order_id","order_id","create_date","create_user","sub_order_status"],"properties":{"sub_order_id":{"type":"string","example":"11317276351909","description":"sub_order_id"},"order_id":{"type":"string","example":"12317276351908","description":"order_id"},"create_date":{"type":"string","example":"11/23/2020 12:18:29","description":"create_date"},"create_user":{"type":"string","example":"SuperAdmin","description":"create_user"},"sub_order_name":{"type":"string","example":"Safe Custody Order","description":"sub_order_name"},"sub_order_status":{"type":"string","example":"Failed","description":"sub_order_status"}}}}}}}}},"400":{"description":"bad request","content":{"application/json":{"schema":{"type":"object","required":["request_id","source_node","result_code","result_desc"],"properties":{"request_id":{"type":"string","example":"8729871123","description":"Unique id generated by system for purticular request"},"source_node":{"type":"string","example":"CRM","description":"Requested Channel id"},"result_code":{"type":"string","example":"400","description":"Result Code"},"result_desc":{"type":"string","example":"Request validation failed","description":"Result Description"},"message":{"type":"string","example":"Required fields username are missing in Header","description":"Message provided upon missing the values in header"}}}}}},"404":{"description":"not found","content":{"application/json":{"schema":{"type":"object","required":["request_id","source_node","result_code","result_desc"],"properties":{"request_id":{"type":"string","example":"1623970840","description":"Unique id generated by system for purticular request"},"source_node":{"type":"string","example":"CRM","description":"Requested Channel id"},"result_code":{"type":"string","example":"404","description":"Result Code"},"result_desc":{"type":"string","example":"Failure","description":"Result Description"},"message":{"type":"string","example":"No data found for the seach query orderId 12317276351908s","description":"Message provided upon no data found"},"dataset":{"type":"object","required":["param"],"properties":{"param":{"type":"array","items":{"type":"object","required":["id","value"],"properties":{"id":{"type":"string","example":"order_id","description":"order_id"},"value":{"type":"string","example":"12317276351908s","description":"order_id value"}}}}}}}}}}},"405":{"description":"Invalid input"},"500":{"description":"bad request","content":{"application/json":{"schema":{"type":"object","required":["request_id","source_node","result_code","result_desc"],"properties":{"request_id":{"type":"string","example":"8729871123","description":"Unique id generated by system for purticular request"},"source_node":{"type":"string","example":"CRM","description":"Requested Channel id"},"result_code":{"type":"string","example":"500","description":"Result Code"},"result_desc":{"type":"string","example":"Failure","description":"Result Description"},"message":{"type":"string","example":"Internal Server Error","description":"Message provided upon internal Error"}}}}}}}}},"/orders/{order_id}/sub-orders/{sub_order_id}":{"get":{"tags":["ViewSubOrder"],"summary":"The API returns the purticular sub order details associated with an order","parameters":[{"in":"path","name":"order_id","schema":{"type":"string"},"required":true,"description":"ID of the order that need to fetch.","example":125001},{"in":"path","name":"sub_order_id","schema":{"type":"string"},"required":true,"description":"ID of the order that need to fetch.","example":125001},{"in":"query","name":"sub_order_status","schema":{"type":"string"},"required":false,"allowReserved":true,"description":"pass in the query parameters if the search need to be based on sub_order_status, eg. Completed,Pending."},{"in":"query","name":"create_user","schema":{"type":"string"},"required":false,"allowReserved":true,"description":"pass in the query parameters if the search need to be based on create_user, eg. Nithin,Akhil."},{"in":"header","name":"sourcenode","example":"SCM,POS,CRM","schema":{"type":"string"},"required":true,"description":"pass the channel id from the request is being raised."},{"in":"header","name":"userid","example":"1,2,3","schema":{"type":"string"},"required":true,"description":"pass the user id from whom the request is being raised."},{"in":"header","name":"username","example":"Admin,SuperAdmin","schema":{"type":"string"},"required":true,"description":"pass the user name from whom the request is being raised."}],"responses":{"200":{"description":"successfull operation","content":{"application/json":{"schema":{"type":"object","required":["request_id","source_node","result_code","result_desc","record_count","sub_orders"],"properties":{"request_id":{"type":"string","example":"2262736059","description":"Unique id generated by system for purticular request"},"source_node":{"type":"string","example":"CRM","description":"Requested Channel id"},"result_code":{"type":"string","example":"0","description":"Result Code"},"result_desc":{"type":"string","example":"Success","description":"Result Description"},"record_count":{"type":"string","example":"1","description":"number of records found"},"sub_orders":{"type":"array","items":{"type":"object","required":["sub_order_id","order_id","create_date","create_user","sub_order_status"],"properties":{"sub_order_id":{"type":"string","example":"11317276351909","description":"sub_order_id"},"order_id":{"type":"string","example":"12317276351908","description":"order_id"},"create_date":{"type":"string","example":"11/23/2020 12:18:29","description":"create_date"},"create_user":{"type":"string","example":"SuperAdmin","description":"create_user"},"sub_order_name":{"type":"string","example":"Safe Custody Order","description":"sub_order_name"},"sub_order_status":{"type":"string","example":"Failed","description":"sub_order_status"}}}}}}}}}}}},"/orders/{order_id}/sub-orders/{sub_order_id}/stages":{"get":{"tags":["ViewSubOrderStages"],"summary":"The API returns all the sub order stages associated with a sub order","parameters":[{"in":"path","name":"order_id","schema":{"type":"string"},"required":true,"description":"ID of the order that need to fetch.","example":125001},{"in":"path","name":"sub_order_id","schema":{"type":"string"},"required":true,"description":"ID of the sub order that need to fetch.","example":12500},{"in":"header","name":"sourcenode","example":"SCM,POS,CRM","schema":{"type":"string"},"required":true,"description":"pass the channel id from the request is being raised."},{"in":"header","name":"userid","example":"1,2,3","schema":{"type":"string"},"required":true,"description":"pass the user id from whom the request is being raised."},{"in":"header","name":"username","example":"Admin,SuperAdmin","schema":{"type":"string"},"required":true,"description":"pass the user name from whom the request is being raised."}],"responses":{"200":{"description":"successfull operation","content":{"application/json":{"schema":{"type":"object","required":["request_id","source_node","result_code","result_desc","record_count","sub_order"],"properties":{"request_id":{"type":"string","example":"7763249569","description":"Unique id generated by system for purticular request"},"source_node":{"type":"string","example":"CRM","description":"Requested Channel id"},"result_code":{"type":"string","example":"0","description":"Result Code"},"result_desc":{"type":"string","example":"Success","description":"Result Description"},"record_count":{"type":"string","example":"6","description":"Number of records fetched"},"sub_order":{"type":"object","required":["sub_order_id","order_id","create_date","sub_order_name","order_stages"],"properties":{"sub_order_id":{"type":"string","example":"11315040529246","description":"sub_order_id"},"order_id":{"type":"string","example":"11315040529215","description":"order_id"},"create_date":{"type":"string","example":"10/28/2020 15:12:28","description":"create_date"},"sub_order_name":{"type":"string","example":"Onboarding Order","description":"sub_order_name"},"order_stages":{"type":"array","items":{"type":"object","required":["stage_name","stage_status","create_user","stage_code"],"properties":{"stage_name":{"type":"string","example":"Order Acknowledgment","description":"stage_name"},"stage_status":{"type":"string","example":"Completed","description":"stage_status"},"create_user":{"type":"string","example":"Admin","description":"create_user"},"comment":{"type":"string","example":"Draft Order Creation","description":"comment"},"stage_code":{"type":"string","example":"ODR_ACK","description":"stage_code"}}}}}}}}}}},"400":{"description":"bad request","content":{"application/json":{"schema":{"type":"object","required":["request_id","source_node","result_code","result_desc"],"properties":{"request_id":{"type":"string","example":"8729871123","description":"Unique id generated by system for purticular request"},"source_node":{"type":"string","example":"CRM","description":"Requested Channel id"},"result_code":{"type":"string","example":"400","description":"Result Code"},"result_desc":{"type":"string","example":"Request validation failed","description":"Result Description"},"message":{"type":"string","example":"Required fields username are missing in Header","description":"Message provided upon missing the values in header"}}}}}},"404":{"description":"not found","content":{"application/json":{"schema":{"type":"object","required":["request_id","source_node","result_code","result_desc"],"properties":{"request_id":{"type":"string","example":"1623970840","description":"Unique id generated by system for purticular request"},"source_node":{"type":"string","example":"CRM","description":"Requested Channel id"},"result_code":{"type":"string","example":"404","description":"Result Code"},"result_desc":{"type":"string","example":"Failure","description":"Result Description"},"message":{"type":"string","example":"No data found for the seach query orderId 12317276351908s","description":"Message provided upon no data found"},"dataset":{"type":"object","required":["param"],"properties":{"param":{"type":"array","items":{"type":"object","required":["id","value"],"properties":{"id":{"type":"string","example":"order_id","description":"order_id"},"value":{"type":"string","example":"12317276351908s","description":"order_id value"}}}}}}}}}}},"405":{"description":"Invalid input"},"500":{"description":"bad request","content":{"application/json":{"schema":{"type":"object","required":["request_id","source_node","result_code","result_desc"],"properties":{"request_id":{"type":"string","example":"8729871123","description":"Unique id generated by system for purticular request"},"source_node":{"type":"string","example":"CRM","description":"Requested Channel id"},"result_code":{"type":"string","example":"500","description":"Result Code"},"result_desc":{"type":"string","example":"Failure","description":"Result Description"},"message":{"type":"string","example":"Internal Server Error","description":"Message provided upon internal Error"}}}}}}}}},"/orders/{order_id}/sub-orders/{sub_order_id}/detail":{"get":{"tags":["ViewSubOrderStages"],"summary":"The API returns all the sub order stages associated with a sub order","parameters":[{"in":"path","name":"order_id","schema":{"type":"string"},"required":true,"description":"ID of the order that need to fetch.","example":125001},{"in":"path","name":"sub_order_id","schema":{"type":"string"},"required":true,"description":"ID of the order that need to fetch.","example":125001},{"in":"header","name":"sourcenode","example":"SCM,POS,CRM","schema":{"type":"string"},"required":true,"description":"pass the channel id from the request is being raised."},{"in":"header","name":"userid","example":"1,2,3","schema":{"type":"string"},"required":true,"description":"pass the user id from whom the request is being raised."},{"in":"header","name":"username","example":"Admin,SuperAdmin","schema":{"type":"string"},"required":true,"description":"pass the user name from whom the request is being raised."}],"responses":{"200":{"description":"successfull operation","content":{"application/json":{"schema":{"type":"object","required":["request_id","source_node","result_code","result_desc","record_count","sub_order"],"properties":{"request_id":{"type":"string","example":"7763249569","description":"Unique id generated by system for purticular request"},"source_node":{"type":"string","example":"CRM","description":"Requested Channel id"},"result_code":{"type":"string","example":"0","description":"Result Code"},"result_desc":{"type":"string","example":"Success","description":"Result Description"},"record_count":{"type":"string","example":"6","description":"Number of records fetched"},"sub_order":{"type":"object","required":["sub_order_id","order_id","create_date","sub_order_name","order_stages"],"properties":{"sub_order_id":{"type":"string","example":"11315040529246","description":"sub_order_id"},"order_id":{"type":"string","example":"11315040529215","description":"order_id"},"create_date":{"type":"string","example":"10/28/2020 15:12:28","description":"create_date"},"sub_order_name":{"type":"string","example":"Onboarding Order","description":"sub_order_name"},"order_stages":{"type":"array","items":{"type":"object","required":["stage_name","stage_status","create_user","stage_code"],"properties":{"stage_name":{"type":"string","example":"Order Acknowledgment","description":"stage_name"},"stage_status":{"type":"string","example":"Completed","description":"stage_status"},"create_user":{"type":"string","example":"Admin","description":"create_user"},"comment":{"type":"string","example":"Draft Order Creation","description":"comment"},"stage_code":{"type":"string","example":"ODR_ACK","description":"stage_code"}}}}}}}}}}}}}},"/orders/addService":{"post":{"tags":["AddService"],"summary":"AddService","parameters":[{"in":"header","name":"requestid","example":"11284722194081","schema":{"type":"string"},"required":false,"description":"unique id of for the request"},{"in":"header","name":"requesttimestamp","example":"Configurable format","schema":{"type":"string"},"description":"timestamp by which the request is initiated from the source","required":false},{"in":"header","name":"sourcenode","example":"CRM","schema":{"type":"string"},"description":"source identifier from where the request is originated","required":true},{"in":"header","name":"userid","example":"1","schema":{"type":"string"},"description":"id of the user initating the request","required":true},{"in":"header","name":"username","example":"Admin","schema":{"type":"string"},"description":"name of user initating the request","required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["order_information"],"properties":{"order_information":{"type":"object","required":["order_type","customer_name","contact_number","profile","installation_details","access_details"],"properties":{"order_type":{"type":"string","example":"AddService","description":""},"customer_name":{"type":"string","example":"Jonas","description":""},"contact_number":{"type":"string","example":"(555) 555-1234","description":""},"payment_details":{"type":"object","required":["upfront_payment","payment_received","amount","collection_source_type","collection_id","comment","currency_code","total_amount","transaction_id","payment_detail"],"properties":{"upfront_payment":{"type":"string","example":"true","description":""},"payment_received":{"type":"string","example":"true","description":""},"amount":{"type":"string","example":"22.0","description":""},"collection_source_type":{"type":"string","example":"NORMAL","description":""},"collection_id":{"type":"string","example":"12","description":""},"comment":{"type":"string","example":"order payment","description":""},"currency_code":{"type":"string","example":"USD","description":""},"total_amount":{"type":"string","example":"22.00","description":""},"transaction_id":{"type":"string","example":"13213234234","description":""},"payment_detail":{"type":"array","items":{"type":"object","required":["payment_mode","reference_external_id","amount_paid","mode_detail"],"properties":{"payment_mode":{"type":"string","example":"1","description":""},"reference_external_id":{"type":"string","example":"4604","description":""},"amount_paid":{"type":"string","example":"11.0","description":""},"mode_detail":{"type":"array","items":{"type":"object","required":["key","value"],"properties":{"key":{"type":"string","example":"token","description":""},"value":{"type":"string","example":"cus_Dw3ki2DzVqciKV","description":""}}}}}}}}},"profile":{"type":"object","required":["profile_id","account"],"properties":{"profile_id":{"type":"string","example":"100050","description":""},"account":{"type":"object","required":["account_id","service_groups"],"properties":{"account_id":{"type":"string","example":"20003","description":""},"service_groups":{"type":"array","items":{"type":"object","required":["services"],"properties":{"services":{"type":"array","items":{"type":"object","required":["status","credit_limit","connection_type","activation_date","registration_date","network_activation_date","tnc_date","service_code","service_name","sales_rep_id","sales_rep_name","service_code_value","access_type","deposit_amount","rate_plan_name","first_name","last_name","language_id","dependant_devices","param_list","addresses","deposit","subscriptions"],"properties":{"status":{"type":"string","example":"0","description":""},"credit_limit":{"type":"string","example":"0","description":""},"connection_type":{"type":"string","example":"1","description":""},"activation_date":{"type":"string","example":"Configurable format","description":""},"registration_date":{"type":"string","example":"Configurable format","description":""},"network_activation_date":{"type":"string","example":"Configurable format","description":""},"tnc_date":{"type":"string","example":"Configurable format","description":""},"service_code":{"type":"string","example":"6","description":""},"service_name":{"type":"string","example":"IPTV","description":""},"sales_rep_id":{"type":"string","example":"","description":""},"sales_rep_name":{"type":"string","example":"","description":""},"service_code_value":{"type":"string","example":"IPTV","description":""},"access_type":{"type":"string","example":"0","description":""},"deposit_amount":{"type":"string","example":"500.00","description":""},"rate_plan_name":{"type":"string","example":"FAMILY PLAN","description":""},"first_name":{"type":"string","example":"JONAS","description":""},"last_name":{"type":"string","example":"WATSON","description":""},"language_id":{"type":"string","example":"1","description":""},"dependant_devices":{"type":"array","items":{"type":"string","example":"10002","description":""}},"param_list":{"type":"array","items":{"type":"object","required":["id","value"],"properties":{"id":{"type":"string","example":"business_office","description":""},"value":{"type":"string","example":"RDSV","description":""}}}},"addresses":{"type":"array","items":{"type":"object","required":["language_id","address_type","addr_line1","addr_line2","addr_line3","addr_line4","addr_line5"],"properties":{"language_id":{"type":"string","example":"1","description":""},"address_type":{"type":"string","example":"3","description":""},"addr_line1":{"type":"string","example":"930 Laurel St","description":""},"addr_line2":{"type":"string","example":"","description":""},"addr_line3":{"type":"string","example":"Columbia","description":""},"addr_line4":{"type":"string","example":"SC","description":""},"addr_line5":{"type":"string","example":"29201","description":""}}}},"deposit":{"type":"object","required":["comment","currency_code","booking_id","status","actual_amount","deposit_amount","deposit_details"],"properties":{"comment":{"type":"string","example":"deposit","description":""},"currency_code":{"type":"string","example":"USD","description":""},"booking_id":{"type":"string","example":"1","description":""},"status":{"type":"string","example":"1","description":""},"actual_amount":{"type":"string","example":"50.00","description":""},"deposit_amount":{"type":"string","example":"30.00","description":""},"deposit_details":{"type":"array","items":{"type":"object","required":["payment_details"],"properties":{"payment_details":{"type":"array","items":{"type":"object","required":["payment_mode","deposit_amount","charge_code"],"properties":{"payment_mode":{"type":"string","example":"3","description":""},"deposit_amount":{"type":"string","example":"30.00","description":""},"charge_code":{"type":"string","example":"55","description":""}}}}}}}}},"subscriptions":{"type":"array","items":{"type":"object","required":["plan_id","plan_name","status","is_base_plan","plan_desc","plan_type","effective_date","expiry_date","external_plan_id","subscription_type","product_id","product_name","instance_id","version","is_prorata","subscription_charges","cfss"],"properties":{"plan_id":{"type":"string","example":"379","description":""},"plan_name":{"type":"string","example":"Digital Lite","description":""},"status":{"type":"string","example":"0","description":""},"is_base_plan":{"type":"string","example":"1","description":""},"plan_desc":{"type":"string","example":"Digital Lite","description":""},"plan_type":{"type":"string","example":"1","description":""},"effective_date":{"type":"string","example":"Configurable format","description":""},"expiry_date":{"type":"string","example":"Configurable format","description":""},"external_plan_id":{"type":"string","example":"","description":""},"subscription_type":{"type":"string","example":"0","description":""},"product_id":{"type":"string","example":"83","description":""},"product_name":{"type":"string","example":"IPTV","description":""},"instance_id":{"type":"string","example":"10003","description":""},"version":{"type":"string","example":"1","description":""},"is_prorata":{"type":"number","example":"1","description":""},"subscription_charges":{"type":"array","items":{"type":"object","required":["charge_type","charge_name","charge_desc","original_charge_amount","charge_amount","start_date","end_date","charge_tax","total_charge","charge_category","quantity_based","charge_amount_type","charge_frequency","charge_factor","is_prorata","prorata_flags","charge_code","charge_id","version"],"properties":{"charge_type":{"type":"string","example":"2","description":""},"charge_name":{"type":"string","example":"Digital Lite Base Prices","description":""},"charge_desc":{"type":"string","example":"","description":""},"original_charge_amount":{"type":"string","example":"60.00","description":""},"charge_amount":{"type":"string","example":"90","description":""},"start_date":{"type":"string","example":"Configurable format","description":""},"end_date":{"type":"string","example":"Configurable format","description":""},"charge_tax":{"type":"string","example":"","description":""},"total_charge":{"type":"string","example":"90","description":""},"charge_category":{"type":"string","example":"0","description":""},"quantity_based":{"type":"string","example":"N","description":""},"charge_amount_type":{"type":"string","example":"Fixed","description":""},"charge_frequency":{"type":"string","example":"2","description":""},"charge_factor":{"type":"string","example":"1","description":""},"is_prorata":{"type":"string","example":"0","description":""},"prorata_flags":{"type":"string","example":"","description":""},"charge_code":{"type":"string","example":"65","description":""},"charge_id":{"type":"string","example":"464","description":""},"version":{"type":"string","example":"1","description":""}}}},"cfss":{"type":"array","items":{"type":"object","required":["id","name","family","type","service_type","service_class","transport_type","service_category","characteristics"],"properties":{"id":{"type":"string","example":"2788","description":""},"name":{"type":"string","example":"CFSS_VIDEO","description":""},"family":{"type":"string","example":"","description":""},"type":{"type":"string","example":"1","description":""},"service_type":{"type":"string","example":"1","description":""},"service_class":{"type":"string","example":"2","description":""},"transport_type":{"type":"string","example":"3","description":""},"service_category":{"type":"string","example":"2","description":""},"characteristics":{"type":"array","items":{"type":"object","required":["name","value","is_mandatory"],"properties":{"name":{"type":"string","example":"CREDIT_LIMIT ","description":""},"value":{"type":"string","example":"0","description":""},"is_mandatory":{"type":"string","example":"1","description":""}}}}}}}}}}}}}}}}}}}},"installation_details":{"type":"object","required":["installation_type","appointment_details"],"properties":{"installation_type":{"type":"string","example":"Tech","description":""},"appointment_details":{"type":"object","required":["pawId","work_order_type","promised_arrival_window","ONT_reqired","is_drop_installed","is_wiring_required","construction_type","access_po","service_po","action"],"properties":{"pawId":{"type":"string","example":"4017","description":""},"work_order_type":{"type":"string","example":"FTTH","description":""},"promised_arrival_window":{"type":"object","required":["date","slot"],"properties":{"date":{"type":"string","example":"Configurable format","description":""},"slot":{"type":"object","required":["id","start_time","end_time","start_time_12hr_format","end_time_12hr_format"],"properties":{"id":{"type":"string","example":"5","description":""},"start_time":{"type":"string","example":"08:00:00","description":""},"end_time":{"type":"string","example":"10:00:00","description":""},"start_time_12hr_format":{"type":"string","example":"8:00:00 AM","description":""},"end_time_12hr_format":{"type":"string","example":"10:00:00 AM","description":""}}}}},"ONT_reqired":{"type":"string","example":"yes","description":""},"is_drop_installed":{"type":"string","example":"false","description":""},"is_wiring_required":{"type":"string","example":"true","description":""},"construction_type":{"type":"string","example":"Buried","description":""},"access_po":{"type":"string","example":"101","description":""},"service_po":{"type":"string","example":"201","description":""},"action":{"type":"string","example":"301","description":""}}}}},"access_details":{"type":"object","required":["access_service_id"],"properties":{"access_service_id":{"type":"string","example":"222221167174345","description":""}}},"dataset":{"type":"object","required":["param"],"properties":{"param":{"type":"array","items":{"type":"object","required":["id","value"],"properties":{"id":{"type":"string","example":"entity_id","description":""},"value":{"type":"string","example":"200","description":""}}}}}}}}}}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","required":["request_id","source_node","result_code","result_desc"],"properties":{"request_id":{"type":"string","example":"3205387163","description":"A unique identifier from  each request"},"source_node":{"type":"string","example":"CRM","description":"source of system"},"result_code":{"type":"string","example":"0","description":"0 for success, non zero failure"},"result_desc":{"type":"string","example":"Success","description":"Description of the status."},"message":{"type":"string","example":"The order was created successfully","description":"message"},"dataset":{"type":"object","properties":{"param":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"order_id","description":"key"},"value":{"type":"string","example":"11298609938851","description":"value"}}}}}}}}}}},"400":{"description":"bad request","content":{"application/json":{"schema":{"type":"object","required":["request_id","source_node","result_code","result_desc"],"properties":{"request_id":{"type":"string","example":"8729871123","description":"Unique id generated by system for purticular request"},"source_node":{"type":"string","example":"CRM","description":"Requested Channel id"},"result_code":{"type":"string","example":"400","description":"Result Code"},"result_desc":{"type":"string","example":"Request validation failed","description":"Result Description"},"message":{"type":"string","example":"Required fields username are missing in Header","description":"Message provided upon missing values in header"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"type":"object","required":["request_id","source_node","result_code","result_desc"],"properties":{"request_id":{"type":"string","example":"8729871123","description":"Unique id generated by system for purticular request"},"source_node":{"type":"string","example":"CRM","description":"Requested Channel id"},"result_code":{"type":"string","example":"500","description":"Result Code"},"result_desc":{"type":"string","example":"Failure","description":"Result Description"},"message":{"type":"string","example":"Internal Server Error","description":"Message provided upon internal Error"}}}}}}}}},"/orders/changeEquipment":{"post":{"tags":["ChangeEquipment"],"summary":"ChangeEquipment","parameters":[{"in":"header","name":"requestid","example":"11284722194081","schema":{"type":"string"},"required":false,"description":"unique id of for the request"},{"in":"header","name":"requesttimestamp","example":"Configurable format","schema":{"type":"string"},"description":"timestamp by which the request is initiated from the source","required":false},{"in":"header","name":"sourcenode","example":"CRM","schema":{"type":"string"},"description":"source identifier from where the request is originated","required":true},{"in":"header","name":"userid","example":"1","schema":{"type":"string"},"description":"id of the user initating the request","required":true},{"in":"header","name":"username","example":"Admin","schema":{"type":"string"},"description":"name of user initating the request","required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["order_information"],"properties":{"order_information":{"type":"object","required":["order_type","customer_name","contact_number","service_management"],"properties":{"order_type":{"type":"string","example":"ChangeEquipment","description":""},"customer_name":{"type":"string","example":"Harryson Jerico","description":""},"contact_number":{"type":"string","example":"(555) 555-1234","description":""},"service_management":{"type":"object","required":["service_id","profile_id","account_id","old_equipment","new_equipment"],"properties":{"service_id":{"type":"string","example":"IPT300249","description":""},"profile_id":{"type":"string","example":"100388","description":""},"account_id":{"type":"string","example":"200337","description":""},"service_code":{"type":"string","example":"6","description":""},"service_name":{"type":"string","example":"Video","description":""},"service_address":{"type":"object","required":["addr_line1","addr_line2","addr_line3","addr_line4","addr_line5"],"properties":{"addr_line1":{"type":"string","example":"5 DAVIS DR","description":""},"addr_line2":{"type":"string","example":"Savannah Apartments","description":""},"addr_line3":{"type":"string","example":"WARNER ROBINS","description":""},"addr_line4":{"type":"string","example":"SC","description":""},"addr_line5":{"type":"string","example":"29926","description":""}}},"old_equipment":{"type":"object","required":["subscription_details","contract_details"],"properties":{"subscription_details":{"type":"object","required":["subscription_id","plan_id"],"properties":{"subscription_id":{"type":"string","example":"3290","description":""},"plan_id":{"type":"string","example":"358","description":""},"plan_name":{"type":"string","example":"standard_stb","description":""},"prss":{"type":"array","items":{"type":"object","required":["name","characteristics"],"properties":{"name":{"type":"string","example":"PRS_STB","description":""},"characteristics":{"type":"array","items":{"type":"object"}}}}}}},"contract_details":{"type":"object","required":["contract_id"],"properties":{"contract_id":{"type":"string","example":"4223","description":""}}}}},"new_equipment":{"type":"object","required":["subscription_details"],"properties":{"subscription_details":{"type":"object","required":["plan_id","plan_name","status","is_base_plan","plan_desc","plan_type","effective_date","expiry_date","external_plan_id","subscription_type","product_id","product_name","instance_id","version","addon_type","linked_plan_id","subscription_charges","prss"],"properties":{"plan_id":{"type":"string","example":"358","description":""},"plan_name":{"type":"string","example":"STB_MULTIROOM_HD_DVR_PO","description":""},"status":{"type":"string","example":"0","description":""},"is_base_plan":{"type":"string","example":"0","description":""},"plan_desc":{"type":"string","example":"STB_MULTIROOM_HD_DVR_PO","description":""},"plan_type":{"type":"string","example":"1","description":""},"effective_date":{"type":"string","example":"Configurable format","description":""},"expiry_date":{"type":"string","example":"Configurable format","description":""},"external_plan_id":{"type":"string","example":"","description":""},"subscription_type":{"type":"string","example":"1","description":""},"product_id":{"type":"string","example":"85","description":""},"product_name":{"type":"string","example":"Video","description":""},"instance_id":{"type":"string","example":"1003","description":""},"version":{"type":"string","example":"1","description":""},"addon_type":{"type":"string","example":"required/included/allowed","description":""},"linked_plan_id":{"type":"string","example":"379","description":""},"subscription_charges":{"type":"array","items":{"type":"object","required":["charge_type","charge_name","charge_desc","original_charge_amount","charge_amount","start_date","end_date","charge_tax","total_charge","charge_category","quantity_based","charge_amount_type","charge_frequency","charge_factor","is_prorata","prorata_flags","charge_code","version"],"properties":{"charge_type":{"type":"string","example":"2","description":""},"charge_name":{"type":"string","example":"HD Equipment Monthly Fee","description":""},"charge_desc":{"type":"string","example":"","description":""},"original_charge_amount":{"type":"string","example":"10.00","description":""},"charge_amount":{"type":"string","example":"10.00","description":""},"start_date":{"type":"string","example":"Configurable format","description":""},"end_date":{"type":"string","example":"Configurable format","description":""},"charge_tax":{"type":"string","example":"","description":""},"total_charge":{"type":"string","example":"10.00","description":""},"charge_category":{"type":"string","example":"0","description":""},"quantity_based":{"type":"string","example":"N","description":""},"charge_amount_type":{"type":"string","example":"Fixed","description":""},"charge_frequency":{"type":"string","example":"2","description":""},"charge_factor":{"type":"string","example":"1","description":""},"is_prorata":{"type":"string","example":"0","description":""},"prorata_flags":{"type":"string","example":"","description":""},"charge_code":{"type":"string","example":"65","description":""},"version":{"type":"string","example":"1","description":""}}}},"prss":{"type":"array","items":{"type":"object","required":["name","service_type","service_class","transport_type","service_category"],"properties":{"id":{"type":"string","example":"2901","description":""},"name":{"type":"string","example":"PRS_STB","description":""},"family":{"type":"string","example":"","description":""},"type":{"type":"string","example":"1","description":""},"service_type":{"type":"string","example":"3","description":""},"service_class":{"type":"string","example":"2","description":""},"transport_type":{"type":"string","example":"3","description":""},"service_category":{"type":"string","example":"2","description":""},"characteristics":{"type":"array","items":{"type":"object","required":["name","value"],"properties":{"name":{"type":"string","example":"SerialNumber","description":""},"value":{"type":"string","example":"","description":""}}}}}}}}}}}}},"installation_details":{"type":"object","required":["installation_type","appointment_details"],"properties":{"installation_type":{"type":"string","example":"Tech","description":""},"appointment_details":{"type":"object","required":["pawId","promised_arrival_window","access_po","service_po","action"],"properties":{"pawId":{"type":"string","example":"4006","description":""},"promised_arrival_window":{"type":"object","required":["date","slot"],"properties":{"date":{"type":"string","example":"Configurable format","description":""},"slot":{"type":"object","required":["id","start_time","end_time","start_time_12hr_format","end_time_12hr_format"],"properties":{"id":{"type":"string","example":"5","description":""},"start_time":{"type":"string","example":"08:00:00","description":""},"end_time":{"type":"string","example":"10:00:00","description":""},"start_time_12hr_format":{"type":"string","example":"8:00:00 AM","description":""},"end_time_12hr_format":{"type":"string","example":"10:00:00 AM","description":""}}}}},"access_po":{"type":"string","example":"101","description":""},"service_po":{"type":"string","example":"201","description":""},"action":{"type":"string","example":"301","description":""}}}}},"payment_details":{"type":"object","required":["amount","collection_source_type","collection_id","comment","currency_code","total_amount","transaction_id","payment_detail"],"properties":{"upfront_payment":{"type":"string","example":"true","description":""},"payment_received":{"type":"string","example":"true","description":""},"amount":{"type":"string","example":"22.0","description":""},"collection_source_type":{"type":"string","example":"NORMAL","description":""},"collection_id":{"type":"string","example":"12","description":""},"comment":{"type":"string","example":"order payment","description":""},"currency_code":{"type":"string","example":"USD","description":""},"total_amount":{"type":"string","example":"22.00","description":""},"transaction_id":{"type":"string","example":"13213234234","description":""},"payment_detail":{"type":"array","items":{"type":"object","required":["payment_mode","reference_external_id","amount_paid","mode_detail"],"properties":{"payment_mode":{"type":"string","example":"1","description":""},"reference_external_id":{"type":"string","example":"4604","description":""},"amount_paid":{"type":"string","example":"11.0","description":""},"mode_detail":{"type":"array","items":{"type":"object","required":["key","value"],"properties":{"key":{"type":"string","example":"token","description":""},"value":{"type":"string","example":"cus_Dw3ki2DzVqciKV","description":""}}}}}}}}},"dataset":{"type":"object","required":["param"],"properties":{"param":{"type":"array","items":{"type":"object","required":["id","value"],"properties":{"id":{"type":"string","example":"","description":""},"value":{"type":"string","example":"","description":""}}}}}}}}}}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","required":["request_id","source_node","result_code","result_desc"],"properties":{"request_id":{"type":"string","example":"3205387163","description":"A unique identifier from  each request"},"source_node":{"type":"string","example":"CRM","description":"source of system"},"result_code":{"type":"string","example":"0","description":"0 for success, non zero failure"},"result_desc":{"type":"string","example":"Success","description":"Description of the status."},"message":{"type":"string","example":"The order was created successfully","description":"message"},"dataset":{"type":"object","properties":{"param":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"order_id","description":"key"},"value":{"type":"string","example":"11298609938851","description":"value"}}}}}}}}}}},"400":{"description":"bad request","content":{"application/json":{"schema":{"type":"object","required":["request_id","source_node","result_code","result_desc"],"properties":{"request_id":{"type":"string","example":"8729871123","description":"Unique id generated by system for purticular request"},"source_node":{"type":"string","example":"CRM","description":"Requested Channel id"},"result_code":{"type":"string","example":"400","description":"Result Code"},"result_desc":{"type":"string","example":"Request validation failed","description":"Result Description"},"message":{"type":"string","example":"Required fields username are missing in Header","description":"Message provided upon missing of values in header"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"type":"object","required":["request_id","source_node","result_code","result_desc"],"properties":{"request_id":{"type":"string","example":"8729871123","description":"Unique id generated by system for purticular request"},"source_node":{"type":"string","example":"CRM","description":"Requested Channel id"},"result_code":{"type":"string","example":"500","description":"Result Code"},"result_desc":{"type":"string","example":"Failure","description":"Result Description"},"message":{"type":"string","example":"Internal Server Error","description":"Message provided upon internal Error"}}}}}}}}},"/orders/changeSim":{"post":{"tags":["ChangeSim"],"summary":"ChangeSim","parameters":[{"in":"header","name":"requestid","example":"11284722194081","schema":{"type":"string"},"required":false,"description":"unique id of for the request"},{"in":"header","name":"requesttimestamp","example":"Configurable format","schema":{"type":"string"},"description":"timestamp by which the request is initiated from the source","required":false},{"in":"header","name":"sourcenode","example":"CRM","schema":{"type":"string"},"description":"source identifier from where the request is originated","required":true},{"in":"header","name":"userid","example":"1","schema":{"type":"string"},"description":"id of the user initating the request","required":true},{"in":"header","name":"username","example":"Admin","schema":{"type":"string"},"description":"name of user initating the request","required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["order_information"],"properties":{"order_information":{"type":"object","required":["order_type","customer_name","contact_number","service_management","dataset"],"properties":{"order_type":{"type":"string","example":"ChangeSim","description":""},"customer_name":{"type":"string","example":"bernard","description":""},"contact_number":{"type":"string","example":"121324435","description":""},"service_management":{"type":"object","required":["service_id","profile_id","account_id","current_imsi","new_imsi","current_iccid","new_iccid","subscriptions"],"properties":{"service_id":{"type":"string","example":"IPT300074","description":""},"profile_id":{"type":"string","example":"100149","description":""},"account_id":{"type":"string","example":"200126","description":""},"current_imsi":{"type":"string","example":"78945645463220","description":""},"new_imsi":{"type":"string","example":"78945645463221","description":""},"current_iccid":{"type":"string","example":"789456454632206","description":""},"new_iccid":{"type":"string","example":"789456454632207","description":""},"subscriptions":{"type":"array","items":{"type":"object","required":["product_id","product_name","plan_id","plan_name","plan_desc","short_plan_desc","offer_service_id","receipt_no","deposit_amount","offer_service_name","activation_date","effective_date","expiry_date","is_base_plan","external_plan_id","status","subscription_type","isInternationalRoaming","subscription_charges","prss","cfss"],"properties":{"product_id":{"type":"string","example":"83","description":""},"product_name":{"type":"string","example":"IPTV","description":""},"plan_id":{"type":"string","example":"332","description":""},"plan_name":{"type":"string","example":"HBO","description":""},"plan_desc":{"type":"string","example":"HBO","description":""},"short_plan_desc":{"type":"string","example":"PO1004","description":""},"offer_service_id":{"type":"string","example":"12","description":""},"receipt_no":{"type":"string","example":"123","description":""},"deposit_amount":{"type":"string","example":"20","description":""},"offer_service_name":{"type":"string","example":"","description":""},"activation_date":{"type":"string","example":"Configurable format","description":""},"effective_date":{"type":"string","example":"Configurable format","description":""},"expiry_date":{"type":"string","example":"Configurable format","description":""},"is_base_plan":{"type":"string","example":"1","description":""},"external_plan_id":{"type":"string","example":"1004","description":""},"status":{"type":"string","example":"1","description":""},"subscription_type":{"type":"string","example":"0","description":""},"isInternationalRoaming":{"type":"string","example":"false","description":""},"subscription_charges":{"type":"array","items":{"type":"object","required":["charge_code","charge_name","charge_desc","charge_category","charge_amount","charge_frequency","charge_factor","start_date","end_date","charge_tax","total_charge","charge_validity","is_prorata","charge_type","prorata_flags"],"properties":{"charge_code":{"type":"string","example":"28","description":""},"charge_name":{"type":"string","example":"HSI200_POP","description":""},"charge_desc":{"type":"string","example":"HSI200_POP","description":""},"charge_category":{"type":"string","example":"1","description":""},"charge_amount":{"type":"string","example":"1000.0","description":""},"charge_frequency":{"type":"string","example":"2","description":""},"charge_factor":{"type":"string","example":"1","description":""},"start_date":{"type":"string","example":"Configurable format","description":""},"end_date":{"type":"string","example":"Configurable format","description":""},"charge_tax":{"type":"string","example":"0.0","description":""},"total_charge":{"type":"string","example":"1000.0","description":""},"charge_validity":{"type":"string","example":"180","description":""},"is_prorata":{"type":"string","example":"0","description":""},"charge_type":{"type":"string","example":"10","description":""},"prorata_flags":{"type":"string","example":"0000","description":""}}}},"prss":{"type":"array","items":{"type":"object","required":["id","name","family","type","service_type","service_class","transport_type","service_category","characteristics"],"properties":{"id":{"type":"string","example":"2901","description":""},"name":{"type":"string","example":"PRS_DVR_STB","description":""},"family":{"type":"string","example":"","description":""},"type":{"type":"string","example":"1","description":""},"service_type":{"type":"string","example":"3","description":""},"service_class":{"type":"string","example":"2","description":""},"transport_type":{"type":"string","example":"4","description":""},"service_category":{"type":"string","example":"3","description":""},"characteristics":{"type":"array","items":{"type":"object"}}}}},"cfss":{"type":"array","items":{"type":"object","required":["id","name","family","type","service_type","service_class","transport_type","service_category","characteristics"],"properties":{"id":{"type":"string","example":"2788","description":""},"name":{"type":"string","example":"CFSS_CHANNEL_GROUP_BASE","description":""},"family":{"type":"string","example":"","description":""},"type":{"type":"string","example":"1","description":""},"service_type":{"type":"string","example":"1","description":""},"service_class":{"type":"string","example":"3","description":""},"transport_type":{"type":"string","example":"3","description":""},"service_category":{"type":"string","example":"2","description":""},"characteristics":{"type":"array","items":{"type":"object","required":["id","name","value"],"properties":{"id":{"type":"string","example":"30","description":""},"name":{"type":"string","example":"GROUPID","description":""},"value":{"type":"string","example":"CINEMAX","description":""}}}}}}}}}}}},"dataset":{"type":"object","required":["param"],"properties":{"param":{"type":"array","items":{"type":"object","required":["id","value"],"properties":{"id":{"type":"string","example":"entity_id","description":"name of the property, MVNO Unique ID can be passed to represent the MVNO for which this request has to be processed"},"value":{"type":"number","example":"200","description":"value associated for the property"}}}}}}}}}}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","required":["request_id","source_node","result_code","result_desc"],"properties":{"request_id":{"type":"string","example":"3205387163","description":"A unique identifier from  each request"},"source_node":{"type":"string","example":"CRM","description":"source of system"},"result_code":{"type":"string","example":"0","description":"0 for success, non zero failure"},"result_desc":{"type":"string","example":"Success","description":"Description of the status."},"message":{"type":"string","example":"The order was created successfully","description":"message"},"dataset":{"type":"object","properties":{"param":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"order_id","description":"key"},"value":{"type":"string","example":"11298609938851","description":"value"}}}}}}}}}}},"400":{"description":"bad request","content":{"application/json":{"schema":{"type":"object","required":["request_id","source_node","result_code","result_desc"],"properties":{"request_id":{"type":"string","example":"8729871123","description":"Unique id generated by system for purticular request"},"source_node":{"type":"string","example":"CRM","description":"Requested Channel id"},"result_code":{"type":"string","example":"400","description":"Result Code"},"result_desc":{"type":"string","example":"Request validation failed","description":"Result Description"},"message":{"type":"string","example":"Required fields username are missing in Header","description":"Message provided upon missing values in header"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"type":"object","required":["request_id","source_node","result_code","result_desc"],"properties":{"request_id":{"type":"string","example":"8729871123","description":"Unique id generated by system for purticular request"},"source_node":{"type":"string","example":"CRM","description":"Requested Channel id"},"result_code":{"type":"string","example":"500","description":"Result Code"},"result_desc":{"type":"string","example":"Failure","description":"Result Description"},"message":{"type":"string","example":"Internal Server Error","description":"Message provided upon internal Error"}}}}}}}}},"/orders/changeMsisdn":{"post":{"tags":["ChangeMsisdn"],"summary":"Change Msisdn","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["order_information"],"properties":{"order_information":{"type":"object","required":["customer_name","contact_number","order_type","service_management","dataset"],"properties":{"customer_name":{"type":"string","example":"John Honai","description":"Customers Name"},"contact_number":{"type":"string","example":"(865) 765-4635","description":"Customers Telephone Number"},"order_type":{"type":"string","example":"ChangeMsisdn","description":"unique order type that defines the operation"},"service_management":{"type":"object","required":["service_id","new_service_id"],"properties":{"service_id":{"type":"string","example":"8147440522","description":"Old Service ID of the subscriber"},"profile_id":{"type":"string","example":"12345","description":"Profile ID"},"account_id":{"type":"string","example":"12345","description":"Account ID"},"current_imsi":{"type":"string","example":"12345678901234","description":"IMSI of the subscriber"},"new_service_id":{"type":"string","example":"8147440523","description":"New Service ID of the subscriber"},"connection_type":{"type":"number","example":"1","description":"Connection Type"},"comment":{"type":"string","example":"true","description":"comment"}}},"dataset":{"type":"object","required":["param"],"properties":{"param":{"type":"array","items":{"type":"object","required":["id","value"],"properties":{"id":{"type":"string","example":"account_id","description":"name of the property, Mandatory properties are operation_code,account_id.Parameters based on the order_type are service_id,service_type"},"value":{"type":"string","example":"200126","description":"value associated for the property"}}}}}}}}}}}}},"parameters":[{"in":"header","name":"sourcenode","example":"SCM,POS,CRM","schema":{"type":"string"},"required":true,"description":"pass the channel id from the request is being raised."},{"in":"header","name":"userid","example":"1,2,3","schema":{"type":"string"},"required":true,"description":"pass the user id from whom the request is being raised."},{"in":"header","name":"username","example":"Admin,SuperAdmin","schema":{"type":"string"},"required":true,"description":"pass the user name from whom the request is being raised."}],"responses":{"200":{"description":"successfull operation","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["request_id","request_timestamp","source_node","result_code","result_desc","action","message","dataset"],"properties":{"request_id":{"type":"string","example":"1435163396","description":"Unique id generated by system for purticular request"},"request_timestamp":{"type":"string","example":"2020-09-18 17:22:28","description":"Timestamp of the current response received"},"source_node":{"type":"string","example":"SCM,CRM,POS","description":"Requested Channel id"},"result_code":{"type":"string","example":"0","description":"Result Code"},"result_desc":{"type":"string","example":"Success","description":"Result Description"},"action":{"type":"string","example":"ChangeMsisdn","description":""},"message":{"type":"string","example":"The order was created successfully","description":"Message provided upon successfull order submission"},"dataset":{"type":"object","required":["param"],"properties":{"param":{"type":"array","items":{"type":"object","required":["id","value"],"properties":{"id":{"type":"string","example":"order_id,sub_order_id","description":"order and suborder created for the purticular order"},"value":{"type":"string","example":"12311594974509,12311594974510","description":"Unique value for the order and suborder created"}}}}}}}}]}}}},"400":{"description":"bad request","content":{"application/json":{"schema":{"type":"object","required":["request_id","source_node","result_code","result_desc","message","dataset"],"properties":{"request_id":{"type":"string","example":"8729871123","description":"Unique id generated by system for purticular request"},"source_node":{"type":"string","example":"SCM,CRM,POS","description":"Requested Channel id"},"result_code":{"type":"string","example":"400","description":"Result Code"},"result_desc":{"type":"string","example":"Failure","description":"Result Description"},"message":{"type":"string","example":"Invalid Order Type -> CreateAdjustme","description":"Message provided upon receiving of invalid Order Type"},"dataset":{"type":"object","required":["param"],"properties":{"param":{"type":"array","items":{"type":"object"}}}}}}}}},"405":{"description":"Invalid input"},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"type":"object","required":["request_id","source_node","result_code","result_desc"],"properties":{"request_id":{"type":"string","example":"8729871123","description":"Unique id generated by system for purticular request"},"source_node":{"type":"string","example":"CRM","description":"Requested Channel id"},"result_code":{"type":"string","example":"500","description":"Result Code"},"result_desc":{"type":"string","example":"Failure","description":"Result Description"},"message":{"type":"string","example":"Internal Server Error","description":"Message provided upon internal Error"}}}}}}}}},"/orders/safeCustody":{"post":{"tags":["SafeCustody"],"summary":"Create Safe Custody for a purticular service","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["order_information"],"properties":{"order_information":{"type":"object","required":["customer_name","contact_number","order_type","safe_custody","dataset"],"properties":{"customer_name":{"type":"string","example":"John Honai","description":"Customers Name"},"contact_number":{"type":"string","example":"(865) 765-4635","description":"Customers Telephone Number"},"order_type":{"type":"string","example":"SafeCustody","description":"unique order type that defines the operation"},"safe_custody":{"type":"object","required":["service_id","account_id","start_date","end_date","suspension_charge_apply","reason_code"],"properties":{"service_id":{"type":"string","example":"123456","description":"unique ID Service that gets generated in Billing."},"account_id":{"type":"string","example":"234567","description":"unique ID Account that gets generated in Billing."},"start_date":{"type":"string","example":"04-09-2020 00:00:00","description":"start date"},"end_date":{"type":"string","example":"30-09-2020 23:59:59","description":"end date"},"suspension_charge_apply":{"type":"string","example":"0","description":"0/1 based on charges if any"},"reason_code":{"type":"string","example":"10","description":"Unique number for reason which is pre configured"}}},"dataset":{"type":"object","required":["param"],"properties":{"param":{"type":"array","items":{"type":"object","required":["id","value"],"properties":{"id":{"type":"string","example":"account_id,profile_id,service_id","description":"name of the property"},"value":{"type":"string","example":"200126,100149,IPT300074","description":"value associated for the property"}}}}}}}}}}}}},"parameters":[{"in":"header","name":"sourcenode","example":"SCM,POS,CRM","schema":{"type":"string"},"required":true,"description":"pass the channel id from the request is being raised."},{"in":"header","name":"userid","example":"1,2,3","schema":{"type":"string"},"required":true,"description":"pass the user id from whom the request is being raised."},{"in":"header","name":"username","example":"Admin,SuperAdmin","schema":{"type":"string"},"required":true,"description":"pass the user name from whom the request is being raised."}],"responses":{"200":{"description":"successfull operation","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["request_id","request_timestamp","source_node","result_code","result_desc"],"properties":{"request_id":{"type":"string","example":"1435163396","description":"Unique id generated by system for purticular request"},"request_timestamp":{"type":"string","example":"2020-09-18 17:22:28","description":"Timestamp of the current response received"},"source_node":{"type":"string","example":"SCM,CRM,POS","description":"Requested Channel id"},"result_code":{"type":"string","example":"0","description":"Result Code"},"result_desc":{"type":"string","example":"Success","description":"Result Description"},"action":{"type":"string","example":"SafeCustody","description":""},"message":{"type":"string","example":"The order was created successfully","description":"Message provided upon successfull order submission"},"dataset":{"type":"object","required":["param"],"properties":{"param":{"type":"array","items":{"type":"object","required":["id","value"],"properties":{"id":{"type":"string","example":"order_id,sub_order_id","description":"order and suborder created for the purticular order"},"value":{"type":"string","example":"12311594974509,12311594974510","description":"Unique value for the order and suborder created"}}}}}}}}]}}}},"400":{"description":"bad request","content":{"application/json":{"schema":{"type":"object","required":["request_id","source_node","result_code","result_desc"],"properties":{"request_id":{"type":"string","example":"8729871123","description":"Unique id generated by system for purticular request"},"source_node":{"type":"string","example":"SCM,CRM,POS","description":"Requested Channel id"},"result_code":{"type":"string","example":"400","description":"Result Code"},"result_desc":{"type":"string","example":"Failure","description":"Result Description"},"message":{"type":"string","example":"Invalid Order Type -> SafeCustodyij","description":"Message provided upon receiving of invalid Order Type"},"dataset":{"type":"object","required":["param"],"properties":{"param":{"type":"array","items":{"type":"object"}}}}}}}}},"405":{"description":"Invalid input"},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"type":"object","required":["request_id","source_node","result_code","result_desc"],"properties":{"request_id":{"type":"string","example":"8729871123","description":"Unique id generated by system for purticular request"},"source_node":{"type":"string","example":"CRM","description":"Requested Channel id"},"result_code":{"type":"string","example":"500","description":"Result Code"},"result_desc":{"type":"string","example":"Failure","description":"Result Description"},"message":{"type":"string","example":"Internal Server Error","description":"Message provided upon internal Error"}}}}}}}}},"/orders/cancelSafeCustody":{"post":{"tags":["CancelSafeCustody"],"summary":"Update Safe Custody for a purticular service","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["order_information"],"properties":{"order_information":{"type":"object","required":["customer_name","contact_number","order_type","safe_custody","dataset"],"properties":{"customer_name":{"type":"string","example":"John Honai","description":"Customers Name"},"contact_number":{"type":"string","example":"(865) 765-4635","description":"Customers Telephone Number"},"order_type":{"type":"string","example":"CancelSafeCustody","description":"unique order type that defines the operation"},"safe_custody":{"type":"object","required":["service_id","account_id","start_date","end_date","suspension_charge_apply","reason_code"],"properties":{"service_id":{"type":"string","example":"","description":"unique ID Service that gets generated in Billing."},"account_id":{"type":"string","example":"","description":"unique ID Account that gets generated in Billing."},"start_date":{"type":"string","example":"Configurable format","description":"start date"},"end_date":{"type":"string","example":"Configurable format","description":"end date"},"suspension_charge_apply":{"type":"string","example":"0","description":"0/1 based on charges if any"},"reason_code":{"type":"string","example":"10","description":"Unique number for reason which is pre configured"}}},"dataset":{"type":"object","required":["param"],"properties":{"param":{"type":"array","items":{"type":"object","required":["id","value"],"properties":{"id":{"type":"string","example":"account_id,profile_id,service_id","description":"name of the property"},"value":{"type":"string","example":"200126,100149,IPT300074","description":"value associated for the property"}}}}}}}}}}}}},"parameters":[{"in":"header","name":"sourcenode","example":"SCM,POS,CRM","schema":{"type":"string"},"required":true,"description":"pass the channel id from the request is being raised."},{"in":"header","name":"userid","example":"1,2,3","schema":{"type":"string"},"required":true,"description":"pass the user id from whom the request is being raised."},{"in":"header","name":"username","example":"Admin,SuperAdmin","schema":{"type":"string"},"required":true,"description":"pass the user name from whom the request is being raised."}],"responses":{"200":{"description":"successfull operation","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["request_id","request_timestamp","source_node","result_code","result_desc"],"properties":{"request_id":{"type":"string","example":"1435163396","description":"Unique id generated by system for purticular request"},"request_timestamp":{"type":"string","example":"Configurable format","description":"Timestamp of the current response received"},"source_node":{"type":"string","example":"SCM,CRM,POS","description":"Requested Channel id"},"result_code":{"type":"string","example":"0","description":"Result Code"},"result_desc":{"type":"string","example":"Success","description":"Result Description"},"action":{"type":"string","example":"UpdateSafeCustody","description":""},"message":{"type":"string","example":"The order was created successfully","description":"Message provided upon successfull order submission"},"dataset":{"type":"object","required":["param"],"properties":{"param":{"type":"array","items":{"type":"object","required":["id","value"],"properties":{"id":{"type":"string","example":"order_id,sub_order_id","description":"order and suborder created for the purticular order"},"value":{"type":"string","example":"12311594974509,12311594974510","description":"Unique value for the order and suborder created"}}}}}}}}]}}}},"400":{"description":"bad request","content":{"application/json":{"schema":{"type":"object","required":["request_id","source_node","result_code","result_desc","message","dataset"],"properties":{"request_id":{"type":"string","example":"8729871123","description":"Unique id generated by system for purticular request"},"source_node":{"type":"string","example":"SCM,CRM,POS","description":"Requested Channel id"},"result_code":{"type":"string","example":"400","description":"Result Code"},"result_desc":{"type":"string","example":"Failure","description":"Result Description"},"message":{"type":"string","example":"Invalid Order Type -> CancelSafe","description":"Message provided upon receiving of invalid Order Type"},"dataset":{"type":"object","required":["param"],"properties":{"param":{"type":"array","items":{"type":"object"}}}}}}}}},"405":{"description":"Invalid input"},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"type":"object","required":["request_id","source_node","result_code","result_desc"],"properties":{"request_id":{"type":"string","example":"8729871123","description":"Unique id generated by system for purticular request"},"source_node":{"type":"string","example":"CRM","description":"Requested Channel id"},"result_code":{"type":"string","example":"500","description":"Result Code"},"result_desc":{"type":"string","example":"Failure","description":"Result Description"},"message":{"type":"string","example":"Internal Server Error","description":"Message provided upon internal Error"}}}}}}}}},"/orders/updateSafeCustody":{"post":{"tags":["UpdateSafeCustody"],"summary":"Update Safe Custody for a particular service","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["order_information"],"properties":{"order_information":{"type":"object","required":["customer_name","contact_number","order_type","safe_custody","dataset"],"properties":{"customer_name":{"type":"string","example":"John Honai","description":"Customers Name"},"contact_number":{"type":"string","example":"(865) 765-4635","description":"Customers Telephone Number"},"order_type":{"type":"string","example":"UpdateSafeCustody","description":"unique order type that defines the operation"},"safe_custody":{"type":"object","required":["service_id","immediate_cancel_suspension"],"properties":{"service_id":{"type":"string","example":"","description":"unique ID Service that gets generated in Billing."},"immediate_cancel_suspension":{"type":"string","example":"1","description":"unique number in billing which will immediately cancel safe custody"}}},"dataset":{"type":"object","required":["param"],"properties":{"param":{"type":"array","items":{"type":"object","required":["id","value"],"properties":{"id":{"type":"string","example":"account_id,profile_id,service_id","description":"name of the property"},"value":{"type":"string","example":"200126,100149,IPT300074","description":"value associated for the property"}}}}}}}}}}}}},"parameters":[{"in":"header","name":"sourcenode","example":"SCM,POS,CRM","schema":{"type":"string"},"required":true,"description":"pass the channel id from the request is being raised."},{"in":"header","name":"userid","example":"1,2,3","schema":{"type":"string"},"required":true,"description":"pass the user id from whom the request is being raised."},{"in":"header","name":"username","example":"Admin,SuperAdmin","schema":{"type":"string"},"required":true,"description":"pass the user name from whom the request is being raised."}],"responses":{"200":{"description":"successfull operation","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["request_id","request_timestamp","source_node","result_code","result_desc"],"properties":{"request_id":{"type":"string","example":"1435163396","description":"Unique id generated by system for purticular request"},"request_timestamp":{"type":"string","example":"Configurable format","description":"Timestamp of the current response received"},"source_node":{"type":"string","example":"SCM,CRM,POS","description":"Requested Channel id"},"result_code":{"type":"string","example":"0","description":"Result Code"},"result_desc":{"type":"string","example":"Success","description":"Result Description"},"action":{"type":"string","example":"UpdateSafeCustody","description":""},"message":{"type":"string","example":"The order was created successfully","description":"Message provided upon successfull order submission"},"dataset":{"type":"object","required":["param"],"properties":{"param":{"type":"array","items":{"type":"object","required":["id","value"],"properties":{"id":{"type":"string","example":"order_id,sub_order_id","description":"order and suborder created for the purticular order"},"value":{"type":"string","example":"12311594974509,12311594974510","description":"Unique value for the order and suborder created"}}}}}}}}]}}}},"400":{"description":"bad request","content":{"application/json":{"schema":{"type":"object","required":["request_id","source_node","result_code","result_desc","message","dataset"],"properties":{"request_id":{"type":"string","example":"8729871123","description":"Unique id generated by system for purticular request"},"source_node":{"type":"string","example":"SCM,CRM,POS","description":"Requested Channel id"},"result_code":{"type":"string","example":"400","description":"Result Code"},"result_desc":{"type":"string","example":"Failure","description":"Result Description"},"message":{"type":"string","example":"Invalid Order Type -> UpdateSafe","description":"Message provided upon receiving of invalid Order Type"},"dataset":{"type":"object","required":["param"],"properties":{"param":{"type":"array","items":{"type":"object"}}}}}}}}},"405":{"description":"Invalid input"},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"type":"object","required":["request_id","source_node","result_code","result_desc"],"properties":{"request_id":{"type":"string","example":"8729871123","description":"Unique id generated by system for purticular request"},"source_node":{"type":"string","example":"CRM","description":"Requested Channel id"},"result_code":{"type":"string","example":"500","description":"Result Code"},"result_desc":{"type":"string","example":"Failure","description":"Result Description"},"message":{"type":"string","example":"Internal Server Error","description":"Message provided upon internal Error"}}}}}}}}},"/orders/updateCPEDetails":{"post":{"tags":["UpdateCPEDetails"],"summary":"Update CPE details in BIL and ARM","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["order_information"],"properties":{"order_information":{"type":"object","required":["order_type","customer_name","contact_number","device_info","dataset"],"properties":{"order_type":{"type":"string","example":"UpdateCPEDetails","description":"unique order type that defines the operation"},"customer_name":{"type":"string","example":"Nitin","description":"Customers Name"},"contact_number":{"type":"string","example":"(865) 765-4635","description":"Customers Telephone Number"},"device_info":{"type":"array","items":{"type":"object","required":["serial_number","status","subscription_id","mac_id"],"properties":{"serial_number":{"type":"string","example":"859758833","description":"Serial number of purticular device"},"status":{"type":"string","example":"1","description":"Status of the purticular device"},"subscription_id":{"type":"string","example":"2578","description":"Subscription associated with the purticular device"},"model":{"type":"string","example":"STBs for TVs","description":"Model of the device"},"name":{"type":"string","example":"BK-104","description":"Name of the device"},"make":{"type":"string","example":"Belkin","description":"Make of the device"},"warranty_period":{"type":"string","example":"180","description":"No of warranty days"},"sale_time":{"type":"string","example":"Configurable format","description":"Sale date and time of the device"},"sale_type":{"type":"string","example":"2","description":"Sale type"},"contract_id":{"type":"string","example":"4025","description":"Contract id associated with the device"},"mac_id":{"type":"string","example":"4025","description":"mac id associated with the device"}}}},"dataset":{"type":"object","required":["param"],"properties":{"param":{"type":"array","items":{"type":"object","required":["id","value"],"properties":{"id":{"type":"string","example":"order_id","description":"name of the property"},"value":{"type":"string","example":"12309163030655","description":"value associated for the property"}}}}}}}}}}}}},"parameters":[{"in":"header","name":"sourcenode","example":"SCM,POS,CRM","schema":{"type":"string"},"required":true,"description":"pass the channel id from the request is being raised."},{"in":"header","name":"userid","example":"1,2,3","schema":{"type":"string"},"required":true,"description":"pass the user id from whom the request is being raised."},{"in":"header","name":"username","example":"Admin,SuperAdmin","schema":{"type":"string"},"required":true,"description":"pass the user name from whom the request is being raised."}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["request_id","request_timestamp","source_node","result_code","result_desc","dataset"],"properties":{"request_id":{"type":"string","example":"5144884302","description":"Unique id generated by system for purticular request"},"request_timestamp":{"type":"string","example":"Configurable format","description":"Timestamp of the current response received"},"source_node":{"type":"string","example":"CRM,POS,SCM","description":"Requested Channel id"},"result_code":{"type":"string","example":"0","description":"Result Code"},"result_desc":{"type":"string","example":"Success","description":"Result Description"},"action":{"type":"string","example":"UpdateCPEDetails","description":"unique order type that defines the operation"},"message":{"type":"string","example":"The order was created successfully","description":"Message provided upon successfull order submission"},"dataset":{"type":"object","required":["param"],"properties":{"param":{"type":"array","items":{"type":"object","required":["id","value"],"properties":{"id":{"type":"string","example":"order_id","description":"order created for the purticular request"},"value":{"type":"string","example":"11311418796702","description":"Unique value for the order created"}}}}}}}}]}}}},"400":{"description":"bad request","content":{"application/json":{"schema":{"type":"object","required":["request_id","source_node","result_code","result_desc"],"properties":{"request_id":{"type":"string","example":"8729871123","description":"Unique id generated by system for purticular request"},"source_node":{"type":"string","example":"CRM","description":"Requested Channel id"},"result_code":{"type":"string","example":"400","description":"Result Code"},"result_desc":{"type":"string","example":"Request validation failed","description":"Result Description"},"message":{"type":"string","example":"Required fields username are missing in Header","description":"Message provided upon missing the values in header"}}}}}},"405":{"description":"Invalid input"},"500":{"description":"internal server error","content":{"application/json":{"schema":{"type":"object","required":["request_id","source_node","result_code","result_desc"],"properties":{"request_id":{"type":"string","example":"8729871123","description":"Unique id generated by system for purticular request"},"source_node":{"type":"string","example":"CRM","description":"Requested Channel id"},"result_code":{"type":"string","example":"500","description":"Result Code"},"result_desc":{"type":"string","example":"Failure","description":"Result Description"},"message":{"type":"string","example":"Internal Server Error","description":"Message provided upon internal Error"}}}}}}}}},"/orders/updateProfileDetails":{"post":{"tags":["UpdateProfileBasicDetails"],"summary":"UpdateProfileBasicDetails","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["order_information"],"properties":{"order_information":{"type":"object","required":["order_type","customer_name","contact_number","account_info"],"properties":{"order_type":{"type":"string","example":"UpdateAccountBasicDetails","description":"unique order type that defines the operation"},"customer_name":{"type":"string","example":"John Honai","description":"Customers Name"},"contact_number":{"type":"string","example":"(865) 765-4635","description":"Customers Telephone Number"},"account_info":{"type":"object","required":["param"],"properties":{"param":{"type":"array","items":{"type":"object","required":["id","value"],"properties":{"id":{"type":"string","example":"profile_id","description":"name of the property"},"value":{"type":"string","example":"100078","description":"value associated for the property"}}}}}}}}}}}}},"parameters":[{"in":"header","name":"sourcenode","example":"SCM,POS,CRM","schema":{"type":"string"},"required":true,"description":"pass the channel id from the request is being raised."},{"in":"header","name":"userid","example":"1,2,3","schema":{"type":"string"},"required":true,"description":"pass the user id from whom the request is being raised."},{"in":"header","name":"username","example":"Admin,SuperAdmin","schema":{"type":"string"},"required":true,"description":"pass the user name from whom the request is being raised."}],"responses":{"200":{"description":"successfull operation","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["request_id","request_timestamp","source_node","result_code","result_desc","action","message","dataset"],"properties":{"request_id":{"type":"string","example":"3897904336","description":"Unique id generated by system for purticular request"},"request_timestamp":{"type":"string","example":"Configurable format","description":"Timestamp of the current response received"},"source_node":{"type":"string","example":"CRM,POS,SCM","description":"Requested Channel id"},"result_code":{"type":"string","example":"0","description":"Result Code"},"result_desc":{"type":"string","example":"Success","description":"Result Description"},"action":{"type":"string","example":"UpdateAccountBasicDetails","description":""},"message":{"type":"string","example":"The order was created successfully","description":"Message provided upon successfull order submission"},"dataset":{"type":"object","required":["param"],"properties":{"param":{"type":"array","items":{"type":"object","required":["id","value"],"properties":{"id":{"type":"string","example":"order_id","description":"order created for the purticular request"},"value":{"type":"string","example":"11313909686771","description":"Unique value for the order created"}}}}}}}}]}}}},"400":{"description":"bad request","content":{"application/json":{"schema":{"type":"object","required":["request_id","source_node","result_code","result_desc"],"properties":{"request_id":{"type":"string","example":"8729871123","description":"Unique id generated by system for purticular request"},"source_node":{"type":"string","example":"CRM","description":"Requested Channel id"},"result_code":{"type":"string","example":"400","description":"Result Code"},"result_desc":{"type":"string","example":"Request validation failed","description":"Result Description"},"message":{"type":"string","example":"Required fields username are missing in Header","description":"Message provided upon missing the values in header"}}}}}},"405":{"description":"Invalid input"},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"type":"object","required":["request_id","source_node","result_code","result_desc"],"properties":{"request_id":{"type":"string","example":"8729871123","description":"Unique id generated by system for purticular request"},"source_node":{"type":"string","example":"CRM","description":"Requested Channel id"},"result_code":{"type":"string","example":"500","description":"Result Code"},"result_desc":{"type":"string","example":"Failure","description":"Result Description"},"message":{"type":"string","example":"Internal Server Error","description":"Message provided upon internal Error"}}}}}}}}},"/orders/updateAccountDetails":{"post":{"tags":["UpdateAccountBasicDetails"],"summary":"Update basic account details in BIL","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["order_information"],"properties":{"order_information":{"type":"object","required":["order_type","customer_name","contact_number","account_info"],"properties":{"order_type":{"type":"string","example":"UpdateAccountBasicDetails","description":"unique order type that defines the operation"},"customer_name":{"type":"string","example":"John Honai","description":"Customers Name"},"contact_number":{"type":"string","example":"(865) 765-4635","description":"Customers Telephone Number"},"account_info":{"type":"object","required":["param"],"properties":{"param":{"type":"array","items":{"type":"object","required":["id","value"],"properties":{"id":{"type":"string","example":"account_id","description":"name of the property"},"value":{"type":"string","example":"100078","description":"value associated for the property"}}}}}}}}}}}}},"parameters":[{"in":"header","name":"sourcenode","example":"SCM,POS,CRM","schema":{"type":"string"},"required":true,"description":"pass the channel id from the request is being raised."},{"in":"header","name":"userid","example":"1,2,3","schema":{"type":"string"},"required":true,"description":"pass the user id from whom the request is being raised."},{"in":"header","name":"username","example":"Admin,SuperAdmin","schema":{"type":"string"},"required":true,"description":"pass the user name from whom the request is being raised."}],"responses":{"200":{"description":"successfull operation","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["request_id","request_timestamp","source_node","result_code","result_desc","action","message","dataset"],"properties":{"request_id":{"type":"string","example":"3897904336","description":"Unique id generated by system for purticular request"},"request_timestamp":{"type":"string","example":"Configurable format","description":"Timestamp of the current response received"},"source_node":{"type":"string","example":"CRM,POS,SCM","description":"Requested Channel id"},"result_code":{"type":"string","example":"0","description":"Result Code"},"result_desc":{"type":"string","example":"Success","description":"Result Description"},"action":{"type":"string","example":"UpdateAccountBasicDetails","description":""},"message":{"type":"string","example":"The order was created successfully","description":"Message provided upon successfull order submission"},"dataset":{"type":"object","required":["param"],"properties":{"param":{"type":"array","items":{"type":"object","required":["id","value"],"properties":{"id":{"type":"string","example":"order_id","description":"order created for the purticular request"},"value":{"type":"string","example":"11313909686771","description":"Unique value for the order created"}}}}}}}}]}}}},"400":{"description":"bad request","content":{"application/json":{"schema":{"type":"object","required":["request_id","source_node","result_code","result_desc"],"properties":{"request_id":{"type":"string","example":"8729871123","description":"Unique id generated by system for purticular request"},"source_node":{"type":"string","example":"CRM","description":"Requested Channel id"},"result_code":{"type":"string","example":"400","description":"Result Code"},"result_desc":{"type":"string","example":"Request validation failed","description":"Result Description"},"message":{"type":"string","example":"Required fields username are missing in Header","description":"Message provided upon missing the values in header"}}}}}},"405":{"description":"Invalid input"},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"type":"object","required":["request_id","source_node","result_code","result_desc"],"properties":{"request_id":{"type":"string","example":"8729871123","description":"Unique id generated by system for purticular request"},"source_node":{"type":"string","example":"CRM","description":"Requested Channel id"},"result_code":{"type":"string","example":"500","description":"Result Code"},"result_desc":{"type":"string","example":"Failure","description":"Result Description"},"message":{"type":"string","example":"Internal Server Error","description":"Message provided upon internal Error"}}}}}}}}},"/orders/terminateAccount":{"post":{"tags":["TerminateAccount"],"summary":"Terminate Multiple services leading to termination of given account","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["order_information"],"properties":{"order_information":{"type":"object","required":["order_type","customer_name","contact_number","account_management","dataset"],"properties":{"order_type":{"type":"string","example":"TerminateAccount","description":"unique order type that defines the operation"},"customer_name":{"type":"string","example":"BERNARD","description":"Customers Name"},"contact_number":{"type":"string","example":"5643546374","description":"Customers Telephone Number"},"account_management":{"type":"object","required":["profile_id","account_id","account_status","reason_code","reason_desc","service_groups"],"properties":{"profile_id":{"type":"string","example":"100149","description":"profile id under which the account resides"},"account_id":{"type":"string","example":"200126","description":"account id under which the services reside"},"account_status":{"type":"string","example":"Active","description":"current status of the account"},"reason_code":{"type":"string","example":"1","description":"reason code for termination"},"reason_desc":{"type":"string","example":"Terminate","description":"reason description for termination"},"service_groups":{"type":"array","items":{"type":"object","required":["services"],"properties":{"service_address":{"type":"object","required":["addr_line1","addr_line2","addr_line3","addr_line4","addr_line5"],"properties":{"addr_line1":{"type":"string","example":"5 DAVIS DR","description":"address line 1"},"addr_line2":{"type":"string","example":"Savannah Apartments","description":"address line 2"},"addr_line3":{"type":"string","example":"WARNER ROBINS","description":"address line 3"},"addr_line4":{"type":"string","example":"SC","description":"address line 4"},"addr_line5":{"type":"string","example":"29926","description":"address line 5"}}},"services":{"type":"array","items":{"type":"object","required":["service_id","service_code","service_status"],"properties":{"service_id":{"type":"string","example":"NET300098","description":"service which need to be terminated"},"service_code":{"type":"string","example":"3","description":"type of service which need to be terminated"},"service_status":{"type":"string","example":"Active","description":"current status of the service"},"subscriptions":{"type":"array","items":{"type":"object","required":["expiry_date","effective_date","product_name","plan_desc","version","plan_name","is_base_plan","external_plan_id","product_id","plan_type","subscription_type","plan_id","status","subscription_charges"],"properties":{"expiry_date":{"type":"string","example":"21102020154811","description":"expiry_date"},"effective_date":{"type":"string","example":"21102020154811","description":"effective_date"},"product_name":{"type":"string","example":"Termination Charges","description":"product_name"},"plan_desc":{"type":"string","example":"plan_desc","description":""},"version":{"type":"string","example":"3","description":"version"},"plan_name":{"type":"string","example":"Termination Charges","description":"plan_name"},"is_base_plan":{"type":"string","example":"0","description":"is_base_plan"},"external_plan_id":{"type":"string","example":"24","description":"external_plan_id"},"product_id":{"type":"string","example":"24","description":"product_id"},"plan_type":{"type":"string","example":"2","description":"plan_type"},"subscription_type":{"type":"string","example":"0","description":"subscription_type"},"plan_id":{"type":"string","example":"24","description":"plan_id"},"status":{"type":"string","example":"1","description":"status"},"subscription_charges":{"type":"array","items":{"type":"object","required":["end_date","quantity_based","charge_type","charge_amount_type","charge_frequency","charge_code","epc_enabled","charge_tax","total_charge","discount_type","charge_factor","version","charge_name","charge_category","is_prorata","charge_id","charge_classification","prorata_flags","charge_desc","charge_validity","charge_category_upc","charge_amount","start_date"],"properties":{"end_date":{"type":"string","example":"21102020154811","description":"end_date"},"quantity_based":{"type":"string","example":"quantity_based","description":""},"charge_type":{"type":"string","example":"1","description":"charge_type"},"charge_amount_type":{"type":"string","example":"Fixed","description":"charge_amount_type"},"charge_frequency":{"type":"string","example":"charge_frequency","description":""},"charge_code":{"type":"string","example":"6","description":"charge_code"},"epc_enabled":{"type":"string","example":"1","description":"epc_enabled"},"charge_tax":{"type":"string","example":"","description":"charge_tax"},"total_charge":{"type":"string","example":"55.00","description":"total_charge"},"discount_type":{"type":"string","example":"","description":"charge_factor"},"charge_factor":{"type":"string","example":"","description":"charge_factor"},"version":{"type":"string","example":"3","description":"version"},"charge_name":{"type":"string","example":"Termination Charges","description":"charge_name"},"charge_category":{"type":"string","example":"3","description":"charge_category"},"is_prorata":{"type":"string","example":"0","description":"is_prorata"},"charge_id":{"type":"string","example":"24","description":"charge_id"},"charge_classification":{"type":"string","example":"","description":"charge_classification"},"prorata_flags":{"type":"string","example":"0000","description":"prorata_flags"},"charge_desc":{"type":"string","example":"","description":"charge_desc"},"charge_validity":{"type":"string","example":"","description":"charge_validity"},"charge_category_upc":{"type":"string","example":"6","description":"charge_category_upc"},"charge_amount":{"type":"string","example":"55.00","description":"charge_amount"},"start_date":{"type":"string","example":"21102020154811","description":"start_date"}}}}}}},"prss":{"type":"array","items":{"type":"object","required":["name","service_type","service_class","transport_type","service_category","characteristics"],"properties":{"name":{"type":"string","example":"PRS_MODEM","description":"name"},"service_type":{"type":"string","example":"3","description":"service type"},"service_class":{"type":"string","example":"2","description":"service class"},"transport_type":{"type":"string","example":"3","description":"transport type"},"service_category":{"type":"string","example":"2","description":"service category"},"characteristics":{"type":"array","items":{"type":"object","required":["name","value"],"properties":{"name":{"type":"string","example":"SERIAL_NUMBER","description":"characteristic type"},"value":{"type":"string","example":"1213213213","description":"characteristics type value"}}}}}}}}}}}}}}},"dataset":{"type":"object","required":["param"],"properties":{"param":{"type":"array","items":{"type":"object","required":["id","value"],"properties":{"id":{"type":"string","example":"","description":""},"value":{"type":"string","example":"","description":""}}}}}}}}}}}}},"parameters":[{"in":"header","name":"sourcenode","example":"SCM,POS,CRM","schema":{"type":"string"},"required":true,"description":"pass the channel id from the request is being raised."},{"in":"header","name":"userid","example":"1,2,3","schema":{"type":"string"},"required":true,"description":"pass the user id from whom the request is being raised."},{"in":"header","name":"username","example":"Admin,SuperAdmin","schema":{"type":"string"},"required":true,"description":"pass the user name from whom the request is being raised."}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","required":["request_id","request_timestamp","source_node","result_code","result_desc","action","dataset"],"properties":{"request_id":{"type":"string","example":"5144884302","description":"Unique id generated by system for purticular request"},"request_timestamp":{"type":"string","example":"Configurable format","description":"Timestamp of the current response received"},"source_node":{"type":"string","example":"CRM,POS,SCM","description":"Requested Channel id"},"result_code":{"type":"string","example":"0","description":"Result Code"},"result_desc":{"type":"string","example":"Success","description":"Result Description"},"action":{"type":"string","example":"UpdateCPEDetails","description":"unique order type that defines the operation"},"message":{"type":"string","example":"The order was created successfully","description":"Message provided upon successfull order submission"},"dataset":{"type":"object","required":["param"],"properties":{"param":{"type":"array","items":{"type":"object","required":["id","value"],"properties":{"id":{"type":"string","example":"order_id","description":"order created for the purticular request"},"value":{"type":"string","example":"11311418796702","description":"Unique value for the order created"}}}}}}}}}}},"400":{"description":"bad request","content":{"application/json":{"schema":{"type":"object","required":["request_id","source_node","result_code","result_desc"],"properties":{"request_id":{"type":"string","example":"8729871123","description":"Unique id generated by system for purticular request"},"source_node":{"type":"string","example":"CRM","description":"Requested Channel id"},"result_code":{"type":"string","example":"400","description":"Result Code"},"result_desc":{"type":"string","example":"Request validation failed","description":"Result Description"},"message":{"type":"string","example":"Required fields username are missing in Header","description":"Message provided upon missing the values in header"}}}}}},"405":{"description":"Invalid input"},"500":{"description":"internal server error","content":{"application/json":{"schema":{"type":"object","required":["request_id","source_node","result_code","result_desc"],"properties":{"request_id":{"type":"string","example":"8729871123","description":"Unique id generated by system for purticular request"},"source_node":{"type":"string","example":"CRM","description":"Requested Channel id"},"result_code":{"type":"string","example":"500","description":"Result Code"},"result_desc":{"type":"string","example":"Failure","description":"Result Description"},"message":{"type":"string","example":"Internal Server Error","description":"Message provided upon internal Error"}}}}}}}}},"/subscriber-info/payment-details":{"post":{"tags":["GetPaymentDetails"],"summary":"Add a operation","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["search_param"],"properties":{"search_param":{"type":"object","required":["param"],"properties":{"param":{"type":"array","items":{"type":"object","required":["id","value"],"properties":{"id":{"type":"string","example":"account_id","description":"property name. Along with account_id, input can be limit, offset, from_date and to_date. Date format is ddMMyyyyHHmmss."},"value":{"type":"string","example":"1000178","description":"value associated with the property name"}}}}}}}}}}},"parameters":[{"in":"header","name":"sourcenode","example":"SCM,POS,CRM","schema":{"type":"string"},"required":true,"description":"pass the channel id from the request is being raised."},{"in":"header","name":"userid","example":"1,2,3","schema":{"type":"string"},"required":true,"description":"pass the user id from whom the request is being raised."},{"in":"header","name":"username","example":"Admin,SuperAdmin","schema":{"type":"string"},"required":true,"description":"pass the user name from whom the request is being raised."}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","required":["request_id","source_node","result_code","result_desc","total_record_count","record_count","payment_details"],"properties":{"request_id":{"type":"string","example":"3160915218","description":"Unique id generated by system for purticular request"},"source_node":{"type":"string","example":"CRM","description":"Requested Channel id"},"result_code":{"type":"string","example":"0","description":"Result Code"},"result_desc":{"type":"string","example":"Success","description":"Result Description"},"total_record_count":{"type":"number","example":"100","description":"Total record count"},"record_count":{"type":"number","example":"1","description":"Record count"},"payment_details":{"type":"array","items":{"type":"object","required":["payment_id","transaction_id","amount","payment_mode","profile_id","account_id","order_type","currency_code","source","collection_source_type","collection_id","payment_date","exchange_rate","requested_amount","outstanding_before","outstanding_after","userid","username","comment","credit_balance_before","credit_balance_after","cancellation_status","invoice_ids","pos_id","bank_id","reference_no","amount_paid","transaction_status"],"properties":{"payment_id":{"type":"string","example":"1","description":"Internal generated ID"},"transaction_id":{"type":"string","example":"2057","description":"Payment transaction ID"},"amount":{"type":"number","example":"50.0","description":"Payment transaction ID"},"payment_mode":{"type":"number","example":"CC","description":"Payment mode, That is, cash, cheque, dd_no"},"profile_id":{"type":"string","example":"249506","description":"Profile ID of subscriber/MSISDN"},"account_id":{"type":"string","example":"349755","description":"Account ID of subscriber/MSISDN"},"order_type":{"type":"string","example":"Billpayment","description":"Billpayment, registration fee, charging"},"cheque_no":{"type":"string","example":"","description":"If payment is done via cheque"},"dd_no":{"type":"string","example":"","description":"If payment is done via DD"},"currency_code":{"type":"string","example":"USD","description":"Currency used for making payment"},"source":{"type":"string","example":"CRM","description":"Source of payment"},"collection_source_type":{"type":"string","example":"","description":"Source collector if any"},"collection_id":{"type":"string","example":"","description":"Source collector user ID"},"payment_date":{"type":"string","example":"20-11-2016 18:33:42","description":"Payment date"},"exchange_rate":{"type":"number","example":"1.0","description":"Exchange rate of that current time"},"requested_amount":{"type":"number","example":"100.0","description":"Amount for which payment was made"},"outstanding_before":{"type":"number","example":"70.0","description":"Outstanding before"},"outstanding_after":{"type":"number","example":"0.0","description":"Outstanding after"},"userid":{"type":"number","example":"1","description":"User ID who requested"},"username":{"type":"string","example":"admin","description":"Username who requested"},"comment":{"type":"string","example":"","description":"Comments"},"credit_balance_before":{"type":"number","example":"0.0","description":"Credit balance before"},"credit_balance_after":{"type":"number","example":"30.0","description":"Credit balance after"},"cancellation_status":{"type":"number","example":"1","description":"Status of the payment if it has been reversed or cancelled.(0:-Reversal, 1:-Cancel)"},"invoice_ids":{"type":"string","example":"","description":"Invoice Ids"},"pos_id":{"type":"string","example":"","description":"POS ID"},"bank_id":{"type":"string","example":"","description":"Issued Bank ID"},"reference_no":{"type":"string","example":"","description":"Reference Number"},"amount_paid":{"type":"number","example":"0.0","description":"Amount paid"},"transaction_status":{"type":"string","example":"","description":"Transaction status"}}}}}}}}},"400":{"description":"bad request","content":{"application/json":{"schema":{"type":"object","required":["request_id","source_node","result_code","result_desc"],"properties":{"request_id":{"type":"string","example":"8729871123","description":"Unique id generated by system for purticular request"},"source_node":{"type":"string","example":"CRM","description":"Requested Channel id"},"result_code":{"type":"string","example":"400","description":"Result Code"},"result_desc":{"type":"string","example":"Request validation failed","description":"Result Description"},"message":{"type":"string","example":"Required fields username are missing in Header","description":"Message provided upon missing the values in header"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","required":["request_id","source_node","result_code","result_desc"],"properties":{"request_id":{"type":"string","example":"2321136342","description":"Unique id generated by system for purticular request"},"source_node":{"type":"string","example":"CRM","description":"Requested Channel id"},"result_code":{"type":"string","example":"691","description":"Result Code"},"result_desc":{"type":"string","example":"Failure","description":"Result Code"},"message":{"type":"string","example":"No data found for the seached query","description":"Message provided upon No data found"},"dataset":{"type":"object","required":["param"],"properties":{"param":{"type":"array","items":{"type":"object"}}}}}}}}},"405":{"description":"Invalid input"},"500":{"description":"internal server error","content":{"application/json":{"schema":{"type":"object","required":["request_id","source_node","result_code","result_desc"],"properties":{"request_id":{"type":"string","example":"8729871123","description":"Unique id generated by system for purticular request"},"source_node":{"type":"string","example":"CRM","description":"Requested Channel id"},"result_code":{"type":"string","example":"500","description":"Result Code"},"result_desc":{"type":"string","example":"Failure","description":"Result Description"},"message":{"type":"string","example":"Internal Server Error","description":"Message provided upon internal Error"}}}}}}}}},"/subscriber-info/invoice-details":{"post":{"tags":["GetInvoiceDetails"],"summary":"Add a operation","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["search_param"],"properties":{"search_param":{"type":"object","required":["param"],"properties":{"param":{"type":"array","items":{"type":"object","required":["id","value"],"properties":{"id":{"type":"string","example":"account_id","description":"property name. Along with account_id, input can be limit, offset, from_date, to_date and status. Date format is ddMMyyyyHHmmss. Status can be 0- pending or 3- confirm."},"value":{"type":"string","example":"1000178","description":"value associated with the property name"}}}}}}}}}}},"parameters":[{"in":"header","name":"sourcenode","example":"SCM,POS,CRM","schema":{"type":"string"},"required":true,"description":"pass the channel id from the request is being raised."},{"in":"header","name":"userid","example":"1,2,3","schema":{"type":"string"},"required":true,"description":"pass the user id from whom the request is being raised."},{"in":"header","name":"username","example":"Admin,SuperAdmin","schema":{"type":"string"},"required":true,"description":"pass the user name from whom the request is being raised."}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","required":["request_id","source_node","result_code","result_desc","total_record_count","record_count","invoice_details"],"properties":{"request_id":{"type":"string","example":"3160915218","description":"Unique id generated by system for purticular request"},"source_node":{"type":"string","example":"CRM","description":"Requested Channel id"},"result_code":{"type":"string","example":"0","description":"Result Code"},"result_desc":{"type":"string","example":"Success","description":"Result Description"},"total_record_count":{"type":"number","example":"100","description":"Total record count"},"record_count":{"type":"number","example":"1","description":"Record count"},"invoice_details":{"type":"array","items":{"type":"object","required":["account_id","seq_id","bill_id","file_type","status","profile_type","bill_date","from_date","to_date","current_cycle_charges_with_tax","total_charges","due_date","clear_status","is_paid","pending_invoice_amount"],"properties":{"account_id":{"type":"string","example":"349755","description":"Account ID of subscriber"},"seq_id":{"type":"number","example":"27","description":"Internal seq ID"},"bill_id":{"type":"number","example":"454954090540","description":"Invoice id of subscriber"},"file_type":{"type":"number","example":"1","description":"File_type represent its service level statement, account invoice etc. For example,  1-Account Level invoice."},"status":{"type":"number","example":"3","description":"Bill generation status"},"profile_type":{"type":"number","example":"1","description":"Profile type"},"bill_date":{"type":"string","example":"2016-12-22","description":"Bill generation date for the invoice"},"from_date":{"type":"string","example":"2016-11-15","description":"The starting bill date of the bill period considered for the invoice"},"to_date":{"type":"string","example":"2016-12-15","description":"The ending bill date of the bill period considered for the invoice"},"current_cycle_charges_with_tax":{"type":"number","example":"150.83","description":"Current cycle changes with tax"},"total_charges":{"type":"number","example":"173.45","description":"Monthly charges including tax and previous pending balance if any"},"due_date":{"type":"string","example":"2016-12-26","description":"Bill due date of the invoice"},"clear_status":{"type":"number","example":"1","description":"The status of the invoice. For example, 1-Cleared; 0-Not-cleared."},"is_paid":{"type":"number","example":"0","description":"If the complete payment has been received for the invoice. For example, 1-Paid; 2-Not-paid."},"pending_invoice_amount":{"type":"number","example":"173.45","description":"The amount pending to be realised yet to the invoice. If the payment has been realised for the invoice, the value will be 0."}}}}}}}}},"400":{"description":"bad request","content":{"application/json":{"schema":{"type":"object","required":["request_id","source_node","result_code","result_desc"],"properties":{"request_id":{"type":"string","example":"8729871123","description":"Unique id generated by system for purticular request"},"source_node":{"type":"string","example":"CRM","description":"Requested Channel id"},"result_code":{"type":"string","example":"400","description":"Result Code"},"result_desc":{"type":"string","example":"Request validation failed","description":"Result Description"},"message":{"type":"string","example":"Required fields username are missing in Header","description":"Message provided upon missing the values in header"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","required":["request_id","source_node","result_code","result_desc"],"properties":{"request_id":{"type":"string","example":"2321136342","description":"Unique id generated by system for purticular request"},"source_node":{"type":"string","example":"CRM","description":"Requested Channel id"},"result_code":{"type":"string","example":"691","description":"Result Code"},"result_desc":{"type":"string","example":"Failure","description":"Result Code"},"message":{"type":"string","example":"No data found for the seached query","description":"Message provided upon No data found"},"dataset":{"type":"object","required":["param"],"properties":{"param":{"type":"array","items":{"type":"object"}}}}}}}}},"405":{"description":"Invalid input"},"500":{"description":"internal server error","content":{"application/json":{"schema":{"type":"object","required":["request_id","source_node","result_code","result_desc"],"properties":{"request_id":{"type":"string","example":"8729871123","description":"Unique id generated by system for purticular request"},"source_node":{"type":"string","example":"CRM","description":"Requested Channel id"},"result_code":{"type":"string","example":"500","description":"Result Code"},"result_desc":{"type":"string","example":"Failure","description":"Result Description"},"message":{"type":"string","example":"Internal Server Error","description":"Message provided upon internal Error"}}}}}}}}},"/orders/manageHlrServices":{"post":{"tags":["ManageHlrServices"],"summary":"ManageHlrServices","parameters":[{"in":"header","name":"requestid","example":"11284722194081","schema":{"type":"string"},"required":false,"description":"unique id of for the request"},{"in":"header","name":"requesttimestamp","example":"Configurable format","schema":{"type":"string"},"description":"timestamp by which the request is initiated from the source","required":false},{"in":"header","name":"sourcenode","example":"CRM","schema":{"type":"string"},"description":"source identifier from where the request is originated","required":true},{"in":"header","name":"userid","example":"1","schema":{"type":"string"},"description":"id of the user initating the request","required":true},{"in":"header","name":"username","example":"Admin","schema":{"type":"string"},"description":"name of user initating the request","required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["order_information"],"properties":{"order_information":{"type":"object","required":["order_type","customer_name","contact_number","hlr_services"],"properties":{"order_type":{"type":"string","example":"ManageHlrServices","description":""},"customer_name":{"type":"string","example":"bernard","description":""},"contact_number":{"type":"string","example":"121324435","description":""},"hlr_services":{"type":"object","required":["service_id"],"properties":{"service_id":{"type":"string","example":"9876543210","description":"Service ID of the subscriber"},"connection_type":{"type":"number","example":"1","description":"Connection Type"},"clir":{"type":"string","example":"1","description":"CLIR. 1-enable; 2-disable."},"apn":{"type":"string","example":"cellcardAP","description":"APN"},"roaming":{"type":"number","example":"1","description":"Roaming. 1-enable; 2-disable"},"gprs":{"type":"number","example":"1","description":"2G Service. 1-enable; 2-disable"},"prbt":{"type":"number","example":"1","description":"PRBT. 1-enable; 2-disable"},"call_hold":{"type":"number","example":"1","description":"Call Hold. 1-enable; 2-disable"},"super_clir":{"type":"number","example":"1","description":"Super CLIR. 1-enable; 2-disable"},"call_forward":{"type":"number","example":"1","description":"Call Forwarding. 1-enable; 2-disable"},"call_forwarding_type":{"type":"string","example":"CFU","description":"Call Forwarding Type"},"call_forwarding_number":{"type":"string","example":"748373478734","description":"Call Forwarding Number"},"incoming_voice":{"type":"number","example":"1","description":"Incoming Voice. 1-enable; 2-disable"},"outgoing_voice":{"type":"number","example":"1","description":"Outgoing Voice. 1-enable; 2-disable"},"international_calls":{"type":"number","example":"1","description":"International Calls. 1-enable; 2-disable"},"multiparty":{"type":"number","example":"1","description":"Multiparty. 1-enable; 2-disable"},"call_waiting":{"type":"number","example":"1","description":"Call Waiting. 1-enable; 2-disable"},"3g_service":{"type":"number","example":"1","description":"3G Service. 1-enable; 2-disable"},"4g_lte_service":{"type":"number","example":"1","description":"4G LTE Service. 1-enable; 2-disable"},"call_screening":{"type":"number","example":"1","description":"Call Screening. 1-enable; 2-disable"},"call_screening_number":{"type":"string","example":"748373478734","description":"Call Screening Number."}}},"dataset":{"type":"object","required":["param"],"properties":{"param":{"type":"array","items":{"type":"object","required":["id","value"],"properties":{"id":{"type":"string","example":"entity_id","description":"name of the property, MVNO Unique ID can be passed to represent the MVNO for which this request has to be processed"},"value":{"type":"number","example":"200","description":"value associated for the property"}}}}}}}}}}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","required":["request_id","source_node","result_code","result_desc"],"properties":{"request_id":{"type":"string","example":"3205387163","description":"A unique identifier from  each request"},"source_node":{"type":"string","example":"CRM","description":"source of system"},"result_code":{"type":"string","example":"0","description":"0 for success, non zero failure"},"result_desc":{"type":"string","example":"Success","description":"Description of the status."},"message":{"type":"string","example":"The order was created successfully","description":"message"},"dataset":{"type":"object","properties":{"param":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"order_id","description":"key"},"value":{"type":"string","example":"11298609938851","description":"value"}}}}}}}}}}},"400":{"description":"bad request","content":{"application/json":{"schema":{"type":"object","required":["request_id","source_node","result_code","result_desc"],"properties":{"request_id":{"type":"string","example":"8729871123","description":"Unique id generated by system for purticular request"},"source_node":{"type":"string","example":"CRM","description":"Requested Channel id"},"result_code":{"type":"string","example":"400","description":"Result Code"},"result_desc":{"type":"string","example":"Request validation failed","description":"Result Description"},"message":{"type":"string","example":"Required fields username are missing in Header","description":"Message provided upon missing values in header"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"type":"object","required":["request_id","source_node","result_code","result_desc"],"properties":{"request_id":{"type":"string","example":"8729871123","description":"Unique id generated by system for purticular request"},"source_node":{"type":"string","example":"CRM","description":"Requested Channel id"},"result_code":{"type":"string","example":"500","description":"Result Code"},"result_desc":{"type":"string","example":"Failure","description":"Result Description"},"message":{"type":"string","example":"Internal Server Error","description":"Message provided upon internal Error"}}}}}}}}}}}