Jump to

• Request
• Response

Update a fee item

patch

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

Request

Path Parameters

• publicSectorFeeItemsUniqID(required): string
  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>

Header Parameters

• Metadata-Context:
  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".
• REST-Framework-Version:
  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

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• DepartmentId: string
  Title: Department

  Maximum Length: 30

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

  Maximum Length: 50

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

  Maximum Length: 1

  Indicates whether this fee item is enabled for use or not. The default value is true.
• RevrecDateOption: 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.

{
    "type":"object",
    "properties":{
        "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.",
            "nullable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"50",
            "type":"string",
            "description":"The description of the fee item.",
            "nullable":false
        },
        "DepartmentId":{
            "title":"Department",
            "maxLength":"30",
            "type":"string",
            "description":"The department identifier for a fee item.",
            "nullable":true
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether this fee item is enabled for use or not. The default value is true.",
            "nullable":false
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  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".
• REST-Framework-Version:
  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 : publicSectorFeeItems-item-response

Type: object

Show Source

• AgencyId: integer
  Title: Agency ID

  Default Value: 1

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

  Read Only: true

  Maximum Length: 64

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

  Read Only: true

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

  Maximum Length: 30

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

  Maximum Length: 50

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

  Maximum Length: 1

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

  Maximum Length: 30

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

  Read Only: true

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

  Read Only: true

  Maximum Length: 64

  The user who last updated the fee item.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• RevrecDateOption: 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.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the fee item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the fee item was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FeeItemId":{
            "title":"Fee Item",
            "maxLength":"30",
            "type":"string",
            "description":"The unique identifier for a fee item.",
            "nullable":false,
            "x-queryable":true
        },
        "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.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the fee item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"50",
            "type":"string",
            "description":"The description of the fee item.",
            "nullable":false,
            "x-queryable":true
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The identifier for a public sector agency.",
            "nullable":false,
            "default":"1",
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "DepartmentId":{
            "title":"Department",
            "maxLength":"30",
            "type":"string",
            "description":"The department identifier for a fee item.",
            "nullable":true,
            "x-queryable":true
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether this fee item is enabled for use or not. The default value is true.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the fee item was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

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

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top