Jump to

• Request
• Response

Create a parcel value

post

/fscmRestApi/resources/11.13.18.05/publicSectorParcelValues

Request

Header Parameters

• Effective-Of:
  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.
• 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.
• Upsert-Mode:
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• CurrencyCode: string
  Title: Currency Code

  Maximum Length: 3

  The currency in which the parcel value is stated.
• EffectiveEndDate: string (date)
  Title: Effective End Date

  The date on which the parcel value is no longer valid.
• EffectiveStartDate: string (date)
  Title: Effective Start Date

  The date on which the parcel value becomes valid.
• FixtureExemption: number
  Title: Fixture Exemption

  The exempted fixture information of the parcel.
• Fixtures: number
  Title: Fixtures

  The fixtures associated with the parcel.
• ImprovementValue: number
  Title: Improvement Value

  The improvement value of the parcel.
• LandValue: number
  Title: Land Value

  The land value of the parcel.
• NetAssessedValues: number
  Title: Net Assessed Value

  The net assessed value of the parcel.
• OtherExemption: number
  Title: Other Exemption

  Any additional exemptions for the parcel.
• OwnerExemption: number
  Title: Owner Exemption

  The exempted owner information of the parcel.
• ParcelId: integer (int64)
  The unique identifier for the parcel.
• ParcelIdEntered: string
  Title: Parcel Number

  Maximum Length: 50

  The parcel number.
• ParcelSizeOne: number
  Title: Parcel Size 1

  The first parcel size.
• ParcelSizeOneUOM: string
  Title: Parcel Size 1 UOM

  Maximum Length: 5

  The unit of measure for the first parcel size.
• ParcelSizeTwo: number
  Title: Parcel Size 2

  The second parcel size.
• ParcelSizeTwoUOM: string
  Title: Parcel Size 2 UOM

  Maximum Length: 5

  The unit of measure for the second parcel size.
• PersonalPropertyValue: number
  Title: Personal Property Value

  The personal property value of the parcel.
• PropertyUseCode: string
  Title: Property Use Code

  Maximum Length: 30

  The property use code of the parcel.

