Create a project parcel owner

post

/fscmRestApi/resources/11.13.18.05/publicSectorProjects/{publicSectorProjectsUniqID}/child/ProjectParcel/{ParcelKey}/child/PrjParcelOwner

Request

Path Parameters
  • The unique identifier for the project parcel.
  • 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
  • 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".
  • 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.
  • 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
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
  • Title: Address
    Maximum Length: 240
    The first or main address of the project parcel owner.
  • Title: Address Line 2
    Maximum Length: 240
    The second address of the project parcel owner, if present.
  • Title: Address Line 3
    Maximum Length: 240
    The third address of the project parcel owner, if present.
  • Title: Address Line 4
    Maximum Length: 240
    The fourth address of the project parcel owner, if present.
  • Title: Address Field 1
    Maximum Length: 20
    The address field of the project parcel owner search.
  • Title: Address Field 2
    Maximum Length: 20
    The address field of the project parcel owner search.
  • Title: Address Field 3
    Maximum Length: 20
    The address field of the project parcel owner search.
  • Default Value: 1
    The unique identifier for a public sector agency.
  • Title: Building Type
    Maximum Length: 20
    The building type in the project parcel owner search. For example, Tower A or Block 3.
  • Title: Cell Phone Country Code
    Maximum Length: 10
    The cell phone country code of the project parcel owner.
  • Title: Cell Phone Number
    Maximum Length: 40
    The cell phone number of the project parcel owner.
  • Title: City
    Maximum Length: 60
    The city of the project parcel owner address.
  • Title: Country
    Maximum Length: 60
    The country of the project parcel owner address.
  • Title: County
    Maximum Length: 60
    The county of the project parcel owner address.
  • Title: Document Number
    Maximum Length: 50
    The document number of the project parcel owner.
  • Title: Email Address
    Maximum Length: 50
    The email ID of the project parcel owner.
  • Title: Fax Country Code
    Maximum Length: 10
    The fax country code of the project parcel owner.
  • Title: Fax Number
    Maximum Length: 40
    The fax number of the project parcel owner.
  • Title: Floor
    Maximum Length: 20
    The floor of the building. For example, mezzanine level, penthouse, or garage level C.
  • Title: Home Phone Country Code
    Maximum Length: 10
    The home phone country code of the project parcel owner.
  • Title: Home Phone Number
    Maximum Length: 40
    The home phone number of the project parcel owner.
  • Title: Last Transfer Date
    The last transfer date of the project parcel owner.
  • Title: Last Transfer Type
    Maximum Length: 50
    The last transfer type of the project parcel owner.
  • Title: Name 1
    Maximum Length: 150
    The first name of the parcel owner.
  • Title: Name 2
    Maximum Length: 150
    The second name of the parcel owner.
  • Title: Owner ID
    The identifier of the parcel owner.
  • Title: Owner ID
    The unique identifier for the project parcel owner.
  • Title: Owner Type
    Maximum Length: 20
    The type of parcel owner.
  • Title: Parcel ID
    The identifier of the parcel.
  • Title: Parcel ID
    The unique identifier for the project parcel.
  • Title: Postal Code
    Maximum Length: 60
    The postal code of the project parcel owner address.
  • Title: Postal Plus 4 Code
    Maximum Length: 20
    The postal plus four code of the project parcel owner address.
  • Title: Primary
    Maximum Length: 1
    Default Value: false
    Indicates the primary project parcel owner. If the value is Y, then the parcel owner is the primary parcel owner. The default value is N.
  • Title: Project ID
    Maximum Length: 30
    The unique identifier for a project.
  • Title: Province
    Maximum Length: 60
    The province of the project parcel owner address.
  • Title: State
    Maximum Length: 60
    The state of the project parcel owner address.
  • Title: Street Direction
    Maximum Length: 10
    The 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.
  • Title: Street Name
    Maximum Length: 240
    The street name of the address in the project parcel owner search.
  • Title: Street Name
    Maximum Length: 20
    The street number of the address in the project parcel owner search.
  • Title: Street Type
    Maximum Length: 20
    The street type of the address in the project parcel owner search. For example, alley, boulevard, avenue, lane, street, loop, and so on.
  • Title: Unit Number
    Maximum Length: 30
    The exact unit in a building. For example, Apartment 208A or Suite 300.
  • Title: Work Phone Country Code
    Maximum Length: 10
    The work phone country code of the project parcel owner.
  • Title: Work Phone Number
    Maximum Length: 40
    The work phone number of the project parcel owner.
Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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.
Body ()
Root Schema : publicSectorProjects-ProjectParcel-PrjParcelOwner-item-response
Type: object
Show Source
  • Title: Address
    Maximum Length: 240
    The first or main address of the project parcel owner.
  • Title: Address Line 2
    Maximum Length: 240
    The second address of the project parcel owner, if present.
  • Title: Address Line 3
    Maximum Length: 240
    The third address of the project parcel owner, if present.
  • Title: Address Line 4
    Maximum Length: 240
    The fourth address of the project parcel owner, if present.
  • Title: Address Field 1
    Maximum Length: 20
    The address field of the project parcel owner search.
  • Title: Address Field 2
    Maximum Length: 20
    The address field of the project parcel owner search.
  • Title: Address Field 3
    Maximum Length: 20
    The address field of the project parcel owner search.
  • Default Value: 1
    The unique identifier for a public sector agency.
  • Title: Building Type
    Maximum Length: 20
    The building type in the project parcel owner search. For example, Tower A or Block 3.
  • Title: Cell Phone Country Code
    Maximum Length: 10
    The cell phone country code of the project parcel owner.
  • Title: Cell Phone Number
    Maximum Length: 40
    The cell phone number of the project parcel owner.
  • Title: City
    Maximum Length: 60
    The city of the project parcel owner address.
  • Title: Country
    Maximum Length: 60
    The country of the project parcel owner address.
  • Title: County
    Maximum Length: 60
    The county of the project parcel owner address.
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    The user who created the project parcel owner.
  • Title: Creation Date
    Read Only: true
    The date when the project parcel owner was created.
  • Title: Document Number
    Maximum Length: 50
    The document number of the project parcel owner.
  • Title: Email Address
    Maximum Length: 50
    The email ID of the project parcel owner.
  • Title: Fax Country Code
    Maximum Length: 10
    The fax country code of the project parcel owner.
  • Title: Fax Number
    Maximum Length: 40
    The fax number of the project parcel owner.
  • Title: Floor
    Maximum Length: 20
    The floor of the building. For example, mezzanine level, penthouse, or garage level C.
  • Title: Home Phone Country Code
    Maximum Length: 10
    The home phone country code of the project parcel owner.
  • Title: Home Phone Number
    Maximum Length: 40
    The home phone number of the project parcel owner.
  • Title: Last Transfer Date
    The last transfer date of the project parcel owner.
  • Title: Last Transfer Type
    Maximum Length: 50
    The last transfer type of the project parcel owner.
  • Title: Last Updated Date
    Read Only: true
    The user who last updated the project parcel owner.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    The date when the project parcel owner was last updated.
  • Title: Last Update Login
    Read Only: true
    Maximum Length: 32
    The login ID of the user who last updated the project parcel owner.
  • Links
  • Title: Name 1
    Maximum Length: 150
    The first name of the parcel owner.
  • Title: Name 2
    Maximum Length: 150
    The second name of the parcel owner.
  • Title: Owner ID
    The identifier of the parcel owner.
  • Title: Owner ID
    The unique identifier for the project parcel owner.
  • Title: Owner Type
    Maximum Length: 20
    The type of parcel owner.
  • Title: Parcel ID
    The identifier of the parcel.
  • Title: Parcel ID
    The unique identifier for the project parcel.
  • Title: Postal Code
    Maximum Length: 60
    The postal code of the project parcel owner address.
  • Title: Postal Plus 4 Code
    Maximum Length: 20
    The postal plus four code of the project parcel owner address.
  • Title: Primary
    Maximum Length: 1
    Default Value: false
    Indicates the primary project parcel owner. If the value is Y, then the parcel owner is the primary parcel owner. The default value is N.
  • Title: Project ID
    Maximum Length: 30
    The unique identifier for a project.
  • Title: Province
    Maximum Length: 60
    The province of the project parcel owner address.
  • Title: State
    Maximum Length: 60
    The state of the project parcel owner address.
  • Title: Street Direction
    Maximum Length: 10
    The 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.
  • Title: Street Name
    Maximum Length: 240
    The street name of the address in the project parcel owner search.
  • Title: Street Name
    Maximum Length: 20
    The street number of the address in the project parcel owner search.
  • Title: Street Type
    Maximum Length: 20
    The street type of the address in the project parcel owner search. For example, alley, boulevard, avenue, lane, street, loop, and so on.
  • Title: Unit Number
    Maximum Length: 30
    The exact unit in a building. For example, Apartment 208A or Suite 300.
  • Title: Work Phone Country Code
    Maximum Length: 10
    The work phone country code of the project parcel owner.
  • Title: Work Phone Number
    Maximum Length: 40
    The work phone number of the project parcel owner.
Back to Top