@itentialopensource/adapter-glds_customerexperiencegateway
Version:
This adapter integrates with system described as: GLDS Customer Experience Gateway.
1,473 lines • 133 kB
JSON
{
"openapi": "3.1.0",
"info": {
"title": "",
"version": "1.0.0"
},
"paths": {
"/subscriber/search": {
"get": {
"tags": [
"Subscriber"
],
"operationId": "subscriberLookup",
"description": "The parameters and request body are for method: subscriberLookup. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"Account": {
"type": "string"
},
"AccountName": {
"type": "string"
},
"ServiceAddress": {
"type": "string"
}
}
}
},
"example": [
{
"Account": "123456203",
"AccountName": "Roxanne Hunn",
"ServiceAddress": "721 Kimball Terrace San Ysidro CA 94636-9101"
}
]
}
}
}
},
"parameters": [
{
"name": "externalID",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "phoneNumber",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "dL",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "sSN",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "lookupCode",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/subscriber/{aCCOUNT}": {
"get": {
"tags": [
"Subscriber"
],
"operationId": "getSubscriber",
"description": "The parameters and request body are for method: getSubscriber. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"Account": {
"type": "string"
},
"SubscriberStatus": {
"type": "object",
"properties": {
"Code": {
"type": "string"
},
"Name": {
"type": "string"
},
"BaseCustStatus": {
"type": "number"
}
}
},
"SubscriberType": {
"type": "object",
"properties": {
"Code": {
"type": "string"
},
"Name": {
"type": "string"
}
}
},
"AccountName": {
"type": "string"
},
"FirstName": {
"type": "string"
},
"SecondName": {
"type": "string"
},
"LastName": {
"type": "string"
},
"PhoneNumbers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"PhoneNumber": {
"type": "string"
},
"PhoneNumberType": {
"type": "object",
"properties": {
"Code": {
"type": "string"
},
"Name": {
"type": "string"
}
}
}
}
}
},
"BillingEmail": {
"type": "string"
},
"ServiceAddress": {
"type": "object",
"properties": {
"FullAddress": {
"type": "string"
},
"City": {
"type": "string"
},
"State": {
"type": "string"
},
"ZIP": {
"type": "string"
},
"ZIPPlus4": {
"type": "string"
},
"BlockFIPS": {
"type": "string"
},
"Franchise": {
"type": "object",
"properties": {
"Code": {
"type": "string"
},
"Name": {
"type": "string"
}
}
},
"PropertyType": {
"type": "object",
"properties": {
"Code": {
"type": "string"
},
"Name": {
"type": "string"
}
}
},
"HeadEnd": {
"type": "object",
"properties": {
"Code": {
"type": "string"
},
"Name": {
"type": "string"
}
}
},
"Hub": {
"type": "object",
"properties": {
"Code": {
"type": "string"
},
"Name": {
"type": "string"
}
}
},
"Node": {
"type": "object",
"properties": {
"Code": {
"type": "string"
},
"Name": {
"type": "string"
}
}
},
"VoIPRateCenter": {
"type": "object",
"properties": {
"Code": {
"type": "string"
},
"Name": {
"type": "string"
}
}
},
"DropTag": {
"type": "string"
},
"Wired": {
"type": "boolean"
},
"DropConnected": {
"type": "boolean"
},
"TechRegion": {
"type": "object",
"properties": {
"Code": {
"type": "string"
},
"Name": {
"type": "string"
}
}
},
"SalesArea": {
"type": "object",
"properties": {
"Code": {
"type": "string"
},
"Name": {
"type": "string"
}
}
},
"ManagementArea": {
"type": "object",
"properties": {
"Code": {
"type": "string"
},
"Name": {
"type": "string"
}
}
}
}
},
"Franchise": {
"type": "object",
"properties": {
"Code": {
"type": "string"
},
"Name": {
"type": "string"
}
}
},
"TimeZone": {
"type": "object",
"properties": {
"ID": {
"type": "number"
},
"BIAS": {
"type": "number"
},
"Name": {
"type": "string"
},
"Description": {
"type": "string"
}
}
},
"PaymentPlan": {
"type": "string"
},
"PaymentTypes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"ID": {
"type": "number"
},
"Code": {
"type": "string"
},
"Name": {
"type": "string"
}
}
}
},
"DOB": {
"type": "string"
},
"WinScoreRiskFactor": {
"type": "string"
},
"ParentAccounts": {
"type": "array",
"items": {
"type": "object",
"properties": {
"Account": {
"type": "string"
},
"AccountName": {
"type": "string"
}
}
}
},
"ChildAccounts": {
"type": "array",
"items": {
"type": "object",
"properties": {
"Account": {
"type": "string"
},
"AccountName": {
"type": "string"
}
}
}
},
"SoftDisconnect": {
"type": "object",
"properties": {
"SDStatus": {
"type": "string"
},
"SDDate": {
"type": "string"
}
}
},
"PINisSet": {
"type": "boolean"
},
"CanOrderPPV": {
"type": "boolean"
},
"PPVDenyReason": {
"type": "object",
"properties": {
"Value": {
"type": "number"
},
"Text": {
"type": "string"
}
}
},
"InOutageArea": {
"type": "boolean"
},
"ActiveOutages": {
"type": "array",
"items": {
"type": "object",
"properties": {
"ID": {
"type": "number"
},
"OutageStatus": {
"type": "string"
},
"OutageType": {
"type": "string"
},
"Description": {
"type": "string"
},
"StartTime": {
"type": "string"
},
"EstCloseTime": {
"type": "string"
},
"ActualEndDate": {
"type": "string"
},
"Resolutions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"Code": {
"type": "string"
},
"Name": {
"type": "string"
}
}
}
}
}
}
}
}
},
"example": {
"Account": "123456203",
"SubscriberStatus": {
"Code": "ACT",
"Name": "Active",
"BaseCustStatus": 237
},
"SubscriberType": {
"Code": "RES",
"Name": "Residential"
},
"AccountName": "Roxanne Hunn",
"FirstName": "Roxanne",
"SecondName": "string",
"LastName": "Hunn",
"PhoneNumbers": [
{
"PhoneNumber": "(760) 385-4792",
"PhoneNumberType": {
"Code": "HOM",
"Name": "Home"
}
},
{
"PhoneNumber": "(760) 385-4792",
"PhoneNumberType": {
"Code": "HOM",
"Name": "Home"
}
},
{
"PhoneNumber": "(760) 385-4792",
"PhoneNumberType": {
"Code": "HOM",
"Name": "Home"
}
},
{
"PhoneNumber": "(760) 385-4792",
"PhoneNumberType": {
"Code": "HOM",
"Name": "Home"
}
},
{
"PhoneNumber": "(760) 385-4792",
"PhoneNumberType": {
"Code": "HOM",
"Name": "Home"
}
}
],
"BillingEmail": "name@provider.com",
"ServiceAddress": {
"FullAddress": "721 Kimball Terrace San Ysidro CA 94636-9101",
"City": "San Ysidro",
"State": "CA",
"ZIP": "94636",
"ZIPPlus4": "94636-9101",
"BlockFIPS": "060730176041014",
"Franchise": {
"Code": "001",
"Name": "South Park1"
},
"PropertyType": {
"Code": "RES",
"Name": "Residential"
},
"HeadEnd": {
"Code": "HTS",
"Name": "Hits"
},
"Hub": {
"Code": "HTS",
"Name": "Hits"
},
"Node": {
"Code": "005",
"Name": "005"
},
"VoIPRateCenter": {
"Code": "DRC",
"Name": "Default"
},
"DropTag": "LM89546",
"Wired": true,
"DropConnected": true,
"TechRegion": {
"Code": "TRD",
"Name": "Default Tech Region"
},
"SalesArea": {
"Code": "DFT",
"Name": "Default Sales Area"
},
"ManagementArea": {
"Code": "DFT",
"Name": "Default Management Area"
}
},
"Franchise": {
"Code": "001",
"Name": "South Park1"
},
"TimeZone": {
"ID": 75,
"BIAS": 480,
"Name": "Pacific Standard Time (Mexico)",
"Description": "(UTC-08:00) Baja California"
},
"PaymentPlan": "Pre-paid",
"PaymentTypes": [
{
"ID": 5,
"Code": "string",
"Name": "string"
},
{
"ID": 2,
"Code": "string",
"Name": "string"
},
{
"ID": 2,
"Code": "string",
"Name": "string"
},
{
"ID": 9,
"Code": "string",
"Name": "string"
},
{
"ID": 6,
"Code": "string",
"Name": "string"
},
{
"ID": 3,
"Code": "string",
"Name": "string"
}
],
"DOB": "1975-03-09",
"WinScoreRiskFactor": "RiskFactor",
"ParentAccounts": [
{
"Account": "123456201",
"AccountName": "Parent Account Name"
},
{
"Account": "123456201",
"AccountName": "Parent Account Name"
},
{
"Account": "123456201",
"AccountName": "Parent Account Name"
},
{
"Account": "123456201",
"AccountName": "Parent Account Name"
},
{
"Account": "123456201",
"AccountName": "Parent Account Name"
}
],
"ChildAccounts": [
{
"Account": "123456204",
"AccountName": "Child Account Name"
},
{
"Account": "123456204",
"AccountName": "Child Account Name"
},
{
"Account": "123456204",
"AccountName": "Child Account Name"
},
{
"Account": "123456204",
"AccountName": "Child Account Name"
},
{
"Account": "123456204",
"AccountName": "Child Account Name"
},
{
"Account": "123456204",
"AccountName": "Child Account Name"
},
{
"Account": "123456204",
"AccountName": "Child Account Name"
},
{
"Account": "123456204",
"AccountName": "Child Account Name"
},
{
"Account": "123456204",
"AccountName": "Child Account Name"
}
],
"SoftDisconnect": {
"SDStatus": "Active",
"SDDate": "2020-12-12"
},
"PINisSet": true,
"CanOrderPPV": false,
"PPVDenyReason": {
"Value": 20,
"Text": "Subscriber's PPV is Temporary disabled"
},
"InOutageArea": true,
"ActiveOutages": [
{
"ID": 1,
"OutageStatus": "Closed",
"OutageType": "Unplanned",
"Description": "string",
"StartTime": "string",
"EstCloseTime": "string",
"ActualEndDate": "string",
"Resolutions": [
{
"Code": "001",
"Name": "Resolution 1"
},
{
"Code": "001",
"Name": "Resolution 1"
},
{
"Code": "001",
"Name": "Resolution 1"
},
{
"Code": "001",
"Name": "Resolution 1"
},
{
"Code": "001",
"Name": "Resolution 1"
},
{
"Code": "001",
"Name": "Resolution 1"
},
{
"Code": "001",
"Name": "Resolution 1"
}
]
},
{
"ID": 1,
"OutageStatus": "Open",
"OutageType": "Unplanned",
"Description": "string",
"StartTime": "string",
"EstCloseTime": "string",
"ActualEndDate": "string",
"Resolutions": [
{
"Code": "001",
"Name": "Resolution 1"
},
{
"Code": "001",
"Name": "Resolution 1"
},
{
"Code": "001",
"Name": "Resolution 1"
},
{
"Code": "001",
"Name": "Resolution 1"
},
{
"Code": "001",
"Name": "Resolution 1"
},
{
"Code": "001",
"Name": "Resolution 1"
}
]
},
{
"ID": 1,
"OutageStatus": "Closed",
"OutageType": "Unplanned",
"Description": "string",
"StartTime": "string",
"EstCloseTime": "string",
"ActualEndDate": "string",
"Resolutions": [
{
"Code": "001",
"Name": "Resolution 1"
},
{
"Code": "001",
"Name": "Resolution 1"
},
{
"Code": "001",
"Name": "Resolution 1"
},
{
"Code": "001",
"Name": "Resolution 1"
},
{
"Code": "001",
"Name": "Resolution 1"
},
{
"Code": "001",
"Name": "Resolution 1"
}
]
},
{
"ID": 1,
"OutageStatus": "Closed",
"OutageType": "Unplanned",
"Description": "string",
"StartTime": "string",
"EstCloseTime": "string",
"ActualEndDate": "string",
"Resolutions": [
{
"Code": "001",
"Name": "Resolution 1"
},
{
"Code": "001",
"Name": "Resolution 1"
},
{
"Code": "001",
"Name": "Resolution 1"
},
{
"Code": "001",
"Name": "Resolution 1"
},
{
"Code": "001",
"Name": "Resolution 1"
},
{
"Code": "001",
"Name": "Resolution 1"
},
{
"Code": "001",
"Name": "Resolution 1"
},
{
"Code": "001",
"Name": "Resolution 1"
},
{
"Code": "001",
"Name": "Resolution 1"
},
{
"Code": "001",
"Name": "Resolution 1"
}
]
},
{
"ID": 1,
"OutageStatus": "Closed",
"OutageType": "Unplanned",
"Description": "string",
"StartTime": "string",
"EstCloseTime": "string",
"ActualEndDate": "string",
"Resolutions": [
{
"Code": "001",
"Name": "Resolution 1"
},
{
"Code": "001",
"Name": "Resolution 1"
},
{
"Code": "001",
"Name": "Resolution 1"
},
{
"Code": "001",
"Name": "Resolution 1"
},
{
"Code": "001",
"Name": "Resolution 1"
}
]
},
{
"ID": 1,
"OutageStatus": "Open",
"OutageType": "Planned",
"Description": "string",
"StartTime": "string",
"EstCloseTime": "string",
"ActualEndDate": "string",
"Resolutions": [
{
"Code": "001",
"Name": "Resolution 1"
},
{
"Code": "001",
"Name": "Resolution 1"
}
]
},
{
"ID": 1,
"OutageStatus": "Closed",
"OutageType": "Planned",
"Description": "string",
"StartTime": "string",
"EstCloseTime": "string",
"ActualEndDate": "string",
"Resolutions": [
{
"Code": "001",
"Name": "Resolution 1"
},
{
"Code": "001",
"Name": "Resolution 1"
},
{
"Code": "001",
"Name": "Resolution 1"
},
{
"Code": "001",
"Name": "Resolution 1"
},
{
"Code": "001",
"Name": "Resolution 1"
},
{
"Code": "001",
"Name": "Resolution 1"
},
{
"Code": "001",
"Name": "Resolution 1"
},
{
"Code": "001",
"Name": "Resolution 1"
},
{
"Code": "001",
"Name": "Resolution 1"
}
]
},
{
"ID": 1,
"OutageStatus": "Open",
"OutageType": "Unplanned",
"Description": "string",
"StartTime": "string",
"EstCloseTime": "string",
"ActualEndDate": "string",
"Resolutions": [
{
"Code": "001",
"Name": "Resolution 1"
},
{
"Code": "001",
"Name": "Resolution 1"
},
{
"Code": "001",
"Name": "Resolution 1"
}
]
},
{
"ID": 1,
"OutageStatus": "Open",
"OutageType": "Unplanned",
"Description": "string",
"StartTime": "string",
"EstCloseTime": "string",
"ActualEndDate": "string",
"Resolutions": [
{
"Code": "001",
"Name": "Resolution 1"
},
{
"Code": "001",
"Name": "Resolution 1"
},
{
"Code": "001",
"Name": "Resolution 1"
},
{
"Code": "001",
"Name": "Resolution 1"
},
{
"Code": "001",
"Name": "Resolution 1"
},
{
"Code": "001",
"Name": "Resolution 1"
},
{
"Code": "001",
"Name": "Resolution 1"
},
{
"Code": "001",
"Name": "Resolution 1"
},
{
"Code": "001",
"Name": "Resolution 1"
},
{
"Code": "001",
"Name": "Resolution 1"
}
]
},
{
"ID": 1,
"OutageStatus": "Open",
"OutageType": "Unplanned",
"Description": "string",
"StartTime": "string",
"EstCloseTime": "string",
"ActualEndDate": "string",
"Resolutions": [
{
"Code": "001",
"Name": "Resolution 1"
},
{
"Code": "001",
"Name": "Resolution 1"
},
{
"Code": "001",
"Name": "Resolution 1"
},
{
"Code": "001",
"Name": "Resolution 1"
},
{
"Code": "001",
"Name": "Resolution 1"
},
{
"Code": "001",
"Name": "Resolution 1"
},
{
"Code": "001",
"Name": "Resolution 1"
},
{
"Code": "001",
"Name": "Resolution 1"
},
{
"Code": "001",
"Name": "Resolution 1"
}
]
}
]
}
}
}
}
},
"parameters": [
{
"name": "aCCOUNT",
"in": "path",
"required": true,
"schema": {
"title": "aCCOUNT",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/subscriber/{aCCOUNT}/balance": {
"get": {
"tags": [
"Subscriber"
],
"operationId": "getBalance",
"description": "The parameters and request body are for method: getBalance. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"PaymentPlan": {
"type": "string"
},
"LastBillAfterPayments": {
"type": "number"
},
"CurrentBalance": {
"type": "number"
},
"NewActivity": {
"type": "number"
},
"CurrentAging30": {
"type": "number"
},
"CurrentAging60": {
"type": "number"
},
"CurrentAging90": {
"type": "number"
},
"CurrentAging120": {
"type": "number"
},
"PastDueAmt": {
"type": "number"
},
"CurrentBillDueDate": {
"type": "string"
},
"LastBillAmount": {
"type": "number"
},
"LastBillDate": {
"type": "string"
},
"BillFormIsSet": {
"type": "boolean"
},
"LastCycleCloseDate": {
"type": "string"
},
"LastPaymentAmount": {
"type": "number"
},
"LastPaymentDate": {
"type": "string"
},
"LatePaymentAmount": {
"type": "number"
},
"MonthlyPPVCreditLimit": {
"type": "number"
},
"AvailPPVCreditLimit": {
"type": "number"
},
"PTP": {
"type": "object",
"properties": {
"PTPDate": {
"type": "string"
},
"PTPAgingCategory": {
"type": "string"
},
"PTPAmount": {
"type": "number"
}
}
}
}
},
"example": {
"PaymentPlan": "Post-paid",
"LastBillAfterPayments": 13062.13,
"CurrentBalance": 19991.3,
"NewActivity": 6929.17,
"CurrentAging30": 256.37,
"CurrentAging60": 249.72,
"CurrentAging90": 236.37,
"CurrentAging120": 12319.67,
"PastDueAmt": 12319.67,
"CurrentBillDueDate": "2020-11-01",
"LastBillAmount": 14690.5,
"LastBillDate": "2020-10-30",
"BillFormIsSet": false,
"LastCycleCloseDate": "2020-10-30",
"LastPaymentAmount": 99.99,
"LastPaymentDate": "2020-10-30",
"LatePaymentAmount": 1628.37,
"MonthlyPPVCreditLimit": 100,
"AvailPPVCreditLimit": 10.1,
"PTP": {
"PTPDate": "2020-12-12",
"PTPAgingCategory": "31-60",
"PTPAmount": 10
}
}
}
}
}
},
"parameters": [
{
"name": "aCCOUNT",
"in": "path",
"required": true,
"schema": {
"title": "aCCOUNT",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/subscriber/{aCCOUNT}/buckets": {
"get": {
"tags": [
"Subscriber"
],
"operationId": "getSubBucketBalances",
"description": "The parameters and request body are for method: getSubBucketBalances. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"Code": {
"type": "string"
},
"Description": {
"type": "string"
},
"Balance": {
"type": "number"
}
}
}
},
"example": [
{
"Code": "TVD",
"Description": "TV AND DATA",
"Balance": -2.34
},
{
"Code": "TVD",
"Description": "TV AND DATA",
"Balance": -2.34
},
{
"Code": "TVD",
"Description": "TV AND DATA",
"Balance": -2.34
}
]
}
}
}
},
"parameters": [
{
"name": "aCCOUNT",
"in": "path",
"required": true,
"schema": {
"title": "aCCOUNT",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/subscriber/{aCCOUNT}/packages": {
"get": {
"tags": [
"Subscriber"
],
"operationId": "getSubscriberPackages",
"description": "The parameters and request body are for method: getSubscriberPackages. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"PackageCode": {
"type": "string"
},
"PackageName": {
"type": "string"
},
"Price": {
"type": "number"
}
}
}
},
"example": [
{
"PackageCode": "015",
"PackageName": "HBO",
"Price": 10
},
{
"PackageCode": "015",
"PackageName": "HBO",
"Price": 10
},
{
"PackageCode": "015",
"PackageName": "HBO",
"Price": 10
},
{
"PackageCode": "015",
"PackageName": "HBO",
"Price": 10
}
]
}
}
}
},
"parameters": [
{
"name": "aCCOUNT",
"in": "path",
"required": true,
"schema": {
"title": "aCCOUNT",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/subscriber/{aCCOUNT}/packages/sis": {
"get": {
"tags": [
"Subscriber"
],
"operationId": "getSIS",
"description": "The parameters and request body are for method: getSIS. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"Packages": {
"type": "array",
"items": {
"type": "object",
"properties": {
"ServiceClass": {
"type": "object",
"properties": {
"Code": {
"type": "string"
},
"Name": {
"type": "string"
}
}
},
"Code": {
"type": "string"
},
"Name": {
"type": "string"
},
"Quantity": {
"type": "number"
},
"Price": {
"type": "number"
},
"Taxes": {
"type": "number"
},
"ContractNumber": {
"type": "string"
},
"ContractEndDate": {
"type": "string"
}
}
}
},
"Discounts": {
"type": "array",
"items": {
"type": "object",
"properties": {
"ServiceClass": {
"type": "object",
"properties": {
"Code": {
"type": "string"
},
"Name": {
"type": "string"
}
}
},
"Code": {
"type": "string"
},
"Name": {
"type": "string"
},
"Discount": {
"type": "number"
},
"Taxes": {
"type": "number"
},
"ContractNumber": {
"type": "string"
},
"ContractE