Service Eligibility
post
https://server:port/spl/rest/apis/customer/service/startStopTransferTasks/serviceEligibility
This operation determines if a customer is eligible to start service. It is used when starting new service, adding service, or transferring service. If the customer is eligible, a new self-service start/stop/transfer task is created where the input customer information and the results of processing performed throughout the transaction are persisted.
Request
There are no request parameters for this operation.
Supported Media Types
- application/xml
- application/json
Root Schema : schema
Type:
Show Source
object
-
accountId: string
Maximum Length:
10
Account ID -
actionMethodRole: string
Allowed Values:
[ "C1-ADDPERSONTOACCCOUNT", "C1-SSADDSERVICE", "C1-TRANSFERSERVICE", "C1-SSTRANSFERSERVICE", "C1-STOPSERVICE", "C1-SSSTOPSERVICE", "C1-SERVICECALL", "C1-SSNEWSERVICE", "C1-STARTSERVICE" ]
Action Method Role represents a self-service start/stop/transfer service use case. * `C1-ADDPERSONTOACCCOUNT` - Add Person to Account, * `C1-SSADDSERVICE` - Self-Service Add Service, * `C1-TRANSFERSERVICE` - Transfer Service, * `C1-SSTRANSFERSERVICE` - Self-Service Transfer Service, * `C1-STOPSERVICE` - Stop Service, * `C1-SSSTOPSERVICE` - Self-Service Stop Service, * `C1-SERVICECALL` - Service Call, * `C1-SSNEWSERVICE` - Self-Service New Service, * `C1-STARTSERVICE` - Start ServiceExample:C1-SSNEWSERVICE
-
cisDivision: string
Maximum Length:
5
CIS Division defines the governing jurisdiction.Example:CA
-
cssUser: string
Maximum Length:
30
Self-Service User ID -
customerClass: string
Maximum Length:
8
Customer Class controls financial parameters related to billing and collections.Example:R
-
customerServiceRequestType: string
Maximum Length:
30
Customer Service Request Type controls how a specific customer service request is processed.Example:DSS-NEW-SERVICE
-
dateOfBirth: string
(date)
Date of Birth
-
emailAddress: string
Maximum Length:
254
Email Address.Example:mark.brazil@email.com
-
emailContacts: object
emailContacts
-
entityName: string
Maximum Length:
254
Name -
firstName: string
Maximum Length:
50
First Name -
ipAddress: string
Maximum Length:
15
IP Address -
lastName: string
Maximum Length:
50
Last Name -
newAccount: string
Allowed Values:
[ "N ", "Y " ]
New Account switch indicates that the request is for a new account. * `N ` - No, * `Y ` - Yes -
newCustomer: string
Allowed Values:
[ "N ", "Y " ]
New Customer switch indicates that the request is for a new customer. * `N ` - No, * `Y ` - Yes -
personId: string
Maximum Length:
10
Person ID -
personIdentifiers: object
personIdentifiers
-
personOrBusiness: string
Allowed Values:
[ "B ", "P " ]
Person/Business: * `B ` - Business, * `P ` - Person -
phoneContacts: object
phoneContacts
-
premiseId: string
Maximum Length:
10
Premise ID -
requestMode: string
Allowed Values:
[ "C1SP", "C1ST", "C1TR" ]
Request Mode indicates the type of start/stop/transfer transaction. * `C1SP` - Stop Service, * `C1ST` - Start Service, * `C1TR` - Transfer Service -
serviceTaskType: string
Maximum Length:
30
Self-service task type defines properties that control how a self-service task is processedExample:DSSSTARTSTOPTRANSFER
-
webUserId: string
Maximum Length:
30
Web User ID
Nested Schema : items
Type:
Show Source
object
-
activeInactive: string
Allowed Values:
[ "C1AC", "C1IN" ]
Most contact preferences will remain active. When a contact is no longer valid, the existing contact should be updated to Inactive. * `C1AC` - Active, * `C1IN` - Inactive -
contactId: string
Maximum Length:
10
Contact Detail ID is a system-assigned unique identifier of the person contact.Example:4050952629
-
contactNickname: string
Maximum Length:
100
Person contact details nickname.Example:Home
-
contactStatus: string
Allowed Values:
[ "C1AP", "C1PN", "C1RJ" ]
Contact Status indicates the option contact's status. * `C1AP` - Approved, * `C1PN` - Pending, * `C1RJ` - Rejected. -
contactType: string
Maximum Length:
30
Person Contact Type indicates the type of contact such as, home phone, cell phone, or work email.Example:HOMEPHONE, WORKEMAIL
-
contactValue: string
Maximum Length:
254
Contact Detail Value contains the specific contact information such as the phone number or email address in the associated format.Example:415-123-4567, mark.brazil@email.com
-
contactValueExtension: string
Maximum Length:
6
Extension, if any, of the contact information. (This field is only active when the contact's contact routing is phone or fax.)Example:121
-
doNotDisturbEndTime: string
Do Not Disturb (To) indicates the end time when a person contact should not be used.Example:
20.30.00
-
doNotDisturbStartTime: string
Do Not Disturb (From) indicates the start time when a person contact should not be used.Example:
08.00.00
-
primaryContact: string
Allowed Values:
[ "C1NO", "C1YS" ]
Primary switch must be set for exactly one person contact for each contact routing. * `C1NO` - No, * `C1YS` - Yes
Nested Schema : items
Type:
Show Source
object
-
idType: string
Maximum Length:
8
ID Type defines the type of identification.Example:SSN
-
idValue: string
Maximum Length:
100
The unique Identification Number assigned to an individual person or business by a government agency or any other authority.Example:***-**-1844
Nested Schema : items
Type:
Show Source
object
-
activeInactive: string
Allowed Values:
[ "C1AC", "C1IN" ]
Most contact preferences will remain active. When a contact is no longer valid, the existing contact should be updated to Inactive. * `C1AC` - Active, * `C1IN` - Inactive -
contactId: string
Maximum Length:
10
Contact Detail ID is a system-assigned unique identifier of the person contact.Example:4050952629
-
contactNickname: string
Maximum Length:
100
Person contact details nickname.Example:Home
-
contactStatus: string
Allowed Values:
[ "C1AP", "C1PN", "C1RJ" ]
Contact Status indicates the option contact's status. * `C1AP` - Approved, * `C1PN` - Pending, * `C1RJ` - Rejected. -
contactType: string
Maximum Length:
30
Person Contact Type indicates the type of contact such as, home phone, cell phone, or work email.Example:HOMEPHONE, WORKEMAIL
-
contactValue: string
Maximum Length:
254
Contact Detail Value contains the specific contact information such as the phone number or email address in the associated format.Example:415-123-4567, mark.brazil@email.com
-
contactValueExtension: string
Maximum Length:
6
Extension, if any, of the contact information. (This field is only active when the contact's contact routing is phone or fax.)Example:121
-
doNotDisturbEndTime: string
Do Not Disturb (To) indicates the end time when a person contact should not be used.Example:
20.30.00
-
doNotDisturbStartTime: string
Do Not Disturb (From) indicates the start time when a person contact should not be used.Example:
08.00.00
-
primaryContact: string
Allowed Values:
[ "C1NO", "C1YS" ]
Primary switch must be set for exactly one person contact for each contact routing. * `C1NO` - No, * `C1YS` - Yes
Root Schema : schema
Type:
Show Source
object
-
accountId: string
Maximum Length:
10
Account ID -
actionMethodRole: string
Allowed Values:
[ "C1-ADDPERSONTOACCCOUNT", "C1-SSADDSERVICE", "C1-TRANSFERSERVICE", "C1-SSTRANSFERSERVICE", "C1-STOPSERVICE", "C1-SSSTOPSERVICE", "C1-SERVICECALL", "C1-SSNEWSERVICE", "C1-STARTSERVICE" ]
Action Method Role represents a self-service start/stop/transfer service use case. * `C1-ADDPERSONTOACCCOUNT` - Add Person to Account, * `C1-SSADDSERVICE` - Self-Service Add Service, * `C1-TRANSFERSERVICE` - Transfer Service, * `C1-SSTRANSFERSERVICE` - Self-Service Transfer Service, * `C1-STOPSERVICE` - Stop Service, * `C1-SSSTOPSERVICE` - Self-Service Stop Service, * `C1-SERVICECALL` - Service Call, * `C1-SSNEWSERVICE` - Self-Service New Service, * `C1-STARTSERVICE` - Start ServiceExample:C1-SSNEWSERVICE
-
cisDivision: string
Maximum Length:
5
CIS Division defines the governing jurisdiction.Example:CA
-
cssUser: string
Maximum Length:
30
Self-Service User ID -
customerClass: string
Maximum Length:
8
Customer Class controls financial parameters related to billing and collections.Example:R
-
customerServiceRequestType: string
Maximum Length:
30
Customer Service Request Type controls how a specific customer service request is processed.Example:DSS-NEW-SERVICE
-
dateOfBirth: string
(date)
Date of Birth
-
emailAddress: string
Maximum Length:
254
Email Address.Example:mark.brazil@email.com
-
emailContacts: object
emailContacts
-
entityName: string
Maximum Length:
254
Name -
firstName: string
Maximum Length:
50
First Name -
ipAddress: string
Maximum Length:
15
IP Address -
lastName: string
Maximum Length:
50
Last Name -
newAccount: string
Allowed Values:
[ "N ", "Y " ]
New Account switch indicates that the request is for a new account. * `N ` - No, * `Y ` - Yes -
newCustomer: string
Allowed Values:
[ "N ", "Y " ]
New Customer switch indicates that the request is for a new customer. * `N ` - No, * `Y ` - Yes -
personId: string
Maximum Length:
10
Person ID -
personIdentifiers: object
personIdentifiers
-
personOrBusiness: string
Allowed Values:
[ "B ", "P " ]
Person/Business: * `B ` - Business, * `P ` - Person -
phoneContacts: object
phoneContacts
-
premiseId: string
Maximum Length:
10
Premise ID -
requestMode: string
Allowed Values:
[ "C1SP", "C1ST", "C1TR" ]
Request Mode indicates the type of start/stop/transfer transaction. * `C1SP` - Stop Service, * `C1ST` - Start Service, * `C1TR` - Transfer Service -
serviceTaskType: string
Maximum Length:
30
Self-service task type defines properties that control how a self-service task is processedExample:DSSSTARTSTOPTRANSFER
-
webUserId: string
Maximum Length:
30
Web User ID
Nested Schema : items
Type:
Show Source
object
-
activeInactive: string
Allowed Values:
[ "C1AC", "C1IN" ]
Most contact preferences will remain active. When a contact is no longer valid, the existing contact should be updated to Inactive. * `C1AC` - Active, * `C1IN` - Inactive -
contactId: string
Maximum Length:
10
Contact Detail ID is a system-assigned unique identifier of the person contact.Example:4050952629
-
contactNickname: string
Maximum Length:
100
Person contact details nickname.Example:Home
-
contactStatus: string
Allowed Values:
[ "C1AP", "C1PN", "C1RJ" ]
Contact Status indicates the option contact's status. * `C1AP` - Approved, * `C1PN` - Pending, * `C1RJ` - Rejected. -
contactType: string
Maximum Length:
30
Person Contact Type indicates the type of contact such as, home phone, cell phone, or work email.Example:HOMEPHONE, WORKEMAIL
-
contactValue: string
Maximum Length:
254
Contact Detail Value contains the specific contact information such as the phone number or email address in the associated format.Example:415-123-4567, mark.brazil@email.com
-
contactValueExtension: string
Maximum Length:
6
Extension, if any, of the contact information. (This field is only active when the contact's contact routing is phone or fax.)Example:121
-
doNotDisturbEndTime: string
Do Not Disturb (To) indicates the end time when a person contact should not be used.Example:
20.30.00
-
doNotDisturbStartTime: string
Do Not Disturb (From) indicates the start time when a person contact should not be used.Example:
08.00.00
-
primaryContact: string
Allowed Values:
[ "C1NO", "C1YS" ]
Primary switch must be set for exactly one person contact for each contact routing. * `C1NO` - No, * `C1YS` - Yes
Nested Schema : items
Type:
Show Source
object
-
idType: string
Maximum Length:
8
ID Type defines the type of identification.Example:SSN
-
idValue: string
Maximum Length:
100
The unique Identification Number assigned to an individual person or business by a government agency or any other authority.Example:***-**-1844
Nested Schema : items
Type:
Show Source
object
-
activeInactive: string
Allowed Values:
[ "C1AC", "C1IN" ]
Most contact preferences will remain active. When a contact is no longer valid, the existing contact should be updated to Inactive. * `C1AC` - Active, * `C1IN` - Inactive -
contactId: string
Maximum Length:
10
Contact Detail ID is a system-assigned unique identifier of the person contact.Example:4050952629
-
contactNickname: string
Maximum Length:
100
Person contact details nickname.Example:Home
-
contactStatus: string
Allowed Values:
[ "C1AP", "C1PN", "C1RJ" ]
Contact Status indicates the option contact's status. * `C1AP` - Approved, * `C1PN` - Pending, * `C1RJ` - Rejected. -
contactType: string
Maximum Length:
30
Person Contact Type indicates the type of contact such as, home phone, cell phone, or work email.Example:HOMEPHONE, WORKEMAIL
-
contactValue: string
Maximum Length:
254
Contact Detail Value contains the specific contact information such as the phone number or email address in the associated format.Example:415-123-4567, mark.brazil@email.com
-
contactValueExtension: string
Maximum Length:
6
Extension, if any, of the contact information. (This field is only active when the contact's contact routing is phone or fax.)Example:121
-
doNotDisturbEndTime: string
Do Not Disturb (To) indicates the end time when a person contact should not be used.Example:
20.30.00
-
doNotDisturbStartTime: string
Do Not Disturb (From) indicates the start time when a person contact should not be used.Example:
08.00.00
-
primaryContact: string
Allowed Values:
[ "C1NO", "C1YS" ]
Primary switch must be set for exactly one person contact for each contact routing. * `C1NO` - No, * `C1YS` - Yes
Response
Supported Media Types
- application/xml
- application/json
200 Response
Success response
Root Schema : C1SSSvcElig
Type:
Show Source
object
-
personHasMatch: boolean
Match switch indicates whether or not an existing person in the system matches the input name, ID, and contact information.Example:
true
-
serviceEligibilityDetails: object
serviceEligibilityDetails
-
serviceTaskId: string
Maximum Length:
14
Self-Service Task ID is the system-assigned unique identifier of the self-service task.Example:69216126491457
Nested Schema : serviceEligibilityDetails
Type:
Show Source
object
-
eligibilityMessages: object
eligibilityMessages
-
eligibleAccounts: object
eligibleAccounts
-
inEligibleAccounts: object
inEligibleAccounts
-
serviceCanStart: boolean
Service Can Start switch indicates whether or not the customer is eligible for service.Example:
true
400 Response
Bad Request
Root Schema : problemDetailDocument
Type:
Show Source
object
-
detail: string
Maximum Length:
60
The long message description from the Oracle Utilities Application Framework in CDATA format. -
httpStatus: number
Minimum Value:
0
Maximum Value:9999
The HTTP Status code for the error. -
problemInstance: string
Maximum Length:
60
Fully qualified URL consisting of the Base URI Timestamp of error in ISO format, the User used for the transaction, the Message Category within Oracle Utilities Application Framework, the Message Number within Oracle Utilities Application Framework, the Request URL and the HTTP method used for the transaction. -
problemType: string
Maximum Length:
60
URL of the format "A/message/X/Y" where A is the base URI, X is the Message Category and Y is the Message Number within Oracle Utilities Application Framework. -
serverMessage: object
serverMessage
-
stackTrace: string
Maximum Length:
60
The stack trace shows where the error occurs during the execution of a program. -
title: string
Maximum Length:
60
Fully qualified error message from Oracle Utilities Application Framework in CDATA format.
Nested Schema : serverMessage
Type:
Show Source
object
-
callSequence: string
Maximum Length:
60
Delimited sequence of programs called. -
longDescription: string
Maximum Length:
60
The long message description from the Oracle Utilities Application Framework in CDATA format. -
messageCategory: number
Minimum Value:
0
Maximum Value:0
Message Category within Oracle Utilities Application Framework. -
messageNbr: number
Minimum Value:
-99999
Maximum Value:99999
Message Number within Oracle Utilities Application Framework. -
messageText: string
Maximum Length:
60
Fully qualified error message from Oracle Utilities Application Framework in CDATA format. -
programName: string
Maximum Length:
60
Name of the program that encountered the error.
500 Response
Internal Server Error
Root Schema : problemDetailDocument
Type:
Show Source
object
-
detail: string
Maximum Length:
60
The long message description from the Oracle Utilities Application Framework in CDATA format. -
httpStatus: number
Minimum Value:
0
Maximum Value:9999
The HTTP Status code for the error. -
problemInstance: string
Maximum Length:
60
Fully qualified URL consisting of the Base URI Timestamp of error in ISO format, the User used for the transaction, the Message Category within Oracle Utilities Application Framework, the Message Number within Oracle Utilities Application Framework, the Request URL and the HTTP method used for the transaction. -
problemType: string
Maximum Length:
60
URL of the format "A/message/X/Y" where A is the base URI, X is the Message Category and Y is the Message Number within Oracle Utilities Application Framework. -
serverMessage: object
serverMessage
-
stackTrace: string
Maximum Length:
60
The stack trace shows where the error occurs during the execution of a program. -
title: string
Maximum Length:
60
Fully qualified error message from Oracle Utilities Application Framework in CDATA format.
Nested Schema : serverMessage
Type:
Show Source
object
-
callSequence: string
Maximum Length:
60
Delimited sequence of programs called. -
longDescription: string
Maximum Length:
60
The long message description from the Oracle Utilities Application Framework in CDATA format. -
messageCategory: number
Minimum Value:
0
Maximum Value:0
Message Category within Oracle Utilities Application Framework. -
messageNbr: number
Minimum Value:
-99999
Maximum Value:99999
Message Number within Oracle Utilities Application Framework. -
messageText: string
Maximum Length:
60
Fully qualified error message from Oracle Utilities Application Framework in CDATA format. -
programName: string
Maximum Length:
60
Name of the program that encountered the error.