Create a parcel address
post
/fscmRestApi/resources/11.13.18.05/publicSectorParcelAddresses
Request
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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
Address1: string
Title:
Address Line 1
Maximum Length:240
The first line of the parcel address. -
Address2: string
Title:
Address Line 2
Maximum Length:240
The second line of the parcel address. -
AddressCode: string
Maximum Length:
480
The address code of the parcel address. -
AddressId: integer
(int64)
Title:
Address ID
The unique identifier for the parcel address. -
BuildingType: string
Title:
Address Type
Maximum Length:20
The building type of the parcel address. -
CellPhoneNumber: string
Title:
Cell Phone Number
Maximum Length:40
The cell phone number of the parcel address. -
City: string
Title:
City
Maximum Length:60
The city of the parcel address. -
CoordinateX: number
The x coordinate of the parcel address.
-
CoordinateY: number
The y coordinate of the parcel address.
-
Country: string
Title:
Country
Maximum Length:3
The country of the parcel address. -
County: string
Title:
County
Maximum Length:60
The county of the parcel address. -
CrossroadOne: string
Title:
Crossroad
Maximum Length:240
The first crossroad of the intersection. -
CrossroadTwo: string
Title:
Crossroad 2
Maximum Length:240
The second crossroad of the intersection. -
EmailId: string
Title:
Email Address
Maximum Length:50
The email address of the parcel address. -
EnabledFlag: boolean
Maximum Length:
1
Indicates whether the parcel address is available to be used. -
FaxNumber: string
Title:
Fax Number
Maximum Length:40
The fax phone number of the parcel address. -
Floor: string
Title:
Floor
Maximum Length:20
The floor the parcel address is on. -
HomePhoneNumber: string
Title:
Home Phone Number
Maximum Length:40
The home phone number of the parcel address. -
InputSource: string
Maximum Length:
1
The input source of the parcel address. -
Landmark: string
Title:
Landmark
Maximum Length:200
The landmark associated with the address. -
Latitude: number
The latitude of the parcel address.
-
Longitude: number
The longitude of the parcel address.
-
Name: string
Title:
Name 1
Maximum Length:150
The name of the first contact person. -
ParcelId: integer
(int64)
The unique identifier for the parcel.
-
ParcelIdEntered: string
Title:
Parcel Number
Maximum Length:30
The parcel number. -
PostalCode: string
Title:
Postal Code
Maximum Length:60
The postal code of the parcel address. -
PrimaryFlag: boolean
Title:
Primary
Maximum Length:1
Indicates whether the parcel address is marked as primary for that parcel. -
SecondaryName: string
Title:
Name 2
Maximum Length:150
The name of the second contact person. -
State: string
Title:
State
Maximum Length:60
The state of the parcel address. -
StreeName: string
Title:
Street Name
Maximum Length:240
The street name of the parcel address. -
StreetDirection: string
Title:
Direction Prefix
Maximum Length:10
The street direction of the parcel address. -
StreetNumber: string
Title:
Street Number
Maximum Length:20
The street number of the parcel address. -
StreetSuffix: string
Title:
Direction Suffix
Maximum Length:20
The streeet suffix that further describes that street like Drive, Avenue etc. -
StreetType: string
Title:
Street Suffix
Maximum Length:20
The street type of the parcel address. -
UnitNumber: string
Title:
Unit
Maximum Length:30
The unit number of the parcel address. -
WorkPhoneNumber: string
Title:
Work Phone Number
Maximum Length:40
The work phone number of the parcel address.
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 : publicSectorParcelAddresses-item-response
Type:
Show Source
object
-
Address1: string
Title:
Address Line 1
Maximum Length:240
The first line of the parcel address. -
Address2: string
Title:
Address Line 2
Maximum Length:240
The second line of the parcel address. -
Address3: string
Title:
Address Line 3
Read Only:true
Maximum Length:240
The third line of the parcel address. -
Address4: string
Title:
Address Line 4
Read Only:true
Maximum Length:240
The fourth line of the parcel address. -
AddressCode: string
Maximum Length:
480
The address code of the parcel address. -
AddressId: integer
(int64)
Title:
Address ID
The unique identifier for the parcel address. -
AddressType: string
Title:
Address Type
Read Only:true
Maximum Length:20
The type of the parcel address. -
BuildingType: string
Title:
Address Type
Maximum Length:20
The building type of the parcel address. -
CellPhoneCountry: string
Title:
Cell Phone Country Code
Read Only:true
Maximum Length:10
The cell phone country code of the parcel address. -
CellPhoneNumber: string
Title:
Cell Phone Number
Maximum Length:40
The cell phone number of the parcel address. -
City: string
Title:
City
Maximum Length:60
The city of the parcel address. -
CoordinateX: number
The x coordinate of the parcel address.
-
CoordinateY: number
The y coordinate of the parcel address.
-
Country: string
Title:
Country
Maximum Length:3
The country of the parcel address. -
County: string
Title:
County
Maximum Length:60
The county of the parcel address. -
CrossroadOne: string
Title:
Crossroad
Maximum Length:240
The first crossroad of the intersection. -
CrossroadTwo: string
Title:
Crossroad 2
Maximum Length:240
The second crossroad of the intersection. -
EmailId: string
Title:
Email Address
Maximum Length:50
The email address of the parcel address. -
EnabledFlag: boolean
Maximum Length:
1
Indicates whether the parcel address is available to be used. -
FaxCountry: string
Title:
Fax Country Code
Read Only:true
Maximum Length:10
The fax country code of the parcel address. -
FaxNumber: string
Title:
Fax Number
Maximum Length:40
The fax phone number of the parcel address. -
Floor: string
Title:
Floor
Maximum Length:20
The floor the parcel address is on. -
HomePhoneCountry: string
Title:
Home Phone Country Code
Read Only:true
Maximum Length:10
The home phone country code of the parcel address. -
HomePhoneNumber: string
Title:
Home Phone Number
Maximum Length:40
The home phone number of the parcel address. -
InputSource: string
Maximum Length:
1
The input source of the parcel address. -
Landmark: string
Title:
Landmark
Maximum Length:200
The landmark associated with the address. -
Latitude: number
The latitude of the parcel address.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Longitude: number
The longitude of the parcel address.
-
MunicipalityId: string
Read Only:
true
Maximum Length:20
The unique identifier for the municipality of the parcel address. -
Name: string
Title:
Name 1
Maximum Length:150
The name of the first contact person. -
ParcelId: integer
(int64)
The unique identifier for the parcel.
-
ParcelIdEntered: string
Title:
Parcel Number
Maximum Length:30
The parcel number. -
ParcelNumber: string
Title:
Parcel Number
Read Only:true
Maximum Length:30
The parcel associated with the address. -
PostalCode: string
Title:
Postal Code
Maximum Length:60
The postal code of the parcel address. -
PostalPlus4Code: string
Read Only:
true
Maximum Length:10
The postal plus 4 code of the parcel address. -
PrimaryFlag: boolean
Title:
Primary
Maximum Length:1
Indicates whether the parcel address is marked as primary for that parcel. -
Province: string
Read Only:
true
Maximum Length:60
The province of the parcel address. -
SecondaryName: string
Title:
Name 2
Maximum Length:150
The name of the second contact person. -
Srid: integer
(int64)
Read Only:
true
The spatial reference identifier. This is a unique coordinate identifier for a local, regional, or global system used to locate geographical or spatial entities within geographic information systems. -
State: string
Title:
State
Maximum Length:60
The state of the parcel address. -
StreeName: string
Title:
Street Name
Maximum Length:240
The street name of the parcel address. -
StreetDirection: string
Title:
Direction Prefix
Maximum Length:10
The street direction of the parcel address. -
StreetNameConcat: string
Read Only:
true
Maximum Length:350
Indicates the concatenated value of the street name corresponding to the parcel address. The concatenated value of the street name is obtained by concatenating direction prefix, street name, street suffix and direction suffix. -
StreetNumber: string
Title:
Street Number
Maximum Length:20
The street number of the parcel address. -
StreetNumberAlpha: string
Read Only:
true
Maximum Length:20
Indicates the alphabetic portion of the street number in the parcel address. -
StreetNumberNumeric: integer
(int64)
Read Only:
true
Indicates the numerical portion of the street number in the parcel address. -
StreetSuffix: string
Title:
Direction Suffix
Maximum Length:20
The streeet suffix that further describes that street like Drive, Avenue etc. -
StreetType: string
Title:
Street Suffix
Maximum Length:20
The street type of the parcel address. -
UnitNumber: string
Title:
Unit
Maximum Length:30
The unit number of the parcel address. -
WorkPhoneCountry: string
Title:
Work Phone Country Code
Read Only:true
Maximum Length:10
The work phone country code of the parcel address. -
WorkPhoneNumber: string
Title:
Work Phone Number
Maximum Length:40
The work phone number of the parcel address.
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.