Jump to

• Request
• Response

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

Request Body - application/xml ()

Root Schema : schema

Type: object

Show Source

• 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 Service

  Example: 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: [e-mail]
• 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 processed

  Example: DSSSTARTSTOPTRANSFER
• webUserId: string
  Maximum Length: 30

  Web User ID

{
    "type":"object",
    "properties":{
        "requestMode":{
            "type":"string",
            "enum":[
                "C1SP",
                "C1ST",
                "C1TR"
            ],
            "description":"Request Mode indicates the type of start/stop/transfer transaction.\n* `C1SP` - Stop Service,\n* `C1ST` - Start Service,\n* `C1TR` - Transfer Service"
        },
        "newCustomer":{
            "type":"string",
            "enum":[
                "N   ",
                "Y   "
            ],
            "description":"New Customer switch indicates that the request is for a new customer.\n* `N   ` - No,\n* `Y   ` - Yes"
        },
        "newAccount":{
            "type":"string",
            "enum":[
                "N   ",
                "Y   "
            ],
            "description":"New Account switch indicates that the request is for a new account.\n* `N   ` - No,\n* `Y   ` - Yes"
        },
        "actionMethodRole":{
            "type":"string",
            "enum":[
                "C1-ADDPERSONTOACCCOUNT",
                "C1-SSADDSERVICE",
                "C1-TRANSFERSERVICE",
                "C1-SSTRANSFERSERVICE",
                "C1-STOPSERVICE",
                "C1-SSSTOPSERVICE",
                "C1-SERVICECALL",
                "C1-SSNEWSERVICE",
                "C1-STARTSERVICE"
            ],
            "description":"Action Method Role represents a self-service start/stop/transfer service use case.\n* `C1-ADDPERSONTOACCCOUNT` - Add Person to Account,\n* `C1-SSADDSERVICE` - Self-Service Add Service,\n* `C1-TRANSFERSERVICE` - Transfer Service,\n* `C1-SSTRANSFERSERVICE` - Self-Service Transfer Service,\n* `C1-STOPSERVICE` - Stop Service,\n* `C1-SSSTOPSERVICE` - Self-Service Stop Service,\n* `C1-SERVICECALL` - Service Call,\n* `C1-SSNEWSERVICE` - Self-Service New Service,\n* `C1-STARTSERVICE` - Start Service",
            "example":"C1-SSNEWSERVICE"
        },
        "customerServiceRequestType":{
            "type":"string",
            "maxLength":30,
            "description":"Customer Service Request Type controls how a specific customer service request is processed.",
            "example":"DSS-NEW-SERVICE"
        },
        "serviceTaskType":{
            "type":"string",
            "maxLength":30,
            "description":"Self-service task type defines properties that control how a self-service task is processed",
            "example":"DSSSTARTSTOPTRANSFER"
        },
        "personOrBusiness":{
            "type":"string",
            "enum":[
                "B   ",
                "P   "
            ],
            "description":"Person/Business:\n* `B   ` - Business,\n* `P   ` - Person"
        },
        "customerClass":{
            "type":"string",
            "maxLength":8,
            "description":"Customer Class controls financial parameters related to billing and collections.",
            "example":"R"
        },
        "cisDivision":{
            "type":"string",
            "maxLength":5,
            "description":"CIS Division defines the governing jurisdiction.",
            "example":"CA"
        },
        "premiseId":{
            "type":"string",
            "maxLength":10,
            "description":"Premise ID"
        },
        "personId":{
            "type":"string",
            "maxLength":10,
            "description":"Person ID"
        },
        "accountId":{
            "type":"string",
            "maxLength":10,
            "description":"Account ID"
        },
        "firstName":{
            "type":"string",
            "maxLength":50,
            "description":"First Name"
        },
        "lastName":{
            "type":"string",
            "maxLength":50,
            "description":"Last Name"
        },
        "entityName":{
            "type":"string",
            "maxLength":254,
            "description":"Name"
        },
        "personIdentifiers":{
            "type":"object",
            "properties":{
                "personIdentifier":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "idType":{
                                "type":"string",
                                "maxLength":8,
                                "description":"ID Type defines the type of identification.",
                                "example":"SSN"
                            },
                            "idValue":{
                                "type":"string",
                                "maxLength":100,
                                "description":"The unique Identification Number assigned to an individual person or business by a government agency or any other authority.",
                                "example":"***-**-1844"
                            }
                        }
                    }
                }
            }
        },
        "phoneContacts":{
            "type":"object",
            "properties":{
                "phoneContact":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "contactId":{
                                "type":"string",
                                "maxLength":10,
                                "description":"Contact Detail ID is a system-assigned unique identifier of the person contact.",
                                "example":"4050952629"
                            },
                            "contactType":{
                                "type":"string",
                                "maxLength":30,
                                "description":"Person Contact Type indicates the type of contact such as, home phone, cell phone, or work email.",
                                "example":"HOMEPHONE, WORKEMAIL"
                            },
                            "contactValue":{
                                "type":"string",
                                "maxLength":254,
                                "description":"Contact Detail Value contains the specific contact information such as  the phone number or email address in the associated format.",
                                "example":"415-123-4567, [e-mail]"
                            },
                            "contactValueExtension":{
                                "type":"string",
                                "maxLength":6,
                                "description":"Extension, if any, of the contact information. (This field is only active when the contact's contact routing is phone or fax.)",
                                "example":"121"
                            },
                            "contactStatus":{
                                "type":"string",
                                "enum":[
                                    "C1AP",
                                    "C1PN",
                                    "C1RJ"
                                ],
                                "description":"Contact Status indicates the option contact's status.\n* `C1AP` - Approved,\n* `C1PN` - Pending,\n* `C1RJ` - Rejected."
                            },
                            "primaryContact":{
                                "type":"string",
                                "enum":[
                                    "C1NO",
                                    "C1YS"
                                ],
                                "description":"Primary switch must be set for exactly one person contact for each contact routing.\n* `C1NO` - No,\n* `C1YS` - Yes"
                            },
                            "activeInactive":{
                                "type":"string",
                                "enum":[
                                    "C1AC",
                                    "C1IN"
                                ],
                                "description":"Most contact preferences will remain active. When a contact is no longer valid, the existing contact should be updated to Inactive.\n* `C1AC` - Active,\n* `C1IN` - Inactive"
                            },
                            "doNotDisturbStartTime":{
                                "type":"string",
                                "description":"Do Not Disturb (From) indicates the start time when a person contact should not be used.",
                                "example":"08.00.00"
                            },
                            "doNotDisturbEndTime":{
                                "type":"string",
                                "description":"Do Not Disturb (To) indicates the end time when a person contact should not be used.",
                                "example":"20.30.00"
                            },
                            "contactNickname":{
                                "type":"string",
                                "maxLength":100,
                                "description":"Person contact details nickname.",
                                "example":"Home"
                            }
                        }
                    }
                }
            }
        },
        "emailContacts":{
            "type":"object",
            "properties":{
                "emailContact":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "contactId":{
                                "type":"string",
                                "maxLength":10,
                                "description":"Contact Detail ID is a system-assigned unique identifier of the person contact.",
                                "example":"4050952629"
                            },
                            "contactType":{
                                "type":"string",
                                "maxLength":30,
                                "description":"Person Contact Type indicates the type of contact such as, home phone, cell phone, or work email.",
                                "example":"HOMEPHONE, WORKEMAIL"
                            },
                            "contactValue":{
                                "type":"string",
                                "maxLength":254,
                                "description":"Contact Detail Value contains the specific contact information such as  the phone number or email address in the associated format.",
                                "example":"415-123-4567, [e-mail]"
                            },
                            "contactValueExtension":{
                                "type":"string",
                                "maxLength":6,
                                "description":"Extension, if any, of the contact information. (This field is only active when the contact's contact routing is phone or fax.)",
                                "example":"121"
                            },
                            "contactStatus":{
                                "type":"string",
                                "enum":[
                                    "C1AP",
                                    "C1PN",
                                    "C1RJ"
                                ],
                                "description":"Contact Status indicates the option contact's status.\n* `C1AP` - Approved,\n* `C1PN` - Pending,\n* `C1RJ` - Rejected."
                            },
                            "primaryContact":{
                                "type":"string",
                                "enum":[
                                    "C1NO",
                                    "C1YS"
                                ],
                                "description":"Primary switch must be set for exactly one person contact for each contact routing.\n* `C1NO` - No,\n* `C1YS` - Yes"
                            },
                            "activeInactive":{
                                "type":"string",
                                "enum":[
                                    "C1AC",
                                    "C1IN"
                                ],
                                "description":"Most contact preferences will remain active. When a contact is no longer valid, the existing contact should be updated to Inactive.\n* `C1AC` - Active,\n* `C1IN` - Inactive"
                            },
                            "doNotDisturbStartTime":{
                                "type":"string",
                                "description":"Do Not Disturb (From) indicates the start time when a person contact should not be used.",
                                "example":"08.00.00"
                            },
                            "doNotDisturbEndTime":{
                                "type":"string",
                                "description":"Do Not Disturb (To) indicates the end time when a person contact should not be used.",
                                "example":"20.30.00"
                            },
                            "contactNickname":{
                                "type":"string",
                                "maxLength":100,
                                "description":"Person contact details nickname.",
                                "example":"Home"
                            }
                        }
                    }
                }
            }
        },
        "dateOfBirth":{
            "type":"string",
            "format":"date",
            "description":"Date of Birth"
        },
        "webUserId":{
            "type":"string",
            "maxLength":30,
            "description":"Web User ID"
        },
        "cssUser":{
            "type":"string",
            "maxLength":30,
            "description":"Self-Service User ID"
        },
        "emailAddress":{
            "type":"string",
            "maxLength":254,
            "description":"Email Address.",
            "example":"[e-mail]"
        },
        "ipAddress":{
            "type":"string",
            "maxLength":15,
            "description":"IP Address"
        }
    },
    "xml":{
        "name":"C1SSSvcElig"
    }
}

