1. REST API for Oracle Public Sector Permitting and Licensing
  2. Tasks
  3. Common Setup
  4. Fee Schedules

Update a fee schedule

patch

/fscmRestApi/resources/11.13.18.05/publicSectorFeeSchedules/{publicSectorFeeSchedulesUniqID}

Request

Path Parameters
  • This is the hash key of the attributes which make up the composite key--- AgencyId, FeeScheduleId, EffectiveStartDate and EffectiveEndDate ---for the Fee Schedules resource and used to uniquely identify an instance of Fee Schedules. The client should not generate the hash key value. Instead, the client should query on the Fee Schedules collection resource with a filter on the primary key values in order to navigate to a specific instance of Fee Schedules.

    For example: publicSectorFeeSchedules?q=AgencyId=<value1>;FeeScheduleId=<value2>;EffectiveStartDate=<value3>;EffectiveEndDate=<value4>
Header Parameters
  • This header accepts a string value. The string is a semi-colon separated list of =. It is used to perform effective date range operations. The accepted parameters are RangeMode, RangeSpan, RangeStartDate, RangeEndDate, RangeStartSequence and RangeEndSequence. The parameter values are always strings. The possible values for RangeMode are SET_LOGICAL_START, SET_LOGICAL_END, END_DATE, SET_EFFECTIVE_START, SET_EFFECTIVE_END, REPLACE_CORRECTION, REPLACE_UPDATE, RECONCILE_CORRECTION, CORRECTION, RECONCILE_UPDATE, UPDATE, ZAP and DELETE_CHANGES. The possible values for RangeSpan are PHYSICAL_ROW_END_DATE and LOGICAL_ROW_END_DATE. The values for RangeStartDate and RangeEndDate have to be a string representation of a date in yyyy-MM-dd format. The value for RangeStartSequence and RangeEndSequence must be strings such that when parsed they yield positive integers.
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
  • Title: Description
    Maximum Length: 50
    A description of the fee schedule.
  • Title: Default Fee Item
    Maximum Length: 30
    The default fee item is used if the fee item in the decision model does not match any fee items in the common fee item table.
  • Fee Lines
    Title: Fee Lines
    The fee lines resource is used to view, create, delete, or modify fee lines. A fee line is used to define which decision model in OIC is used for the current fee schedule.
  • Title: Refund Fee Item
    Maximum Length: 30
    Default Value: MISCELLANEOUS
    The fee item used for refunds.
Nested Schema : Fee Lines
Type: array
Title: Fee Lines
The fee lines resource is used to view, create, delete, or modify fee lines. A fee line is used to define which decision model in OIC is used for the current fee schedule.
Show Source
Nested Schema : publicSectorFeeSchedules-FeeLine-item-patch-request
Type: object
Show Source
  • Title: Currency
    Maximum Length: 3
    The default currency code from the COM_AGENCY table. For now, this field is display-only.
  • Title: Model Name
    Maximum Length: 1000
    The fee decision model name.
  • Title: Service Name
    Maximum Length: 1000
    The OIC REST service name for the deployed model.
  • Title: Space ID
    Maximum Length: 1000
    The internal ID for the Oracle Autonomous Integration Cloud (OIC) space. This is the workflow space that OIC actually uses to reference the decision model; however, it is not exposed to the user.
  • Title: Space Name
    Maximum Length: 1000
    The user-friendly OIC space name. This field relates to the DMN_SPACE_ID field.
  • Title: Version
    Maximum Length: 1000
    The OIC tag is the version number for the deployed fee decision model.
  • Fee Schedule Map Data
    Title: Fee Schedule Map Data
    The fee schedule map data resource is used to view, create, delete, or modify the data. The fee mapping is to store the mapping data and to calculate the DMN fee outside of the form design.
  • Title: Map Fee Amount
    Maximum Length: 50
    The output resource name for fee amount to be stored.
  • Title: Map Fee Item
    Maximum Length: 50
    The output resource name for the fee item to be stored.
  • Title: Map Fee Reference
    Maximum Length: 50
    The identifier of the map fee reference for the decision model.
  • Title: Mapping Source
    Maximum Length: 10
    The source transaction that requires field mapping to calculate fees.
  • Title: Pay Now
    Maximum Length: 1
    Indicates whether the fee item is payable upon submission of the application or not. The default value is no.
  • Maximum Length: 1
    Indicates whether this fee line is used for amended fees. This field is for future use. There is no default value.
  • Maximum Length: 1
    Indicates whether this fee line is used for the original fees. The default value is yes.
  • Maximum Length: 1
    Indicates whether this fee line is used for renewal fees. This field is for future use. There is no default value.
