1. Oracle Utilities REST API for Metering and Customer Information
  2. Tasks
  3. Service
  4. Start Stop Transfer Tasks

Retrieve Request Type Details

post

https://server:port/spl/rest/apis/customer/service/startStopTransferTasks/requestTypeDetails

This operation is used to retrieve the configuration information at the beginning of the start, stop and transfer transaction.

Request

There are no request parameters for this operation.

Supported Media Types
Request Body - application/xml ()
Root Schema : schema
Type: object
Show Source
  • Maximum Length: 10
    Account ID
  • Maximum Length: 5
    CIS Division defines the governing jurisdiction.
    Example: CA
  • Maximum Length: 8
    Customer Class controls financial parameters related to billing and collections.
    Example: R
  • Allowed Values: [ "N ", "Y " ]
    New Account switch indicates that the request is for a new account. * `N ` - No, * `Y ` - Yes
  • Allowed Values: [ "N ", "Y " ]
    New Customer switch indicates that the request is for a new customer. * `N ` - No, * `Y ` - Yes
  • Allowed Values: [ "B ", "P " ]
    Person/Business: * `B ` - Business, * `P ` - Person
  • Maximum Length: 10
    Premise ID
  • Allowed Values: [ "C1SP", "C1ST", "C1TR" ]
    Request Mode indicates the type of start/stop/transfer transaction. * `C1SP` - Stop Service, * `C1ST` - Start Service, * `C1TR` - Transfer Service
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
  • Maximum Length: 10
    Account ID
  • Maximum Length: 5
    CIS Division defines the governing jurisdiction.
    Example: CA
  • Maximum Length: 8
    Customer Class controls financial parameters related to billing and collections.
    Example: R
  • Allowed Values: [ "N ", "Y " ]
    New Account switch indicates that the request is for a new account. * `N ` - No, * `Y ` - Yes
  • Allowed Values: [ "N ", "Y " ]
    New Customer switch indicates that the request is for a new customer. * `N ` - No, * `Y ` - Yes
  • Allowed Values: [ "B ", "P " ]
    Person/Business: * `B ` - Business, * `P ` - Person
  • Maximum Length: 10
    Premise ID
  • Allowed Values: [ "C1SP", "C1ST", "C1TR" ]
    Request Mode indicates the type of start/stop/transfer transaction. * `C1SP` - Stop Service, * `C1ST` - Start Service, * `C1TR` - Transfer Service
Back to Top

Response

Supported Media Types

200 Response

Success response
Body ()
Root Schema : C1SSRqTyRead
Type: object
Show Source
  • Maximum Length: 30
    Action Method is an object that may be used to define configuration based on some criteria.
    Example: DSS-NEW-SERVICE
  • 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
  • Maximum Length: 30
    Customer Service Request Type controls how a specific customer service request is processed.
    Example: DSS-NEW-SERVICE
  • personOrBusinessControls
  • Maximum Length: 30
    Self-service task type defines properties that control how a self-service task is processed
    Example: DSSSTARTSTOPTRANSFER
  • startServiceControls
  • stopServiceControls
Nested Schema : personOrBusinessControls
Type: object
Show Source
  • Allowed Values: [ "C1BC", "C1BK", "C1CC", "C1NO" ]
    Autopay Usage indicates whether or not automatic payments are supported. * `C1BC` - Bank and Credit Card, * `C1BK` - Bank Only, * `C1CC` - Credit Card Only, * `C1NO` - None
  • Paperless switch indicates whether or not the customer will be enrolled to paperless billing.
    Example: true
  • Allowed Values: [ "C1NS", "C1SN", "C1SS" ]
    Fax Usage determines the availability of contact information with 'Fax' contact routing. * `C1NS` - Not Shown, * `C1SN` - Shown, * `C1SS` - Shown If Exists
  • Allowed Values: [ "C1NS", "C1SN", "C1SS" ]
    Language Usage determines the availability of language information. * `C1NS` - Not Shown, * `C1SN` - Shown, * `C1SS` - Shown If Not Default
  • Allowed Values: [ "C1NS", "C1SN", "C1SS" ]
    Life Support/Sensitive Load Usage determines the availability of Life Support/Sensitive Load information. * `C1NS` - Not Shown, * `C1SN` - Shown, * `C1SS` - Shown If Set
  • Allowed Values: [ "C1AO", "C1BT", "C1PE" ]
    Mailing Address Source Usage indicates whether Account Override and/or Person address sources are supported. * `C1AO` - Account Override, * `C1BT` - Both, * `C1PE` - Person
  • New Account Allowed switch indicates whether or not a new account can be created.
    Example: true
  • Allowed Values: [ "C1NS", "C1SN", "C1SS" ]
    Other Name Usage determines the availability of person names other than the primary name. * `C1NS` - Not Shown, * `C1SN` - Shown, * `C1SS` - Shown If Exists
  • Allowed Values: [ "C1NS", "C1SN", "C1SS" ]
    Other Person Contacts Usage determines the availability of contact information with contact routing that is not 'Phone', 'Email' or 'Fax'. * `C1NS` - Not Shown, * `C1SN` - Shown, * `C1SS` - Shown If Exists
  • otherPersonsOnAccount
  • personIdentifiers
  • Prompt For Date of Birth switch indicates whether or not the customer will be prompted for a Date of Birth.
    Example: true
  • Store Date Of Birth On Person switch indicates whether or not Date of Birth is stores on the person.
    Example: true
  • Allowed Values: [ "C1NS", "C1SN", "C1SS" ]
    Usage determines the availability of language information. * `C1NS` - Not Shown, * `C1SN` - Shown, * `C1SS` - Shown If Set
  • Perform ID/Credit Check switch indicates whether or not ID check will be performed.
    Example: true
