Create Case
post
https://server:port/spl/rest/apis/customer/interactions/cases/
Request
There are no request parameters for this operation.
Supported Media Types
- application/xml
- application/json
Root Schema : schema
Type:
Show Source
object
-
account: object
account
-
caseCondition: string
Allowed Values:
[ "CLSD", "OPEN" ]
Case Condition * `CLSD` - Closed, * `OPEN` - OpenExample:OPEN
-
caseType: object
caseType
Case Type defines the type of case.
-
characteristics: object
characteristics
-
comments: string
Maximum Length:
2000
Comments can be used to describe anything interesting or unusual about the case.Example:new Test
-
contactDetail: string
Maximum Length:
10
System-assigned, unique identifier of the person contact record. -
contactInformation: object
contactInformation
-
isEligibleForArchiving: boolean
ILM Archive Switch
-
person: object
person
-
premise: object
premise
-
responsibleUser: object
responsibleUser
-
status: string
Maximum Length:
12
Status shows the current state of the case.Example:NEW
-
version: number
Minimum Value:
-99999
Maximum Value:99999
The Version number is used for internal concurrency checks.
Nested Schema : account
Type:
Show Source
object
-
accountId: string
Maximum Length:
10
Account ID references the account associated with this case.Example:0777774590
Nested Schema : caseType
Type:
object
Case Type defines the type of case.
Show Source
-
caseType: string
Maximum Length:
12
Case Type defines the type of case.Example:BANKRUPT
Nested Schema : contactInformation
Type:
Show Source
object
-
callBackPhoneNumber: string
Maximum Length:
24
Callback Phone Number indicate the actual phone numberExample:(999) 432-2135
-
callBackPhoneType: string
Maximum Length:
12
Callback Phone Type indicate the actual phone typeExample:CAMP
-
contactInstructions: string
Maximum Length:
2000
Contact Instructions indicates any special instructions indicated for when or how to return a call.Example:Only in Day
-
contactPerson: object
contactPerson
Contact Person references the person who should be contacted.
-
extension: string
Maximum Length:
6
1234 -
preferredContactMethod: string
Allowed Values:
[ "C1PC", "EM ", "FAX ", "N/A ", "PH ", "POST", "SMS " ]
Preferred Contact Method indicates how the person prefers to be contacted. * `C1PC` - Person Contact, * `EM ` - Email, * `FAX ` - Fax, * `N/A ` - Not Applicable, * `PH ` - Phone, * `POST` - Postal, * `SMS ` - SMSExample:FAX
Nested Schema : person
Type:
Show Source
object
-
personId: string
Maximum Length:
10
Person ID references the person associated with this case.Example:0003339882
Nested Schema : premise
Type:
Show Source
object
-
premiseId: string
Maximum Length:
10
Premise ID references the premise associated with this case.Example:0005606666
Nested Schema : items
Type:
Show Source
object
-
characteristicType: object
characteristicType
-
characteristicValue: object
characteristicValue
-
sequence: number
Minimum Value:
-999
Maximum Value:999
Sequence NumberExample:10
-
typeOfCharacteristicValue: string
Maximum Length:
4
Type of Characteristic Value indicates whether the characteristic type value is Adhoc, Predefined, Foreign Key, or a File/URL Location.Example:FKV
-
version: number
Minimum Value:
-99999
Maximum Value:99999
The Version number is used for internal concurrency checks.
Nested Schema : characteristicType
Type:
Show Source
object
-
characteristicType: string
Maximum Length:
8
Characteristic Type
Nested Schema : characteristicValue
Type:
Show Source
object
-
_link: string
(_link)
-
value: string
(value)
-
value2: string
(value2)
-
value3: string
(value3)
-
value4: string
(value4)
-
value5: string
(value5)
Nested Schema : contactPerson
Type:
object
Contact Person references the person who should be contacted.
Show Source
-
contactPersonId: string
Maximum Length:
10
Contact Person
Root Schema : schema
Type:
Show Source
object
-
account: object
account
-
caseCondition: string
Allowed Values:
[ "CLSD", "OPEN" ]
Case Condition * `CLSD` - Closed, * `OPEN` - OpenExample:OPEN
-
caseType: object
caseType
Case Type defines the type of case.
-
characteristics: object
characteristics
-
comments: string
Maximum Length:
2000
Comments can be used to describe anything interesting or unusual about the case.Example:new Test
-
contactDetail: string
Maximum Length:
10
System-assigned, unique identifier of the person contact record. -
contactInformation: object
contactInformation
-
isEligibleForArchiving: boolean
ILM Archive Switch
-
person: object
person
-
premise: object
premise
-
responsibleUser: object
responsibleUser
-
status: string
Maximum Length:
12
Status shows the current state of the case.Example:NEW
-
version: number
Minimum Value:
-99999
Maximum Value:99999
The Version number is used for internal concurrency checks.
Nested Schema : account
Type:
Show Source
object
-
accountId: string
Maximum Length:
10
Account ID references the account associated with this case.Example:0777774590
Nested Schema : caseType
Type:
object
Case Type defines the type of case.
Show Source
-
caseType: string
Maximum Length:
12
Case Type defines the type of case.Example:BANKRUPT
Nested Schema : contactInformation
Type:
Show Source
object
-
callBackPhoneNumber: string
Maximum Length:
24
Callback Phone Number indicate the actual phone numberExample:(999) 432-2135
-
callBackPhoneType: string
Maximum Length:
12
Callback Phone Type indicate the actual phone typeExample:CAMP
-
contactInstructions: string
Maximum Length:
2000
Contact Instructions indicates any special instructions indicated for when or how to return a call.Example:Only in Day
-
contactPerson: object
contactPerson
Contact Person references the person who should be contacted.
-
extension: string
Maximum Length:
6
1234 -
preferredContactMethod: string
Allowed Values:
[ "C1PC", "EM ", "FAX ", "N/A ", "PH ", "POST", "SMS " ]
Preferred Contact Method indicates how the person prefers to be contacted. * `C1PC` - Person Contact, * `EM ` - Email, * `FAX ` - Fax, * `N/A ` - Not Applicable, * `PH ` - Phone, * `POST` - Postal, * `SMS ` - SMSExample:FAX
Nested Schema : person
Type:
Show Source
object
-
personId: string
Maximum Length:
10
Person ID references the person associated with this case.Example:0003339882
Nested Schema : premise
Type:
Show Source
object
-
premiseId: string
Maximum Length:
10
Premise ID references the premise associated with this case.Example:0005606666
Nested Schema : items
Type:
Show Source
object
-
characteristicType: object
characteristicType
-
characteristicValue: object
characteristicValue
-
sequence: number
Minimum Value:
-999
Maximum Value:999
Sequence NumberExample:10
-
typeOfCharacteristicValue: string
Maximum Length:
4
Type of Characteristic Value indicates whether the characteristic type value is Adhoc, Predefined, Foreign Key, or a File/URL Location.Example:FKV
-
version: number
Minimum Value:
-99999
Maximum Value:99999
The Version number is used for internal concurrency checks.
Nested Schema : characteristicType
Type:
Show Source
object
-
characteristicType: string
Maximum Length:
8
Characteristic Type
Nested Schema : characteristicValue
Type:
Show Source
object
-
_link: string
(_link)
-
value: string
(value)
-
value2: string
(value2)
-
value3: string
(value3)
-
value4: string
(value4)
-
value5: string
(value5)
Nested Schema : contactPerson
Type:
object
Contact Person references the person who should be contacted.
Show Source
-
contactPersonId: string
Maximum Length:
10
Contact Person
Response
Supported Media Types
- application/xml
- application/json
200 Response
Success response
Root Schema : C1-Case
Type:
Show Source
object
-
_self: string
_self
-
account: object
account
-
caseCondition: string
Allowed Values:
[ "CLSD", "OPEN" ]
Case Condition * `CLSD` - Closed, * `OPEN` - OpenExample:OPEN
-
caseId: string
Maximum Length:
10
Case ID is the system-assigned unique identifier of the case.Example:1118286467
-
caseType: object
caseType
Case Type defines the type of case.
-
characteristics: object
characteristics
-
comments: string
Maximum Length:
2000
Comments can be used to describe anything interesting or unusual about the case.Example:new Test
-
contactDetail: string
Maximum Length:
10
System-assigned, unique identifier of the person contact record. -
contactInformation: object
contactInformation
-
isEligibleForArchiving: boolean
ILM Archive Switch
-
person: object
person
-
premise: object
premise
-
responsibleUser: object
responsibleUser
-
status: string
Maximum Length:
12
Status shows the current state of the case.Example:NEW
-
version: number
Minimum Value:
-99999
Maximum Value:99999
The Version number is used for internal concurrency checks.
Nested Schema : account
Type:
Show Source
object
-
_link: string
_link
-
accountId: string
Maximum Length:
10
Account ID references the account associated with this case.Example:0777774590
Nested Schema : caseType
Type:
object
Case Type defines the type of case.
Show Source
-
_link: string
_link
-
caseType: string
Maximum Length:
12
Case Type defines the type of case.Example:BANKRUPT
Nested Schema : contactInformation
Type:
Show Source
object
-
callBackPhoneNumber: string
Maximum Length:
24
Callback Phone Number indicate the actual phone numberExample:(999) 432-2135
-
callBackPhoneType: string
Maximum Length:
12
Callback Phone Type indicate the actual phone typeExample:CAMP
-
contactInstructions: string
Maximum Length:
2000
Contact Instructions indicates any special instructions indicated for when or how to return a call.Example:Only in Day
-
contactPerson: object
contactPerson
Contact Person references the person who should be contacted.
-
extension: string
Maximum Length:
6
1234 -
preferredContactMethod: string
Allowed Values:
[ "C1PC", "EM ", "FAX ", "N/A ", "PH ", "POST", "SMS " ]
Preferred Contact Method indicates how the person prefers to be contacted. * `C1PC` - Person Contact, * `EM ` - Email, * `FAX ` - Fax, * `N/A ` - Not Applicable, * `PH ` - Phone, * `POST` - Postal, * `SMS ` - SMSExample:FAX
Nested Schema : person
Type:
Show Source
object
-
_link: string
_link
-
personId: string
Maximum Length:
10
Person ID references the person associated with this case.Example:0003339882
Nested Schema : premise
Type:
Show Source
object
-
_link: string
_link
-
premiseId: string
Maximum Length:
10
Premise ID references the premise associated with this case.Example:0005606666
Nested Schema : responsibleUser
Type:
Show Source
object
-
_link: string
_link
-
userId: string
Maximum Length:
8
User
Nested Schema : items
Type:
Show Source
object
-
characteristicType: object
characteristicType
-
characteristicValue: object
characteristicValue
-
sequence: number
Minimum Value:
-999
Maximum Value:999
Sequence NumberExample:10
-
typeOfCharacteristicValue: string
Maximum Length:
4
Type of Characteristic Value indicates whether the characteristic type value is Adhoc, Predefined, Foreign Key, or a File/URL Location.Example:FKV
-
version: number
Minimum Value:
-99999
Maximum Value:99999
The Version number is used for internal concurrency checks.
Nested Schema : characteristicType
Type:
Show Source
object
-
_link: string
_link
-
characteristicType: string
Maximum Length:
8
Characteristic Type
Nested Schema : characteristicValue
Type:
Show Source
object
-
_link: string
(_link)
-
value: string
(value)
-
value2: string
(value2)
-
value3: string
(value3)
-
value4: string
(value4)
-
value5: string
(value5)
Nested Schema : contactPerson
Type:
object
Contact Person references the person who should be contacted.
Show Source
-
_link: string
_link
-
contactPersonId: string
Maximum Length:
10
Contact Person
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.