Create a record parcel owner
post
/fscmRestApi/resources/11.13.18.05/publicSectorRecParcelOwners
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 or main address of the parcel owner. -
Address2: string
Title:
Address Line 2
Maximum Length:240
The second address of the parcel owner, if present. -
Address3: string
Title:
Address Line 3
Maximum Length:240
The third address of the parcel owner, if present. -
Address4: string
Title:
Address Line 4
Maximum Length:240
The fourth address of the parcel owner, if present. -
AgencyId: integer
(int32)
Title:
Agency ID
Default Value:1
The unique identifier for a public sector agency associated with a parcel owner. -
BuildingType: string
Title:
Building
Maximum Length:20
The building type of building used in an address search. For example, Tower A or Block 3. -
CellPhoneCountry: string
Title:
Cell Phone Country
Maximum Length:10
The country code for the cell phone number of parcel owner. -
CellPhoneNumber: string
Title:
Cell Phone
Maximum Length:40
The cell phone number of the parcel owner. -
City: string
Title:
City
Maximum Length:60
The city in the parcel owner's address. -
Country: string
Title:
Country
Maximum Length:60
The country in the parcel owner's address. -
County: string
Title:
County
Maximum Length:60
The county in the parcel owner's address. -
DocumentNumber: string
Title:
Document
Maximum Length:50
The County Recorder's office document number for the transfer of ownership. -
EmailId: string
Title:
Email
Maximum Length:50
The email address of the parcel owner. -
FaxCountry: string
Title:
Fax Country
Maximum Length:10
The country code for the fax number of the parcel owner. -
FaxNumber: string
Title:
Fax
Maximum Length:40
The fax number of the parcel owner. -
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
Maximum Length:10
The country code for the home telephone number of the parcel owner. -
HomePhoneNumber: string
Title:
Home Phone
Maximum Length:40
The home telephone number of the parcel owner. -
LastTransferDate: string
(date)
Title:
Last Transfer Date
The date of the last transfer of ownership. -
LastTransferType: string
Title:
Last Transfer Type
Maximum Length:50
The type of last transfer of ownership. For example, grant deed, gift deed, or regular sale. -
LnpRecordId: string
Title:
Record ID
Maximum Length:50
The unique identifier for the application record. -
LnpRecordKey: integer
(int64)
Title:
Record
The unique identifier for the record associated with the parcel. -
Owner: string
Title:
Owner
Maximum Length:150
The name of the first or main owner. -
OwnerId: integer
(int64)
Title:
Owner
The unique identifier for the parcel owner. -
OwnerKey: integer
(int64)
Title:
Owner Key
The unique identifier for a record parcel owner. -
OwnerType: string
Title:
Ownership Type
Maximum Length:20
The type of ownership. For example, business or private person. -
ParcelId: integer
(int64)
Title:
Parcel
The unique identifier for the parcel. -
ParcelKey: integer
(int64)
Title:
Parcel Key
The unique identifier for the record parcel. -
PostalCode: string
Title:
Postal Code
Maximum Length:60
The postal code in the parcel owner's address. -
PostalPlus4Code: string
Title:
Postal Plus 4 Code
Maximum Length:20
The extended postal code in the parcel owner's address. -
PrimaryFlag: boolean
Title:
Primary
Maximum Length:1
Indicates the primary parcel owner. If the value is Y, then the parcel owner is the primary owner. The default value is N. -
Province: string
Title:
Province
Maximum Length:60
The province in the parcel owner's address. -
SecondaryOwner: string
Title:
Secondary Owner
Maximum Length:150
The name of the secondary owner. -
State: string
Title:
State
Maximum Length:60
The state in the parcel owner's address. -
StreetDirection: string
Title:
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, they can be used to find all parcels with an address that is north of the city center. -
StreetName: string
Title:
Street
Maximum Length:240
The street name in the parcel owner's address used during a search. -
StreetNumber: string
Title:
Street Number
Maximum Length:20
The street number in the parcel owner's 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
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
Maximum Length:10
The country code for the work telephone number of the parcel owner. -
WorkPhoneNumber: string
Title:
Work Phone
Maximum Length:40
The work telephone number of the parcel owner.
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.
Root Schema : publicSectorRecParcelOwners-item-response
Type:
Show Source
object
-
Address1: string
Title:
Address Line 1
Maximum Length:240
The first or main address of the parcel owner. -
Address2: string
Title:
Address Line 2
Maximum Length:240
The second address of the parcel owner, if present. -
Address3: string
Title:
Address Line 3
Maximum Length:240
The third address of the parcel owner, if present. -
Address4: string
Title:
Address Line 4
Maximum Length:240
The fourth address of the parcel owner, if present. -
AgencyId: integer
(int32)
Title:
Agency ID
Default Value:1
The unique identifier for a public sector agency associated with a parcel owner. -
BuildingType: string
Title:
Building
Maximum Length:20
The building type of building used in an address search. For example, Tower A or Block 3. -
CellPhoneCountry: string
Title:
Cell Phone Country
Maximum Length:10
The country code for the cell phone number of parcel owner. -
CellPhoneNumber: string
Title:
Cell Phone
Maximum Length:40
The cell phone number of the parcel owner. -
City: string
Title:
City
Maximum Length:60
The city in the parcel owner's address. -
Country: string
Title:
Country
Maximum Length:60
The country in the parcel owner's address. -
County: string
Title:
County
Maximum Length:60
The county in the parcel owner's address. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the parcel owner was created. -
DocumentNumber: string
Title:
Document
Maximum Length:50
The County Recorder's office document number for the transfer of ownership. -
EmailId: string
Title:
Email
Maximum Length:50
The email address of the parcel owner. -
FaxCountry: string
Title:
Fax Country
Maximum Length:10
The country code for the fax number of the parcel owner. -
FaxNumber: string
Title:
Fax
Maximum Length:40
The fax number of the parcel owner. -
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
Maximum Length:10
The country code for the home telephone number of the parcel owner. -
HomePhoneNumber: string
Title:
Home Phone
Maximum Length:40
The home telephone number of the parcel owner. -
LastTransferDate: string
(date)
Title:
Last Transfer Date
The date of the last transfer of ownership. -
LastTransferType: string
Title:
Last Transfer Type
Maximum Length:50
The type of last transfer of ownership. For example, grant deed, gift deed, or regular sale. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date when the parcel owner was last updated. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LnpRecordId: string
Title:
Record ID
Maximum Length:50
The unique identifier for the application record. -
LnpRecordKey: integer
(int64)
Title:
Record
The unique identifier for the record associated with the parcel. -
Owner: string
Title:
Owner
Maximum Length:150
The name of the first or main owner. -
OwnerId: integer
(int64)
Title:
Owner
The unique identifier for the parcel owner. -
OwnerKey: integer
(int64)
Title:
Owner Key
The unique identifier for a record parcel owner. -
OwnerType: string
Title:
Ownership Type
Maximum Length:20
The type of ownership. For example, business or private person. -
ParcelId: integer
(int64)
Title:
Parcel
The unique identifier for the parcel. -
ParcelKey: integer
(int64)
Title:
Parcel Key
The unique identifier for the record parcel. -
PostalCode: string
Title:
Postal Code
Maximum Length:60
The postal code in the parcel owner's address. -
PostalPlus4Code: string
Title:
Postal Plus 4 Code
Maximum Length:20
The extended postal code in the parcel owner's address. -
PrimaryFlag: boolean
Title:
Primary
Maximum Length:1
Indicates the primary parcel owner. If the value is Y, then the parcel owner is the primary owner. The default value is N. -
Province: string
Title:
Province
Maximum Length:60
The province in the parcel owner's address. -
SecondaryOwner: string
Title:
Secondary Owner
Maximum Length:150
The name of the secondary owner. -
State: string
Title:
State
Maximum Length:60
The state in the parcel owner's address. -
StreetDirection: string
Title:
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, they can be used to find all parcels with an address that is north of the city center. -
StreetName: string
Title:
Street
Maximum Length:240
The street name in the parcel owner's address used during a search. -
StreetNumber: string
Title:
Street Number
Maximum Length:20
The street number in the parcel owner's 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
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
Maximum Length:10
The country code for the work telephone number of the parcel owner. -
WorkPhoneNumber: string
Title:
Work Phone
Maximum Length:40
The work telephone number of the parcel owner.
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.