Nested Schema : startServiceControls
Type: object
Show Source
Nested Schema : stopServiceControls
Type: object
Show Source
Nested Schema : otherPersonsOnAccount
Type: object
Show Source
Nested Schema : personIdentifiers
Type: object
Show Source
Nested Schema : accountRelationshipTypes
Type: object
Show Source
Nested Schema : personIdentifiers
Type: object
Show Source
Nested Schema : accountRelationshipType
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : personIdentifier
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : personIdentifier
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : calendarDetails
Type: object
Show Source
Nested Schema : calendarHoliday
Type: array
Show Source
Nested Schema : workDays
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : calendarDetails
Type: object
Show Source
Nested Schema : calendarHoliday
Type: array
Show Source
Nested Schema : workDays
Type: object
Show Source
Nested Schema : items
Type: object
Show Source

400 Response

Bad Request
Body ()
Root Schema : problemDetailDocument
Type: object
Show Source
  • Maximum Length: 60
    The long message description from the Oracle Utilities Application Framework in CDATA format.
  • Minimum Value: 0
    Maximum Value: 9999
    The HTTP Status code for the error.
  • 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.
  • 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
  • Maximum Length: 60
    The stack trace shows where the error occurs during the execution of a program.
  • Maximum Length: 60
    Fully qualified error message from Oracle Utilities Application Framework in CDATA format.
Nested Schema : serverMessage
Type: object
Show Source
  • Maximum Length: 60
    Delimited sequence of programs called.
  • Maximum Length: 60
    The long message description from the Oracle Utilities Application Framework in CDATA format.
  • Minimum Value: 0
    Maximum Value: 0
    Message Category within Oracle Utilities Application Framework.
  • Minimum Value: -99999
    Maximum Value: 99999
    Message Number within Oracle Utilities Application Framework.
  • Maximum Length: 60
    Fully qualified error message from Oracle Utilities Application Framework in CDATA format.
  • Maximum Length: 60
    Name of the program that encountered the error.

500 Response

Internal Server Error
Body ()
Root Schema : problemDetailDocument
Type: object
Show Source
  • Maximum Length: 60
    The long message description from the Oracle Utilities Application Framework in CDATA format.
  • Minimum Value: 0
    Maximum Value: 9999
    The HTTP Status code for the error.
  • 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.
  • 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
  • Maximum Length: 60
    The stack trace shows where the error occurs during the execution of a program.
  • Maximum Length: 60
    Fully qualified error message from Oracle Utilities Application Framework in CDATA format.
Nested Schema : serverMessage
Type: object
Show Source
  • Maximum Length: 60
    Delimited sequence of programs called.
  • Maximum Length: 60
    The long message description from the Oracle Utilities Application Framework in CDATA format.
  • Minimum Value: 0
    Maximum Value: 0
    Message Category within Oracle Utilities Application Framework.
  • Minimum Value: -99999
    Maximum Value: 99999
    Message Number within Oracle Utilities Application Framework.
  • Maximum Length: 60
    Fully qualified error message from Oracle Utilities Application Framework in CDATA format.
  • Maximum Length: 60
    Name of the program that encountered the error.
Back to Top