Search Case
post
https://server:port/spl/rest/apis/customer/interactions/cases/search
This operation retrieves Case details based on given filters i.e. accountId/personId/premiseId.
Request
There are no request parameters for this operation.
Supported Media Types
- application/xml
- application/json
Root Schema : schema
Type:
Show Source
object
-
caseList: object
caseList
-
count: number
Minimum Value:
0
Maximum Value:99999
Count -
filters: object
filters
-
totalNumberOfRecords: number
Minimum Value:
0
Maximum Value:99999
Total Number Of Records
Nested Schema : filters
Type:
Show Source
object
-
accountId: string
Maximum Length:
10
Account ID references the account associated with this case.Example:0777774590
-
historicalDate: string
(date)
Creation Date
-
limit: number
Minimum Value:
0
Maximum Value:9.99999999999999E8
Limit -
personId: string
Maximum Length:
10
Person ID references the person associated with this case.Example:0003339882
-
premiseId: string
Maximum Length:
10
Premise ID references the premise associated with this case.Example:0005606666
Nested Schema : items
Type:
Show Source
object
-
account: object
account
-
address: string
Maximum Length:
150
Address -
case: object
case
-
caseCondition: string
Maximum Length:
4
Case ConditionExample:OPEN
-
caseType: object
caseType
-
creationDate: string
(date)
Creation Date
-
name: string
Maximum Length:
254
Name -
person: object
person
-
premise: object
premise
-
status: string
Maximum Length:
30
Status
Root Schema : schema
Type:
Show Source
object
-
caseList: object
caseList
-
count: number
Minimum Value:
0
Maximum Value:99999
Count -
filters: object
filters
-
totalNumberOfRecords: number
Minimum Value:
0
Maximum Value:99999
Total Number Of Records
Nested Schema : filters
Type:
Show Source
object
-
accountId: string
Maximum Length:
10
Account ID references the account associated with this case.Example:0777774590
-
historicalDate: string
(date)
Creation Date
-
limit: number
Minimum Value:
0
Maximum Value:9.99999999999999E8
Limit -
personId: string
Maximum Length:
10
Person ID references the person associated with this case.Example:0003339882
-
premiseId: string
Maximum Length:
10
Premise ID references the premise associated with this case.Example:0005606666
Nested Schema : items
Type:
Show Source
object
-
account: object
account
-
address: string
Maximum Length:
150
Address -
case: object
case
-
caseCondition: string
Maximum Length:
4
Case ConditionExample:OPEN
-
caseType: object
caseType
-
creationDate: string
(date)
Creation Date
-
name: string
Maximum Length:
254
Name -
person: object
person
-
premise: object
premise
-
status: string
Maximum Length:
30
Status
Response
Supported Media Types
- application/xml
- application/json
200 Response
Success response
Root Schema : C1CaseSearch
Type:
Show Source
object
-
caseList: object
caseList
-
count: number
Minimum Value:
0
Maximum Value:99999
Count -
totalNumberOfRecords: number
Minimum Value:
0
Maximum Value:99999
Total Number Of Records
Nested Schema : items
Type:
Show Source
object
-
account: object
account
-
address: string
Maximum Length:
150
Address -
case: object
case
-
caseCondition: string
Maximum Length:
4
Case ConditionExample:OPEN
-
caseType: object
caseType
-
creationDate: string
(date)
Creation Date
-
name: string
Maximum Length:
254
Name -
person: object
person
-
premise: object
premise
-
status: string
Maximum Length:
30
Status
Nested Schema : account
Type:
Show Source
object
-
_link: string
_link
-
accountId: string
Maximum Length:
10
Account ID
Nested Schema : case
Type:
Show Source
object
-
_link: string
_link
-
caseId: string
Maximum Length:
10
Case ID
Nested Schema : caseType
Type:
Show Source
object
-
_link: string
_link
-
caseType: string
Maximum Length:
12
Case Type
Nested Schema : person
Type:
Show Source
object
-
_link: string
_link
-
personId: string
Maximum Length:
10
Person ID
Nested Schema : premise
Type:
Show Source
object
-
_link: string
_link
-
premiseId: string
Maximum Length:
10
Premise ID
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.