Jump to

• Request
• Response

Get all project parcels

get

/fscmRestApi/resources/11.13.18.05/publicSectorProjects/{publicSectorProjectsUniqID}/child/ProjectParcel

Request

Path Parameters

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

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• finder: string
  Used as a predefined finder to search the collection.
  
  Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables:
  
  

  • PrimaryKey: Finds a project parcel by the primary key criteria.
    Finder Variables:
    • ParcelKey; integer; The unique identifier for a project parcel.
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • AgencyId; integer; The unique identifier for a public sector agency.
  • BlockNum; string; The block number of the parcel in the Detail Land Information, which is part of the Assessor Parcel Number (APN).
  • BookNum; string; The book number of the parcel in the Detail Land Information, which is part of the Assessor Parcel Number (APN).
  • BoundaryDescription; string; A textual description of the property boundaries. This is not a listing of coordinates. For example, SMITH LOT - COME E 155 FT FROM SW CORNER OF LOT 206 THEN 77.5 FT N TO A LINE WHICH EXTENDS FROM A PT N 309.91 FT AND E 55.25 FT FROM BEG TO A PT E 155 FT FROM LOT 206.
  • CoordinateX; number; The x-axis coordinate for the project parcel.
  • CoordinateY; number; The y-axis coordinate for the project parcel.
  • CreatedBy; string; The user who created the project parcel.
  • CreationDate; string; The date when the project parcel was created.
  • DistrictName; string; The district name of the parcel.
  • Jurisdiction; string; The name of the city, if incorporated, or the name of the county, if unincorporated.
  • LandUseCode; string; The land use code of the parcel in the Detail Land Information, which is part of the Assessor Parcel Number (APN).
  • LastUpdateDate; string; The user who last updated the project parcel.
  • LastUpdateLogin; string; The login ID of the user who last updated the project parcel.
  • LastUpdatedBy; string; The date when the project parcel was last updated.
  • Latitude; number; The geographic location of the parcel that is north or south of the equator.
  • Longitude; number; The geographic location of the parcel address that is east or west of the meridian. It typically points to a specific entrance area within a large parcel, for example, a security checkpoint gate, delivery entrance, or employee entrance.
  • LotNum; string; The lot number of the parcel in the Detail Land Information, which is part of the Assessor Parcel Number (APN).
  • MapBookPage; string; The recorded map book and page.
  • MapName; string; The recorded map name. For example, Public Works.
  • PageNum; string; The page number of the parcel in the Detail Land Information, which is part of the Assessor Parcel Number (APN).
  • ParcelId; integer; The identifier for the project parcel.
  • ParcelIdEntered; string; The identifier for the project parcel.
  • ParcelKey; integer; The unique identifier for the project parcel.
  • ParcelType; string; The type of the parcel. For example, commercial, residential, or government.
  • ParentParcelId; integer; The unique identifier for the parent parcel.
  • PrimaryFlag; boolean; Indicates the primary project parcel. If the value is Y, then the parcel is the primary parcel. The default value is N.
  • PrimaryZoningId; string; The primary zoning ID of the zoning for the parcel.
  • ProjectCode; string; The unique identifier for a project.
  • PropertyDescription; string; The property description.
  • SectionNum; string; The section number of the parcel in the Detail Land Information, which is part of the Assessor Parcel Number (APN).
  • Srid; integer; The GIS coordinate system in use.
  • Subdivision; string; The subdivision of the parcel in the Detail Land Information, which is part of the Assessor Parcel Number (APN).
  • UnitNum; string; The unit number of the parcel in the Detail Land Information, which is part of the Assessor Parcel Number (APN).
  • ZoningDescription; string; The zoning description.
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

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.

There's no request body for this operation.

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 : publicSectorProjects-ProjectParcel

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/publicSectorProjects-ProjectParcel-item-response"
            }
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object publicSectorProjects-ProjectParcel-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/publicSectorProjects-ProjectParcel-item-response"
    }
}

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 : publicSectorProjects-ProjectParcel-item-response

Type: object

Show Source

• AgencyId: integer (int32)
  Default Value: 1

  The unique identifier for a public sector agency.
• BlockNum: string
  Title: Block Number

  Maximum Length: 30

  The block number of the parcel in the Detail Land Information, which is part of the Assessor Parcel Number (APN).
• BookNum: string
  Title: Book Number

  Maximum Length: 30

  The book number of the parcel in the Detail Land Information, which is part of the Assessor Parcel Number (APN).
• BoundaryDescription: string
  Title: Boundary Description

  Maximum Length: 480

  A textual description of the property boundaries. This is not a listing of coordinates. For example, SMITH LOT - COME E 155 FT FROM SW CORNER OF LOT 206 THEN 77.5 FT N TO A LINE WHICH EXTENDS FROM A PT N 309.91 FT AND E 55.25 FT FROM BEG TO A PT E 155 FT FROM LOT 206.
• CoordinateX: number
  Title: X Coordinate

  The x-axis coordinate for the project parcel.
• CoordinateY: number
  Title: Y Coordinate

  The y-axis coordinate for the project parcel.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

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

  Read Only: true

  The date when the project parcel was created.
• DistrictName: string
  Maximum Length: 50

  The district name of the parcel.
• Jurisdiction: string
  Title: Jurisdiction

  Maximum Length: 50

  The name of the city, if incorporated, or the name of the county, if unincorporated.
• LandUseCode: string
  Title: Land Use Code

  Maximum Length: 30

  The land use code of the parcel in the Detail Land Information, which is part of the Assessor Parcel Number (APN).
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The user who last updated the project parcel.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The date when the project parcel was last updated.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The login ID of the user who last updated the project parcel.
• Latitude: number
  Title: Latitude

  The geographic location of the parcel that is north or south of the equator.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Longitude: number
  Title: Longitude

  The geographic location of the parcel address that is east or west of the meridian. It typically points to a specific entrance area within a large parcel, for example, a security checkpoint gate, delivery entrance, or employee entrance.
