Jump to

• Request
• Response

Update a fee record summary by project

patch

/fscmRestApi/resources/11.13.18.05/publicSectorProjectOverviewFees/{publicSectorProjectOverviewFeesUniqID}

Request

Path Parameters

• publicSectorProjectOverviewFeesUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- AgencyId and ProjectCode ---for the Project Overview Fees resource and used to uniquely identify an instance of Project Overview Fees. The client should not generate the hash key value. Instead, the client should query on the Project Overview Fees collection resource with a filter on the primary key values in order to navigate to a specific instance of Project Overview Fees.
  
  For example: publicSectorProjectOverviewFees?q=AgencyId=<value1>;ProjectCode=<value2>

Header Parameters

• Metadata-Context: string
  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: string
  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

{
    "type":"object",
    "properties":{
    }
}

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 : publicSectorProjectOverviewFees-item-response

Type: object

Show Source

• AgencyId: integer
  Read Only: true

  The unique identifier of the public sector agency.
• CurrencyCode: string
  Read Only: true

  Maximum Length: 3

  The default currency code for the fee schedule.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ProjectCode: string
  Read Only: true

  Maximum Length: 30

  The unique identifier of the project.
• Total: number
  Read Only: true

  The sum of fee amounts for the record.
• TotalDue: number
  Read Only: true

  The sum of fee amounts for the record, with the fee status as due.
• TotalEstimated: number
  Read Only: true

  The total fees estimated for the application.
• TotalInReview: number
  Read Only: true

  The sum of fee amounts for a record that are in Pending or Hold statuses.
• TotalNotPayable: number
  Read Only: true

  The sum of fee amounts for a record that are in Waived or Cancelled statuses.
• TotalPaid: number
  Read Only: true

  The sum of fee amounts for the record, with the fee status as paid.
• TotalPayable: number
  Read Only: true

  The sum of fee amounts for the record, with the fee status as payable.
• TotalPaymentsInProcess: number
  Read Only: true

  The total fee amount that is processing through the payment service.

{
    "type":"object",
    "properties":{
        "AgencyId":{
            "type":"integer",
            "description":"The unique identifier of the public sector agency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrencyCode":{
            "maxLength":3,
            "type":"string",
            "description":"The default currency code for the fee schedule.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProjectCode":{
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier of the project.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Total":{
            "type":"number",
            "description":"The sum of fee amounts for the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TotalDue":{
            "type":"number",
            "description":"The sum of fee amounts for the record, with the fee status as due.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TotalEstimated":{
            "type":"number",
            "description":"The total fees estimated for the application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TotalInReview":{
            "type":"number",
            "description":"The sum of fee amounts for a record that are in Pending or Hold statuses.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TotalNotPayable":{
            "type":"number",
            "description":"The sum of fee amounts for a record that are in Waived or Cancelled statuses.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TotalPaid":{
            "type":"number",
            "description":"The sum of fee amounts for the record, with the fee status as paid.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TotalPayable":{
            "type":"number",
            "description":"The sum of fee amounts for the record, with the fee status as payable.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TotalPaymentsInProcess":{
            "type":"number",
            "description":"The total fee amount that is processing through the payment service.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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