Retrieve Service-Related Customer Details
post
/rest/apis/customer/service/startStopTransferTasks/serviceRelatedCustomerDetails
This operation is used to retrieve the service-related information for the input account and/or person.
Request
There are no request parameters for this operation.
Supported Media Types
- application/xml
- application/json
Root Schema : schema
Type:
Show Source
object
-
accountId: string
Maximum Length:
10
Account ID -
customerServiceRequestType: string
Maximum Length:
30
Customer Service Request Type controls how a specific customer service request is processed.Example:DSS-NEW-SERVICE
-
personId: string
Maximum Length:
10
Person ID -
personOrBusiness: string
Allowed Values:
[ "B ", "P " ]
Person/Business: * `B ` - Business, * `P ` - Person
Root Schema : schema
Type:
Show Source
object
-
accountId: string
Maximum Length:
10
Account ID -
customerServiceRequestType: string
Maximum Length:
30
Customer Service Request Type controls how a specific customer service request is processed.Example:DSS-NEW-SERVICE
-
personId: string
Maximum Length:
10
Person ID -
personOrBusiness: string
Allowed Values:
[ "B ", "P " ]
Person/Business: * `B ` - Business, * `P ` - Person
Response
Supported Media Types
- application/xml
- application/json
200 Response
Success response
Root Schema : C1SSCustRead
Type:
Show Source
object
-
emailContacts: object
emailContacts
-
entityName: string
Maximum Length:
254
Name -
faxContacts: object
faxContacts
-
firstName: string
Maximum Length:
50
First Name -
lastName: string
Maximum Length:
50
Last Name -
mailingAddress: object
mailingAddress
-
otherContacts: object
otherContacts
-
otherPendStopExists: boolean
Another Pending Task Exists switch indicates whether or not a non-final self-service task with phone and email information exists for an account.Example:
true
-
personIdentifiers: object
personIdentifiers
-
phoneContacts: object
phoneContacts
-
phoneNumbers: object
phoneNumbers
-
shouldPromptForId: boolean
Should Prompt For ID switch indicates whether or not the customer will be prompted for an Identification Number.Example:
true
Nested Schema : mailingAddress
Type:
Show Source
object
-
addressLine1: string
Maximum Length:
254
Address -
addressLine2: string
Maximum Length:
254
Address 2 -
addressLine3: string
Maximum Length:
254
Address 3 -
addressLine4: string
Maximum Length:
254
Address 4 -
city: string
Maximum Length:
90
City -
country: string
Maximum Length:
3
Country -
county: string
Maximum Length:
90
County -
geographic: string
Maximum Length:
11
Geographical Code -
houseType: string
Allowed Values:
[ "AB ", "WW " ]
House Type: * `AB ` - House Boat References, * `WW ` - House Trailer Reference -
inCityLimit: boolean
In City Limit
-
number1: string
Maximum Length:
6
Number 1 -
number2: string
Maximum Length:
4
Number 2 -
postal: string
Maximum Length:
12
Postal -
state: string
Maximum Length:
6
State
Nested Schema : items
Type:
Show Source
object
-
contactActiveInactive: 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
-
contactPrimary: string
Allowed Values:
[ "C1NO", "C1YS" ]
Primary switch must be set for exactly one person contact for each contact routing. * `C1NO` - No, * `C1YS` - Yes -
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
Nested Schema : items
Type:
Show Source
object
-
contactActiveInactive: 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
-
contactPrimary: string
Allowed Values:
[ "C1NO", "C1YS" ]
Primary switch must be set for exactly one person contact for each contact routing. * `C1NO` - No, * `C1YS` - Yes -
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
Nested Schema : items
Type:
Show Source
object
-
contactActiveInactive: 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
-
contactPrimary: string
Allowed Values:
[ "C1NO", "C1YS" ]
Primary switch must be set for exactly one person contact for each contact routing. * `C1NO` - No, * `C1YS` - Yes -
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
Nested Schema : items
Type:
Show Source
object
-
idType: string
Maximum Length:
8
ID Type defines the type of identification.Example:SSN
Nested Schema : items
Type:
Show Source
object
-
contactActiveInactive: 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
-
contactPrimary: string
Allowed Values:
[ "C1NO", "C1YS" ]
Primary switch must be set for exactly one person contact for each contact routing. * `C1NO` - No, * `C1YS` - Yes -
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
Nested Schema : items
Type:
Show Source
object
-
phone: string
Maximum Length:
24
Phone Number -
phoneType: string
Maximum Length:
12
Phone Type -
phoneTypeDescription: string
Maximum Length:
60
Description -
sequence: number
Minimum Value:
-999
Maximum Value:999
Sequence
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.