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

Process Other Person

post

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

This operation process additional persons when starting new service. The main customer's eligibility should be evaluated, and a pending self-service start/stop/transfer task already exists before this operation can be used. Eligible persons are persisted on the service task. Ineligible persons may be persisted based on the service task based on the Other Person Eligibility controls. Each person's eligibility is returned as output. Note that any additional persons that are currently in the self-service start/stop/transfer task are replaced with the input when this operation is called.

Request

There are no request parameters for this operation.

Supported Media Types
Request Body - application/xml ()
Root Schema : schema
Type: object
Show Source
Nested Schema : otherPersons
Type: object
Show Source
Nested Schema : otherPerson
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : emailContacts
Type: object
Show Source
Nested Schema : personIdentifiers
Type: object
Show Source
Nested Schema : phoneContacts
Type: object
Show Source
Nested Schema : emailContact
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
  • 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
  • Maximum Length: 100
    Person contact details nickname.
    Example: Home
  • Allowed Values: [ "C1AP", "C1PN", "C1RJ" ]
    Contact Status indicates the option contact's status. * `C1AP` - Approved, * `C1PN` - Pending, * `C1RJ` - Rejected.
  • Maximum Length: 30
    Person Contact Type indicates the type of contact such as, home phone, cell phone, or work email.
    Example: HOMEPHONE, WORKEMAIL
  • Maximum Length: 254
    Contact Detail Value contains the specific contact information such as the phone number or email address in the associated format.
    Example: 415-123-4567, mark.brazil@email.com
  • 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
  • Do Not Disturb (To) indicates the end time when a person contact should not be used.
    Example: 20.30.00
  • Do Not Disturb (From) indicates the start time when a person contact should not be used.
    Example: 08.00.00
  • Allowed Values: [ "C1NO", "C1YS" ]
    Primary switch must be set for exactly one person contact for each contact routing. * `C1NO` - No, * `C1YS` - Yes
Nested Schema : personIdentifier
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
  • Maximum Length: 8
    ID Type defines the type of identification.
    Example: SSN
  • Maximum Length: 100
    The unique Identification Number assigned to an individual person or business by a government agency or any other authority.
    Example: ***-**-1844
Nested Schema : phoneContact
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
  • 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
  • Maximum Length: 100
    Person contact details nickname.
    Example: Home
  • Allowed Values: [ "C1AP", "C1PN", "C1RJ" ]
    Contact Status indicates the option contact's status. * `C1AP` - Approved, * `C1PN` - Pending, * `C1RJ` - Rejected.
  • Maximum Length: 30
    Person Contact Type indicates the type of contact such as, home phone, cell phone, or work email.
    Example: HOMEPHONE, WORKEMAIL
  • Maximum Length: 254
    Contact Detail Value contains the specific contact information such as the phone number or email address in the associated format.
    Example: 415-123-4567, mark.brazil@email.com
  • 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
  • Do Not Disturb (To) indicates the end time when a person contact should not be used.
    Example: 20.30.00
  • Do Not Disturb (From) indicates the start time when a person contact should not be used.
    Example: 08.00.00
  • Allowed Values: [ "C1NO", "C1YS" ]
    Primary switch must be set for exactly one person contact for each contact routing. * `C1NO` - No, * `C1YS` - Yes
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
Nested Schema : otherPersons
Type: object
Show Source
Nested Schema : otherPerson
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : emailContacts
Type: object
Show Source
Nested Schema : personIdentifiers
Type: object
Show Source
Nested Schema : phoneContacts
Type: object
Show Source
Nested Schema : emailContact
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
  • 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
  • Maximum Length: 100
    Person contact details nickname.
    Example: Home
  • Allowed Values: [ "C1AP", "C1PN", "C1RJ" ]
    Contact Status indicates the option contact's status. * `C1AP` - Approved, * `C1PN` - Pending, * `C1RJ` - Rejected.
  • Maximum Length: 30
    Person Contact Type indicates the type of contact such as, home phone, cell phone, or work email.
    Example: HOMEPHONE, WORKEMAIL
  • Maximum Length: 254
    Contact Detail Value contains the specific contact information such as the phone number or email address in the associated format.
    Example: 415-123-4567, mark.brazil@email.com
  • 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
  • Do Not Disturb (To) indicates the end time when a person contact should not be used.
    Example: 20.30.00
  • Do Not Disturb (From) indicates the start time when a person contact should not be used.
    Example: 08.00.00
  • Allowed Values: [ "C1NO", "C1YS" ]
    Primary switch must be set for exactly one person contact for each contact routing. * `C1NO` - No, * `C1YS` - Yes
