Jump to

• Request
• Response

Get a project parcel owner

get

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

Request

Path Parameters

• OwnerKey(required): integer(int64)
  The unique identifier for the project parcel owner.
• 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>

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

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.

There's no request body for this operation.

Back to Top

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.

Body ()

Root Schema : publicSectorProjects-ProjectParcel-PrjParcelOwner-item-response

Type: object

Show Source

• 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 of the project parcel owner, if present.
• Address3: string
  Title: Address Line 3

  Maximum Length: 240

  The third address of the project parcel owner, if present.
• Address4: string
  Title: Address Line 4

  Maximum Length: 240

  The fourth address of the project parcel owner, if present.
• 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 for a public sector agency.
• BuildingType: string
  Title: Building Type

  Maximum Length: 20

  The building type in the project parcel owner search. For example, Tower A or Block 3.
• 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 address.
• Country: string
  Title: Country

  Maximum Length: 60

  The country of the project parcel owner address.
• County: string
  Title: County

  Maximum Length: 60

  The county of the project parcel owner address.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  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 ID 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 floor of the building. For example, mezzanine level, penthouse, or garage level C.
• 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 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 ID 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 for 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 for the project parcel.
• PostalCode: string
  Title: Postal Code

  Maximum Length: 60

  The postal code of the project parcel owner address.
• PostalPlus4Code: string
  Title: Postal Plus 4 Code

  Maximum Length: 20

  The postal plus four code of the project parcel owner address.
• PrimaryFlag: boolean
  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.
• ProjectCode: string
  Title: Project ID

  Maximum Length: 30

  The unique identifier for a project.
• Province: string
  Title: Province

  Maximum Length: 60

  The province of the project parcel owner address.
• State: string
  Title: State

  Maximum Length: 60

  The state of the project parcel owner address.
• StreetDirection: string
  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.
• StreetName: string
  Title: Street Name

  Maximum Length: 240

  The street name of the address in the project parcel owner search.
• StreetNumber: string
  Title: Street Name

  Maximum Length: 20

  The street number of the address in the project parcel owner search.
• StreetType: string
  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.
• UnitNumber: string
  Title: Unit Number

  Maximum Length: 30

  The exact unit in a 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.