Nested Schema : emailContacts

Type: object

Show Source

• emailContact: array emailContact

{
    "type":"object",
    "properties":{
        "emailContact":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "contactId":{
                        "type":"string",
                        "maxLength":10,
                        "description":"Contact Detail ID is a system-assigned unique identifier of the person contact.",
                        "example":"4050952629"
                    },
                    "contactType":{
                        "type":"string",
                        "maxLength":30,
                        "description":"Person Contact Type indicates the type of contact such as, home phone, cell phone, or work email.",
                        "example":"HOMEPHONE, WORKEMAIL"
                    },
                    "contactValue":{
                        "type":"string",
                        "maxLength":254,
                        "description":"Contact Detail Value contains the specific contact information such as  the phone number or email address in the associated format.",
                        "example":"415-123-4567, [e-mail]"
                    },
                    "contactValueExtension":{
                        "type":"string",
                        "maxLength":6,
                        "description":"Extension, if any, of the contact information. (This field is only active when the contact's contact routing is phone or fax.)",
                        "example":"121"
                    },
                    "contactStatus":{
                        "type":"string",
                        "enum":[
                            "C1AP",
                            "C1PN",
                            "C1RJ"
                        ],
                        "description":"Contact Status indicates the option contact's status.\n* `C1AP` - Approved,\n* `C1PN` - Pending,\n* `C1RJ` - Rejected."
                    },
                    "primaryContact":{
                        "type":"string",
                        "enum":[
                            "C1NO",
                            "C1YS"
                        ],
                        "description":"Primary switch must be set for exactly one person contact for each contact routing.\n* `C1NO` - No,\n* `C1YS` - Yes"
                    },
                    "activeInactive":{
                        "type":"string",
                        "enum":[
                            "C1AC",
                            "C1IN"
                        ],
                        "description":"Most contact preferences will remain active. When a contact is no longer valid, the existing contact should be updated to Inactive.\n* `C1AC` - Active,\n* `C1IN` - Inactive"
                    },
                    "doNotDisturbStartTime":{
                        "type":"string",
                        "description":"Do Not Disturb (From) indicates the start time when a person contact should not be used.",
                        "example":"08.00.00"
                    },
                    "doNotDisturbEndTime":{
                        "type":"string",
                        "description":"Do Not Disturb (To) indicates the end time when a person contact should not be used.",
                        "example":"20.30.00"
                    },
                    "contactNickname":{
                        "type":"string",
                        "maxLength":100,
                        "description":"Person contact details nickname.",
                        "example":"Home"
                    }
                }
            }
        }
    }
}

Nested Schema : personIdentifiers

Type: object

Show Source

• personIdentifier: array personIdentifier

{
    "type":"object",
    "properties":{
        "personIdentifier":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "idType":{
                        "type":"string",
                        "maxLength":8,
                        "description":"ID Type defines the type of identification.",
                        "example":"SSN"
                    },
                    "idValue":{
                        "type":"string",
                        "maxLength":100,
                        "description":"The unique Identification Number assigned to an individual person or business by a government agency or any other authority.",
                        "example":"***-**-1844"
                    }
                }
            }
        }
    }
}

Nested Schema : phoneContacts

Type: object

Show Source

• phoneContact: array phoneContact

{
    "type":"object",
    "properties":{
        "phoneContact":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "contactId":{
                        "type":"string",
                        "maxLength":10,
                        "description":"Contact Detail ID is a system-assigned unique identifier of the person contact.",
                        "example":"4050952629"
                    },
                    "contactType":{
                        "type":"string",
                        "maxLength":30,
                        "description":"Person Contact Type indicates the type of contact such as, home phone, cell phone, or work email.",
                        "example":"HOMEPHONE, WORKEMAIL"
                    },
                    "contactValue":{
                        "type":"string",
                        "maxLength":254,
                        "description":"Contact Detail Value contains the specific contact information such as  the phone number or email address in the associated format.",
                        "example":"415-123-4567, [e-mail]"
                    },
                    "contactValueExtension":{
                        "type":"string",
                        "maxLength":6,
                        "description":"Extension, if any, of the contact information. (This field is only active when the contact's contact routing is phone or fax.)",
                        "example":"121"
                    },
                    "contactStatus":{
                        "type":"string",
                        "enum":[
                            "C1AP",
                            "C1PN",
                            "C1RJ"
                        ],
                        "description":"Contact Status indicates the option contact's status.\n* `C1AP` - Approved,\n* `C1PN` - Pending,\n* `C1RJ` - Rejected."
                    },
                    "primaryContact":{
                        "type":"string",
                        "enum":[
                            "C1NO",
                            "C1YS"
                        ],
                        "description":"Primary switch must be set for exactly one person contact for each contact routing.\n* `C1NO` - No,\n* `C1YS` - Yes"
                    },
                    "activeInactive":{
                        "type":"string",
                        "enum":[
                            "C1AC",
                            "C1IN"
                        ],
                        "description":"Most contact preferences will remain active. When a contact is no longer valid, the existing contact should be updated to Inactive.\n* `C1AC` - Active,\n* `C1IN` - Inactive"
                    },
                    "doNotDisturbStartTime":{
                        "type":"string",
                        "description":"Do Not Disturb (From) indicates the start time when a person contact should not be used.",
                        "example":"08.00.00"
                    },
                    "doNotDisturbEndTime":{
                        "type":"string",
                        "description":"Do Not Disturb (To) indicates the end time when a person contact should not be used.",
                        "example":"20.30.00"
                    },
                    "contactNickname":{
                        "type":"string",
                        "maxLength":100,
                        "description":"Person contact details nickname.",
                        "example":"Home"
                    }
                }
            }
        }
    }
}

