Update Service Call Communication
patch
https://server:port/spl/rest/apis/customer/sync/serviceCallCommunication/{serviceCallCommId}
Request
Path Parameters
Supported Media Types
- application/xml
- application/json
Nested Schema : errorInformation
Type:
Show Source
object
-
errorText: string
Maximum Length:
400
Error Message -
hadError: boolean
An error was encountered
-
messageCategory: number
Minimum Value:
-99999
Maximum Value:99999
Message Category -
messageNumber: number
Minimum Value:
-99999
Maximum Value:99999
Message Number -
messageParameters: object
messageParameters
Nested Schema : input
Type:
Show Source
object
-
adjustmentCancelReason: string
Maximum Length:
4
Adjustment Cancel Reason describes the reason for cancelling related adjustment when Accounts Payable Check Request gets canceled. -
apRequestId: string
Maximum Length:
12
Accounts Payable Request ID is the system-assigned, unique identifier of the Accounts Payable check request.Example:873490693226
-
paidAmount: string
Maximum Length:
15
Paid Amount is the amount of the check. This field can be provided after Accounts Payable cuts the check.Example:20.00
-
paymentCurrency: string
Maximum Length:
3
Payment CurrencyExample:USD
-
paymentDate: string
Maximum Length:
10
Payment Date is the date on which the check was cut in A/P. This field is provided after Accounts Payable cuts the check.Example:2022-07-18
-
paymentMethod: string
Maximum Length:
3
Payment methodExample:CHK
-
paymentNumber: string
Maximum Length:
36
Payment Number is the system-assigned number of the payment in Accounts Payable (this number typically appears on the printed check). This field can be provided after Accounts Payable cuts the check.Example:873483873762
-
paymentSelectionStatus: string
Maximum Length:
1
Payment Selection Status is the status of the check request. The values are: ??? Not Selected for Payment before it's selected by Accounts Payable for payment ??? Requested for Payment after it's selected by Accounts Payable ??? Paid after it's paid by Accounts Payable ??? Canceled if it's been canceled in Accounts Payable ??? Hold if it's been held in Accounts PayableExample:P
Nested Schema : items
Type:
Show Source
object
-
parameterType: string
Allowed Values:
[ "AMT ", "DATE", "DTTM", "DUR ", "FLD ", "MMDD", "MSG ", "NBR ", "SRVC", "TBL ", "TIME" ]
Message Parameter Type * `AMT ` - Amount parameter, * `DATE` - Date format parameter, * `DTTM` - Date/time format parameter, * `DUR ` - Duration parameter, * `FLD ` - Field name parameter, * `MMDD` - Month/Day format parameter, * `MSG ` - Message parameter, * `NBR ` - Numeric parameter, * `SRVC` - Service name parameter, * `TBL ` - Table name parameter, * `TIME` - Time format parameterExample:FLD
-
parameterValue: string
Maximum Length:
2000
Message Parameter Value
Nested Schema : errorInformation
Type:
Show Source
object
-
errorText: string
Maximum Length:
400
Error Message -
hadError: boolean
An error was encountered
-
messageCategory: number
Minimum Value:
-99999
Maximum Value:99999
Message Category -
messageNumber: number
Minimum Value:
-99999
Maximum Value:99999
Message Number -
messageParameters: object
messageParameters
Nested Schema : input
Type:
Show Source
object
-
adjustmentCancelReason: string
Maximum Length:
4
Adjustment Cancel Reason describes the reason for cancelling related adjustment when Accounts Payable Check Request gets canceled. -
apRequestId: string
Maximum Length:
12
Accounts Payable Request ID is the system-assigned, unique identifier of the Accounts Payable check request.Example:873490693226
-
paidAmount: string
Maximum Length:
15
Paid Amount is the amount of the check. This field can be provided after Accounts Payable cuts the check.Example:20.00
-
paymentCurrency: string
Maximum Length:
3
Payment CurrencyExample:USD
-
paymentDate: string
Maximum Length:
10
Payment Date is the date on which the check was cut in A/P. This field is provided after Accounts Payable cuts the check.Example:2022-07-18
-
paymentMethod: string
Maximum Length:
3
Payment methodExample:CHK
-
paymentNumber: string
Maximum Length:
36
Payment Number is the system-assigned number of the payment in Accounts Payable (this number typically appears on the printed check). This field can be provided after Accounts Payable cuts the check.Example:873483873762
-
paymentSelectionStatus: string
Maximum Length:
1
Payment Selection Status is the status of the check request. The values are: ??? Not Selected for Payment before it's selected by Accounts Payable for payment ??? Requested for Payment after it's selected by Accounts Payable ??? Paid after it's paid by Accounts Payable ??? Canceled if it's been canceled in Accounts Payable ??? Hold if it's been held in Accounts PayableExample:P
Nested Schema : items
Type:
Show Source
object
-
parameterType: string
Allowed Values:
[ "AMT ", "DATE", "DTTM", "DUR ", "FLD ", "MMDD", "MSG ", "NBR ", "SRVC", "TBL ", "TIME" ]
Message Parameter Type * `AMT ` - Amount parameter, * `DATE` - Date format parameter, * `DTTM` - Date/time format parameter, * `DUR ` - Duration parameter, * `FLD ` - Field name parameter, * `MMDD` - Month/Day format parameter, * `MSG ` - Message parameter, * `NBR ` - Numeric parameter, * `SRVC` - Service name parameter, * `TBL ` - Table name parameter, * `TIME` - Time format parameterExample:FLD
-
parameterValue: string
Maximum Length:
2000
Message Parameter Value
Response
Supported Media Types
- application/xml
- application/json
200 Response
Success response
Nested Schema : errorInformation
Type:
Show Source
object
-
errorText: string
Maximum Length:
400
Error Message -
hadError: boolean
An error was encountered
-
messageCategory: number
Minimum Value:
-99999
Maximum Value:99999
Message Category -
messageNumber: number
Minimum Value:
-99999
Maximum Value:99999
Message Number -
messageParameters: object
messageParameters
Nested Schema : input
Type:
Show Source
object
-
adjustmentCancelReason: string
Maximum Length:
4
Adjustment Cancel Reason describes the reason for cancelling related adjustment when Accounts Payable Check Request gets canceled. -
apRequestId: string
Maximum Length:
12
Accounts Payable Request ID is the system-assigned, unique identifier of the Accounts Payable check request.Example:873490693226
-
paidAmount: string
Maximum Length:
15
Paid Amount is the amount of the check. This field can be provided after Accounts Payable cuts the check.Example:20.00
-
paymentCurrency: string
Maximum Length:
3
Payment CurrencyExample:USD
-
paymentDate: string
Maximum Length:
10
Payment Date is the date on which the check was cut in Accounts Payable. This field is provided after Accounts Payable cuts the check.Example:2022-07-18
-
paymentMethod: string
Maximum Length:
3
Payment methodExample:CHK
-
paymentNumber: string
Maximum Length:
36
Payment Number is the system-assigned number of the payment in Accounts Payable (this number typically appears on the printed check). This field can be provided after Accounts Payable cuts the check.Example:873483873762
-
paymentSelectionStatus: string
Maximum Length:
1
Payment Selection Status is the status of the check request. The values are: ??? Not Selected for Payment before it's selected by Accounts Payable for payment ??? Requested for Payment after it's selected by Accounts Payable ??? Paid after it's paid by Accounts Payable ??? Canceled if it's been canceled in Accounts Payable ??? Hold if it's been held in Accounts PayableExample:P
Nested Schema : items
Type:
Show Source
object
-
parameterType: string
Allowed Values:
[ "AMT ", "DATE", "DTTM", "DUR ", "FLD ", "MMDD", "MSG ", "NBR ", "SRVC", "TBL ", "TIME" ]
Message Parameter Type * `AMT ` - Amount parameter, * `DATE` - Date format parameter, * `DTTM` - Date/time format parameter, * `DUR ` - Duration parameter, * `FLD ` - Field name parameter, * `MMDD` - Month/Day format parameter, * `MSG ` - Message parameter, * `NBR ` - Numeric parameter, * `SRVC` - Service name parameter, * `TBL ` - Table name parameter, * `TIME` - Time format parameterExample:FLD
-
parameterValue: string
Maximum Length:
2000
Message Parameter Value
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.