Jump to

• Request
• Response

Create a set of project parcel addresses

post

/fscmRestApi/resources/11.13.18.05/publicSectorProjectParcels/{ParcelKey}/child/ProjectAddress

Request

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• application/json

Path Parameters

• ParcelKey: integer
  The unique identifier of the project parcel.

Body ()

The following table describes the body parameters in the request for this task.

Root Schema : publicSectorProjectParcels-ProjectAddress-item

Type: object

Show Source

• Address1(optional): string
  Title: Address Line 1

  Maximum Length: 240

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

  Maximum Length: 240

  The second address line, if available.
• Address3(optional): string
  Title: Address Line 3

  Maximum Length: 240

  The third address line, if available.
• Address4(optional): string
  Title: Address Line 4

  Maximum Length: 240

  The fourth address line, if available.
• AddressField1(optional): string
  Title: Address Field 1

  Maximum Length: 20

  The first address or main address additional information of the parcel address.
• AddressField2(optional): string
  Title: Address Field 2

  Maximum Length: 20

  The second address additional information of the parcel address, if available.
• AddressField3(optional): string
  Title: Address Field 3

  Maximum Length: 20

  The third address additional information of the parcel address, if available.
• AddressId(optional): integer(int64)
  Title: Address ID

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

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

  Maximum Length: 20

  The type of address used for delivery point validation (DPV). For example, main address, side address, or virtual address.
• AgencyId(optional): integer(int32)
  The unique identifier of the public sector agency.
• BuildingType(optional): string
  Title: Building Type

  Maximum Length: 20

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

  Maximum Length: 10

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

  Maximum Length: 40

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

  Maximum Length: 60

  The name of the city in the parcel address.
• CoordinateX(optional): number
  Title: X Coordinate

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

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

  Maximum Length: 60

  The name of the country in the parcel address.
• County(optional): string
  Title: County

  Maximum Length: 60

  The name of the county in the parcel address.
• CreatedBy(optional): string
  Title: Created By

  Maximum Length: 64

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

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

  Maximum Length: 50

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

  Maximum Length: 10

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

  Maximum Length: 40

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

  Maximum Length: 20

  The name of the floor or level in the address search. For example, mezzanine level, penthouse, or garage level C.
• HomePhoneCountry(optional): string
  Title: Home Phone Country Code

  Maximum Length: 10

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

  Maximum Length: 40

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

  Maximum Length: 1

  Indicates how the data was entered or loaded into the application. The value 'S' indicates that the data entered is the system data and the value 'U' indicates the user-entered data.
• LastUpdateDate(optional): string(date-time)
  Title: Last Updated Date

  The name of the user who last updated the project parcel address.
• LastUpdatedBy(optional): string
  Title: Last Updated By

  Maximum Length: 64

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

  Maximum Length: 32

  The login detail of the user who last updated the project parcel address.
• Latitude(optional): number
  Title: Latitude

  The latitude value of the parcel address. The geographic location typically identifies a specific entrance area within a large parcel area. For example, a security checkpoint gate, delivery entrance, or employee entrance.
• links(optional): array Items
  Title: Items

  Link Relations
• Longitude(optional): number
  Title: Longitude

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

  Maximum Length: 20

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

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

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

  Maximum Length: 60

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

  Maximum Length: 20

  The extended postal code in the parcel address.
• PrimaryFlag(optional): string
  Title: Primary

  Maximum Length: 1

  Indicates if the current project address is the primary project address. The value 'Y' indicates that the project address is the primary project address and the value 'N' indicates that address is not the primary address. The default value is 'N'.
• ProjectCode(optional): string
  Title: Project ID

  Maximum Length: 30

  The unique identifier of the project.
• Province(optional): string
  Title: Province

  Maximum Length: 60

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

  The identifier of the parcel address. The Spatial Reference System Identifier (SRID) identifies the projected, not projected, and the local spatial coordinate system definitions. The identifier is used in all GIS systems.
• State(optional): string
  Title: State

  Maximum Length: 60

  The name of the state in the parcel address.
• StreetDirection(optional): string
  Title: Street Direction

  Maximum Length: 10

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

  Maximum Length: 240

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

  Maximum Length: 20

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

  Maximum Length: 20

  The type of street used during the search. For example, alley, boulevard, avenue, lane, street, loop, and so on.
• UnitNumber(optional): string
  Title: Unit Number

  Maximum Length: 30

  The particular unit in the building used in the address search. For example, Apartment 208A or Suite 300.
• WorkPhoneCountry(optional): string
  Title: Work Phone Country Code

  Maximum Length: 10

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

  Maximum Length: 40

  The work telephone number of the parcel address contact.

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

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : link

