Process Other Person
post
/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
- application/xml
- application/json
Root Schema : schema
Type:
Show Source
object
-
otherPersons: object
otherPersons
-
serviceTaskId: string
Maximum Length:
14
Self-Service Task ID is the system-assigned unique identifier of the self-service task.Example:69216126491457
Nested Schema : items
Type:
Show Source
object
-
accountRelationshipType: string
Maximum Length:
8
Relationship Type defines the relationship between the person and the account.Example:SPOUSE
-
dateOfBirth: string
(date)
Date of Birth
-
emailContacts: object
emailContacts
-
firstName: string
Maximum Length:
50
First Name -
lastName: string
Maximum Length:
50
Last Name -
personIdentifiers: object
personIdentifiers
-
phoneContacts: object
phoneContacts
Nested Schema : items
Type:
Show Source
object
-
activeInactive: string
Allowed Values:
[ "C1AC", "C1IN" ]
Most contact preferences will remain active. When a contact is no longer valid, the existing contact should be updated to Inactive. * `C1AC` - Active, * `C1IN` - Inactive -
contactNickname: string
Maximum Length:
100
Person contact details nickname.Example:Home
-
contactStatus: string
Allowed Values:
[ "C1AP", "C1PN", "C1RJ", "ZZBN", "ZZPE" ]
Contact Status indicates the option contact's status. * `C1AP` - Approved, * `C1PN` - Pending, * `C1RJ` - Rejected, * `ZZBN` - ZZBounced, * `ZZPE` - ZZPending -
contactType: string
Maximum Length:
30
Person Contact Type indicates the type of contact such as, home phone, cell phone, or work email.Example:HOMEPHONE, WORKEMAIL
-
contactValue: string
Maximum Length:
254
Contact Detail Value contains the specific contact information such as the phone number or email address in the associated format.Example:415-123-4567, mark.brazil@email.com
-
contactValueExtension: string
Maximum Length:
6
Extension, if any, of the contact information. (This field is only active when the contact's contact routing is phone or fax.)Example:121
-
doNotDisturbEndTime: string
Do Not Disturb (To) indicates the end time when a person contact should not be used.Example:
20.30.00
-
doNotDisturbStartTime: string
Do Not Disturb (From) indicates the start time when a person contact should not be used.Example:
08.00.00
-
primaryContact: string
Allowed Values:
[ "C1NO", "C1YS" ]
Primary switch must be set for exactly one person contact for each contact routing. * `C1NO` - No, * `C1YS` - Yes
Nested Schema : items
Type:
Show Source
object
-
idType: string
Maximum Length:
8
ID Type defines the type of identification.Example:SSN
-
idValue: string
Maximum Length:
100
The unique Identification Number assigned to an individual person or business by a government agency or any other authority.Example:***-**-1844
Nested Schema : items
Type:
Show Source
object
-
activeInactive: string
Allowed Values:
[ "C1AC", "C1IN" ]
Most contact preferences will remain active. When a contact is no longer valid, the existing contact should be updated to Inactive. * `C1AC` - Active, * `C1IN` - Inactive -
contactNickname: string
Maximum Length:
100
Person contact details nickname.Example:Home
-
contactStatus: string
Allowed Values:
[ "C1AP", "C1PN", "C1RJ", "ZZBN", "ZZPE" ]
Contact Status indicates the option contact's status. * `C1AP` - Approved, * `C1PN` - Pending, * `C1RJ` - Rejected, * `ZZBN` - ZZBounced, * `ZZPE` - ZZPending -
contactType: string
Maximum Length:
30
Person Contact Type indicates the type of contact such as, home phone, cell phone, or work email.Example:HOMEPHONE, WORKEMAIL
-
contactValue: string
Maximum Length:
254
Contact Detail Value contains the specific contact information such as the phone number or email address in the associated format.Example:415-123-4567, mark.brazil@email.com
-
contactValueExtension: string
Maximum Length:
6
Extension, if any, of the contact information. (This field is only active when the contact's contact routing is phone or fax.)Example:121
-
doNotDisturbEndTime: string
Do Not Disturb (To) indicates the end time when a person contact should not be used.Example:
20.30.00
-
doNotDisturbStartTime: string
Do Not Disturb (From) indicates the start time when a person contact should not be used.Example:
08.00.00
-
primaryContact: string
Allowed Values:
[ "C1NO", "C1YS" ]
Primary switch must be set for exactly one person contact for each contact routing. * `C1NO` - No, * `C1YS` - Yes
Root Schema : schema
Type:
Show Source
object
-
otherPersons: object
otherPersons
-
serviceTaskId: string
Maximum Length:
14
Self-Service Task ID is the system-assigned unique identifier of the self-service task.Example:69216126491457
Nested Schema : items
Type:
Show Source
object
-
accountRelationshipType: string
Maximum Length:
8
Relationship Type defines the relationship between the person and the account.Example:SPOUSE
-
dateOfBirth: string
(date)
Date of Birth
-
emailContacts: object
emailContacts
-
firstName: string
Maximum Length:
50
First Name -
lastName: string
Maximum Length:
50
Last Name -
personIdentifiers: object
personIdentifiers
-
phoneContacts: object
phoneContacts
Nested Schema : items
Type:
Show Source
object
-
activeInactive: string
Allowed Values:
[ "C1AC", "C1IN" ]
Most contact preferences will remain active. When a contact is no longer valid, the existing contact should be updated to Inactive. * `C1AC` - Active, * `C1IN` - Inactive -
contactNickname: string
Maximum Length:
100
Person contact details nickname.Example:Home
-
contactStatus: string
Allowed Values:
[ "C1AP", "C1PN", "C1RJ", "ZZBN", "ZZPE" ]
Contact Status indicates the option contact's status. * `C1AP` - Approved, * `C1PN` - Pending, * `C1RJ` - Rejected, * `ZZBN` - ZZBounced, * `ZZPE` - ZZPending -
contactType: string
Maximum Length:
30
Person Contact Type indicates the type of contact such as, home phone, cell phone, or work email.Example:HOMEPHONE, WORKEMAIL
-
contactValue: string
Maximum Length:
254
Contact Detail Value contains the specific contact information such as the phone number or email address in the associated format.Example:415-123-4567, mark.brazil@email.com
-
contactValueExtension: string
Maximum Length:
6
Extension, if any, of the contact information. (This field is only active when the contact's contact routing is phone or fax.)Example:121
-
doNotDisturbEndTime: string
Do Not Disturb (To) indicates the end time when a person contact should not be used.Example:
20.30.00
-
doNotDisturbStartTime: string
Do Not Disturb (From) indicates the start time when a person contact should not be used.Example:
08.00.00
-
primaryContact: string
Allowed Values:
[ "C1NO", "C1YS" ]
Primary switch must be set for exactly one person contact for each contact routing. * `C1NO` - No, * `C1YS` - Yes
Nested Schema : items
Type:
Show Source
object
-
idType: string
Maximum Length:
8
ID Type defines the type of identification.Example:SSN
-
idValue: string
Maximum Length:
100
The unique Identification Number assigned to an individual person or business by a government agency or any other authority.Example:***-**-1844
Nested Schema : items
Type:
Show Source
object
-
activeInactive: string
Allowed Values:
[ "C1AC", "C1IN" ]
Most contact preferences will remain active. When a contact is no longer valid, the existing contact should be updated to Inactive. * `C1AC` - Active, * `C1IN` - Inactive -
contactNickname: string
Maximum Length:
100
Person contact details nickname.Example:Home
-
contactStatus: string
Allowed Values:
[ "C1AP", "C1PN", "C1RJ", "ZZBN", "ZZPE" ]
Contact Status indicates the option contact's status. * `C1AP` - Approved, * `C1PN` - Pending, * `C1RJ` - Rejected, * `ZZBN` - ZZBounced, * `ZZPE` - ZZPending -
contactType: string
Maximum Length:
30
Person Contact Type indicates the type of contact such as, home phone, cell phone, or work email.Example:HOMEPHONE, WORKEMAIL
-
contactValue: string
Maximum Length:
254
Contact Detail Value contains the specific contact information such as the phone number or email address in the associated format.Example:415-123-4567, mark.brazil@email.com
-
contactValueExtension: string
Maximum Length:
6
Extension, if any, of the contact information. (This field is only active when the contact's contact routing is phone or fax.)Example:121
-
doNotDisturbEndTime: string
Do Not Disturb (To) indicates the end time when a person contact should not be used.Example:
20.30.00
-
doNotDisturbStartTime: string
Do Not Disturb (From) indicates the start time when a person contact should not be used.Example:
08.00.00
-
primaryContact: string
Allowed Values:
[ "C1NO", "C1YS" ]
Primary switch must be set for exactly one person contact for each contact routing. * `C1NO` - No, * `C1YS` - Yes
Response
Supported Media Types
- application/xml
- application/json
200 Response
Success response
Nested Schema : items
Type:
Show Source
object
-
accountRelationshipType: string
Maximum Length:
8
Relationship Type defines the relationship between the person and the account.Example:SPOUSE
-
dateOfBirth: string
(date)
Date of Birth
-
eligibilityMessage: string
Maximum Length:
254
Additional person eligibility information.Example:Person is linked to account with past due debt.
-
emailContacts: object
emailContacts
-
firstName: string
Maximum Length:
50
First Name -
lastName: string
Maximum Length:
50
Last Name -
otherPersonEligible: boolean
Other Person Eligible switch indicates whether or not the additional person is eligible.Example:
true
-
personIdentifiers: object
personIdentifiers
-
personSearchMatch: string
Allowed Values:
[ "C1AM", "C1MT", "C1NM" ]
Person Search Match indicates if an existing person in the system that matches the input name, ID, and contact information. * `C1AM` - Ambiguous Match, * `C1MT` - Match, * `C1NM` - No Match -
phoneContacts: object
phoneContacts
Nested Schema : items
Type:
Show Source
object
-
activeInactive: string
Allowed Values:
[ "C1AC", "C1IN" ]
Most contact preferences will remain active. When a contact is no longer valid, the existing contact should be updated to Inactive. * `C1AC` - Active, * `C1IN` - Inactive -
contactNickname: string
Maximum Length:
100
Person contact details nickname.Example:Home
-
contactStatus: string
Allowed Values:
[ "C1AP", "C1PN", "C1RJ", "ZZBN", "ZZPE" ]
Contact Status indicates the option contact's status. * `C1AP` - Approved, * `C1PN` - Pending, * `C1RJ` - Rejected, * `ZZBN` - ZZBounced, * `ZZPE` - ZZPending -
contactType: string
Maximum Length:
30
Person Contact Type indicates the type of contact such as, home phone, cell phone, or work email.Example:HOMEPHONE, WORKEMAIL
-
contactValue: string
Maximum Length:
254
Contact Detail Value contains the specific contact information such as the phone number or email address in the associated format.Example:415-123-4567, mark.brazil@email.com
-
contactValueExtension: string
Maximum Length:
6
Extension, if any, of the contact information. (This field is only active when the contact's contact routing is phone or fax.)Example:121
-
doNotDisturbEndTime: string
Do Not Disturb (To) indicates the end time when a person contact should not be used.Example:
20.30.00
-
doNotDisturbStartTime: string
Do Not Disturb (From) indicates the start time when a person contact should not be used.Example:
08.00.00
-
primaryContact: string
Allowed Values:
[ "C1NO", "C1YS" ]
Primary switch must be set for exactly one person contact for each contact routing. * `C1NO` - No, * `C1YS` - Yes
Nested Schema : items
Type:
Show Source
object
-
idType: string
Maximum Length:
8
ID Type defines the type of identification.Example:SSN
-
idValue: string
Maximum Length:
100
The unique Identification Number assigned to an individual person or business by a government agency or any other authority.Example:***-**-1844
Nested Schema : items
Type:
Show Source
object
-
activeInactive: string
Allowed Values:
[ "C1AC", "C1IN" ]
Most contact preferences will remain active. When a contact is no longer valid, the existing contact should be updated to Inactive. * `C1AC` - Active, * `C1IN` - Inactive -
contactNickname: string
Maximum Length:
100
Person contact details nickname.Example:Home
-
contactStatus: string
Allowed Values:
[ "C1AP", "C1PN", "C1RJ", "ZZBN", "ZZPE" ]
Contact Status indicates the option contact's status. * `C1AP` - Approved, * `C1PN` - Pending, * `C1RJ` - Rejected, * `ZZBN` - ZZBounced, * `ZZPE` - ZZPending -
contactType: string
Maximum Length:
30
Person Contact Type indicates the type of contact such as, home phone, cell phone, or work email.Example:HOMEPHONE, WORKEMAIL
-
contactValue: string
Maximum Length:
254
Contact Detail Value contains the specific contact information such as the phone number or email address in the associated format.Example:415-123-4567, mark.brazil@email.com
-
contactValueExtension: string
Maximum Length:
6
Extension, if any, of the contact information. (This field is only active when the contact's contact routing is phone or fax.)Example:121
-
doNotDisturbEndTime: string
Do Not Disturb (To) indicates the end time when a person contact should not be used.Example:
20.30.00
-
doNotDisturbStartTime: string
Do Not Disturb (From) indicates the start time when a person contact should not be used.Example:
08.00.00
-
primaryContact: string
Allowed Values:
[ "C1NO", "C1YS" ]
Primary switch must be set for exactly one person contact for each contact routing. * `C1NO` - No, * `C1YS` - Yes
400 Response
Bad Request
Root Schema : problemDetailDocument
Type:
Show Source
object
-
detail: string
Maximum Length:
60
The long message description from the Oracle Utilities Application Framework in CDATA format. -
httpStatus: number
Minimum Value:
0
Maximum Value:9999
The HTTP Status code for the error. -
problemInstance: string
Maximum Length:
60
Fully qualified URL consisting of the Base URI Timestamp of error in ISO format, the User used for the transaction, the Message Category within Oracle Utilities Application Framework, the Message Number within Oracle Utilities Application Framework, the Request URL and the HTTP method used for the transaction. -
problemType: string
Maximum Length:
60
URL of the format "A/message/X/Y" where A is the base URI, X is the Message Category and Y is the Message Number within Oracle Utilities Application Framework. -
serverMessage: object
serverMessage
-
stackTrace: string
Maximum Length:
60
The stack trace shows where the error occurs during the execution of a program. -
title: string
Maximum Length:
60
Fully qualified error message from Oracle Utilities Application Framework in CDATA format.
Nested Schema : serverMessage
Type:
Show Source
object
-
callSequence: string
Maximum Length:
60
Delimited sequence of programs called. -
longDescription: string
Maximum Length:
60
The long message description from the Oracle Utilities Application Framework in CDATA format. -
messageCategory: number
Minimum Value:
0
Maximum Value:0
Message Category within Oracle Utilities Application Framework. -
messageNbr: number
Minimum Value:
-99999
Maximum Value:99999
Message Number within Oracle Utilities Application Framework. -
messageText: string
Maximum Length:
60
Fully qualified error message from Oracle Utilities Application Framework in CDATA format. -
programName: string
Maximum Length:
60
Name of the program that encountered the error.
500 Response
Internal Server Error
Root Schema : problemDetailDocument
Type:
Show Source
object
-
detail: string
Maximum Length:
60
The long message description from the Oracle Utilities Application Framework in CDATA format. -
httpStatus: number
Minimum Value:
0
Maximum Value:9999
The HTTP Status code for the error. -
problemInstance: string
Maximum Length:
60
Fully qualified URL consisting of the Base URI Timestamp of error in ISO format, the User used for the transaction, the Message Category within Oracle Utilities Application Framework, the Message Number within Oracle Utilities Application Framework, the Request URL and the HTTP method used for the transaction. -
problemType: string
Maximum Length:
60
URL of the format "A/message/X/Y" where A is the base URI, X is the Message Category and Y is the Message Number within Oracle Utilities Application Framework. -
serverMessage: object
serverMessage
-
stackTrace: string
Maximum Length:
60
The stack trace shows where the error occurs during the execution of a program. -
title: string
Maximum Length:
60
Fully qualified error message from Oracle Utilities Application Framework in CDATA format.
Nested Schema : serverMessage
Type:
Show Source
object
-
callSequence: string
Maximum Length:
60
Delimited sequence of programs called. -
longDescription: string
Maximum Length:
60
The long message description from the Oracle Utilities Application Framework in CDATA format. -
messageCategory: number
Minimum Value:
0
Maximum Value:0
Message Category within Oracle Utilities Application Framework. -
messageNbr: number
Minimum Value:
-99999
Maximum Value:99999
Message Number within Oracle Utilities Application Framework. -
messageText: string
Maximum Length:
60
Fully qualified error message from Oracle Utilities Application Framework in CDATA format. -
programName: string
Maximum Length:
60
Name of the program that encountered the error.