Create
post
/fscmRestApi/resources/11.13.18.05/publicSectorRecordQueries/{LnpRecordKey}/child/RecordParcel/{ParcelKey}/child/ParcelAddress
Request
Path Parameters
-
LnpRecordKey(required): integer
The unique identifier for a record. The record is for a permit, business license, professional license, or planning and zoning, and is determined by the classification.
-
ParcelKey(required): integer(int64)
The unique identifier for the parcel associated with a parcel 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.
-
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
The following table describes the body parameters in the request for this task.
Root Schema : schema
Type:
Show Source
object-
Address1: string
Title:
Address Line 1Maximum Length:240 -
Address2: string
Title:
Address Line 2Maximum Length:240 -
Address3: string
Title:
Address Line 3Maximum Length:240 -
Address4: string
Title:
Address Line 4Maximum Length:240 -
AddressId: integer
(int64)
Title:
Address -
AddressKey: integer
(int64)
Title:
Address Key -
AddressType: string
Title:
Address TypeMaximum Length:20 -
AgencyId: integer
(int32)
Title:
Agency IDDefault Value:1 -
BuildingType: string
Title:
BuildingMaximum Length:20 -
CellPhoneCountry: string
Title:
Cell Phone CountryMaximum Length:10 -
CellPhoneNumber: string
Title:
Cell PhoneMaximum Length:40 -
City: string
Title:
CityMaximum Length:60 -
CoordinateX: number
Title:
Coordinate X -
CoordinateY: number
Title:
Coordinate Y -
Country: string
Title:
CountryMaximum Length:60 -
County: string
Title:
CountyMaximum Length:60 -
CrossroadOne: string
Maximum Length:
240 -
CrossroadTwo: string
Maximum Length:
240 -
EmailId: string
Title:
EmailMaximum Length:50 -
FaxCountry: string
Title:
Fax CountryMaximum Length:10 -
FaxNumber: string
Title:
FaxMaximum Length:40 -
Floor: string
Title:
FloorMaximum Length:20 -
HomePhoneCountry: string
Title:
Home Phone CountryMaximum Length:10 -
HomePhoneNumber: string
Title:
Home PhoneMaximum Length:40 -
InputSource: string
Title:
SourceMaximum Length:1 -
Landmark: string
Maximum Length:
200 -
Latitude: number
Title:
Latitude -
LnpRecordId: string
Title:
Record IDMaximum Length:50 -
LnpRecordKey: integer
(int64)
Title:
Record -
Longitude: number
Title:
Longitude -
MunicipalityId: string
Title:
MunicipalityMaximum Length:20 -
ParcelId: integer
(int64)
Title:
Parcel -
ParcelKey: integer
(int64)
Title:
Parcel Key -
PostalCode: string
Title:
Postal CodeMaximum Length:60 -
PostalPlus4Code: string
Title:
Postal Plus 4 CodeMaximum Length:20 -
PrimaryFlag: boolean
Title:
PrimaryMaximum Length:1 -
PrimaryTransAddress: boolean
Title:
Primary Transaction AddressMaximum Length:1 -
Province: string
Title:
ProvinceMaximum Length:60 -
Srid: integer
(int64)
Title:
SRID -
State: string
Title:
StateMaximum Length:60 -
StreetDirection: string
Title:
DirectionMaximum Length:10 -
StreetName: string
Title:
StreetMaximum Length:240 -
StreetNameConcat: string
Maximum Length:
350 -
StreetNumber: string
Title:
Street NumberMaximum Length:20 -
StreetSuffix: string
Maximum Length:
20 -
StreetType: string
Title:
Street TypeMaximum Length:20 -
UnitNumber: string
Title:
UnitMaximum Length:30 -
WorkPhoneCountry: string
Title:
Work Phone CountryMaximum Length:10 -
WorkPhoneNumber: string
Title:
Work PhoneMaximum Length:40
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 : publicSectorRecordQueries-RecordParcel-ParcelAddress-item-response
Type:
Show Source
object-
Address1: string
Title:
Address Line 1Maximum Length:240 -
Address2: string
Title:
Address Line 2Maximum Length:240 -
Address3: string
Title:
Address Line 3Maximum Length:240 -
Address4: string
Title:
Address Line 4Maximum Length:240 -
AddressId: integer
(int64)
Title:
Address -
AddressKey: integer
(int64)
Title:
Address Key -
AddressType: string
Title:
Address TypeMaximum Length:20 -
AgencyId: integer
(int32)
Title:
Agency IDDefault Value:1 -
BuildingType: string
Title:
BuildingMaximum Length:20 -
CellPhoneCountry: string
Title:
Cell Phone CountryMaximum Length:10 -
CellPhoneNumber: string
Title:
Cell PhoneMaximum Length:40 -
City: string
Title:
CityMaximum Length:60 -
CoordinateX: number
Title:
Coordinate X -
CoordinateY: number
Title:
Coordinate Y -
Country: string
Title:
CountryMaximum Length:60 -
County: string
Title:
CountyMaximum Length:60 -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:true -
CrossroadOne: string
Maximum Length:
240 -
CrossroadTwo: string
Maximum Length:
240 -
EmailId: string
Title:
EmailMaximum Length:50 -
FaxCountry: string
Title:
Fax CountryMaximum Length:10 -
FaxNumber: string
Title:
FaxMaximum Length:40 -
Floor: string
Title:
FloorMaximum Length:20 -
HomePhoneCountry: string
Title:
Home Phone CountryMaximum Length:10 -
HomePhoneNumber: string
Title:
Home PhoneMaximum Length:40 -
InputSource: string
Title:
SourceMaximum Length:1 -
Landmark: string
Maximum Length:
200 -
LastUpdateDate: string
(date-time)
Title:
Last Updated DateRead Only:true -
Latitude: number
Title:
Latitude -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
LnpRecordId: string
Title:
Record IDMaximum Length:50 -
LnpRecordKey: integer
(int64)
Title:
Record -
Longitude: number
Title:
Longitude -
MunicipalityId: string
Title:
MunicipalityMaximum Length:20 -
ParcelId: integer
(int64)
Title:
Parcel -
ParcelKey: integer
(int64)
Title:
Parcel Key -
PostalCode: string
Title:
Postal CodeMaximum Length:60 -
PostalPlus4Code: string
Title:
Postal Plus 4 CodeMaximum Length:20 -
PrimaryFlag: boolean
Title:
PrimaryMaximum Length:1 -
PrimaryTransAddress: boolean
Title:
Primary Transaction AddressMaximum Length:1 -
Province: string
Title:
ProvinceMaximum Length:60 -
Srid: integer
(int64)
Title:
SRID -
State: string
Title:
StateMaximum Length:60 -
StreetDirection: string
Title:
DirectionMaximum Length:10 -
StreetName: string
Title:
StreetMaximum Length:240 -
StreetNameConcat: string
Maximum Length:
350 -
StreetNumber: string
Title:
Street NumberMaximum Length:20 -
StreetSuffix: string
Maximum Length:
20 -
StreetType: string
Title:
Street TypeMaximum Length:20 -
UnitNumber: string
Title:
UnitMaximum Length:30 -
WorkPhoneCountry: string
Title:
Work Phone CountryMaximum Length:10 -
WorkPhoneNumber: string
Title:
Work PhoneMaximum Length:40
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed 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.