{
    "type":"object",
    "properties":{
        "StreetName":{
            "title":"Street Name",
            "maxLength":"240",
            "type":"string",
            "description":"The street name of the address in the project parcel owner search.",
            "nullable":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the project parcel owner was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CellPhoneCountry":{
            "title":"Cell Phone Country Code",
            "maxLength":"10",
            "type":"string",
            "description":"The cell phone country code of the project parcel owner.",
            "nullable":true,
            "x-queryable":true
        },
        "FaxCountry":{
            "title":"Fax Country Code",
            "maxLength":"10",
            "type":"string",
            "description":"The fax country code of the project parcel owner.",
            "nullable":true,
            "x-queryable":true
        },
        "OwnerType":{
            "title":"Owner Type",
            "maxLength":"20",
            "type":"string",
            "description":"The type of parcel owner.",
            "nullable":true,
            "x-queryable":true
        },
        "BuildingType":{
            "title":"Building Type",
            "maxLength":"20",
            "type":"string",
            "description":"The building type in the project parcel owner search. For example, Tower A or Block 3.",
            "nullable":true,
            "x-queryable":true
        },
        "WorkPhoneCountry":{
            "title":"Work Phone Country Code",
            "maxLength":"10",
            "type":"string",
            "description":"The work phone country code of the project parcel owner.",
            "nullable":true,
            "x-queryable":true
        },
        "StreetNumber":{
            "title":"Street Name",
            "maxLength":"20",
            "type":"string",
            "description":"The street number of the address in the project parcel owner search.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ParcelKey":{
            "title":"Parcel ID",
            "type":"integer",
            "description":"The unique identifier for the project parcel.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Name1":{
            "title":"Name 1",
            "maxLength":"150",
            "type":"string",
            "description":"The first name of the parcel owner.",
            "nullable":true,
            "x-queryable":true
        },
        "Name2":{
            "title":"Name 2",
            "maxLength":"150",
            "type":"string",
            "description":"The second name of the parcel owner.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The date when the project parcel owner was last updated.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EmailId":{
            "title":"Email Address",
            "maxLength":"50",
            "type":"string",
            "description":"The email ID of the project parcel owner.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the project parcel owner.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "HomePhoneNum":{
            "title":"Home Phone Number",
            "maxLength":"40",
            "type":"string",
            "description":"The home phone number of the project parcel owner.",
            "nullable":true,
            "x-queryable":true
        },
        "City":{
            "title":"City",
            "maxLength":"60",
            "type":"string",
            "description":"The city of the project parcel owner address.",
            "nullable":true,
            "x-queryable":true
        },
        "StreetType":{
            "title":"Street Type",
            "maxLength":"20",
            "type":"string",
            "description":"The street type of the address in the project parcel owner search. For example, alley, boulevard, avenue, lane, street, loop, and so on.",
            "nullable":true,
            "x-queryable":true
        },
        "Province":{
            "title":"Province",
            "maxLength":"60",
            "type":"string",
            "description":"The province of the project parcel owner address.",
            "nullable":true,
            "x-queryable":true
        },
        "PostalPlus4Code":{
            "title":"Postal Plus 4 Code",
            "maxLength":"20",
            "type":"string",
            "description":"The postal plus four code of the project parcel owner address.",
            "nullable":true,
            "x-queryable":true
        },
        "State":{
            "title":"State",
            "maxLength":"60",
            "type":"string",
            "description":"The state of the project parcel owner address.",
            "nullable":true,
            "x-queryable":true
        },
        "OwnerKey":{
            "title":"Owner ID",
            "type":"integer",
            "description":"The unique identifier for the project parcel owner.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "Country":{
            "title":"Country",
            "maxLength":"60",
            "type":"string",
            "description":"The country of the project parcel owner address.",
            "nullable":true,
            "x-queryable":true
        },
        "StreetDirection":{
            "title":"Street Direction",
            "maxLength":"10",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "UnitNumber":{
            "title":"Unit Number",
            "maxLength":"30",
            "type":"string",
            "description":"The exact unit in a building. For example, Apartment 208A or Suite 300.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":"32",
            "type":"string",
            "description":"The login ID of the user who last updated the project parcel owner.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryFlag":{
            "title":"Primary",
            "maxLength":"1",
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "AgencyId":{
            "type":"integer",
            "description":"The unique identifier for a public sector agency.",
            "format":"int32",
            "nullable":false,
            "default":"1",
            "x-hints":{
                "precision":"8"
            },
            "x-queryable":true
        },
        "FaxNum":{
            "title":"Fax Number",
            "maxLength":"40",
            "type":"string",
            "description":"The fax number of the project parcel owner.",
            "nullable":true,
            "x-queryable":true
        },
        "PostalCode":{
            "title":"Postal Code",
            "maxLength":"60",
            "type":"string",
            "description":"The postal code of the project parcel owner address.",
            "nullable":true,
            "x-queryable":true
        },
        "County":{
            "title":"County",
            "maxLength":"60",
            "type":"string",
            "description":"The county of the project parcel owner address.",
            "nullable":true,
            "x-queryable":true
        },
        "OwnerId":{
            "title":"Owner ID",
            "type":"integer",
            "description":"The identifier of the parcel owner.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Address4":{
            "title":"Address Line 4",
            "maxLength":"240",
            "type":"string",
            "description":"The fourth address of the project parcel owner, if present.",
            "nullable":true,
            "x-queryable":true
        },
        "DocumentNum":{
            "title":"Document Number",
            "maxLength":"50",
            "type":"string",
            "description":"The document number of the project parcel owner.",
            "nullable":true,
            "x-queryable":true
        },
        "ProjectCode":{
            "title":"Project ID",
            "maxLength":"30",
            "type":"string",
            "description":"The unique identifier for a project.",
            "nullable":false,
            "x-queryable":true
        },
        "AddressField1":{
            "title":"Address Field 1",
            "maxLength":"20",
            "type":"string",
            "description":"The address field of the project parcel owner search.",
            "nullable":true,
            "x-queryable":true
        },
        "AddressField3":{
            "title":"Address Field 3",
            "maxLength":"20",
            "type":"string",
            "description":"The address field of the project parcel owner search.",
            "nullable":true,
            "x-queryable":true
        },
        "AddressField2":{
            "title":"Address Field 2",
            "maxLength":"20",
            "type":"string",
            "description":"The address field of the project parcel owner search.",
            "nullable":true,
            "x-queryable":true
        },
        "ParcelId":{
            "title":"Parcel ID",
            "type":"integer",
            "description":"The identifier of the parcel.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Floor":{
            "title":"Floor",
            "maxLength":"20",
            "type":"string",
            "description":"The floor of the building. For example, mezzanine level, penthouse, or garage level C.",
            "nullable":true,
            "x-queryable":true
        },
        "LastTransferType":{
            "title":"Last Transfer Type",
            "maxLength":"50",
            "type":"string",
            "description":"The last transfer type of the project parcel owner.",
            "nullable":true,
            "x-queryable":true
        },
        "Address2":{
            "title":"Address Line 2",
            "maxLength":"240",
            "type":"string",
            "description":"The second address of the project parcel owner, if present.",
            "nullable":true,
            "x-queryable":true
        },
        "Address3":{
            "title":"Address Line 3",
            "maxLength":"240",
            "type":"string",
            "description":"The third address of the project parcel owner, if present.",
            "nullable":true,
            "x-queryable":true
        },
        "Address1":{
            "title":"Address",
            "maxLength":"240",
            "type":"string",
            "description":"The first or main address of the project parcel owner.",
            "nullable":true,
            "x-queryable":true
        },
        "WorkPhoneNum":{
            "title":"Work Phone Number",
            "maxLength":"40",
            "type":"string",
            "description":"The work phone number of the project parcel owner.",
            "nullable":true,
            "x-queryable":true
        },
        "CellPhoneNum":{
            "title":"Cell Phone Number",
            "maxLength":"40",
            "type":"string",
            "description":"The cell phone number of the project parcel owner.",
            "nullable":true,
            "x-queryable":true
        },
        "HomePhoneCountry":{
            "title":"Home Phone Country Code",
            "maxLength":"10",
            "type":"string",
            "description":"The home phone country code of the project parcel owner.",
            "nullable":true,
            "x-queryable":true
        },
        "LastTransferDate":{
            "title":"Last Transfer Date",
            "type":"string",
            "description":"The last transfer date of the project parcel owner.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The user who last updated the project parcel owner.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top