• LotNum: string
  Title: Lot Number

  Maximum Length: 30

  The lot number of the parcel in the Detail Land Information, which is part of the Assessor Parcel Number (APN).
• MapBookPage: string
  Title: Map Book Page

  Maximum Length: 50

  The recorded map book and page.
• MapName: string
  Title: Map Name

  Maximum Length: 50

  The recorded map name. For example, Public Works.
• PageNum: string
  Title: Page Number

  Maximum Length: 30

  The page number of the parcel in the Detail Land Information, which is part of the Assessor Parcel Number (APN).
• ParcelId: integer (int64)
  Title: Parcel ID

  The identifier for the project parcel.
• ParcelIdEntered: string
  Title: Parcel ID

  Maximum Length: 50

  The identifier for the project parcel.
• ParcelKey: integer (int64)
  The unique identifier for the project parcel.
• ParcelType: string
  Title: Parcel Type

  Maximum Length: 30

  The type of the parcel. For example, commercial, residential, or government.
• ParentParcelId: integer (int64)
  Title: Parent Parcel ID

  The unique identifier for the parent parcel.
• PrimaryFlag: boolean
  Title: Primary

  Maximum Length: 1

  Default Value: false

  Indicates the primary project parcel. If the value is Y, then the parcel is the primary parcel. The default value is N.
• PrimaryZoningId: string
  Title: Primary Zoning ID

  Maximum Length: 30

  The primary zoning ID of the zoning for the parcel.
• PrjParcelOwner: array Project Parcel Owners
  Title: Project Parcel Owners

  The resource is used to create, view, or update the project parcel owners related to a project.
• ProjectAddress: array Project Addresses
  Title: Project Addresses

  The resource is used to create, view, or update the project parcel addresses related to a project.
• ProjectCode: string
  Title: Project ID

  Maximum Length: 30

  The unique identifier for a project.
• PropertyDescription: string
  Title: Property Description

  Maximum Length: 240

  The property description.
• SectionNum: string
  Title: Section Number

  Maximum Length: 30

  The section number of the parcel in the Detail Land Information, which is part of the Assessor Parcel Number (APN).
• Srid: integer (int64)
  Title: SRID

  The GIS coordinate system in use.
• Subdivision: string
  Title: Subdivision

  Maximum Length: 30

  The subdivision of the parcel in the Detail Land Information, which is part of the Assessor Parcel Number (APN).
• UnitNum: string
  Title: Unit Number

  Maximum Length: 30

  The unit number of the parcel in the Detail Land Information, which is part of the Assessor Parcel Number (APN).