Nested Schema : Fee Schedule Map Data
Type: array
Title: Fee Schedule Map Data
The fee schedule map data resource is used to view, create, delete, or modify the data. The fee mapping is to store the mapping data and to calculate the DMN fee outside of the form design.
Show Source
Nested Schema : publicSectorFeeSchedules-FeeLine-FeeScheduleMapD-item-patch-request
Type: object
Show Source
Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Body ()
Root Schema : publicSectorFeeSchedules-item-response
Type: object
Show Source
Nested Schema : Fee Lines
Type: array
Title: Fee Lines
The fee lines resource is used to view, create, delete, or modify fee lines. A fee line is used to define which decision model in OIC is used for the current fee schedule.
Show Source
Nested Schema : publicSectorFeeSchedules-FeeLine-item-response
Type: object
Show Source
  • Title: Agency ID
    Default Value: 1
    The identifier for the public sector agency to which this fee schedule belongs.
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    The user who created the fee line.
  • Title: Creation Date
    Read Only: true
    The date when the fee line was created.
  • Title: Currency
    Maximum Length: 3
    The default currency code from the COM_AGENCY table. For now, this field is display-only.
  • Title: Model Name
    Maximum Length: 1000
    The fee decision model name.
  • Title: Service Name
    Maximum Length: 1000
    The OIC REST service name for the deployed model.
  • Title: Space ID
    Maximum Length: 1000
    The internal ID for the Oracle Autonomous Integration Cloud (OIC) space. This is the workflow space that OIC actually uses to reference the decision model; however, it is not exposed to the user.
  • Title: Space Name
    Maximum Length: 1000
    The user-friendly OIC space name. This field relates to the DMN_SPACE_ID field.
  • Title: Version
    Maximum Length: 1000
    The OIC tag is the version number for the deployed fee decision model.
  • Title: Effective End Date
    The end date of the fee schedule.
  • Title: Effective Start Date
    The start date of the fee schedule.
  • Title: Fee Schedule
    Maximum Length: 20
    A unique name that identifies a fee schedule.
  • Title: Fee Items
    The line number for the current fee schedule. When the user adds a new line, it is incremented up to the maximum number of fee schedule lines.
  • Fee Schedule Map Data
    Title: Fee Schedule Map Data
    The fee schedule map data resource is used to view, create, delete, or modify the data. The fee mapping is to store the mapping data and to calculate the DMN fee outside of the form design.
  • Title: Last Updated Date
    Read Only: true
    The date when the fee line was last updated.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    The user who last updated the fee line.
  • Links
  • Title: Map Fee Amount
    Maximum Length: 50
    The output resource name for fee amount to be stored.
  • Title: Map Fee Item
    Maximum Length: 50
    The output resource name for the fee item to be stored.
  • Title: Map Fee Reference
    Maximum Length: 50
    The identifier of the map fee reference for the decision model.
  • Title: Mapping Source
    Maximum Length: 10
    The source transaction that requires field mapping to calculate fees.
  • Title: Pay Now
    Maximum Length: 1
    Indicates whether the fee item is payable upon submission of the application or not. The default value is no.
  • Maximum Length: 1
    Indicates whether this fee line is used for amended fees. This field is for future use. There is no default value.
  • Maximum Length: 1
    Indicates whether this fee line is used for the original fees. The default value is yes.
  • Maximum Length: 1
    Indicates whether this fee line is used for renewal fees. This field is for future use. There is no default value.
Nested Schema : Fee Schedule Map Data
Type: array
Title: Fee Schedule Map Data
The fee schedule map data resource is used to view, create, delete, or modify the data. The fee mapping is to store the mapping data and to calculate the DMN fee outside of the form design.
Show Source
Nested Schema : publicSectorFeeSchedules-FeeLine-FeeScheduleMapD-item-response
Type: object
Show Source
Links
FeeLine
Parameters:
  • publicSectorFeeSchedulesUniqID: $request.path.publicSectorFeeSchedulesUniqID
The fee lines resource is used to view, create, delete, or modify fee lines. A fee line is used to define which decision model in OIC is used for the current fee schedule.
Back to Top