Nested Schema : emailContact

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "contactId":{
                "type":"string",
                "maxLength":10,
                "description":"Contact Detail ID is a system-assigned unique identifier of the person contact.",
                "example":"4050952629"
            },
            "contactType":{
                "type":"string",
                "maxLength":30,
                "description":"Person Contact Type indicates the type of contact such as, home phone, cell phone, or work email.",
                "example":"HOMEPHONE, WORKEMAIL"
            },
            "contactValue":{
                "type":"string",
                "maxLength":254,
                "description":"Contact Detail Value contains the specific contact information such as  the phone number or email address in the associated format.",
                "example":"415-123-4567, [e-mail]"
            },
            "contactValueExtension":{
                "type":"string",
                "maxLength":6,
                "description":"Extension, if any, of the contact information. (This field is only active when the contact's contact routing is phone or fax.)",
                "example":"121"
            },
            "contactStatus":{
                "type":"string",
                "enum":[
                    "C1AP",
                    "C1PN",
                    "C1RJ"
                ],
                "description":"Contact Status indicates the option contact's status.\n* `C1AP` - Approved,\n* `C1PN` - Pending,\n* `C1RJ` - Rejected."
            },
            "primaryContact":{
                "type":"string",
                "enum":[
                    "C1NO",
                    "C1YS"
                ],
                "description":"Primary switch must be set for exactly one person contact for each contact routing.\n* `C1NO` - No,\n* `C1YS` - Yes"
            },
            "activeInactive":{
                "type":"string",
                "enum":[
                    "C1AC",
                    "C1IN"
                ],
                "description":"Most contact preferences will remain active. When a contact is no longer valid, the existing contact should be updated to Inactive.\n* `C1AC` - Active,\n* `C1IN` - Inactive"
            },
            "doNotDisturbStartTime":{
                "type":"string",
                "description":"Do Not Disturb (From) indicates the start time when a person contact should not be used.",
                "example":"08.00.00"
            },
            "doNotDisturbEndTime":{
                "type":"string",
                "description":"Do Not Disturb (To) indicates the end time when a person contact should not be used.",
                "example":"20.30.00"
            },
            "contactNickname":{
                "type":"string",
                "maxLength":100,
                "description":"Person contact details nickname.",
                "example":"Home"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• 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, [e-mail]
• 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

{
    "type":"object",
    "properties":{
        "contactId":{
            "type":"string",
            "maxLength":10,
            "description":"Contact Detail ID is a system-assigned unique identifier of the person contact.",
            "example":"4050952629"
        },
        "contactType":{
            "type":"string",
            "maxLength":30,
            "description":"Person Contact Type indicates the type of contact such as, home phone, cell phone, or work email.",
            "example":"HOMEPHONE, WORKEMAIL"
        },
        "contactValue":{
            "type":"string",
            "maxLength":254,
            "description":"Contact Detail Value contains the specific contact information such as  the phone number or email address in the associated format.",
            "example":"415-123-4567, [e-mail]"
        },
        "contactValueExtension":{
            "type":"string",
            "maxLength":6,
            "description":"Extension, if any, of the contact information. (This field is only active when the contact's contact routing is phone or fax.)",
            "example":"121"
        },
        "contactStatus":{
            "type":"string",
            "enum":[
                "C1AP",
                "C1PN",
                "C1RJ"
            ],
            "description":"Contact Status indicates the option contact's status.\n* `C1AP` - Approved,\n* `C1PN` - Pending,\n* `C1RJ` - Rejected."
        },
        "primaryContact":{
            "type":"string",
            "enum":[
                "C1NO",
                "C1YS"
            ],
            "description":"Primary switch must be set for exactly one person contact for each contact routing.\n* `C1NO` - No,\n* `C1YS` - Yes"
        },
        "activeInactive":{
            "type":"string",
            "enum":[
                "C1AC",
                "C1IN"
            ],
            "description":"Most contact preferences will remain active. When a contact is no longer valid, the existing contact should be updated to Inactive.\n* `C1AC` - Active,\n* `C1IN` - Inactive"
        },
        "doNotDisturbStartTime":{
            "type":"string",
            "description":"Do Not Disturb (From) indicates the start time when a person contact should not be used.",
            "example":"08.00.00"
        },
        "doNotDisturbEndTime":{
            "type":"string",
            "description":"Do Not Disturb (To) indicates the end time when a person contact should not be used.",
            "example":"20.30.00"
        },
        "contactNickname":{
            "type":"string",
            "maxLength":100,
            "description":"Person contact details nickname.",
            "example":"Home"
        }
    }
}

Nested Schema : personIdentifier

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "idType":{
                "type":"string",
                "maxLength":8,
                "description":"ID Type defines the type of identification.",
                "example":"SSN"
            },
            "idValue":{
                "type":"string",
                "maxLength":100,
                "description":"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: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "idType":{
            "type":"string",
            "maxLength":8,
            "description":"ID Type defines the type of identification.",
            "example":"SSN"
        },
        "idValue":{
            "type":"string",
            "maxLength":100,
            "description":"The unique Identification Number assigned to an individual person or business by a government agency or any other authority.",
            "example":"***-**-1844"
        }
    }
}