• ZoningDescription: string
  Title: Zoning Description

  Maximum Length: 240

  The zoning description.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the project parcel was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryFlag":{
            "title":"Primary",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates the primary project parcel. If the value is Y, then the parcel is the primary parcel. The default value is N.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "PrjParcelOwner":{
            "title":"Project Parcel Owners",
            "type":"array",
            "description":"The resource is used to create, view, or update the project parcel owners related to a project.",
            "items":{
                "$ref":"#/components/schemas/publicSectorProjects-ProjectParcel-PrjParcelOwner-item-response"
            }
        },
        "AgencyId":{
            "type":"integer",
            "description":"The unique identifier for a public sector agency.",
            "format":"int32",
            "nullable":false,
            "default":1,
            "x-hints":{
                "precision":8
            },
            "x-queryable":true
        },
        "PageNum":{
            "title":"Page Number",
            "maxLength":30,
            "type":"string",
            "description":"The page number of the parcel in the Detail Land Information, which is part of the Assessor Parcel Number (APN).",
            "nullable":true,
            "x-queryable":true
        },
        "Latitude":{
            "title":"Latitude",
            "type":"number",
            "description":"The geographic location of the parcel that is north or south of the equator.",
            "nullable":true,
            "x-queryable":true
        },
        "ParentParcelId":{
            "title":"Parent Parcel ID",
            "type":"integer",
            "description":"The unique identifier for the parent parcel.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ProjectAddress":{
            "title":"Project Addresses",
            "type":"array",
            "description":"The resource is used to create, view, or update the project parcel addresses related to a project.",
            "items":{
                "$ref":"#/components/schemas/publicSectorProjects-ProjectParcel-ProjectAddress-item-response"
            }
        },
        "LotNum":{
            "title":"Lot Number",
            "maxLength":30,
            "type":"string",
            "description":"The lot number of the parcel in the Detail Land Information, which is part of the Assessor Parcel Number (APN).",
            "nullable":true,
            "x-queryable":true
        },
        "MapBookPage":{
            "title":"Map Book Page",
            "maxLength":50,
            "type":"string",
            "description":"The recorded map book and page.",
            "nullable":true,
            "x-queryable":true
        },
        "ParcelIdEntered":{
            "title":"Parcel ID",
            "maxLength":50,
            "type":"string",
            "description":"The identifier for the project parcel.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ParcelKey":{
            "type":"integer",
            "description":"The unique identifier for the project parcel.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ProjectCode":{
            "title":"Project ID",
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier for a project.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The date when the project parcel was last updated.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ParcelType":{
            "title":"Parcel Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of the parcel. For example, commercial, residential, or government.",
            "nullable":true,
            "x-queryable":true
        },
        "ParcelId":{
            "title":"Parcel ID",
            "type":"integer",
            "description":"The identifier for the project parcel.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the project parcel.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "BlockNum":{
            "title":"Block Number",
            "maxLength":30,
            "type":"string",
            "description":"The block number of the parcel in the Detail Land Information, which is part of the Assessor Parcel Number (APN).",
            "nullable":true,
            "x-queryable":true
        },
        "UnitNum":{
            "title":"Unit Number",
            "maxLength":30,
            "type":"string",
            "description":"The unit number of the parcel in the Detail Land Information, which is part of the Assessor Parcel Number (APN).",
            "nullable":true,
            "x-queryable":true
        },
        "Subdivision":{
            "title":"Subdivision",
            "maxLength":30,
            "type":"string",
            "description":"The subdivision of the parcel in the Detail Land Information, which is part of the Assessor Parcel Number (APN).",
            "nullable":true,
            "x-queryable":true
        },
        "Longitude":{
            "title":"Longitude",
            "type":"number",
            "description":"The geographic location of the parcel address that is east or west of the meridian. It typically points to a specific entrance area within a large parcel, for example, a security checkpoint gate, delivery entrance, or employee entrance.",
            "nullable":true,
            "x-queryable":true
        },
        "BookNum":{
            "title":"Book Number",
            "maxLength":30,
            "type":"string",
            "description":"The book number of the parcel in the Detail Land Information, which is part of the Assessor Parcel Number (APN).",
            "nullable":true,
            "x-queryable":true
        },
        "ZoningDescription":{
            "title":"Zoning Description",
            "maxLength":240,
            "type":"string",
            "description":"The zoning description.",
            "nullable":true,
            "x-queryable":true
        },
        "Jurisdiction":{
            "title":"Jurisdiction",
            "maxLength":50,
            "type":"string",
            "description":"The name of the city, if incorporated, or the name of the county, if  unincorporated.",
            "nullable":true,
            "x-queryable":true
        },
        "PropertyDescription":{
            "title":"Property Description",
            "maxLength":240,
            "type":"string",
            "description":"The property description.",
            "nullable":true,
            "x-queryable":true
        },
        "DistrictName":{
            "maxLength":50,
            "type":"string",
            "description":"The district name of the parcel.",
            "nullable":true,
            "x-queryable":true
        },
        "MapName":{
            "title":"Map Name",
            "maxLength":50,
            "type":"string",
            "description":"The recorded map name. For example, Public Works.",
            "nullable":true,
            "x-queryable":true
        },
        "SectionNum":{
            "title":"Section Number",
            "maxLength":30,
            "type":"string",
            "description":"The section number of the parcel in the Detail Land Information, which is part of the Assessor Parcel Number (APN).",
            "nullable":true,
            "x-queryable":true
        },
        "CoordinateX":{
            "title":"X Coordinate",
            "type":"number",
            "description":"The x-axis coordinate for the project parcel.",
            "nullable":true,
            "x-queryable":true
        },
        "LandUseCode":{
            "title":"Land Use Code",
            "maxLength":30,
            "type":"string",
            "description":"The land use code of the parcel in the Detail Land Information, which is part of the Assessor Parcel Number (APN).",
            "nullable":true,
            "x-queryable":true
        },
        "Srid":{
            "title":"SRID",
            "type":"integer",
            "description":"The GIS coordinate system in use.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":10
            },
            "x-queryable":true
        },
        "CoordinateY":{
            "title":"Y Coordinate",
            "type":"number",
            "description":"The y-axis coordinate for the project parcel.",
            "nullable":true,
            "x-queryable":true
        },
        "PrimaryZoningId":{
            "title":"Primary Zoning ID",
            "maxLength":30,
            "type":"string",
            "description":"The primary zoning ID of the zoning for the parcel.",
            "nullable":true,
            "x-queryable":true
        },
        "BoundaryDescription":{
            "title":"Boundary Description",
            "maxLength":480,
            "type":"string",
            "description":"A textual description of the property boundaries. This is not a listing of coordinates. For example, SMITH LOT - COME E 155 FT FROM SW CORNER OF LOT 206 THEN 77.5 FT N TO A LINE WHICH EXTENDS FROM A PT N 309.91 FT AND E 55.25 FT FROM BEG TO A PT E 155 FT FROM LOT 206.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The user who last updated the project parcel.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The login ID of the user who last updated the project parcel.",
            "nullable":true,
            "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 : Project Parcel Owners

Type: array

Title: Project Parcel Owners

The resource is used to create, view, or update the project parcel owners related to a project.

Show Source

• Array of: object publicSectorProjects-ProjectParcel-PrjParcelOwner-item-response

{
    "title":"Project Parcel Owners",
    "type":"array",
    "description":"The resource is used to create, view, or update the project parcel owners related to a project.",
    "items":{
        "$ref":"#/components/schemas/publicSectorProjects-ProjectParcel-PrjParcelOwner-item-response"
    }
}

Nested Schema : Project Addresses

Type: array

Title: Project Addresses

The resource is used to create, view, or update the project parcel addresses related to a project.

Show Source

• Array of: object publicSectorProjects-ProjectParcel-ProjectAddress-item-response

{
    "title":"Project Addresses",
    "type":"array",
    "description":"The resource is used to create, view, or update the project parcel addresses related to a project.",
    "items":{
        "$ref":"#/components/schemas/publicSectorProjects-ProjectParcel-ProjectAddress-item-response"
    }
}

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."
        }
    }
}

Nested Schema : publicSectorProjects-ProjectParcel-PrjParcelOwner-item-response

Type: object

Show Source

• Address1: string
  Title: Address

  Maximum Length: 240

  The first or main address of the project parcel owner.
• Address2: string
  Title: Address Line 2

  Maximum Length: 240

  The second address of the project parcel owner, if present.
• Address3: string
  Title: Address Line 3

  Maximum Length: 240

  The third address of the project parcel owner, if present.
• Address4: string
  Title: Address Line 4

  Maximum Length: 240

  The fourth address of the project parcel owner, if present.
• AddressField1: string
  Title: Address Field 1

  Maximum Length: 20

  The address field of the project parcel owner search.
