Jump to

• Request
• Response

Update a project parcel address

patch

/fscmRestApi/resources/11.13.18.05/publicSectorProjects/{publicSectorProjectsUniqID}/child/ProjectParcel/{ParcelKey}/child/ProjectAddress/{AddressKey}

Request

Path Parameters

• AddressKey(required): integer(int64)
  The unique identifier of the project address.
• ParcelKey(required): integer(int64)
  The unique identifier for the project parcel.
• 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>

Header Parameters

• Metadata-Context: string
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version: string
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• 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.
• 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.
• 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.
• 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.
• 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.
• 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.
• 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.
• 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
        },
        "CellPhoneCountry":{
            "title":"Cell Phone Country Code",
            "maxLength":10,
            "type":"string",
            "description":"The country code for the cell phone number of parcel contact.",
            "nullable":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
        },
        "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
        },
        "FaxCountry":{
            "title":"Fax Country Code",
            "maxLength":10,
            "type":"string",
            "description":"The country code for the fax number of the parcel contact.",
            "nullable":true
        },
        "FaxNum":{
            "title":"Fax Number",
            "maxLength":40,
            "type":"string",
            "description":"The fax number of the parcel address contact.",
            "nullable":true
        },
        "PostalCode":{
            "title":"Postal Code",
            "maxLength":60,
            "type":"string",
            "description":"The postal code in the parcel address.",
            "nullable":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
        },
        "County":{
            "title":"County",
            "maxLength":60,
            "type":"string",
            "description":"The county in the parcel address.",
            "nullable":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
        },
        "Address4":{
            "title":"Address Line 4",
            "maxLength":240,
            "type":"string",
            "description":"The fourth address, if present.",
            "nullable":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
        },
        "StreetNumber":{
            "title":"Street Number",
            "maxLength":20,
            "type":"string",
            "description":"The street number in the parcel address.",
            "nullable":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
        },
        "AddressField3":{
            "title":"Address Field 3",
            "maxLength":20,
            "type":"string",
            "description":"Additional information for the third address of the parcel, if present.",
            "nullable":true
        },
        "AddressId":{
            "title":"Address ID",
            "type":"integer",
            "description":"The identifier of the parcel address.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "AddressField2":{
            "title":"Address Field 2",
            "maxLength":20,
            "type":"string",
            "description":"Additional information for the second address of the parcel, if present.",
            "nullable":true
        },
        "ParcelId":{
            "title":"Parcel ID",
            "type":"integer",
            "description":"The identifier of the parcel.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "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
        },
        "EmailId":{
            "title":"Email Address",
            "maxLength":50,
            "type":"string",
            "description":"The email address of the parcel address contact.",
            "nullable":true
        },
        "HomePhoneNum":{
            "title":"Home Phone Number",
            "maxLength":40,
            "type":"string",
            "description":"The home telephone number of the parcel address contact.",
            "nullable":true
        },
        "Address2":{
            "title":"Address Line 2",
            "maxLength":240,
            "type":"string",
            "description":"The second address, if present.",
            "nullable":true
        },
        "Address3":{
            "title":"Address Line 3",
            "maxLength":240,
            "type":"string",
            "description":"The third address, if present.",
            "nullable":true
        },
        "Address1":{
            "title":"Address Line 1",
            "maxLength":240,
            "type":"string",
            "description":"The first or main address.",
            "nullable":true
        },
        "City":{
            "title":"City",
            "maxLength":60,
            "type":"string",
            "description":"The city in the parcel address.",
            "nullable":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
        },
        "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
        },
        "WorkPhoneNum":{
            "title":"Work Phone Number",
            "maxLength":40,
            "type":"string",
            "description":"The work telephone number of the parcel address contact.",
            "nullable":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
        },
        "Province":{
            "title":"Province",
            "maxLength":60,
            "type":"string",
            "description":"The province in the parcel address.",
            "nullable":true
        },
        "PostalPlus4Code":{
            "title":"Postal Plus 4 Code",
            "maxLength":20,
            "type":"string",
            "description":"The postal plus four code of the parcel address.",
            "nullable":true
        },
        "State":{
            "title":"State",
            "maxLength":60,
            "type":"string",
            "description":"The state in the parcel address.",
            "nullable":true
        },
        "Country":{
            "title":"Country",
            "maxLength":60,
            "type":"string",
            "description":"The country in the parcel address.",
            "nullable":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
        },
        "CellPhoneNum":{
            "title":"Cell Phone Number",
            "maxLength":40,
            "type":"string",
            "description":"The cell phone number of the parcel address contact.",
            "nullable":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
        },
        "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
        },
        "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
        },
        "CoordinateX":{
            "title":"X Coordinate",
            "type":"number",
            "description":"The x-axis coordinate of the project parcel address.",
            "nullable":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
            }
        },
        "CoordinateY":{
            "title":"Y Coordinate",
            "type":"number",
            "description":"The y-axis coordinate of the project parcel address.",
            "nullable":true
        }
    }
}

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

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