Nested Schema : phoneContact

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "contactId":{
                "type":"string",
                "maxLength":10,
                "description":"Contact Detail ID is a system-assigned unique identifier of the person contact.",
                "example":"4050952629"
            },
            "contactType":{
                "type":"string",
                "maxLength":30,
                "description":"Person Contact Type indicates the type of contact such as, home phone, cell phone, or work email.",
                "example":"HOMEPHONE, WORKEMAIL"
            },
            "contactValue":{
                "type":"string",
                "maxLength":254,
                "description":"Contact Detail Value contains the specific contact information such as  the phone number or email address in the associated format.",
                "example":"415-123-4567, [e-mail]"
            },
            "contactValueExtension":{
                "type":"string",
                "maxLength":6,
                "description":"Extension, if any, of the contact information. (This field is only active when the contact's contact routing is phone or fax.)",
                "example":"121"
            },
            "contactStatus":{
                "type":"string",
                "enum":[
                    "C1AP",
                    "C1PN",
                    "C1RJ"
                ],
                "description":"Contact Status indicates the option contact's status.\n* `C1AP` - Approved,\n* `C1PN` - Pending,\n* `C1RJ` - Rejected."
            },
            "primaryContact":{
                "type":"string",
                "enum":[
                    "C1NO",
                    "C1YS"
                ],
                "description":"Primary switch must be set for exactly one person contact for each contact routing.\n* `C1NO` - No,\n* `C1YS` - Yes"
            },
            "activeInactive":{
                "type":"string",
                "enum":[
                    "C1AC",
                    "C1IN"
                ],
                "description":"Most contact preferences will remain active. When a contact is no longer valid, the existing contact should be updated to Inactive.\n* `C1AC` - Active,\n* `C1IN` - Inactive"
            },
            "doNotDisturbStartTime":{
                "type":"string",
                "description":"Do Not Disturb (From) indicates the start time when a person contact should not be used.",
                "example":"08.00.00"
            },
            "doNotDisturbEndTime":{
                "type":"string",
                "description":"Do Not Disturb (To) indicates the end time when a person contact should not be used.",
                "example":"20.30.00"
            },
            "contactNickname":{
                "type":"string",
                "maxLength":100,
                "description":"Person contact details nickname.",
                "example":"Home"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• 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, [e-mail]
• 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

{
    "type":"object",
    "properties":{
        "contactId":{
            "type":"string",
            "maxLength":10,
            "description":"Contact Detail ID is a system-assigned unique identifier of the person contact.",
            "example":"4050952629"
        },
        "contactType":{
            "type":"string",
            "maxLength":30,
            "description":"Person Contact Type indicates the type of contact such as, home phone, cell phone, or work email.",
            "example":"HOMEPHONE, WORKEMAIL"
        },
        "contactValue":{
            "type":"string",
            "maxLength":254,
            "description":"Contact Detail Value contains the specific contact information such as  the phone number or email address in the associated format.",
            "example":"415-123-4567, [e-mail]"
        },
        "contactValueExtension":{
            "type":"string",
            "maxLength":6,
            "description":"Extension, if any, of the contact information. (This field is only active when the contact's contact routing is phone or fax.)",
            "example":"121"
        },
        "contactStatus":{
            "type":"string",
            "enum":[
                "C1AP",
                "C1PN",
                "C1RJ"
            ],
            "description":"Contact Status indicates the option contact's status.\n* `C1AP` - Approved,\n* `C1PN` - Pending,\n* `C1RJ` - Rejected."
        },
        "primaryContact":{
            "type":"string",
            "enum":[
                "C1NO",
                "C1YS"
            ],
            "description":"Primary switch must be set for exactly one person contact for each contact routing.\n* `C1NO` - No,\n* `C1YS` - Yes"
        },
        "activeInactive":{
            "type":"string",
            "enum":[
                "C1AC",
                "C1IN"
            ],
            "description":"Most contact preferences will remain active. When a contact is no longer valid, the existing contact should be updated to Inactive.\n* `C1AC` - Active,\n* `C1IN` - Inactive"
        },
        "doNotDisturbStartTime":{
            "type":"string",
            "description":"Do Not Disturb (From) indicates the start time when a person contact should not be used.",
            "example":"08.00.00"
        },
        "doNotDisturbEndTime":{
            "type":"string",
            "description":"Do Not Disturb (To) indicates the end time when a person contact should not be used.",
            "example":"20.30.00"
        },
        "contactNickname":{
            "type":"string",
            "maxLength":100,
            "description":"Person contact details nickname.",
            "example":"Home"
        }
    }
}

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• 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 Service

  Example: 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: [e-mail]
• 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 processed

  Example: DSSSTARTSTOPTRANSFER
• webUserId: string
  Maximum Length: 30

  Web User ID

{
    "type":"object",
    "properties":{
        "requestMode":{
            "type":"string",
            "enum":[
                "C1SP",
                "C1ST",
                "C1TR"
            ],
            "description":"Request Mode indicates the type of start/stop/transfer transaction.\n* `C1SP` - Stop Service,\n* `C1ST` - Start Service,\n* `C1TR` - Transfer Service"
        },
        "newCustomer":{
            "type":"string",
            "enum":[
                "N   ",
                "Y   "
            ],
            "description":"New Customer switch indicates that the request is for a new customer.\n* `N   ` - No,\n* `Y   ` - Yes"
        },
        "newAccount":{
            "type":"string",
            "enum":[
                "N   ",
                "Y   "
            ],
            "description":"New Account switch indicates that the request is for a new account.\n* `N   ` - No,\n* `Y   ` - Yes"
        },
        "actionMethodRole":{
            "type":"string",
            "enum":[
                "C1-ADDPERSONTOACCCOUNT",
                "C1-SSADDSERVICE",
                "C1-TRANSFERSERVICE",
                "C1-SSTRANSFERSERVICE",
                "C1-STOPSERVICE",
                "C1-SSSTOPSERVICE",
                "C1-SERVICECALL",
                "C1-SSNEWSERVICE",
                "C1-STARTSERVICE"
            ],
            "description":"Action Method Role represents a self-service start/stop/transfer service use case.\n* `C1-ADDPERSONTOACCCOUNT` - Add Person to Account,\n* `C1-SSADDSERVICE` - Self-Service Add Service,\n* `C1-TRANSFERSERVICE` - Transfer Service,\n* `C1-SSTRANSFERSERVICE` - Self-Service Transfer Service,\n* `C1-STOPSERVICE` - Stop Service,\n* `C1-SSSTOPSERVICE` - Self-Service Stop Service,\n* `C1-SERVICECALL` - Service Call,\n* `C1-SSNEWSERVICE` - Self-Service New Service,\n* `C1-STARTSERVICE` - Start Service",
            "example":"C1-SSNEWSERVICE"
        },
        "customerServiceRequestType":{
            "type":"string",
            "maxLength":30,
            "description":"Customer Service Request Type controls how a specific customer service request is processed.",
            "example":"DSS-NEW-SERVICE"
        },
        "serviceTaskType":{
            "type":"string",
            "maxLength":30,
            "description":"Self-service task type defines properties that control how a self-service task is processed",
            "example":"DSSSTARTSTOPTRANSFER"
        },
        "personOrBusiness":{
            "type":"string",
            "enum":[
                "B   ",
                "P   "
            ],
            "description":"Person/Business:\n* `B   ` - Business,\n* `P   ` - Person"
        },
        "customerClass":{
            "type":"string",
            "maxLength":8,
            "description":"Customer Class controls financial parameters related to billing and collections.",
            "example":"R"
        },
        "cisDivision":{
            "type":"string",
            "maxLength":5,
            "description":"CIS Division defines the governing jurisdiction.",
            "example":"CA"
        },
        "premiseId":{
            "type":"string",
            "maxLength":10,
            "description":"Premise ID"
        },
        "personId":{
            "type":"string",
            "maxLength":10,
            "description":"Person ID"
        },
        "accountId":{
            "type":"string",
            "maxLength":10,
            "description":"Account ID"
        },
        "firstName":{
            "type":"string",
            "maxLength":50,
            "description":"First Name"
        },
        "lastName":{
            "type":"string",
            "maxLength":50,
            "description":"Last Name"
        },
        "entityName":{
            "type":"string",
            "maxLength":254,
            "description":"Name"
        },
        "personIdentifiers":{
            "type":"object",
            "properties":{
                "personIdentifier":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "idType":{
                                "type":"string",
                                "maxLength":8,
                                "description":"ID Type defines the type of identification.",
                                "example":"SSN"
                            },
                            "idValue":{
                                "type":"string",
                                "maxLength":100,
                                "description":"The unique Identification Number assigned to an individual person or business by a government agency or any other authority.",
                                "example":"***-**-1844"
                            }
                        }
                    }
                }
            }
        },
        "phoneContacts":{
            "type":"object",
            "properties":{
                "phoneContact":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "contactId":{
                                "type":"string",
                                "maxLength":10,
                                "description":"Contact Detail ID is a system-assigned unique identifier of the person contact.",
                                "example":"4050952629"
                            },
                            "contactType":{
                                "type":"string",
                                "maxLength":30,
                                "description":"Person Contact Type indicates the type of contact such as, home phone, cell phone, or work email.",
                                "example":"HOMEPHONE, WORKEMAIL"
                            },
                            "contactValue":{
                                "type":"string",
                                "maxLength":254,
                                "description":"Contact Detail Value contains the specific contact information such as  the phone number or email address in the associated format.",
                                "example":"415-123-4567, [e-mail]"
                            },
                            "contactValueExtension":{
                                "type":"string",
                                "maxLength":6,
                                "description":"Extension, if any, of the contact information. (This field is only active when the contact's contact routing is phone or fax.)",
                                "example":"121"
                            },
                            "contactStatus":{
                                "type":"string",
                                "enum":[
                                    "C1AP",
                                    "C1PN",
                                    "C1RJ"
                                ],
                                "description":"Contact Status indicates the option contact's status.\n* `C1AP` - Approved,\n* `C1PN` - Pending,\n* `C1RJ` - Rejected."
                            },
                            "primaryContact":{
                                "type":"string",
                                "enum":[
                                    "C1NO",
                                    "C1YS"
                                ],
                                "description":"Primary switch must be set for exactly one person contact for each contact routing.\n* `C1NO` - No,\n* `C1YS` - Yes"
                            },
                            "activeInactive":{
                                "type":"string",
                                "enum":[
                                    "C1AC",
                                    "C1IN"
                                ],
                                "description":"Most contact preferences will remain active. When a contact is no longer valid, the existing contact should be updated to Inactive.\n* `C1AC` - Active,\n* `C1IN` - Inactive"
                            },
                            "doNotDisturbStartTime":{
                                "type":"string",
                                "description":"Do Not Disturb (From) indicates the start time when a person contact should not be used.",
                                "example":"08.00.00"
                            },
                            "doNotDisturbEndTime":{
                                "type":"string",
                                "description":"Do Not Disturb (To) indicates the end time when a person contact should not be used.",
                                "example":"20.30.00"
                            },
                            "contactNickname":{
                                "type":"string",
                                "maxLength":100,
                                "description":"Person contact details nickname.",
                                "example":"Home"
                            }
                        }
                    }
                }
            }
        },
        "emailContacts":{
            "type":"object",
            "properties":{
                "emailContact":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "contactId":{
                                "type":"string",
                                "maxLength":10,
                                "description":"Contact Detail ID is a system-assigned unique identifier of the person contact.",
                                "example":"4050952629"
                            },
                            "contactType":{
                                "type":"string",
                                "maxLength":30,
                                "description":"Person Contact Type indicates the type of contact such as, home phone, cell phone, or work email.",
                                "example":"HOMEPHONE, WORKEMAIL"
                            },
                            "contactValue":{
                                "type":"string",
                                "maxLength":254,
                                "description":"Contact Detail Value contains the specific contact information such as  the phone number or email address in the associated format.",
                                "example":"415-123-4567, [e-mail]"
                            },
                            "contactValueExtension":{
                                "type":"string",
                                "maxLength":6,
                                "description":"Extension, if any, of the contact information. (This field is only active when the contact's contact routing is phone or fax.)",
                                "example":"121"
                            },
                            "contactStatus":{
                                "type":"string",
                                "enum":[
                                    "C1AP",
                                    "C1PN",
                                    "C1RJ"
                                ],
                                "description":"Contact Status indicates the option contact's status.\n* `C1AP` - Approved,\n* `C1PN` - Pending,\n* `C1RJ` - Rejected."
                            },
                            "primaryContact":{
                                "type":"string",
                                "enum":[
                                    "C1NO",
                                    "C1YS"
                                ],
                                "description":"Primary switch must be set for exactly one person contact for each contact routing.\n* `C1NO` - No,\n* `C1YS` - Yes"
                            },
                            "activeInactive":{
                                "type":"string",
                                "enum":[
                                    "C1AC",
                                    "C1IN"
                                ],
                                "description":"Most contact preferences will remain active. When a contact is no longer valid, the existing contact should be updated to Inactive.\n* `C1AC` - Active,\n* `C1IN` - Inactive"
                            },
                            "doNotDisturbStartTime":{
                                "type":"string",
                                "description":"Do Not Disturb (From) indicates the start time when a person contact should not be used.",
                                "example":"08.00.00"
                            },
                            "doNotDisturbEndTime":{
                                "type":"string",
                                "description":"Do Not Disturb (To) indicates the end time when a person contact should not be used.",
                                "example":"20.30.00"
                            },
                            "contactNickname":{
                                "type":"string",
                                "maxLength":100,
                                "description":"Person contact details nickname.",
                                "example":"Home"
                            }
                        }
                    }
                }
            }
        },
        "dateOfBirth":{
            "type":"string",
            "format":"date",
            "description":"Date of Birth"
        },
        "webUserId":{
            "type":"string",
            "maxLength":30,
            "description":"Web User ID"
        },
        "cssUser":{
            "type":"string",
            "maxLength":30,
            "description":"Self-Service User ID"
        },
        "emailAddress":{
            "type":"string",
            "maxLength":254,
            "description":"Email Address.",
            "example":"[e-mail]"
        },
        "ipAddress":{
            "type":"string",
            "maxLength":15,
            "description":"IP Address"
        }
    },
    "xml":{
        "name":"C1SSSvcElig"
    }
}

