Update a project parcel address
patch
/fscmRestApi/resources/11.13.18.05/publicSectorProjectAddresses/{AddressKey}
Request
Path Parameters
-
AddressKey(required): integer(int64)
The unique identifier of the project address.
Header Parameters
-
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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
Address1: string
Title:
Address Line 1
Maximum Length:240
The first or the main address. -
Address2: string
Title:
Address Line 2
Maximum Length:240
The second address line, if applicable. -
Address3: string
Title:
Address Line 3
Maximum Length:240
The third address line, if applicable. -
Address4: string
Title:
Address Line 4
Maximum Length:240
The fourth address line, if applicable. -
AddressField1: string
Title:
Address Field 1
Maximum Length:20
The additional first address or main address information of the parcel address. -
AddressField2: string
Title:
Address Field 2
Maximum Length:20
The additional second address information of the parcel address if available. -
AddressField3: string
Title:
Address Field 3
Maximum Length:20
The additional third address information of the parcel address, if available. -
AddressId: integer
(int64)
Title:
Address ID
The identifier of the parcel address. -
AddressType: string
Title:
Address Type
Maximum Length:20
The type of address that is used for the delivery point validation (DPV). For example, main address, side address, or virtual address. -
BuildingType: string
Title:
Building Type
Maximum Length:20
The type of building used in the 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 name of the city in the parcel address. -
CoordinateX: number
Title:
X Coordinate
The x-axis coordinate value of the project parcel address. -
CoordinateY: number
Title:
Y Coordinate
The y-axis coordinate value of the project parcel address. -
Country: string
Title:
Country
Maximum Length:60
The name of the country in the parcel address. -
County: string
Title:
County
Maximum Length:60
The name of 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 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. -
Latitude: number
Title:
Latitude
The latitude value of the parcel address. A geographic location typically identifies a specific entrance area within a large parcel address. For example, a security checkpoint gate, delivery entrance, or employee entrance. -
Longitude: number
Title:
Longitude
The longitude value of the parcel address. A geographic location typically identifies a specific entrance area within a large parcel address. 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 extended postal code in the parcel address. -
PrimaryFlag: boolean
Title:
Primary
Maximum Length:1
Default Value:false
Indicates if the current project address is the primary parcel address. The value 'Y' indicates that the parcel address is the primary parcel address and the value 'N' indicates that parcel address is not the primary parcel address. The default value is 'N'. -
Province: string
Title:
Province
Maximum Length:60
The name of the province in the parcel address. -
Srid: 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: string
Title:
State
Maximum Length:60
The name of the state in the parcel address. -
StreetDirection: string
Title:
Street Direction
Maximum Length:10
The street direction in the address search. Valid values are the compass directions such as N, S, E, W, NW, SE, and others. For example, the search can result in a list all parcels with a street direction that is to the north of the city center. -
StreetName: string
Title:
Street Name
Maximum Length:240
The name of the street in the parcel address used at the time of 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 type of street that is used at the time of search. For example, alley, boulevard, avenue, lane, street, loop, and so on. -
UnitNumber: string
Title:
Unit Number
Maximum Length:30
The particular 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.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
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(required):
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.
Root Schema : publicSectorProjectAddresses-item-response
Type:
Show Source
object
-
Address1: string
Title:
Address Line 1
Maximum Length:240
The first or the main address. -
Address2: string
Title:
Address Line 2
Maximum Length:240
The second address line, if applicable. -
Address3: string
Title:
Address Line 3
Maximum Length:240
The third address line, if applicable. -
Address4: string
Title:
Address Line 4
Maximum Length:240
The fourth address line, if applicable. -
AddressField1: string
Title:
Address Field 1
Maximum Length:20
The additional first address or main address information of the parcel address. -
AddressField2: string
Title:
Address Field 2
Maximum Length:20
The additional second address information of the parcel address if available. -
AddressField3: string
Title:
Address Field 3
Maximum Length:20
The additional third address information of the parcel address, if available. -
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 type of address that is used for the delivery point validation (DPV). For example, main address, side address, or virtual address. -
AgencyId: integer
(int32)
Default Value:
1
The unique identifier of the public sector agency. -
BuildingType: string
Title:
Building Type
Maximum Length:20
The type of building used in the 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 name of the city in the parcel address. -
CoordinateX: number
Title:
X Coordinate
The x-axis coordinate value of the project parcel address. -
CoordinateY: number
Title:
Y Coordinate
The y-axis coordinate value of the project parcel address. -
Country: string
Title:
Country
Maximum Length:60
The name of the country in the parcel address. -
County: string
Title:
County
Maximum Length:60
The name of the county in the parcel address. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The name of 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 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: string
(date-time)
Title:
Last Updated Date
Read Only:true
The name of 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 value of the parcel address. A geographic location typically identifies a specific entrance area within a large parcel address. 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 value of the parcel address. A geographic location typically identifies a specific entrance area within a large parcel address. 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 extended postal code in the parcel address. -
PrimaryFlag: boolean
Title:
Primary
Maximum Length:1
Default Value:false
Indicates if the current project address is the primary parcel address. The value 'Y' indicates that the parcel address is the primary parcel address and the value 'N' indicates that parcel address is not the primary parcel address. The default value is 'N'. -
ProjectCode: string
Title:
Project ID
Maximum Length:30
The unique identifier of the project. -
Province: string
Title:
Province
Maximum Length:60
The name of the province in the parcel address. -
Srid: 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: string
Title:
State
Maximum Length:60
The name of the state in the parcel address. -
StreetDirection: string
Title:
Street Direction
Maximum Length:10
The street direction in the address search. Valid values are the compass directions such as N, S, E, W, NW, SE, and others. For example, the search can result in a list all parcels with a street direction that is to the north of the city center. -
StreetName: string
Title:
Street Name
Maximum Length:240
The name of the street in the parcel address used at the time of 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 type of street that is used at the time of search. For example, alley, boulevard, avenue, lane, street, loop, and so on. -
UnitNumber: string
Title:
Unit Number
Maximum Length:30
The particular 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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.