Jump to

• Request
• Response

Update a fee item

patch

/fscmRestApi/resources/11.13.18.05/publicSectorFeeItems/{publicSectorFeeItemsUniqID}

Request

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• application/json

Path Parameters

• publicSectorFeeItemsUniqID: integer
  This is the hash key of the attributes which make up the composite key--- AgencyId and FeeItemId ---for the Fee Items resource and used to uniquely identify an instance of Fee Items. The client should not generate the hash key value. Instead, the client should query on the Fee Items collection resource with a filter on the primary key values in order to navigate to a specific instance of Fee Items.
  
  For example: publicSectorFeeItems?q=AgencyId=<value1>;FeeItemId=<value2>

Body ()

The following table describes the body parameters in the request for this task.

Root Schema : publicSectorFeeItems-item

Type: object

Show Source

• AgencyId(optional): integer(int64)
  Title: Agency ID

  The identifier for a public sector agency.
• CreatedBy(optional): string
  Title: Created By

  Maximum Length: 64

  The user who created the fee item.
• CreationDate(optional): string(date-time)
  Title: Creation Date

  The date when the fee item was created.
• DepartmentId(optional): string
  Title: Department

  Maximum Length: 30

  The department identifier for a fee item.
• Description(optional): string
  Title: Description

  Maximum Length: 50

  The description of the fee item.
• EnabledFlag(optional): boolean
  Title: Enabled

  Indicates whether this fee item is enabled for use or not. The default value is true.
• FeeItemId(optional): string
  Title: Fee Item

  Maximum Length: 30

  The unique identifier for a fee item.
• LastUpdateDate(optional): string(date-time)
  Title: Last Updated Date

  The date when the fee item was last updated.
• LastUpdatedBy(optional): string
  Title: Last Updated By

  Maximum Length: 64

  The user who last updated the fee item.
• links(optional): array Items
  Title: Items

  Link Relations
• RevrecDateOption(optional): string
  Maximum Length: 30

  Indicates the options for the revenue recognition accounting date.The options are fee paid, fee assessed, and fee refunded. The default value is none.

{
    "properties":{
        "AgencyId":{
            "format":"int64",
            "type":"integer",
            "description":"The identifier for a public sector agency.",
            "title":"Agency ID"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the fee item.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date when the fee item was created.",
            "title":"Creation Date"
        },
        "DepartmentId":{
            "maxLength":30,
            "type":"string",
            "description":"The department identifier for a fee item.",
            "title":"Department"
        },
        "Description":{
            "maxLength":50,
            "type":"string",
            "description":"The description of the fee item.",
            "title":"Description"
        },
        "EnabledFlag":{
            "type":"boolean",
            "description":"Indicates whether this fee item is enabled for use or not. The default value is true.",
            "title":"Enabled"
        },
        "FeeItemId":{
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier for a fee item.",
            "title":"Fee Item"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date when the fee item was last updated.",
            "title":"Last Updated Date"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the fee item.",
            "title":"Last Updated By"
        },
        "RevrecDateOption":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates the options for the revenue recognition accounting date.The options are fee paid, fee assessed, and fee refunded. The default value is none."
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : link

Type: object

Show Source

• href(optional): string
  Title: hyperlink reference

  The URI to the related resource.
• rel(optional): string
  Title: relation

  The name of the relation to the resource instance. Example: self.

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Back to Top

Response

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• application/json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : publicSectorFeeItems-item

Type: object

Show Source

• AgencyId(optional): integer(int64)
  Title: Agency ID

  The identifier for a public sector agency.
• CreatedBy(optional): string
  Title: Created By

  Maximum Length: 64

  The user who created the fee item.
• CreationDate(optional): string(date-time)
  Title: Creation Date

  The date when the fee item was created.
• DepartmentId(optional): string
  Title: Department

  Maximum Length: 30

  The department identifier for a fee item.
• Description(optional): string
  Title: Description

  Maximum Length: 50

  The description of the fee item.
• EnabledFlag(optional): boolean
  Title: Enabled

  Indicates whether this fee item is enabled for use or not. The default value is true.
• FeeItemId(optional): string
  Title: Fee Item

  Maximum Length: 30

  The unique identifier for a fee item.
• LastUpdateDate(optional): string(date-time)
  Title: Last Updated Date

  The date when the fee item was last updated.
• LastUpdatedBy(optional): string
  Title: Last Updated By

  Maximum Length: 64

  The user who last updated the fee item.
• links(optional): array Items
  Title: Items

  Link Relations
• RevrecDateOption(optional): string
  Maximum Length: 30

  Indicates the options for the revenue recognition accounting date.The options are fee paid, fee assessed, and fee refunded. The default value is none.

{
    "properties":{
        "AgencyId":{
            "format":"int64",
            "type":"integer",
            "description":"The identifier for a public sector agency.",
            "title":"Agency ID"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the fee item.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date when the fee item was created.",
            "title":"Creation Date"
        },
        "DepartmentId":{
            "maxLength":30,
            "type":"string",
            "description":"The department identifier for a fee item.",
            "title":"Department"
        },
        "Description":{
            "maxLength":50,
            "type":"string",
            "description":"The description of the fee item.",
            "title":"Description"
        },
        "EnabledFlag":{
            "type":"boolean",
            "description":"Indicates whether this fee item is enabled for use or not. The default value is true.",
            "title":"Enabled"
        },
        "FeeItemId":{
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier for a fee item.",
            "title":"Fee Item"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date when the fee item was last updated.",
            "title":"Last Updated Date"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the fee item.",
            "title":"Last Updated By"
        },
        "RevrecDateOption":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates the options for the revenue recognition accounting date.The options are fee paid, fee assessed, and fee refunded. The default value is none."
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : link

Type: object

Show Source

• href(optional): string
  Title: hyperlink reference

  The URI to the related resource.
• rel(optional): string
  Title: relation

  The name of the relation to the resource instance. Example: self.

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Back to Top