Nested Schema : emailContacts

Type: object

Show Source

• emailContact: array emailContact

{
    "type":"object",
    "properties":{
        "emailContact":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "contactId":{
                        "type":"string",
                        "maxLength":10,
                        "description":"Contact Detail ID is a system-assigned unique identifier of the person contact.",
                        "example":"4050952629"
                    },
                    "contactType":{
                        "type":"string",
                        "maxLength":30,
                        "description":"Person Contact Type indicates the type of contact such as, home phone, cell phone, or work email.",
                        "example":"HOMEPHONE, WORKEMAIL"
                    },
                    "contactValue":{
                        "type":"string",
                        "maxLength":254,
                        "description":"Contact Detail Value contains the specific contact information such as  the phone number or email address in the associated format.",
                        "example":"415-123-4567, [e-mail]"
                    },
                    "contactValueExtension":{
                        "type":"string",
                        "maxLength":6,
                        "description":"Extension, if any, of the contact information. (This field is only active when the contact's contact routing is phone or fax.)",
                        "example":"121"
                    },
                    "contactStatus":{
                        "type":"string",
                        "enum":[
                            "C1AP",
                            "C1PN",
                            "C1RJ"
                        ],
                        "description":"Contact Status indicates the option contact's status.\n* `C1AP` - Approved,\n* `C1PN` - Pending,\n* `C1RJ` - Rejected."
                    },
                    "primaryContact":{
                        "type":"string",
                        "enum":[
                            "C1NO",
                            "C1YS"
                        ],
                        "description":"Primary switch must be set for exactly one person contact for each contact routing.\n* `C1NO` - No,\n* `C1YS` - Yes"
                    },
                    "activeInactive":{
                        "type":"string",
                        "enum":[
                            "C1AC",
                            "C1IN"
                        ],
                        "description":"Most contact preferences will remain active. When a contact is no longer valid, the existing contact should be updated to Inactive.\n* `C1AC` - Active,\n* `C1IN` - Inactive"
                    },
                    "doNotDisturbStartTime":{
                        "type":"string",
                        "description":"Do Not Disturb (From) indicates the start time when a person contact should not be used.",
                        "example":"08.00.00"
                    },
                    "doNotDisturbEndTime":{
                        "type":"string",
                        "description":"Do Not Disturb (To) indicates the end time when a person contact should not be used.",
                        "example":"20.30.00"
                    },
                    "contactNickname":{
                        "type":"string",
                        "maxLength":100,
                        "description":"Person contact details nickname.",
                        "example":"Home"
                    }
                }
            }
        }
    }
}

