Jump to

• Request
• Response

AP Check Request Maintenance

put

/rest/apis/customer/financials/apCheckRequest/{apRequestId}

This is the service script that the AP Check Request (C1-APCheckRequest) inbound service exposes. It invokes the Update AP Check Request (C1APChkMain) via a savepoint dispatcher.

Request

Path Parameters

• apRequestId(required): string
  AP Request ID is the system-assigned, unique identifier of the AP check request.

  Example:

  873490693226

Supported Media Types

• application/xml
• application/json

Request Body - application/xml ()

Root Schema : schema

Type: object

Show Source

• exceptionInformation: object exceptionInformation
• externalId: string
  Maximum Length: 60

  The external system's unique identifier for the communication.

  Example: 95480721390208
• isInError: boolean
  Indicates whether to limit the search to active service calls only.

  Example: true
• serviceCallCommId: string
  Maximum Length: 14

  The system-generated unique identifier for the service call communication.

  Example: 85810617092033
• serviceCallId: string
  Maximum Length: 14

  The external system's unique identifier for the service call.

  Example: 39255986785636
• serviceCallNumber: string
  Maximum Length: 14

  The external system's alternative unique identifier for the service call.

  Example: 20220000000003

{
    "type":"object",
    "properties":{
        "serviceCallCommId":{
            "type":"string",
            "maxLength":14,
            "description":"The system-generated unique identifier for the service call communication.",
            "example":"85810617092033"
        },
        "externalId":{
            "type":"string",
            "maxLength":60,
            "description":"The external system's unique identifier for the communication.",
            "example":"95480721390208"
        },
        "serviceCallId":{
            "type":"string",
            "maxLength":14,
            "description":"The external system's unique identifier for the service call.",
            "example":"39255986785636"
        },
        "serviceCallNumber":{
            "type":"string",
            "maxLength":14,
            "description":"The external system's alternative unique identifier for the service call.",
            "example":"20220000000003"
        },
        "isInError":{
            "type":"boolean",
            "description":"Indicates whether to limit the search to active service calls only.",
            "example":"true"
        },
        "exceptionInformation":{
            "type":"object",
            "properties":{
                "messageCategory":{
                    "type":"number",
                    "maximum":99999,
                    "minimum":-99999,
                    "description":"Message category of the error.",
                    "example":"11508"
                },
                "messageNumber":{
                    "type":"number",
                    "maximum":99999,
                    "minimum":-99999,
                    "description":"Message number of the error.",
                    "example":"17055"
                },
                "messageText":{
                    "type":"string",
                    "maxLength":254,
                    "description":"Message text containing the details of the error encountered.",
                    "example":"Either Location or Address must be populated."
                }
            }
        }
    },
    "xml":{
        "name":"C1SvccUpd"
    }
}

Nested Schema : exceptionInformation

Type: object

Show Source

• messageCategory: number
  Minimum Value: -99999

  Maximum Value: 99999

  Message category of the error.

  Example: 11508
• messageNumber: number
  Minimum Value: -99999

  Maximum Value: 99999

  Message number of the error.

  Example: 17055
• messageText: string
  Maximum Length: 254

  Message text containing the details of the error encountered.

  Example: Either Location or Address must be populated.

{
    "type":"object",
    "properties":{
        "messageCategory":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Message category of the error.",
            "example":"11508"
        },
        "messageNumber":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Message number of the error.",
            "example":"17055"
        },
        "messageText":{
            "type":"string",
            "maxLength":254,
            "description":"Message text containing the details of the error encountered.",
            "example":"Either Location or Address must be populated."
        }
    }
}

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• exceptionInformation: object exceptionInformation
• externalId: string
  Maximum Length: 60

  The external system's unique identifier for the communication.

  Example: 95480721390208
• isInError: boolean
  Indicates whether to limit the search to active service calls only.

  Example: true
• serviceCallCommId: string
  Maximum Length: 14

  The system-generated unique identifier for the service call communication.

  Example: 85810617092033
• serviceCallId: string
  Maximum Length: 14

  The external system's unique identifier for the service call.

  Example: 39255986785636
• serviceCallNumber: string
  Maximum Length: 14

  The external system's alternative unique identifier for the service call.

  Example: 20220000000003