Nested Schema : personIdentifier
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
  • Maximum Length: 8
    ID Type defines the type of identification.
    Example: SSN
  • Maximum Length: 100
    The unique Identification Number assigned to an individual person or business by a government agency or any other authority.
    Example: ***-**-1844
Nested Schema : phoneContact
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
  • 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
  • Maximum Length: 100
    Person contact details nickname.
    Example: Home
  • Allowed Values: [ "C1AP", "C1PN", "C1RJ" ]
    Contact Status indicates the option contact's status. * `C1AP` - Approved, * `C1PN` - Pending, * `C1RJ` - Rejected.
  • Maximum Length: 30
    Person Contact Type indicates the type of contact such as, home phone, cell phone, or work email.
    Example: HOMEPHONE, WORKEMAIL
  • Maximum Length: 254
    Contact Detail Value contains the specific contact information such as the phone number or email address in the associated format.
    Example: 415-123-4567, mark.brazil@email.com
  • 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
  • Do Not Disturb (To) indicates the end time when a person contact should not be used.
    Example: 20.30.00
  • Do Not Disturb (From) indicates the start time when a person contact should not be used.
    Example: 08.00.00
  • Allowed Values: [ "C1NO", "C1YS" ]
    Primary switch must be set for exactly one person contact for each contact routing. * `C1NO` - No, * `C1YS` - Yes
Back to Top

Response

Supported Media Types

200 Response

Success response
Body ()
Root Schema : C1SSPrcOtPer
Type: object
Show Source
Nested Schema : otherPersons
Type: object
Show Source
Nested Schema : otherPerson
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : emailContacts
Type: object
Show Source
Nested Schema : personIdentifiers
Type: object
Show Source
Nested Schema : phoneContacts
Type: object
Show Source
Nested Schema : emailContact
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
  • 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
  • Maximum Length: 100
    Person contact details nickname.
    Example: Home
  • Allowed Values: [ "C1AP", "C1PN", "C1RJ" ]
    Contact Status indicates the option contact's status. * `C1AP` - Approved, * `C1PN` - Pending, * `C1RJ` - Rejected
  • Maximum Length: 30
    Person Contact Type indicates the type of contact such as, home phone, cell phone, or work email.
    Example: HOMEPHONE, WORKEMAIL
  • Maximum Length: 254
    Contact Detail Value contains the specific contact information such as the phone number or email address in the associated format.
    Example: 415-123-4567, mark.brazil@email.com
  • 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
  • Do Not Disturb (To) indicates the end time when a person contact should not be used.
    Example: 20.30.00
  • Do Not Disturb (From) indicates the start time when a person contact should not be used.
    Example: 08.00.00
  • Allowed Values: [ "C1NO", "C1YS" ]
    Primary switch must be set for exactly one person contact for each contact routing. * `C1NO` - No, * `C1YS` - Yes
Nested Schema : personIdentifier
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
  • Maximum Length: 8
    ID Type defines the type of identification.
    Example: SSN
  • Maximum Length: 100
    The unique Identification Number assigned to an individual person or business by a government agency or any other authority.
    Example: ***-**-1844
Nested Schema : phoneContact
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
  • 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
  • Maximum Length: 100
    Person contact details nickname.
    Example: Home
  • Allowed Values: [ "C1AP", "C1PN", "C1RJ" ]
    Contact Status indicates the option contact's status. * `C1AP` - Approved, * `C1PN` - Pending, * `C1RJ` - Rejected
  • Maximum Length: 30
    Person Contact Type indicates the type of contact such as, home phone, cell phone, or work email.
    Example: HOMEPHONE, WORKEMAIL
  • Maximum Length: 254
    Contact Detail Value contains the specific contact information such as the phone number or email address in the associated format.
    Example: 415-123-4567, mark.brazil@email.com
  • 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
  • Do Not Disturb (To) indicates the end time when a person contact should not be used.
    Example: 20.30.00
  • Do Not Disturb (From) indicates the start time when a person contact should not be used.
    Example: 08.00.00
  • Allowed Values: [ "C1NO", "C1YS" ]
    Primary switch must be set for exactly one person contact for each contact routing. * `C1NO` - No, * `C1YS` - Yes

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