Get Customer Activity History
get
https://server:port/spl/rest/apis/customer/interactions/customerActivityHistory/{accountId}
This operation retrieves the particular account's activity history.
Request
Path Parameters
Query Parameters
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/xml
- application/json
200 Response
Success response
Root Schema : C1-GtCuAcHi
Type:
Show Source
object
-
accountId: string
Maximum Length:
10
The Account ID for which the customer activity history is returned.Example:1589809888
-
fromDateTime: string
(date-time)
From Date Time is a required input of date range for which the customer activity history is returned.
-
interactions: array
interactions
-
interactionTypes: array
interactionTypes
-
limit: number
Minimum Value:
0
Maximum Value:99999
The limit element is an integer value that specifies the paging size for number of records to return when serving a client request.Example:20
-
toDateTime: string
(date-time)
To Date Time is a required input of date range for which the customer activity history is returned.
Nested Schema : items
Type:
Show Source
object
-
displayIconOracle: string
Maximum Length:
12
Icon Name from Redwood library for example "ico-contacts.svg", "ico-check.svg". This is the URL value from the display icon reference code definition.Example:ico-financials.svg
-
id: string
Maximum Length:
14
Unique identifier of the row. This is a concatenation of the "activity type" and the entity PK 1-5.Example:BL549134324111
-
interactionDateTime: string
(date-time)
Account Activity Date TimeExample:
2008-11-01T00:00:00-04:00
-
interactionType: string
Maximum Length:
2
Account Activity TypeExample:BL
- navigationInfo: object navigationInfo
-
primaryText: string
Maximum Length:
1000
Primary textExample:Bill for $1002.43
-
secondaryText: string
Maximum Length:
1000
Secondary textExample:Due 11-17-2008
-
tertiaryText: string
Maximum Length:
1000
Tertiary textExample:1037 days in bill period
Nested Schema : items
Type:
Show Source
object
-
description: string
Maximum Length:
60
Description of the interaction type value. -
displayIconOracle: string
Maximum Length:
12
Icon Name from Redwood library for example "ico-contacts.svg", "ico-check.svg". This is the URL value from the display icon reference code definition.Example:ico-financials.svg
-
tags: string
Maximum Length:
10
Tag value for grouping of Interaction Types by categories. -
type: string
Maximum Length:
12
List of Interaction Type Codes for the client to use upon rendering.
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.