{
    "type":"object",
    "properties":{
        "serviceCallCommId":{
            "type":"string",
            "maxLength":14,
            "description":"The system-generated unique identifier for the service call communication.",
            "example":"85810617092033"
        },
        "externalId":{
            "type":"string",
            "maxLength":60,
            "description":"The external system's unique identifier for the communication.",
            "example":"95480721390208"
        },
        "serviceCallId":{
            "type":"string",
            "maxLength":14,
            "description":"The external system's unique identifier for the service call.",
            "example":"39255986785636"
        },
        "serviceCallNumber":{
            "type":"string",
            "maxLength":14,
            "description":"The external system's alternative unique identifier for the service call.",
            "example":"20220000000003"
        },
        "isInError":{
            "type":"boolean",
            "description":"Indicates whether to limit the search to active service calls only.",
            "example":"true"
        },
        "exceptionInformation":{
            "type":"object",
            "properties":{
                "messageCategory":{
                    "type":"number",
                    "maximum":99999,
                    "minimum":-99999,
                    "description":"Message category of the error.",
                    "example":"11508"
                },
                "messageNumber":{
                    "type":"number",
                    "maximum":99999,
                    "minimum":-99999,
                    "description":"Message number of the error.",
                    "example":"17055"
                },
                "messageText":{
                    "type":"string",
                    "maxLength":254,
                    "description":"Message text containing the details of the error encountered.",
                    "example":"Either Location or Address must be populated."
                }
            }
        }
    },
    "xml":{
        "name":"C1SvccUpd"
    }
}

Nested Schema : exceptionInformation

Type: object

Show Source

• messageCategory: number
  Minimum Value: -99999

  Maximum Value: 99999

  Message category of the error.

  Example: 11508
• messageNumber: number
  Minimum Value: -99999

  Maximum Value: 99999

  Message number of the error.

  Example: 17055
• messageText: string
  Maximum Length: 254

  Message text containing the details of the error encountered.

  Example: Either Location or Address must be populated.

{
    "type":"object",
    "properties":{
        "messageCategory":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Message category of the error.",
            "example":"11508"
        },
        "messageNumber":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Message number of the error.",
            "example":"17055"
        },
        "messageText":{
            "type":"string",
            "maxLength":254,
            "description":"Message text containing the details of the error encountered.",
            "example":"Either Location or Address must be populated."
        }
    }
}

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

Success response

Body ()

Root Schema : C1SvccUpd

Type: object

Show Source

• exceptionInformation: object exceptionInformation
• externalId: string
  Maximum Length: 60

  The external system's unique identifier for the communication.

  Example: 95480721390208
• isInError: boolean
  Indicates whether to limit the search to active service calls only.

  Example: true
• serviceCallCommId: string
  Maximum Length: 14

  The system-generated unique identifier for the service call communication.

  Example: 85810617092033
• serviceCallId: string
  Maximum Length: 14

  The external system's unique identifier for the service call.

  Example: 39255986785636
• serviceCallNumber: string
  Maximum Length: 14

  The external system's alternative unique identifier for the service call.

  Example: 20220000000003

{
    "type":"object",
    "properties":{
        "serviceCallCommId":{
            "type":"string",
            "maxLength":14,
            "description":"The system-generated unique identifier for the service call communication.",
            "example":"85810617092033"
        },
        "externalId":{
            "type":"string",
            "maxLength":60,
            "description":"The external system's unique identifier for the communication.",
            "example":"95480721390208"
        },
        "serviceCallId":{
            "type":"string",
            "maxLength":14,
            "description":"The external system's unique identifier for the service call.",
            "example":"39255986785636"
        },
        "serviceCallNumber":{
            "type":"string",
            "maxLength":14,
            "description":"The external system's alternative unique identifier for the service call.",
            "example":"20220000000003"
        },
        "isInError":{
            "type":"boolean",
            "description":"Indicates whether to limit the search to active service calls only.",
            "example":"true"
        },
        "exceptionInformation":{
            "type":"object",
            "properties":{
                "messageCategory":{
                    "type":"number",
                    "maximum":99999,
                    "minimum":-99999,
                    "description":"Message category of the error.",
                    "example":"11508"
                },
                "messageNumber":{
                    "type":"number",
                    "maximum":99999,
                    "minimum":-99999,
                    "description":"Message number of the error.",
                    "example":"17055"
                },
                "messageText":{
                    "type":"string",
                    "maxLength":254,
                    "description":"Message text containing the details of the error encountered.",
                    "example":"Either Location or Address must be populated."
                }
            }
        }
    },
    "xml":{
        "name":"C1SvccUpd"
    }
}

Nested Schema : exceptionInformation

Type: object

Show Source

• messageCategory: number
  Minimum Value: -99999

  Maximum Value: 99999

  Message category of the error.

  Example: 11508
• messageNumber: number
  Minimum Value: -99999

  Maximum Value: 99999

  Message number of the error.

  Example: 17055
• messageText: string
  Maximum Length: 254

  Message text containing the details of the error encountered.

  Example: Either Location or Address must be populated.

