Create a set of project parcel owners
post
/fscmRestApi/resources/11.13.18.05/publicSectorProjectParcelOwners
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
Maximum Length:240
The first or main address of the project parcel owner. -
Address2: string
Title:
Address Line 2
Maximum Length:240
The second address line of the project parcel owner, if applicable. -
Address3: string
Title:
Address Line 3
Maximum Length:240
The third address line of the project parcel owner, if applicable. -
Address4: string
Title:
Address Line 4
Maximum Length:240
The fourth address line of the project parcel owner, if applicable. -
AddressField1: string
Title:
Address Field 1
Maximum Length:20
The address field of the project parcel owner search. -
AddressField2: string
Title:
Address Field 2
Maximum Length:20
The address field of the project parcel owner search. -
AddressField3: string
Title:
Address Field 3
Maximum Length:20
The address field of the project parcel owner search. -
AgencyId: integer
(int32)
Default Value:
1
The unique identifier of the public sector agency. -
BuildingType: string
Title:
Building Type
Maximum Length:20
The building type of building. For example, Tower A or Block 3.The building type of the project parcel owner search. -
CellPhoneCountry: string
Title:
Cell Phone Country Code
Maximum Length:10
The cell phone country code of the project parcel owner. -
CellPhoneNum: string
Title:
Cell Phone Number
Maximum Length:40
The cell phone number of the project parcel owner. -
City: string
Title:
City
Maximum Length:60
The city of the project parcel owner. -
Country: string
Title:
Country
Maximum Length:60
The country of the project parcel owner. -
County: string
Title:
County
Maximum Length:60
The county of the project parcel owner. -
DocumentNum: string
Title:
Document Number
Maximum Length:50
The document number of the project parcel owner. -
EmailId: string
Title:
Email Address
Maximum Length:50
The email address of the project parcel owner. -
FaxCountry: string
Title:
Fax Country Code
Maximum Length:10
The fax country code of the project parcel owner. -
FaxNum: string
Title:
Fax Number
Maximum Length:40
The fax number of the project parcel owner. -
Floor: string
Title:
Floor
Maximum Length:20
The name of the floor in the building. For example, mezzanine level, penthouse, or garage level C among others. -
HomePhoneCountry: string
Title:
Home Phone Country Code
Maximum Length:10
The home phone country code of the project parcel owner. -
HomePhoneNum: string
Title:
Home Phone Number
Maximum Length:40
The home phone number of the project parcel owner. -
LastTransferDate: string
(date)
Title:
Last Transfer Date
The last transfer date of the project parcel owner. -
LastTransferType: string
Title:
Last Transfer Type
Maximum Length:50
The last transfer type of the project parcel owner. -
Name1: string
Title:
Name 1
Maximum Length:150
The first name of the parcel owner. -
Name2: string
Title:
Name 2
Maximum Length:150
The second name of the parcel owner. -
OwnerId: integer
(int64)
Title:
Owner ID
The identifier of the parcel owner. -
OwnerKey: integer
(int64)
Title:
Owner ID
The unique identifier of the project parcel owner. -
OwnerType: string
Title:
Owner Type
Maximum Length:20
The type of parcel owner. -
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 of the project parcel owner. -
PostalPlus4Code: string
Title:
Postal Plus 4 Code
Maximum Length:20
The postal plus four code value of the project parcel owner. -
PrimaryFlag: boolean
Title:
Primary
Maximum Length:1
Default Value:false
Indicates if the parcel owner is the primary project parcel owner (Y or N). The value Y indicates that the parcel owner is the primary parcel owner and the value N indicates that it is not. 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 province of the project parcel owner. -
State: string
Title:
State
Maximum Length:60
The state of the project parcel owner. -
StreetDirection: string
Title:
Street Direction
Maximum Length:10
The street direction in the project parcel owner search. Valid values are the compass directions such as N, S, E, W, NW, SE, and others. -
StreetName: string
Title:
Street Name
Maximum Length:240
The name of the street in the project parcel owner search. -
StreetNumber: string
Title:
Street Name
Maximum Length:20
The street number in the project parcel owner search. -
StreetType: string
Title:
Street Type
Maximum Length:20
The type of the street in the project parcel owner search. For example, alley, boulevard, avenue, lane, street, loop, and others. -
UnitNumber: string
Title:
Unit Number
Maximum Length:30
The particular unit in the building. For example, Apartment 208A or Suite 300. -
WorkPhoneCountry: string
Title:
Work Phone Country Code
Maximum Length:10
The work phone country code of the project parcel owner. -
WorkPhoneNum: string
Title:
Work Phone Number
Maximum Length:40
The 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 : publicSectorProjectParcelOwners-item-response
Type:
Show Source
object
-
Address1: string
Title:
Address
Maximum Length:240
The first or main address of the project parcel owner. -
Address2: string
Title:
Address Line 2
Maximum Length:240
The second address line of the project parcel owner, if applicable. -
Address3: string
Title:
Address Line 3
Maximum Length:240
The third address line of the project parcel owner, if applicable. -
Address4: string
Title:
Address Line 4
Maximum Length:240
The fourth address line of the project parcel owner, if applicable. -
AddressField1: string
Title:
Address Field 1
Maximum Length:20
The address field of the project parcel owner search. -
AddressField2: string
Title:
Address Field 2
Maximum Length:20
The address field of the project parcel owner search. -
AddressField3: string
Title:
Address Field 3
Maximum Length:20
The address field of the project parcel owner search. -
AgencyId: integer
(int32)
Default Value:
1
The unique identifier of the public sector agency. -
BuildingType: string
Title:
Building Type
Maximum Length:20
The building type of building. For example, Tower A or Block 3.The building type of the project parcel owner search. -
CellPhoneCountry: string
Title:
Cell Phone Country Code
Maximum Length:10
The cell phone country code of the project parcel owner. -
CellPhoneNum: string
Title:
Cell Phone Number
Maximum Length:40
The cell phone number of the project parcel owner. -
City: string
Title:
City
Maximum Length:60
The city of the project parcel owner. -
Country: string
Title:
Country
Maximum Length:60
The country of the project parcel owner. -
County: string
Title:
County
Maximum Length:60
The county of the project parcel owner. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The name of the user who created the project parcel owner. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the project parcel owner was created. -
DocumentNum: string
Title:
Document Number
Maximum Length:50
The document number of the project parcel owner. -
EmailId: string
Title:
Email Address
Maximum Length:50
The email address of the project parcel owner. -
FaxCountry: string
Title:
Fax Country Code
Maximum Length:10
The fax country code of the project parcel owner. -
FaxNum: string
Title:
Fax Number
Maximum Length:40
The fax number of the project parcel owner. -
Floor: string
Title:
Floor
Maximum Length:20
The name of the floor in the building. For example, mezzanine level, penthouse, or garage level C among others. -
HomePhoneCountry: string
Title:
Home Phone Country Code
Maximum Length:10
The home phone country code of the project parcel owner. -
HomePhoneNum: string
Title:
Home Phone Number
Maximum Length:40
The home phone number of the project parcel owner. -
LastTransferDate: string
(date)
Title:
Last Transfer Date
The last transfer date of the project parcel owner. -
LastTransferType: string
Title:
Last Transfer Type
Maximum Length:50
The last transfer type of the project parcel owner. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The name of the user who last updated the project parcel owner. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The date when the project parcel owner was last updated. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The login identifier of the user who last updated the project parcel owner. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Name1: string
Title:
Name 1
Maximum Length:150
The first name of the parcel owner. -
Name2: string
Title:
Name 2
Maximum Length:150
The second name of the parcel owner. -
OwnerId: integer
(int64)
Title:
Owner ID
The identifier of the parcel owner. -
OwnerKey: integer
(int64)
Title:
Owner ID
The unique identifier of the project parcel owner. -
OwnerType: string
Title:
Owner Type
Maximum Length:20
The type of parcel owner. -
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 of the project parcel owner. -
PostalPlus4Code: string
Title:
Postal Plus 4 Code
Maximum Length:20
The postal plus four code value of the project parcel owner. -
PrimaryFlag: boolean
Title:
Primary
Maximum Length:1
Default Value:false
Indicates if the parcel owner is the primary project parcel owner (Y or N). The value Y indicates that the parcel owner is the primary parcel owner and the value N indicates that it is not. 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 province of the project parcel owner. -
State: string
Title:
State
Maximum Length:60
The state of the project parcel owner. -
StreetDirection: string
Title:
Street Direction
Maximum Length:10
The street direction in the project parcel owner search. Valid values are the compass directions such as N, S, E, W, NW, SE, and others. -
StreetName: string
Title:
Street Name
Maximum Length:240
The name of the street in the project parcel owner search. -
StreetNumber: string
Title:
Street Name
Maximum Length:20
The street number in the project parcel owner search. -
StreetType: string
Title:
Street Type
Maximum Length:20
The type of the street in the project parcel owner search. For example, alley, boulevard, avenue, lane, street, loop, and others. -
UnitNumber: string
Title:
Unit Number
Maximum Length:30
The particular unit in the building. For example, Apartment 208A or Suite 300. -
WorkPhoneCountry: string
Title:
Work Phone Country Code
Maximum Length:10
The work phone country code of the project parcel owner. -
WorkPhoneNum: string
Title:
Work Phone Number
Maximum Length:40
The work phone number of the project 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.