{
    "type":"object",
    "properties":{
        "ParcelId":{
            "type":"integer",
            "description":"The unique identifier for the parcel.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "EffectiveEndDate":{
            "title":"Effective End Date",
            "type":"string",
            "description":"The date on which the parcel value is no longer valid.",
            "format":"date",
            "nullable":false
        },
        "OwnerExemption":{
            "title":"Owner Exemption",
            "type":"number",
            "description":"The exempted owner information of the parcel.",
            "nullable":true
        },
        "PropertyUseCode":{
            "title":"Property Use Code",
            "maxLength":30,
            "type":"string",
            "description":"The property use code of the parcel.",
            "nullable":true
        },
        "ParcelSizeTwoUOM":{
            "title":"Parcel Size 2 UOM",
            "maxLength":5,
            "type":"string",
            "description":"The unit of measure for the second parcel size.",
            "nullable":true
        },
        "OtherExemption":{
            "title":"Other Exemption",
            "type":"number",
            "description":"Any additional exemptions for the parcel.",
            "nullable":true
        },
        "ImprovementValue":{
            "title":"Improvement Value",
            "type":"number",
            "description":"The improvement value of the parcel.",
            "nullable":true
        },
        "ParcelSizeOne":{
            "title":"Parcel Size 1",
            "type":"number",
            "description":"The first parcel size.",
            "nullable":true,
            "x-hints":{
                "precision":20,
                "scale":5
            }
        },
        "FixtureExemption":{
            "title":"Fixture Exemption",
            "type":"number",
            "description":"The exempted fixture information of the parcel.",
            "nullable":true
        },
        "PersonalPropertyValue":{
            "title":"Personal Property Value",
            "type":"number",
            "description":"The personal property value of the parcel.",
            "nullable":true
        },
        "CurrencyCode":{
            "title":"Currency Code",
            "maxLength":3,
            "type":"string",
            "description":"The currency in which the parcel value is stated.",
            "nullable":true
        },
        "ParcelSizeTwo":{
            "title":"Parcel Size 2",
            "type":"number",
            "description":"The second parcel size.",
            "nullable":true,
            "x-hints":{
                "precision":20,
                "scale":5
            }
        },
        "Fixtures":{
            "title":"Fixtures",
            "type":"number",
            "description":"The fixtures associated with the parcel.",
            "nullable":true
        },
        "ParcelIdEntered":{
            "title":"Parcel Number",
            "maxLength":50,
            "type":"string",
            "description":"The parcel number.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "LandValue":{
            "title":"Land Value",
            "type":"number",
            "description":"The land value of the parcel.",
            "nullable":true
        },
        "NetAssessedValues":{
            "title":"Net Assessed Value",
            "type":"number",
            "description":"The net assessed value of the parcel.",
            "nullable":true
        },
        "ParcelSizeOneUOM":{
            "title":"Parcel Size 1 UOM",
            "maxLength":5,
            "type":"string",
            "description":"The unit of measure for the first parcel size.",
            "nullable":true
        },
        "EffectiveStartDate":{
            "title":"Effective Start Date",
            "type":"string",
            "description":"The date on which the parcel value becomes valid.",
            "format":"date",
            "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 : publicSectorParcelValues-item-response

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the parcel value.
• CreationDate: string (date-time)
  Read Only: true

  The date and time that the parcel value was created.
• CurrencyCode: string
  Title: Currency Code

  Maximum Length: 3

  The currency in which the parcel value is stated.
• EffectiveEndDate: string (date)
  Title: Effective End Date

  The date on which the parcel value is no longer valid.
• EffectiveStartDate: string (date)
  Title: Effective Start Date

  The date on which the parcel value becomes valid.
• FixtureExemption: number
  Title: Fixture Exemption

  The exempted fixture information of the parcel.
• Fixtures: number
  Title: Fixtures

  The fixtures associated with the parcel.
• ImprovementValue: number
  Title: Improvement Value

  The improvement value of the parcel.
• LandValue: number
  Title: Land Value

  The land value of the parcel.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date and time that the parcel value was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the parcel value.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• NetAssessedValues: number
  Title: Net Assessed Value

  The net assessed value of the parcel.
• OtherExemption: number
  Title: Other Exemption

  Any additional exemptions for the parcel.
• OwnerExemption: number
  Title: Owner Exemption

  The exempted owner information of the parcel.
• ParcelId: integer (int64)
  The unique identifier for the parcel.
• ParcelIdEntered: string
  Title: Parcel Number

  Maximum Length: 50

  The parcel number.
• ParcelSizeOne: number
  Title: Parcel Size 1

  The first parcel size.
• ParcelSizeOneUOM: string
  Title: Parcel Size 1 UOM

  Maximum Length: 5

  The unit of measure for the first parcel size.
• ParcelSizeTwo: number
  Title: Parcel Size 2

  The second parcel size.
• ParcelSizeTwoUOM: string
  Title: Parcel Size 2 UOM

  Maximum Length: 5

  The unit of measure for the second parcel size.
• PersonalPropertyValue: number
  Title: Personal Property Value

  The personal property value of the parcel.
• PropertyUseCode: string
  Title: Property Use Code

  Maximum Length: 30

  The property use code of the parcel.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the parcel value.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time that the parcel value was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ParcelId":{
            "type":"integer",
            "description":"The unique identifier for the parcel.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the parcel value.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EffectiveEndDate":{
            "title":"Effective End Date",
            "type":"string",
            "description":"The date on which the parcel value is no longer valid.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "OwnerExemption":{
            "title":"Owner Exemption",
            "type":"number",
            "description":"The exempted owner information of the parcel.",
            "nullable":true,
            "x-queryable":true
        },
        "PropertyUseCode":{
            "title":"Property Use Code",
            "maxLength":30,
            "type":"string",
            "description":"The property use code of the parcel.",
            "nullable":true,
            "x-queryable":true
        },
        "ParcelSizeTwoUOM":{
            "title":"Parcel Size 2 UOM",
            "maxLength":5,
            "type":"string",
            "description":"The unit of measure for the second parcel size.",
            "nullable":true,
            "x-queryable":true
        },
        "OtherExemption":{
            "title":"Other Exemption",
            "type":"number",
            "description":"Any additional exemptions for the parcel.",
            "nullable":true,
            "x-queryable":true
        },
        "ImprovementValue":{
            "title":"Improvement Value",
            "type":"number",
            "description":"The improvement value of the parcel.",
            "nullable":true,
            "x-queryable":true
        },
        "ParcelSizeOne":{
            "title":"Parcel Size 1",
            "type":"number",
            "description":"The first parcel size.",
            "nullable":true,
            "x-hints":{
                "precision":20,
                "scale":5
            },
            "x-queryable":true
        },
        "FixtureExemption":{
            "title":"Fixture Exemption",
            "type":"number",
            "description":"The exempted fixture information of the parcel.",
            "nullable":true,
            "x-queryable":true
        },
        "PersonalPropertyValue":{
            "title":"Personal Property Value",
            "type":"number",
            "description":"The personal property value of the parcel.",
            "nullable":true,
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency Code",
            "maxLength":3,
            "type":"string",
            "description":"The currency in which the parcel value is stated.",
            "nullable":true,
            "x-queryable":true
        },
        "ParcelSizeTwo":{
            "title":"Parcel Size 2",
            "type":"number",
            "description":"The second parcel size.",
            "nullable":true,
            "x-hints":{
                "precision":20,
                "scale":5
            },
            "x-queryable":true
        },
        "Fixtures":{
            "title":"Fixtures",
            "type":"number",
            "description":"The fixtures associated with the parcel.",
            "nullable":true,
            "x-queryable":true
        },
        "ParcelIdEntered":{
            "title":"Parcel Number",
            "maxLength":50,
            "type":"string",
            "description":"The parcel number.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LandValue":{
            "title":"Land Value",
            "type":"number",
            "description":"The land value of the parcel.",
            "nullable":true,
            "x-queryable":true
        },
        "NetAssessedValues":{
            "title":"Net Assessed Value",
            "type":"number",
            "description":"The net assessed value of the parcel.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ParcelSizeOneUOM":{
            "title":"Parcel Size 1 UOM",
            "maxLength":5,
            "type":"string",
            "description":"The unit of measure for the first parcel size.",
            "nullable":true,
            "x-queryable":true
        },
        "EffectiveStartDate":{
            "title":"Effective Start Date",
            "type":"string",
            "description":"The date on which the parcel value becomes valid.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time that the parcel value 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