{
    "type":"object",
    "properties":{
        "messageCategory":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Message category of the error.",
            "example":"11508"
        },
        "messageNumber":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Message number of the error.",
            "example":"17055"
        },
        "messageText":{
            "type":"string",
            "maxLength":254,
            "description":"Message text containing the details of the error encountered.",
            "example":"Either Location or Address must be populated."
        }
    }
}

400 Response

Bad Request

Body ()

Root Schema : problemDetailDocument

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "problemType":{
            "type":"string",
            "maxLength":60,
            "description":"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."
        },
        "title":{
            "type":"string",
            "maxLength":60,
            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
        },
        "httpStatus":{
            "type":"number",
            "maximum":9999,
            "minimum":0,
            "description":"The HTTP Status code for the error."
        },
        "detail":{
            "type":"string",
            "maxLength":60,
            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
        },
        "problemInstance":{
            "type":"string",
            "maxLength":60,
            "description":"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."
        },
        "stackTrace":{
            "type":"string",
            "maxLength":60,
            "description":"The stack trace shows where the error occurs during the execution of a program."
        },
        "serverMessage":{
            "type":"object",
            "properties":{
                "messageCategory":{
                    "type":"number",
                    "maximum":0,
                    "minimum":0,
                    "description":"Message Category within Oracle Utilities Application Framework."
                },
                "messageNbr":{
                    "type":"number",
                    "maximum":99999,
                    "minimum":-99999,
                    "description":"Message Number within Oracle Utilities Application Framework."
                },
                "callSequence":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Delimited sequence of programs called."
                },
                "programName":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Name of the program that encountered the error."
                },
                "messageText":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
                },
                "longDescription":{
                    "type":"string",
                    "maxLength":60,
                    "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
                }
            }
        }
    }
}

Nested Schema : serverMessage

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "messageCategory":{
            "type":"number",
            "maximum":0,
            "minimum":0,
            "description":"Message Category within Oracle Utilities Application Framework."
        },
        "messageNbr":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Message Number within Oracle Utilities Application Framework."
        },
        "callSequence":{
            "type":"string",
            "maxLength":60,
            "description":"Delimited sequence of programs called."
        },
        "programName":{
            "type":"string",
            "maxLength":60,
            "description":"Name of the program that encountered the error."
        },
        "messageText":{
            "type":"string",
            "maxLength":60,
            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
        },
        "longDescription":{
            "type":"string",
            "maxLength":60,
            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
        }
    }
}

500 Response

Internal Server Error

Body ()

Root Schema : problemDetailDocument

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "problemType":{
            "type":"string",
            "maxLength":60,
            "description":"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."
        },
        "title":{
            "type":"string",
            "maxLength":60,
            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
        },
        "httpStatus":{
            "type":"number",
            "maximum":9999,
            "minimum":0,
            "description":"The HTTP Status code for the error."
        },
        "detail":{
            "type":"string",
            "maxLength":60,
            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
        },
        "problemInstance":{
            "type":"string",
            "maxLength":60,
            "description":"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."
        },
        "stackTrace":{
            "type":"string",
            "maxLength":60,
            "description":"The stack trace shows where the error occurs during the execution of a program."
        },
        "serverMessage":{
            "type":"object",
            "properties":{
                "messageCategory":{
                    "type":"number",
                    "maximum":0,
                    "minimum":0,
                    "description":"Message Category within Oracle Utilities Application Framework."
                },
                "messageNbr":{
                    "type":"number",
                    "maximum":99999,
                    "minimum":-99999,
                    "description":"Message Number within Oracle Utilities Application Framework."
                },
                "callSequence":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Delimited sequence of programs called."
                },
                "programName":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Name of the program that encountered the error."
                },
                "messageText":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
                },
                "longDescription":{
                    "type":"string",
                    "maxLength":60,
                    "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
                }
            }
        }
    }
}

Nested Schema : serverMessage

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "messageCategory":{
            "type":"number",
            "maximum":0,
            "minimum":0,
            "description":"Message Category within Oracle Utilities Application Framework."
        },
        "messageNbr":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Message Number within Oracle Utilities Application Framework."
        },
        "callSequence":{
            "type":"string",
            "maxLength":60,
            "description":"Delimited sequence of programs called."
        },
        "programName":{
            "type":"string",
            "maxLength":60,
            "description":"Name of the program that encountered the error."
        },
        "messageText":{
            "type":"string",
            "maxLength":60,
            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
        },
        "longDescription":{
            "type":"string",
            "maxLength":60,
            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
        }
    }
}

Back to Top