• AddressField2: string
  Title: Address Field 2

  Maximum Length: 20

  The address field of the project parcel owner search.
• AddressField3: string
  Title: Address Field 3

  Maximum Length: 20

  The address field of the project parcel owner search.
• AgencyId: integer (int32)
  Default Value: 1

  The unique identifier for a public sector agency.
• BuildingType: string
  Title: Building Type

  Maximum Length: 20

  The building type in the project parcel owner search. For example, Tower A or Block 3.
• CellPhoneCountry: string
  Title: Cell Phone Country Code

  Maximum Length: 10

  The cell phone country code of the project parcel owner.
• CellPhoneNum: string
  Title: Cell Phone Number

  Maximum Length: 40

  The cell phone number of the project parcel owner.
• City: string
  Title: City

  Maximum Length: 60

  The city of the project parcel owner address.
• Country: string
  Title: Country

  Maximum Length: 60

  The country of the project parcel owner address.
• County: string
  Title: County

  Maximum Length: 60

  The county of the project parcel owner address.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the project parcel owner.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the project parcel owner was created.
• DocumentNum: string
  Title: Document Number

  Maximum Length: 50

  The document number of the project parcel owner.
• EmailId: string
  Title: Email Address

  Maximum Length: 50

  The email ID of the project parcel owner.
• FaxCountry: string
  Title: Fax Country Code

  Maximum Length: 10

  The fax country code of the project parcel owner.
• FaxNum: string
  Title: Fax Number

  Maximum Length: 40

  The fax number of the project parcel owner.
• Floor: string
  Title: Floor

  Maximum Length: 20

  The floor of the building. For example, mezzanine level, penthouse, or garage level C.
• HomePhoneCountry: string
  Title: Home Phone Country Code

  Maximum Length: 10

  The home phone country code of the project parcel owner.
• HomePhoneNum: string
  Title: Home Phone Number

  Maximum Length: 40

  The home phone number of the project parcel owner.
• LastTransferDate: string (date)
  Title: Last Transfer Date

  The last transfer date of the project parcel owner.
• LastTransferType: string
  Title: Last Transfer Type

  Maximum Length: 50

  The last transfer type of the project parcel owner.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The user who last updated the project parcel owner.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The date when the project parcel owner was last updated.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The login ID of the user who last updated the project parcel owner.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Name1: string
  Title: Name 1

  Maximum Length: 150

  The first name of the parcel owner.
• Name2: string
  Title: Name 2

  Maximum Length: 150

  The second name of the parcel owner.
• OwnerId: integer (int64)
  Title: Owner ID

  The identifier of the parcel owner.
• OwnerKey: integer (int64)
  Title: Owner ID

  The unique identifier for the project parcel owner.
• OwnerType: string
  Title: Owner Type

  Maximum Length: 20

  The type of parcel owner.
• ParcelId: integer (int64)
  Title: Parcel ID

  The identifier of the parcel.
• ParcelKey: integer (int64)
  Title: Parcel ID

  The unique identifier for the project parcel.
• PostalCode: string
  Title: Postal Code

  Maximum Length: 60

  The postal code of the project parcel owner address.
• PostalPlus4Code: string
  Title: Postal Plus 4 Code

  Maximum Length: 20

  The postal plus four code of the project parcel owner address.
• PrimaryFlag: boolean
  Title: Primary

  Maximum Length: 1

  Default Value: false

  Indicates the primary project parcel owner. If the value is Y, then the parcel owner is the primary parcel owner. The default value is N.
• ProjectCode: string
  Title: Project ID

  Maximum Length: 30

  The unique identifier for a project.
• Province: string
  Title: Province

  Maximum Length: 60

  The province of the project parcel owner address.
• State: string
  Title: State

  Maximum Length: 60

  The state of the project parcel owner address.
• StreetDirection: string
  Title: Street Direction

  Maximum Length: 10

  The street direction of the address in an project parcel owner search. Values are compass directions, such as N, S, E, W, NW, SE, and so on.
• StreetName: string
  Title: Street Name

  Maximum Length: 240

  The street name of the address in the project parcel owner search.
• StreetNumber: string
  Title: Street Name

  Maximum Length: 20

  The street number of the address in the project parcel owner search.
• StreetType: string
  Title: Street Type

  Maximum Length: 20

  The street type of the address in the project parcel owner search. For example, alley, boulevard, avenue, lane, street, loop, and so on.
• UnitNumber: string
  Title: Unit Number

  Maximum Length: 30

  The exact unit in a building. For example, Apartment 208A or Suite 300.
• WorkPhoneCountry: string
  Title: Work Phone Country Code

  Maximum Length: 10

  The work phone country code of the project parcel owner.
• WorkPhoneNum: string
  Title: Work Phone Number

  Maximum Length: 40

  The work phone number of the project parcel owner.