Nested Schema : personIdentifiers

Type: object

Show Source

• personIdentifier: array personIdentifier

{
    "type":"object",
    "properties":{
        "personIdentifier":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "idType":{
                        "type":"string",
                        "maxLength":8,
                        "description":"ID Type defines the type of identification.",
                        "example":"SSN"
                    },
                    "idValue":{
                        "type":"string",
                        "maxLength":100,
                        "description":"The unique Identification Number assigned to an individual person or business by a government agency or any other authority.",
                        "example":"***-**-1844"
                    }
                }
            }
        }
    }
}

Nested Schema : phoneContacts

Type: object

Show Source

• phoneContact: array phoneContact

{
    "type":"object",
    "properties":{
        "phoneContact":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "contactId":{
                        "type":"string",
                        "maxLength":10,
                        "description":"Contact Detail ID is a system-assigned unique identifier of the person contact.",
                        "example":"4050952629"
                    },
                    "contactType":{
                        "type":"string",
                        "maxLength":30,
                        "description":"Person Contact Type indicates the type of contact such as, home phone, cell phone, or work email.",
                        "example":"HOMEPHONE, WORKEMAIL"
                    },
                    "contactValue":{
                        "type":"string",
                        "maxLength":254,
                        "description":"Contact Detail Value contains the specific contact information such as  the phone number or email address in the associated format.",
                        "example":"415-123-4567, [e-mail]"
                    },
                    "contactValueExtension":{
                        "type":"string",
                        "maxLength":6,
                        "description":"Extension, if any, of the contact information. (This field is only active when the contact's contact routing is phone or fax.)",
                        "example":"121"
                    },
                    "contactStatus":{
                        "type":"string",
                        "enum":[
                            "C1AP",
                            "C1PN",
                            "C1RJ"
                        ],
                        "description":"Contact Status indicates the option contact's status.\n* `C1AP` - Approved,\n* `C1PN` - Pending,\n* `C1RJ` - Rejected."
                    },
                    "primaryContact":{
                        "type":"string",
                        "enum":[
                            "C1NO",
                            "C1YS"
                        ],
                        "description":"Primary switch must be set for exactly one person contact for each contact routing.\n* `C1NO` - No,\n* `C1YS` - Yes"
                    },
                    "activeInactive":{
                        "type":"string",
                        "enum":[
                            "C1AC",
                            "C1IN"
                        ],
                        "description":"Most contact preferences will remain active. When a contact is no longer valid, the existing contact should be updated to Inactive.\n* `C1AC` - Active,\n* `C1IN` - Inactive"
                    },
                    "doNotDisturbStartTime":{
                        "type":"string",
                        "description":"Do Not Disturb (From) indicates the start time when a person contact should not be used.",
                        "example":"08.00.00"
                    },
                    "doNotDisturbEndTime":{
                        "type":"string",
                        "description":"Do Not Disturb (To) indicates the end time when a person contact should not be used.",
                        "example":"20.30.00"
                    },
                    "contactNickname":{
                        "type":"string",
                        "maxLength":100,
                        "description":"Person contact details nickname.",
                        "example":"Home"
                    }
                }
            }
        }
    }
}

Nested Schema : emailContact

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "contactId":{
                "type":"string",
                "maxLength":10,
                "description":"Contact Detail ID is a system-assigned unique identifier of the person contact.",
                "example":"4050952629"
            },
            "contactType":{
                "type":"string",
                "maxLength":30,
                "description":"Person Contact Type indicates the type of contact such as, home phone, cell phone, or work email.",
                "example":"HOMEPHONE, WORKEMAIL"
            },
            "contactValue":{
                "type":"string",
                "maxLength":254,
                "description":"Contact Detail Value contains the specific contact information such as  the phone number or email address in the associated format.",
                "example":"415-123-4567, [e-mail]"
            },
            "contactValueExtension":{
                "type":"string",
                "maxLength":6,
                "description":"Extension, if any, of the contact information. (This field is only active when the contact's contact routing is phone or fax.)",
                "example":"121"
            },
            "contactStatus":{
                "type":"string",
                "enum":[
                    "C1AP",
                    "C1PN",
                    "C1RJ"
                ],
                "description":"Contact Status indicates the option contact's status.\n* `C1AP` - Approved,\n* `C1PN` - Pending,\n* `C1RJ` - Rejected."
            },
            "primaryContact":{
                "type":"string",
                "enum":[
                    "C1NO",
                    "C1YS"
                ],
                "description":"Primary switch must be set for exactly one person contact for each contact routing.\n* `C1NO` - No,\n* `C1YS` - Yes"
            },
            "activeInactive":{
                "type":"string",
                "enum":[
                    "C1AC",
                    "C1IN"
                ],
                "description":"Most contact preferences will remain active. When a contact is no longer valid, the existing contact should be updated to Inactive.\n* `C1AC` - Active,\n* `C1IN` - Inactive"
            },
            "doNotDisturbStartTime":{
                "type":"string",
                "description":"Do Not Disturb (From) indicates the start time when a person contact should not be used.",
                "example":"08.00.00"
            },
            "doNotDisturbEndTime":{
                "type":"string",
                "description":"Do Not Disturb (To) indicates the end time when a person contact should not be used.",
                "example":"20.30.00"
            },
            "contactNickname":{
                "type":"string",
                "maxLength":100,
                "description":"Person contact details nickname.",
                "example":"Home"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• 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, [e-mail]
• 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

{
    "type":"object",
    "properties":{
        "contactId":{
            "type":"string",
            "maxLength":10,
            "description":"Contact Detail ID is a system-assigned unique identifier of the person contact.",
            "example":"4050952629"
        },
        "contactType":{
            "type":"string",
            "maxLength":30,
            "description":"Person Contact Type indicates the type of contact such as, home phone, cell phone, or work email.",
            "example":"HOMEPHONE, WORKEMAIL"
        },
        "contactValue":{
            "type":"string",
            "maxLength":254,
            "description":"Contact Detail Value contains the specific contact information such as  the phone number or email address in the associated format.",
            "example":"415-123-4567, [e-mail]"
        },
        "contactValueExtension":{
            "type":"string",
            "maxLength":6,
            "description":"Extension, if any, of the contact information. (This field is only active when the contact's contact routing is phone or fax.)",
            "example":"121"
        },
        "contactStatus":{
            "type":"string",
            "enum":[
                "C1AP",
                "C1PN",
                "C1RJ"
            ],
            "description":"Contact Status indicates the option contact's status.\n* `C1AP` - Approved,\n* `C1PN` - Pending,\n* `C1RJ` - Rejected."
        },
        "primaryContact":{
            "type":"string",
            "enum":[
                "C1NO",
                "C1YS"
            ],
            "description":"Primary switch must be set for exactly one person contact for each contact routing.\n* `C1NO` - No,\n* `C1YS` - Yes"
        },
        "activeInactive":{
            "type":"string",
            "enum":[
                "C1AC",
                "C1IN"
            ],
            "description":"Most contact preferences will remain active. When a contact is no longer valid, the existing contact should be updated to Inactive.\n* `C1AC` - Active,\n* `C1IN` - Inactive"
        },
        "doNotDisturbStartTime":{
            "type":"string",
            "description":"Do Not Disturb (From) indicates the start time when a person contact should not be used.",
            "example":"08.00.00"
        },
        "doNotDisturbEndTime":{
            "type":"string",
            "description":"Do Not Disturb (To) indicates the end time when a person contact should not be used.",
            "example":"20.30.00"
        },
        "contactNickname":{
            "type":"string",
            "maxLength":100,
            "description":"Person contact details nickname.",
            "example":"Home"
        }
    }
}

Nested Schema : personIdentifier

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "idType":{
                "type":"string",
                "maxLength":8,
                "description":"ID Type defines the type of identification.",
                "example":"SSN"
            },
            "idValue":{
                "type":"string",
                "maxLength":100,
                "description":"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: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "idType":{
            "type":"string",
            "maxLength":8,
            "description":"ID Type defines the type of identification.",
            "example":"SSN"
        },
        "idValue":{
            "type":"string",
            "maxLength":100,
            "description":"The unique Identification Number assigned to an individual person or business by a government agency or any other authority.",
            "example":"***-**-1844"
        }
    }
}