Type: object

Show Source

• href(optional): string
  Title: hyperlink reference

  The URI to the related resource.
• rel(optional): string
  Title: relation

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

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Back to Top

Response

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• application/json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : publicSectorProjectParcels-ProjectAddress-item

Type: object

Show Source

• Address1(optional): string
  Title: Address Line 1

  Maximum Length: 240

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

  Maximum Length: 240

  The second address line, if available.
• Address3(optional): string
  Title: Address Line 3

  Maximum Length: 240

  The third address line, if available.
• Address4(optional): string
  Title: Address Line 4

  Maximum Length: 240

  The fourth address line, if available.
• AddressField1(optional): string
  Title: Address Field 1

  Maximum Length: 20

  The first address or main address additional information of the parcel address.
• AddressField2(optional): string
  Title: Address Field 2

  Maximum Length: 20

  The second address additional information of the parcel address, if available.
• AddressField3(optional): string
  Title: Address Field 3

  Maximum Length: 20

  The third address additional information of the parcel address, if available.
• AddressId(optional): integer(int64)
  Title: Address ID

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

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

  Maximum Length: 20

  The type of address used for delivery point validation (DPV). For example, main address, side address, or virtual address.
• AgencyId(optional): integer(int32)
  The unique identifier of the public sector agency.
• BuildingType(optional): string
  Title: Building Type

  Maximum Length: 20

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

  Maximum Length: 10

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

  Maximum Length: 40

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

  Maximum Length: 60

  The name of the city in the parcel address.
• CoordinateX(optional): number
  Title: X Coordinate

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

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

  Maximum Length: 60

  The name of the country in the parcel address.
• County(optional): string
  Title: County

  Maximum Length: 60

  The name of the county in the parcel address.
• CreatedBy(optional): string
  Title: Created By

  Maximum Length: 64

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

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

  Maximum Length: 50

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

  Maximum Length: 10

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

  Maximum Length: 40

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

  Maximum Length: 20

  The name of the floor or level in the address search. For example, mezzanine level, penthouse, or garage level C.
• HomePhoneCountry(optional): string
  Title: Home Phone Country Code

  Maximum Length: 10

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

  Maximum Length: 40

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

  Maximum Length: 1

  Indicates how the data was entered or loaded into the application. The value 'S' indicates that the data entered is the system data and the value 'U' indicates the user-entered data.
• LastUpdateDate(optional): string(date-time)
  Title: Last Updated Date

  The name of the user who last updated the project parcel address.
• LastUpdatedBy(optional): string
  Title: Last Updated By

  Maximum Length: 64

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

  Maximum Length: 32

  The login detail of the user who last updated the project parcel address.
• Latitude(optional): number
  Title: Latitude

  The latitude value of the parcel address. The geographic location typically identifies a specific entrance area within a large parcel area. For example, a security checkpoint gate, delivery entrance, or employee entrance.
• links(optional): array Items
  Title: Items

  Link Relations
• Longitude(optional): number
  Title: Longitude

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

  Maximum Length: 20

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

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

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

  Maximum Length: 60

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

  Maximum Length: 20

  The extended postal code in the parcel address.
• PrimaryFlag(optional): string
  Title: Primary

  Maximum Length: 1

  Indicates if the current project address is the primary project address. The value 'Y' indicates that the project address is the primary project address and the value 'N' indicates that address is not the primary address. The default value is 'N'.
• ProjectCode(optional): string
  Title: Project ID

  Maximum Length: 30

  The unique identifier of the project.
• Province(optional): string
  Title: Province

  Maximum Length: 60

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

  The identifier of the parcel address. The Spatial Reference System Identifier (SRID) identifies the projected, not projected, and the local spatial coordinate system definitions. The identifier is used in all GIS systems.
• State(optional): string
  Title: State

  Maximum Length: 60

  The name of the state in the parcel address.
• StreetDirection(optional): string
  Title: Street Direction

  Maximum Length: 10

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

  Maximum Length: 240

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

  Maximum Length: 20

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

  Maximum Length: 20

  The type of street used during the search. For example, alley, boulevard, avenue, lane, street, loop, and so on.
• UnitNumber(optional): string
  Title: Unit Number

  Maximum Length: 30

  The particular unit in the building used in the address search. For example, Apartment 208A or Suite 300.
• WorkPhoneCountry(optional): string
  Title: Work Phone Country Code

  Maximum Length: 10

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

  Maximum Length: 40

  The work telephone number of the parcel address contact.

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

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : link

Type: object

Show Source

• href(optional): string
  Title: hyperlink reference

  The URI to the related resource.
• rel(optional): string
  Title: relation

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

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Back to Top