{
    "type":"object",
    "properties":{
        "StreetName":{
            "title":"Street Name",
            "maxLength":240,
            "type":"string",
            "description":"The street name of the address in the project parcel owner search.",
            "nullable":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the project parcel owner was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CellPhoneCountry":{
            "title":"Cell Phone Country Code",
            "maxLength":10,
            "type":"string",
            "description":"The cell phone country code of the project parcel owner.",
            "nullable":true,
            "x-queryable":true
        },
        "FaxCountry":{
            "title":"Fax Country Code",
            "maxLength":10,
            "type":"string",
            "description":"The fax country code of the project parcel owner.",
            "nullable":true,
            "x-queryable":true
        },
        "OwnerType":{
            "title":"Owner Type",
            "maxLength":20,
            "type":"string",
            "description":"The type of parcel owner.",
            "nullable":true,
            "x-queryable":true
        },
        "BuildingType":{
            "title":"Building Type",
            "maxLength":20,
            "type":"string",
            "description":"The building type in the project parcel owner search. For example, Tower A or Block 3.",
            "nullable":true,
            "x-queryable":true
        },
        "WorkPhoneCountry":{
            "title":"Work Phone Country Code",
            "maxLength":10,
            "type":"string",
            "description":"The work phone country code of the project parcel owner.",
            "nullable":true,
            "x-queryable":true
        },
        "StreetNumber":{
            "title":"Street Name",
            "maxLength":20,
            "type":"string",
            "description":"The street number of the address in the project parcel owner search.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ParcelKey":{
            "title":"Parcel ID",
            "type":"integer",
            "description":"The unique identifier for the project parcel.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Name1":{
            "title":"Name 1",
            "maxLength":150,
            "type":"string",
            "description":"The first name of the parcel owner.",
            "nullable":true,
            "x-queryable":true
        },
        "Name2":{
            "title":"Name 2",
            "maxLength":150,
            "type":"string",
            "description":"The second name of the parcel owner.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The date when the project parcel owner was last updated.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EmailId":{
            "title":"Email Address",
            "maxLength":50,
            "type":"string",
            "description":"The email ID of the project parcel owner.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the project parcel owner.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "HomePhoneNum":{
            "title":"Home Phone Number",
            "maxLength":40,
            "type":"string",
            "description":"The home phone number of the project parcel owner.",
            "nullable":true,
            "x-queryable":true
        },
        "City":{
            "title":"City",
            "maxLength":60,
            "type":"string",
            "description":"The city of the project parcel owner address.",
            "nullable":true,
            "x-queryable":true
        },
        "StreetType":{
            "title":"Street Type",
            "maxLength":20,
            "type":"string",
            "description":"The street type of the address in the project parcel owner search. For example, alley, boulevard, avenue, lane, street, loop, and so on.",
            "nullable":true,
            "x-queryable":true
        },
        "Province":{
            "title":"Province",
            "maxLength":60,
            "type":"string",
            "description":"The province of the project parcel owner address.",
            "nullable":true,
            "x-queryable":true
        },
        "PostalPlus4Code":{
            "title":"Postal Plus 4 Code",
            "maxLength":20,
            "type":"string",
            "description":"The postal plus four code of the project parcel owner address.",
            "nullable":true,
            "x-queryable":true
        },
        "State":{
            "title":"State",
            "maxLength":60,
            "type":"string",
            "description":"The state of the project parcel owner address.",
            "nullable":true,
            "x-queryable":true
        },
        "OwnerKey":{
            "title":"Owner ID",
            "type":"integer",
            "description":"The unique identifier for the project parcel owner.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "Country":{
            "title":"Country",
            "maxLength":60,
            "type":"string",
            "description":"The country of the project parcel owner address.",
            "nullable":true,
            "x-queryable":true
        },
        "StreetDirection":{
            "title":"Street Direction",
            "maxLength":10,
            "type":"string",
            "description":"The street direction of the address in an project parcel owner search. Values are compass directions, such as N, S, E, W, NW, SE, and so on.",
            "nullable":true,
            "x-queryable":true
        },
        "UnitNumber":{
            "title":"Unit Number",
            "maxLength":30,
            "type":"string",
            "description":"The exact unit in a building. For example, Apartment 208A or Suite 300.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The login ID of the user who last updated the project parcel owner.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryFlag":{
            "title":"Primary",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates the primary project parcel owner. If the value is Y, then the parcel owner is the primary parcel owner. The default value is N.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "AgencyId":{
            "type":"integer",
            "description":"The unique identifier for a public sector agency.",
            "format":"int32",
            "nullable":false,
            "default":1,
            "x-hints":{
                "precision":8
            },
            "x-queryable":true
        },
        "FaxNum":{
            "title":"Fax Number",
            "maxLength":40,
            "type":"string",
            "description":"The fax number of the project parcel owner.",
            "nullable":true,
            "x-queryable":true
        },
        "PostalCode":{
            "title":"Postal Code",
            "maxLength":60,
            "type":"string",
            "description":"The postal code of the project parcel owner address.",
            "nullable":true,
            "x-queryable":true
        },
        "County":{
            "title":"County",
            "maxLength":60,
            "type":"string",
            "description":"The county of the project parcel owner address.",
            "nullable":true,
            "x-queryable":true
        },
        "OwnerId":{
            "title":"Owner ID",
            "type":"integer",
            "description":"The identifier of the parcel owner.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Address4":{
            "title":"Address Line 4",
            "maxLength":240,
            "type":"string",
            "description":"The fourth address of the project parcel owner, if present.",
            "nullable":true,
            "x-queryable":true
        },
        "DocumentNum":{
            "title":"Document Number",
            "maxLength":50,
            "type":"string",
            "description":"The document number of the project parcel owner.",
            "nullable":true,
            "x-queryable":true
        },
        "ProjectCode":{
            "title":"Project ID",
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier for a project.",
            "nullable":false,
            "x-queryable":true
        },
        "AddressField1":{
            "title":"Address Field 1",
            "maxLength":20,
            "type":"string",
            "description":"The address field of the project parcel owner search.",
            "nullable":true,
            "x-queryable":true
        },
        "AddressField3":{
            "title":"Address Field 3",
            "maxLength":20,
            "type":"string",
            "description":"The address field of the project parcel owner search.",
            "nullable":true,
            "x-queryable":true
        },
        "AddressField2":{
            "title":"Address Field 2",
            "maxLength":20,
            "type":"string",
            "description":"The address field of the project parcel owner search.",
            "nullable":true,
            "x-queryable":true
        },
        "ParcelId":{
            "title":"Parcel ID",
            "type":"integer",
            "description":"The identifier of the parcel.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Floor":{
            "title":"Floor",
            "maxLength":20,
            "type":"string",
            "description":"The floor of the building. For example, mezzanine level, penthouse, or garage level C.",
            "nullable":true,
            "x-queryable":true
        },
        "LastTransferType":{
            "title":"Last Transfer Type",
            "maxLength":50,
            "type":"string",
            "description":"The last transfer type of the project parcel owner.",
            "nullable":true,
            "x-queryable":true
        },
        "Address2":{
            "title":"Address Line 2",
            "maxLength":240,
            "type":"string",
            "description":"The second address of the project parcel owner, if present.",
            "nullable":true,
            "x-queryable":true
        },
        "Address3":{
            "title":"Address Line 3",
            "maxLength":240,
            "type":"string",
            "description":"The third address of the project parcel owner, if present.",
            "nullable":true,
            "x-queryable":true
        },
        "Address1":{
            "title":"Address",
            "maxLength":240,
            "type":"string",
            "description":"The first or main address of the project parcel owner.",
            "nullable":true,
            "x-queryable":true
        },
        "WorkPhoneNum":{
            "title":"Work Phone Number",
            "maxLength":40,
            "type":"string",
            "description":"The work phone number of the project parcel owner.",
            "nullable":true,
            "x-queryable":true
        },
        "CellPhoneNum":{
            "title":"Cell Phone Number",
            "maxLength":40,
            "type":"string",
            "description":"The cell phone number of the project parcel owner.",
            "nullable":true,
            "x-queryable":true
        },
        "HomePhoneCountry":{
            "title":"Home Phone Country Code",
            "maxLength":10,
            "type":"string",
            "description":"The home phone country code of the project parcel owner.",
            "nullable":true,
            "x-queryable":true
        },
        "LastTransferDate":{
            "title":"Last Transfer Date",
            "type":"string",
            "description":"The last transfer date of the project parcel owner.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The user who last updated the project parcel owner.",
            "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 : publicSectorProjects-ProjectParcel-ProjectAddress-item-response

Type: object

Show Source

• Address1: string
  Title: Address Line 1

  Maximum Length: 240

  The first or main address.
• Address2: string
  Title: Address Line 2

  Maximum Length: 240

  The second address, if present.
• Address3: string
  Title: Address Line 3

  Maximum Length: 240

  The third address, if present.
• Address4: string
  Title: Address Line 4

  Maximum Length: 240

  The fourth address, if present.
• AddressField1: string
  Title: Address Field 1

  Maximum Length: 20

  Additional information for the first address or main address of the parcel.
• AddressField2: string
  Title: Address Field 2

  Maximum Length: 20

  Additional information for the second address of the parcel, if present.
• AddressField3: string
  Title: Address Field 3

  Maximum Length: 20

  Additional information for the third address of the parcel, if present.
• AddressId: integer (int64)
  Title: Address ID

  The identifier of the parcel address.
• AddressKey: integer (int64)
  Title: Address ID

  The unique identifier of the project address.
• AddressType: string
  Title: Address Type

  Maximum Length: 20

  The address type used for delivery point validation (DPV). For example, main address, side address, or virtual address.
• AgencyId: integer (int32)
  Default Value: 1

  The unique identifier for a public sector agency.
• BuildingType: string
  Title: Building Type

  Maximum Length: 20

  The building type used in an address search. For example, Tower A or Block 3.
• CellPhoneCountry: string
  Title: Cell Phone Country Code

  Maximum Length: 10

  The country code for the cell phone number of parcel contact.
• CellPhoneNum: string
  Title: Cell Phone Number

  Maximum Length: 40

  The cell phone number of the parcel address contact.
• City: string
  Title: City

  Maximum Length: 60

  The city in the parcel address.
• CoordinateX: number
  Title: X Coordinate

  The x-axis coordinate of the project parcel address.
• CoordinateY: number
  Title: Y Coordinate

  The y-axis coordinate of the project parcel address.
• Country: string
  Title: Country

  Maximum Length: 60

  The country in the parcel address.
• County: string
  Title: County

  Maximum Length: 60

  The county in the parcel address.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the project parcel address.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the project parcel address was created.
• EmailId: string
  Title: Email Address

  Maximum Length: 50

  The email address of the parcel address contact.
• FaxCountry: string
  Title: Fax Country Code

  Maximum Length: 10

  The country code for the fax number of the parcel contact.
• FaxNum: string
  Title: Fax Number

  Maximum Length: 40

  The fax number of the parcel address contact.
• Floor: string
  Title: Floor

  Maximum Length: 20

  The floor or level in an address search. For example, mezzanine level, penthouse, or garage level C.
• HomePhoneCountry: string
  Title: Home Phone Country Code

  Maximum Length: 10

  The country code for the home telephone number of the parcel address contact.
• HomePhoneNum: string
  Title: Home Phone Number

  Maximum Length: 40

  The home telephone number of the parcel address contact.
• InputSource: string
  Title: Input Source

  Maximum Length: 1

  Indicates how the data were entered or loaded into the application. The values are S for system data and U for user-entered data.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The user who last updated the project parcel address.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The date when the project parcel address was last updated.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The login ID of the user who last updated the project parcel address.
• Latitude: number
  Title: Latitude

  The latitude of the parcel address. A geographic location typically identifies a specific entrance area within a large parcel, for example, a security checkpoint gate, delivery entrance, or employee entrance.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Longitude: number
  Title: Longitude

  The longitude of the parcel address. A geographic location typically identifies a specific entrance area within a large parcel, for example, a security checkpoint gate, delivery entrance, or employee entrance.
• MunicipalityId: string
  Title: Municipality ID

  Maximum Length: 20

  The municipality identifier if the parcel is not managed at the county level.
• ParcelId: integer (int64)
  Title: Parcel ID

  The identifier of the parcel.
• ParcelKey: integer (int64)
  Title: Parcel ID

  The unique identifier of the project parcel.
• PostalCode: string
  Title: Postal Code

  Maximum Length: 60

  The postal code in the parcel address.
• PostalPlus4Code: string
  Title: Postal Plus 4 Code

  Maximum Length: 20

  The postal plus four code of the parcel address.
• PrimaryFlag: boolean
  Title: Primary

  Maximum Length: 1

  Default Value: false

  Indicates whether the current project address is the primary address. If the value is Y, then the address is the primary project address. The default value is N.
• ProjectCode: string
  Title: Project ID

  Maximum Length: 30

  The unique identifier for a project.
• Province: string
  Title: Province

  Maximum Length: 60

  The province in the parcel address.
• Srid: integer (int64)
  Title: SRID

  The SRID of the parcel address. This attribute indicates the Spatial Reference System Identifier (SRID), which is a unique value that identifies projected, unprojected, and local spatial coordinate system definitions. Used in all GIS systems.
• State: string
  Title: State

  Maximum Length: 60

  The state in the parcel address.
• StreetDirection: string
  Title: Street Direction

  Maximum Length: 10

  The street direction in an address search. Values are compass directions, such as N, S, E, W, NW, SE, and so on. For example, use street direction N to find all parcels with an address that is north of the city center.
• StreetName: string
  Title: Street Name

  Maximum Length: 240

  The street name in the parcel address used during a search.
• StreetNumber: string
  Title: Street Number

  Maximum Length: 20

  The street number in the parcel address.
• StreetType: string
  Title: Street Type

  Maximum Length: 20

  The street type designation used during a search. For example, alley, boulevard, avenue, lane, street, loop, and so on.
• UnitNumber: string
  Title: Unit Number

  Maximum Length: 30

  The exact unit in a building used in an address search. For example, Apartment 208A or Suite 300.
• WorkPhoneCountry: string
  Title: Work Phone Country Code

  Maximum Length: 10

  The country code for the work telephone number of the parcel contact.
• WorkPhoneNum: string
  Title: Work Phone Number

  Maximum Length: 40

  The work telephone number of the parcel address contact.

{
    "type":"object",
    "properties":{
        "StreetName":{
            "title":"Street Name",
            "maxLength":240,
            "type":"string",
            "description":"The street name in the parcel address used during a search.",
            "nullable":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the project parcel address was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CellPhoneCountry":{
            "title":"Cell Phone Country Code",
            "maxLength":10,
            "type":"string",
            "description":"The country code for the cell phone number of parcel contact.",
            "nullable":true,
            "x-queryable":true
        },
        "InputSource":{
            "title":"Input Source",
            "maxLength":1,
            "type":"string",
            "description":"Indicates how the data were entered or loaded into the application. The values are S for system data and U for user-entered data.",
            "nullable":true,
            "x-queryable":true
        },
        "FaxCountry":{
            "title":"Fax Country Code",
            "maxLength":10,
            "type":"string",
            "description":"The country code for the fax number of the parcel contact.",
            "nullable":true,
            "x-queryable":true
        },
        "Latitude":{
            "title":"Latitude",
            "type":"number",
            "description":"The latitude of the parcel address. A geographic location typically identifies a specific entrance area within a large parcel, for example, a security checkpoint gate, delivery entrance, or employee entrance.",
            "nullable":true,
            "x-queryable":true
        },
        "BuildingType":{
            "title":"Building Type",
            "maxLength":20,
            "type":"string",
            "description":"The building type used in an address search. For example, Tower A or Block 3.",
            "nullable":true,
            "x-queryable":true
        },
        "WorkPhoneCountry":{
            "title":"Work Phone Country Code",
            "maxLength":10,
            "type":"string",
            "description":"The country code for the work telephone number of the parcel contact.",
            "nullable":true,
            "x-queryable":true
        },
        "StreetNumber":{
            "title":"Street Number",
            "maxLength":20,
            "type":"string",
            "description":"The street number in the parcel address.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ParcelKey":{
            "title":"Parcel ID",
            "type":"integer",
            "description":"The unique identifier of the project parcel.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AddressId":{
            "title":"Address ID",
            "type":"integer",
            "description":"The identifier of the parcel address.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The date when the project parcel address was last updated.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EmailId":{
            "title":"Email Address",
            "maxLength":50,
            "type":"string",
            "description":"The email address of the parcel address contact.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the project parcel address.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "HomePhoneNum":{
            "title":"Home Phone Number",
            "maxLength":40,
            "type":"string",
            "description":"The home telephone number of the parcel address contact.",
            "nullable":true,
            "x-queryable":true
        },
        "AddressKey":{
            "title":"Address ID",
            "type":"integer",
            "description":"The unique identifier of the project address.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "City":{
            "title":"City",
            "maxLength":60,
            "type":"string",
            "description":"The city in the parcel address.",
            "nullable":true,
            "x-queryable":true
        },
        "StreetType":{
            "title":"Street Type",
            "maxLength":20,
            "type":"string",
            "description":"The street type designation used during a search. For example, alley, boulevard, avenue, lane, street, loop, and so on.",
            "nullable":true,
            "x-queryable":true
        },
        "Longitude":{
            "title":"Longitude",
            "type":"number",
            "description":"The longitude of the parcel address. A geographic location typically identifies a specific entrance area within a large parcel, for example, a security checkpoint gate, delivery entrance, or employee entrance.",
            "nullable":true,
            "x-queryable":true
        },
        "Province":{
            "title":"Province",
            "maxLength":60,
            "type":"string",
            "description":"The province in the parcel address.",
            "nullable":true,
            "x-queryable":true
        },
        "PostalPlus4Code":{
            "title":"Postal Plus 4 Code",
            "maxLength":20,
            "type":"string",
            "description":"The postal plus four code of the parcel address.",
            "nullable":true,
            "x-queryable":true
        },
        "State":{
            "title":"State",
            "maxLength":60,
            "type":"string",
            "description":"The state in the parcel address.",
            "nullable":true,
            "x-queryable":true
        },
        "Country":{
            "title":"Country",
            "maxLength":60,
            "type":"string",
            "description":"The country in the parcel address.",
            "nullable":true,
            "x-queryable":true
        },
        "StreetDirection":{
            "title":"Street Direction",
            "maxLength":10,
            "type":"string",
            "description":"The street direction in an address search. Values are compass directions, such as N, S, E, W, NW, SE, and so on. For example, use street direction N to find all parcels with an address that is north of the city center.",
            "nullable":true,
            "x-queryable":true
        },
        "UnitNumber":{
            "title":"Unit Number",
            "maxLength":30,
            "type":"string",
            "description":"The exact unit in a building used in an address search. For example, Apartment 208A or Suite 300.",
            "nullable":true,
            "x-queryable":true
        },
        "CoordinateX":{
            "title":"X Coordinate",
            "type":"number",
            "description":"The x-axis coordinate of the project parcel address.",
            "nullable":true,
            "x-queryable":true
        },
        "CoordinateY":{
            "title":"Y Coordinate",
            "type":"number",
            "description":"The y-axis coordinate of the project parcel address.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The login ID of the user who last updated the project parcel address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryFlag":{
            "title":"Primary",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the current project address is the primary address. If the value is Y, then the address is the primary project address. The default value is N.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "AgencyId":{
            "type":"integer",
            "description":"The unique identifier for a public sector agency.",
            "format":"int32",
            "nullable":false,
            "default":1,
            "x-hints":{
                "precision":8
            },
            "x-queryable":true
        },
        "FaxNum":{
            "title":"Fax Number",
            "maxLength":40,
            "type":"string",
            "description":"The fax number of the parcel address contact.",
            "nullable":true,
            "x-queryable":true
        },
        "PostalCode":{
            "title":"Postal Code",
            "maxLength":60,
            "type":"string",
            "description":"The postal code in the parcel address.",
            "nullable":true,
            "x-queryable":true
        },
        "County":{
            "title":"County",
            "maxLength":60,
            "type":"string",
            "description":"The county in the parcel address.",
            "nullable":true,
            "x-queryable":true
        },
        "Address4":{
            "title":"Address Line 4",
            "maxLength":240,
            "type":"string",
            "description":"The fourth address, if present.",
            "nullable":true,
            "x-queryable":true
        },
        "ProjectCode":{
            "title":"Project ID",
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier for a project.",
            "nullable":false,
            "x-queryable":true
        },
        "AddressField1":{
            "title":"Address Field 1",
            "maxLength":20,
            "type":"string",
            "description":"Additional information for the first address or main address of the parcel.",
            "nullable":true,
            "x-queryable":true
        },
        "AddressField3":{
            "title":"Address Field 3",
            "maxLength":20,
            "type":"string",
            "description":"Additional information for the third address of the parcel, if present.",
            "nullable":true,
            "x-queryable":true
        },
        "AddressField2":{
            "title":"Address Field 2",
            "maxLength":20,
            "type":"string",
            "description":"Additional information for the second address of the parcel, if present.",
            "nullable":true,
            "x-queryable":true
        },
        "ParcelId":{
            "title":"Parcel ID",
            "type":"integer",
            "description":"The identifier of the parcel.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Floor":{
            "title":"Floor",
            "maxLength":20,
            "type":"string",
            "description":"The floor or level in an address search. For example, mezzanine level, penthouse, or garage level C.",
            "nullable":true,
            "x-queryable":true
        },
        "Address2":{
            "title":"Address Line 2",
            "maxLength":240,
            "type":"string",
            "description":"The second address, if present.",
            "nullable":true,
            "x-queryable":true
        },
        "Address3":{
            "title":"Address Line 3",
            "maxLength":240,
            "type":"string",
            "description":"The third address, if present.",
            "nullable":true,
            "x-queryable":true
        },
        "Address1":{
            "title":"Address Line 1",
            "maxLength":240,
            "type":"string",
            "description":"The first or main address.",
            "nullable":true,
            "x-queryable":true
        },
        "MunicipalityId":{
            "title":"Municipality ID",
            "maxLength":20,
            "type":"string",
            "description":"The municipality identifier if the parcel is not managed at the county level.",
            "nullable":true,
            "x-queryable":true
        },
        "WorkPhoneNum":{
            "title":"Work Phone Number",
            "maxLength":40,
            "type":"string",
            "description":"The work telephone number of the parcel address contact.",
            "nullable":true,
            "x-queryable":true
        },
        "CellPhoneNum":{
            "title":"Cell Phone Number",
            "maxLength":40,
            "type":"string",
            "description":"The cell phone number of the parcel address contact.",
            "nullable":true,
            "x-queryable":true
        },
        "HomePhoneCountry":{
            "title":"Home Phone Country Code",
            "maxLength":10,
            "type":"string",
            "description":"The country code for the home telephone number of the parcel address contact.",
            "nullable":true,
            "x-queryable":true
        },
        "AddressType":{
            "title":"Address Type",
            "maxLength":20,
            "type":"string",
            "description":"The address type used for delivery point validation (DPV). For example, main address, side address, or virtual address.",
            "nullable":true,
            "x-queryable":true
        },
        "Srid":{
            "title":"SRID",
            "type":"integer",
            "description":"The SRID of the parcel address. This attribute indicates the Spatial Reference System Identifier (SRID), which is a unique value that identifies projected, unprojected, and local spatial coordinate system definitions. Used in all GIS systems.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":10
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The user who last updated the project parcel address.",
            "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"
    }
}

Back to Top