Nested Schema : phoneContact

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "contactId":{
                "type":"string",
                "maxLength":10,
                "description":"Contact Detail ID is a system-assigned unique identifier of the person contact.",
                "example":"4050952629"
            },
            "contactType":{
                "type":"string",
                "maxLength":30,
                "description":"Person Contact Type indicates the type of contact such as, home phone, cell phone, or work email.",
                "example":"HOMEPHONE, WORKEMAIL"
            },
            "contactValue":{
                "type":"string",
                "maxLength":254,
                "description":"Contact Detail Value contains the specific contact information such as  the phone number or email address in the associated format.",
                "example":"415-123-4567, [e-mail]"
            },
            "contactValueExtension":{
                "type":"string",
                "maxLength":6,
                "description":"Extension, if any, of the contact information. (This field is only active when the contact's contact routing is phone or fax.)",
                "example":"121"
            },
            "contactStatus":{
                "type":"string",
                "enum":[
                    "C1AP",
                    "C1PN",
                    "C1RJ"
                ],
                "description":"Contact Status indicates the option contact's status.\n* `C1AP` - Approved,\n* `C1PN` - Pending,\n* `C1RJ` - Rejected."
            },
            "primaryContact":{
                "type":"string",
                "enum":[
                    "C1NO",
                    "C1YS"
                ],
                "description":"Primary switch must be set for exactly one person contact for each contact routing.\n* `C1NO` - No,\n* `C1YS` - Yes"
            },
            "activeInactive":{
                "type":"string",
                "enum":[
                    "C1AC",
                    "C1IN"
                ],
                "description":"Most contact preferences will remain active. When a contact is no longer valid, the existing contact should be updated to Inactive.\n* `C1AC` - Active,\n* `C1IN` - Inactive"
            },
            "doNotDisturbStartTime":{
                "type":"string",
                "description":"Do Not Disturb (From) indicates the start time when a person contact should not be used.",
                "example":"08.00.00"
            },
            "doNotDisturbEndTime":{
                "type":"string",
                "description":"Do Not Disturb (To) indicates the end time when a person contact should not be used.",
                "example":"20.30.00"
            },
            "contactNickname":{
                "type":"string",
                "maxLength":100,
                "description":"Person contact details nickname.",
                "example":"Home"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• 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, [e-mail]
• 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

{
    "type":"object",
    "properties":{
        "contactId":{
            "type":"string",
            "maxLength":10,
            "description":"Contact Detail ID is a system-assigned unique identifier of the person contact.",
            "example":"4050952629"
        },
        "contactType":{
            "type":"string",
            "maxLength":30,
            "description":"Person Contact Type indicates the type of contact such as, home phone, cell phone, or work email.",
            "example":"HOMEPHONE, WORKEMAIL"
        },
        "contactValue":{
            "type":"string",
            "maxLength":254,
            "description":"Contact Detail Value contains the specific contact information such as  the phone number or email address in the associated format.",
            "example":"415-123-4567, [e-mail]"
        },
        "contactValueExtension":{
            "type":"string",
            "maxLength":6,
            "description":"Extension, if any, of the contact information. (This field is only active when the contact's contact routing is phone or fax.)",
            "example":"121"
        },
        "contactStatus":{
            "type":"string",
            "enum":[
                "C1AP",
                "C1PN",
                "C1RJ"
            ],
            "description":"Contact Status indicates the option contact's status.\n* `C1AP` - Approved,\n* `C1PN` - Pending,\n* `C1RJ` - Rejected."
        },
        "primaryContact":{
            "type":"string",
            "enum":[
                "C1NO",
                "C1YS"
            ],
            "description":"Primary switch must be set for exactly one person contact for each contact routing.\n* `C1NO` - No,\n* `C1YS` - Yes"
        },
        "activeInactive":{
            "type":"string",
            "enum":[
                "C1AC",
                "C1IN"
            ],
            "description":"Most contact preferences will remain active. When a contact is no longer valid, the existing contact should be updated to Inactive.\n* `C1AC` - Active,\n* `C1IN` - Inactive"
        },
        "doNotDisturbStartTime":{
            "type":"string",
            "description":"Do Not Disturb (From) indicates the start time when a person contact should not be used.",
            "example":"08.00.00"
        },
        "doNotDisturbEndTime":{
            "type":"string",
            "description":"Do Not Disturb (To) indicates the end time when a person contact should not be used.",
            "example":"20.30.00"
        },
        "contactNickname":{
            "type":"string",
            "maxLength":100,
            "description":"Person contact details nickname.",
            "example":"Home"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

Success response

Body ()

Root Schema : C1SSSvcElig

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "personHasMatch":{
            "type":"boolean",
            "description":"Match switch indicates whether or not an existing person in the system matches the input name, ID, and contact information.",
            "example":"true"
        },
        "serviceEligibilityDetails":{
            "type":"object",
            "properties":{
                "serviceCanStart":{
                    "type":"boolean",
                    "description":"Service Can Start switch indicates whether or not the customer is eligible for service.",
                    "example":"true"
                },
                "eligibleAccounts":{
                    "type":"object",
                    "properties":{
                        "eligibleAccount":{
                            "type":"array",
                            "items":{
                                "type":"object",
                                "properties":{
                                    "accountId":{
                                        "type":"string",
                                        "maxLength":10,
                                        "description":"Account ID"
                                    }
                                }
                            }
                        }
                    }
                },
                "inEligibleAccounts":{
                    "type":"object",
                    "properties":{
                        "inEligibleAccount":{
                            "type":"array",
                            "items":{
                                "type":"object",
                                "properties":{
                                    "accountId":{
                                        "type":"string",
                                        "maxLength":10,
                                        "description":"Account ID"
                                    }
                                }
                            }
                        }
                    }
                },
                "eligibilityMessages":{
                    "type":"object",
                    "properties":{
                        "eligibilityMessage":{
                            "type":"array",
                            "items":{
                                "type":"object",
                                "properties":{
                                    "message":{
                                        "type":"string",
                                        "maxLength":254,
                                        "description":"Message Text"
                                    }
                                }
                            }
                        }
                    }
                }
            }
        },
        "serviceTaskId":{
            "type":"string",
            "maxLength":14,
            "description":"Self-Service Task ID is the system-assigned unique identifier of the self-service task.",
            "example":"69216126491457"
        }
    },
    "xml":{
        "name":"C1SSSvcElig"
    }
}

Nested Schema : serviceEligibilityDetails

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "serviceCanStart":{
            "type":"boolean",
            "description":"Service Can Start switch indicates whether or not the customer is eligible for service.",
            "example":"true"
        },
        "eligibleAccounts":{
            "type":"object",
            "properties":{
                "eligibleAccount":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "accountId":{
                                "type":"string",
                                "maxLength":10,
                                "description":"Account ID"
                            }
                        }
                    }
                }
            }
        },
        "inEligibleAccounts":{
            "type":"object",
            "properties":{
                "inEligibleAccount":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "accountId":{
                                "type":"string",
                                "maxLength":10,
                                "description":"Account ID"
                            }
                        }
                    }
                }
            }
        },
        "eligibilityMessages":{
            "type":"object",
            "properties":{
                "eligibilityMessage":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "message":{
                                "type":"string",
                                "maxLength":254,
                                "description":"Message Text"
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : eligibilityMessages

Type: object

Show Source

• eligibilityMessage: array eligibilityMessage

{
    "type":"object",
    "properties":{
        "eligibilityMessage":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "message":{
                        "type":"string",
                        "maxLength":254,
                        "description":"Message Text"
                    }
                }
            }
        }
    }
}

