Create a project parcel owner
post
/fscmRestApi/resources/11.13.18.05/publicSectorProjects/{publicSectorProjectsUniqID}/child/ProjectParcel/{ParcelKey}/child/PrjParcelOwner
Request
Path Parameters
-
ParcelKey(required): integer(int64)
The unique identifier for the project parcel.
-
publicSectorProjectsUniqID(required): string
This is the hash key of the attributes which make up the composite key--- AgencyId and ProjectCode ---for the Project Lists resource and used to uniquely identify an instance of Project Lists. The client should not generate the hash key value. Instead, the client should query on the Project Lists collection resource with a filter on the primary key values in order to navigate to a specific instance of Project Lists.
For example: publicSectorProjects?q=AgencyId=<value1>;ProjectCode=<value2>
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:
AddressMaximum Length:240The first or main address of the project parcel owner. -
Address2: string
Title:
Address Line 2Maximum Length:240The second address of the project parcel owner, if present. -
Address3: string
Title:
Address Line 3Maximum Length:240The third address of the project parcel owner, if present. -
Address4: string
Title:
Address Line 4Maximum Length:240The fourth address of the project parcel owner, if present. -
AddressField1: string
Title:
Address Field 1Maximum Length:20The address field of the project parcel owner search. -
AddressField2: string
Title:
Address Field 2Maximum Length:20The address field of the project parcel owner search. -
AddressField3: string
Title:
Address Field 3Maximum Length:20The address field of the project parcel owner search. -
AgencyId: integer
(int32)
Default Value:
1The unique identifier for a public sector agency. -
BuildingType: string
Title:
Building TypeMaximum Length:20The building type in the project parcel owner search. For example, Tower A or Block 3. -
CellPhoneCountry: string
Title:
Cell Phone Country CodeMaximum Length:10The cell phone country code of the project parcel owner. -
CellPhoneNum: string
Title:
Cell Phone NumberMaximum Length:40The cell phone number of the project parcel owner. -
City: string
Title:
CityMaximum Length:60The city of the project parcel owner address. -
Country: string
Title:
CountryMaximum Length:60The country of the project parcel owner address. -
County: string
Title:
CountyMaximum Length:60The county of the project parcel owner address. -
DocumentNum: string
Title:
Document NumberMaximum Length:50The document number of the project parcel owner. -
EmailId: string
Title:
Email AddressMaximum Length:50The email ID of the project parcel owner. -
FaxCountry: string
Title:
Fax Country CodeMaximum Length:10The fax country code of the project parcel owner. -
FaxNum: string
Title:
Fax NumberMaximum Length:40The fax number of the project parcel owner. -
Floor: string
Title:
FloorMaximum Length:20The floor of the building. For example, mezzanine level, penthouse, or garage level C. -
HomePhoneCountry: string
Title:
Home Phone Country CodeMaximum Length:10The home phone country code of the project parcel owner. -
HomePhoneNum: string
Title:
Home Phone NumberMaximum Length:40The home phone number of the project parcel owner. -
LastTransferDate: string
(date)
Title:
Last Transfer DateThe last transfer date of the project parcel owner. -
LastTransferType: string
Title:
Last Transfer TypeMaximum Length:50The last transfer type of the project parcel owner. -
Name1: string
Title:
Name 1Maximum Length:150The first name of the parcel owner. -
Name2: string
Title:
Name 2Maximum Length:150The second name of the parcel owner. -
OwnerId: integer
(int64)
Title:
Owner IDThe identifier of the parcel owner. -
OwnerKey: integer
(int64)
Title:
Owner IDThe unique identifier for the project parcel owner. -
OwnerType: string
Title:
Owner TypeMaximum Length:20The type of parcel owner. -
ParcelId: integer
(int64)
Title:
Parcel IDThe identifier of the parcel. -
ParcelKey: integer
(int64)
Title:
Parcel IDThe unique identifier for the project parcel. -
PostalCode: string
Title:
Postal CodeMaximum Length:60The postal code of the project parcel owner address. -
PostalPlus4Code: string
Title:
Postal Plus 4 CodeMaximum Length:20The postal plus four code of the project parcel owner address. -
PrimaryFlag: boolean
Title:
PrimaryMaximum Length:1Default Value:falseIndicates the primary project parcel owner. If the value is Y, then the parcel owner is the primary parcel owner. The default value is N. -
ProjectCode: string
Title:
Project IDMaximum Length:30The unique identifier for a project. -
Province: string
Title:
ProvinceMaximum Length:60The province of the project parcel owner address. -
State: string
Title:
StateMaximum Length:60The state of the project parcel owner address. -
StreetDirection: string
Title:
Street DirectionMaximum Length:10The street direction of the address in an project parcel owner search. Values are compass directions, such as N, S, E, W, NW, SE, and so on. -
StreetName: string
Title:
Street NameMaximum Length:240The street name of the address in the project parcel owner search. -
StreetNumber: string
Title:
Street NameMaximum Length:20The street number of the address in the project parcel owner search. -
StreetType: string
Title:
Street TypeMaximum Length:20The street type of the address in the project parcel owner search. For example, alley, boulevard, avenue, lane, street, loop, and so on. -
UnitNumber: string
Title:
Unit NumberMaximum Length:30The exact unit in a building. For example, Apartment 208A or Suite 300. -
WorkPhoneCountry: string
Title:
Work Phone Country CodeMaximum Length:10The work phone country code of the project parcel owner. -
WorkPhoneNum: string
Title:
Work Phone NumberMaximum Length:40The work phone number of the project parcel owner.
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 : publicSectorProjects-ProjectParcel-PrjParcelOwner-item-response
Type:
Show Source
object-
Address1: string
Title:
AddressMaximum Length:240The first or main address of the project parcel owner. -
Address2: string
Title:
Address Line 2Maximum Length:240The second address of the project parcel owner, if present. -
Address3: string
Title:
Address Line 3Maximum Length:240The third address of the project parcel owner, if present. -
Address4: string
Title:
Address Line 4Maximum Length:240The fourth address of the project parcel owner, if present. -
AddressField1: string
Title:
Address Field 1Maximum Length:20The address field of the project parcel owner search. -
AddressField2: string
Title:
Address Field 2Maximum Length:20The address field of the project parcel owner search. -
AddressField3: string
Title:
Address Field 3Maximum Length:20The address field of the project parcel owner search. -
AgencyId: integer
(int32)
Default Value:
1The unique identifier for a public sector agency. -
BuildingType: string
Title:
Building TypeMaximum Length:20The building type in the project parcel owner search. For example, Tower A or Block 3. -
CellPhoneCountry: string
Title:
Cell Phone Country CodeMaximum Length:10The cell phone country code of the project parcel owner. -
CellPhoneNum: string
Title:
Cell Phone NumberMaximum Length:40The cell phone number of the project parcel owner. -
City: string
Title:
CityMaximum Length:60The city of the project parcel owner address. -
Country: string
Title:
CountryMaximum Length:60The country of the project parcel owner address. -
County: string
Title:
CountyMaximum Length:60The county of the project parcel owner address. -
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:64The user who created the project parcel owner. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueThe date when the project parcel owner was created. -
DocumentNum: string
Title:
Document NumberMaximum Length:50The document number of the project parcel owner. -
EmailId: string
Title:
Email AddressMaximum Length:50The email ID of the project parcel owner. -
FaxCountry: string
Title:
Fax Country CodeMaximum Length:10The fax country code of the project parcel owner. -
FaxNum: string
Title:
Fax NumberMaximum Length:40The fax number of the project parcel owner. -
Floor: string
Title:
FloorMaximum Length:20The floor of the building. For example, mezzanine level, penthouse, or garage level C. -
HomePhoneCountry: string
Title:
Home Phone Country CodeMaximum Length:10The home phone country code of the project parcel owner. -
HomePhoneNum: string
Title:
Home Phone NumberMaximum Length:40The home phone number of the project parcel owner. -
LastTransferDate: string
(date)
Title:
Last Transfer DateThe last transfer date of the project parcel owner. -
LastTransferType: string
Title:
Last Transfer TypeMaximum Length:50The last transfer type of the project parcel owner. -
LastUpdateDate: string
(date-time)
Title:
Last Updated DateRead Only:trueThe user who last updated the project parcel owner. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:64The date when the project parcel owner was last updated. -
LastUpdateLogin: string
Title:
Last Update LoginRead Only:trueMaximum Length:32The login ID of the user who last updated the project parcel owner. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
Name1: string
Title:
Name 1Maximum Length:150The first name of the parcel owner. -
Name2: string
Title:
Name 2Maximum Length:150The second name of the parcel owner. -
OwnerId: integer
(int64)
Title:
Owner IDThe identifier of the parcel owner. -
OwnerKey: integer
(int64)
Title:
Owner IDThe unique identifier for the project parcel owner. -
OwnerType: string
Title:
Owner TypeMaximum Length:20The type of parcel owner. -
ParcelId: integer
(int64)
Title:
Parcel IDThe identifier of the parcel. -
ParcelKey: integer
(int64)
Title:
Parcel IDThe unique identifier for the project parcel. -
PostalCode: string
Title:
Postal CodeMaximum Length:60The postal code of the project parcel owner address. -
PostalPlus4Code: string
Title:
Postal Plus 4 CodeMaximum Length:20The postal plus four code of the project parcel owner address. -
PrimaryFlag: boolean
Title:
PrimaryMaximum Length:1Default Value:falseIndicates the primary project parcel owner. If the value is Y, then the parcel owner is the primary parcel owner. The default value is N. -
ProjectCode: string
Title:
Project IDMaximum Length:30The unique identifier for a project. -
Province: string
Title:
ProvinceMaximum Length:60The province of the project parcel owner address. -
State: string
Title:
StateMaximum Length:60The state of the project parcel owner address. -
StreetDirection: string
Title:
Street DirectionMaximum Length:10The street direction of the address in an project parcel owner search. Values are compass directions, such as N, S, E, W, NW, SE, and so on. -
StreetName: string
Title:
Street NameMaximum Length:240The street name of the address in the project parcel owner search. -
StreetNumber: string
Title:
Street NameMaximum Length:20The street number of the address in the project parcel owner search. -
StreetType: string
Title:
Street TypeMaximum Length:20The street type of the address in the project parcel owner search. For example, alley, boulevard, avenue, lane, street, loop, and so on. -
UnitNumber: string
Title:
Unit NumberMaximum Length:30The exact unit in a building. For example, Apartment 208A or Suite 300. -
WorkPhoneCountry: string
Title:
Work Phone Country CodeMaximum Length:10The work phone country code of the project parcel owner. -
WorkPhoneNum: string
Title:
Work Phone NumberMaximum Length:40The work phone number of the project parcel owner.
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.