Nested Schema : eligibleAccounts

Type: object

Show Source

• eligibleAccount: array eligibleAccount

{
    "type":"object",
    "properties":{
        "eligibleAccount":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "accountId":{
                        "type":"string",
                        "maxLength":10,
                        "description":"Account ID"
                    }
                }
            }
        }
    }
}

Nested Schema : inEligibleAccounts

Type: object

Show Source

• inEligibleAccount: array inEligibleAccount

{
    "type":"object",
    "properties":{
        "inEligibleAccount":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "accountId":{
                        "type":"string",
                        "maxLength":10,
                        "description":"Account ID"
                    }
                }
            }
        }
    }
}

Nested Schema : eligibilityMessage

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "message":{
                "type":"string",
                "maxLength":254,
                "description":"Message Text"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• message: string
  Maximum Length: 254

  Message Text

{
    "type":"object",
    "properties":{
        "message":{
            "type":"string",
            "maxLength":254,
            "description":"Message Text"
        }
    }
}

Nested Schema : eligibleAccount

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "accountId":{
                "type":"string",
                "maxLength":10,
                "description":"Account ID"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• accountId: string
  Maximum Length: 10

  Account ID

{
    "type":"object",
    "properties":{
        "accountId":{
            "type":"string",
            "maxLength":10,
            "description":"Account ID"
        }
    }
}

Nested Schema : inEligibleAccount

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "accountId":{
                "type":"string",
                "maxLength":10,
                "description":"Account ID"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• accountId: string
  Maximum Length: 10

  Account ID

{
    "type":"object",
    "properties":{
        "accountId":{
            "type":"string",
            "maxLength":10,
            "description":"Account ID"
        }
    }
}

400 Response

Bad Request

Body ()

Root Schema : problemDetailDocument

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "problemType":{
            "type":"string",
            "maxLength":60,
            "description":"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."
        },
        "title":{
            "type":"string",
            "maxLength":60,
            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
        },
        "httpStatus":{
            "type":"number",
            "maximum":9999,
            "minimum":0,
            "description":"The HTTP Status code for the error."
        },
        "detail":{
            "type":"string",
            "maxLength":60,
            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
        },
        "problemInstance":{
            "type":"string",
            "maxLength":60,
            "description":"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."
        },
        "stackTrace":{
            "type":"string",
            "maxLength":60,
            "description":"The stack trace shows where the error occurs during the execution of a program."
        },
        "serverMessage":{
            "type":"object",
            "properties":{
                "messageCategory":{
                    "type":"number",
                    "maximum":0,
                    "minimum":0,
                    "description":"Message Category within Oracle Utilities Application Framework."
                },
                "messageNbr":{
                    "type":"number",
                    "maximum":99999,
                    "minimum":-99999,
                    "description":"Message Number within Oracle Utilities Application Framework."
                },
                "callSequence":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Delimited sequence of programs called."
                },
                "programName":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Name of the program that encountered the error."
                },
                "messageText":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
                },
                "longDescription":{
                    "type":"string",
                    "maxLength":60,
                    "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
                }
            }
        }
    }
}

Nested Schema : serverMessage

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "messageCategory":{
            "type":"number",
            "maximum":0,
            "minimum":0,
            "description":"Message Category within Oracle Utilities Application Framework."
        },
        "messageNbr":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Message Number within Oracle Utilities Application Framework."
        },
        "callSequence":{
            "type":"string",
            "maxLength":60,
            "description":"Delimited sequence of programs called."
        },
        "programName":{
            "type":"string",
            "maxLength":60,
            "description":"Name of the program that encountered the error."
        },
        "messageText":{
            "type":"string",
            "maxLength":60,
            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
        },
        "longDescription":{
            "type":"string",
            "maxLength":60,
            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
        }
    }
}

500 Response

Internal Server Error

Body ()

Root Schema : problemDetailDocument

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "problemType":{
            "type":"string",
            "maxLength":60,
            "description":"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."
        },
        "title":{
            "type":"string",
            "maxLength":60,
            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
        },
        "httpStatus":{
            "type":"number",
            "maximum":9999,
            "minimum":0,
            "description":"The HTTP Status code for the error."
        },
        "detail":{
            "type":"string",
            "maxLength":60,
            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
        },
        "problemInstance":{
            "type":"string",
            "maxLength":60,
            "description":"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."
        },
        "stackTrace":{
            "type":"string",
            "maxLength":60,
            "description":"The stack trace shows where the error occurs during the execution of a program."
        },
        "serverMessage":{
            "type":"object",
            "properties":{
                "messageCategory":{
                    "type":"number",
                    "maximum":0,
                    "minimum":0,
                    "description":"Message Category within Oracle Utilities Application Framework."
                },
                "messageNbr":{
                    "type":"number",
                    "maximum":99999,
                    "minimum":-99999,
                    "description":"Message Number within Oracle Utilities Application Framework."
                },
                "callSequence":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Delimited sequence of programs called."
                },
                "programName":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Name of the program that encountered the error."
                },
                "messageText":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
                },
                "longDescription":{
                    "type":"string",
                    "maxLength":60,
                    "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
                }
            }
        }
    }
}

Nested Schema : serverMessage

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "messageCategory":{
            "type":"number",
            "maximum":0,
            "minimum":0,
            "description":"Message Category within Oracle Utilities Application Framework."
        },
        "messageNbr":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Message Number within Oracle Utilities Application Framework."
        },
        "callSequence":{
            "type":"string",
            "maxLength":60,
            "description":"Delimited sequence of programs called."
        },
        "programName":{
            "type":"string",
            "maxLength":60,
            "description":"Name of the program that encountered the error."
        },
        "messageText":{
            "type":"string",
            "maxLength":60,
            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
        },
        "longDescription":{
            "type":"string",
            "maxLength":60,
            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
        }
    }
}

Back to Top