Get all record parcel owners

get

/fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/RecordParcel/{ParcelKey}/child/ParcelOwner

Request

Path Parameters
Query Parameters
  • 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>
  • 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).
  • 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
  • Used as a predefined finder to search the collection.

    Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    The following are the available finder names and corresponding finder variables:

    • PrimaryKey: Finds a parcel owner using the specified primary key criteria.
      Finder Variables:
      • OwnerKey; integer; The unique identifier for a parcel owner.
  • This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
  • 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
  • Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
  • This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY

    Format: ?q=expression1;expression2

    You can use these queryable attributes to filter this collection resource using the q query parameter:
    • Address1; string; The first or main address of the parcel owner.
    • Address2; string; The second address of the parcel owner, if present.
    • Address3; string; The third address of the parcel owner, if present.
    • Address4; string; The fourth address of the parcel owner, if present.
    • AgencyId; integer; The unique identifier for a public sector agency associated with a parcel owner.
    • BuildingType; string; The building type of building used in an address search. For example, Tower A or Block 3.
    • CellPhoneCountry; string; The country code for the cell phone number of parcel owner.
    • CellPhoneNumber; string; The cell phone number of the parcel owner.
    • City; string; The city in the parcel owner's address.
    • Country; string; The country in the parcel owner's address.
    • County; string; The county in the parcel owner's address.
    • CreationDate; string; The date when the parcel owner was created.
    • DocumentNumber; string; The County Recorder's office document number for the transfer of ownership.
    • EmailId; string; The email address of the parcel owner.
    • FaxCountry; string; The country code for the fax number of the parcel owner.
    • FaxNumber; string; The fax number of the parcel owner.
    • Floor; string; The floor or level in an address search. For example, mezzanine level, penthouse, or garage level C.
    • HomePhoneCountry; string; The country code for the home telephone number of the parcel owner.
    • HomePhoneNumber; string; The home telephone number of the parcel owner.
    • LastTransferDate; string; The date of the last transfer of ownership.
    • LastTransferType; string; The type of last transfer of ownership. For example, grant deed, gift deed, or regular sale.
    • LastUpdateDate; string; The date when the parcel owner was last updated.
    • LnpRecordId; string; The unique identifier for the application record.
    • LnpRecordKey; integer; The unique identifier for the record associated with the parcel.
    • Owner; string; The name of the first or main owner.
    • OwnerId; integer; The unique identifier for the parcel owner.
    • OwnerKey; integer; The unique identifier for a record parcel owner.
    • OwnerType; string; The type of ownership. For example, business or private person.
    • ParcelId; integer; The unique identifier for the parcel.
    • ParcelKey; integer; The unique identifier for the record parcel.
    • PostalCode; string; The postal code in the parcel owner's address.
    • PostalPlus4Code; string; An extended postal code in the parcel owner's address.
    • PrimaryFlag; boolean; The primary parcel owner. If the value is Y, the parcel owner is the primary owner. The default value is N.
    • Province; string; The province in the parcel owner's address.
    • SecondaryOwner; string; The name of the secondary owner.
    • State; string; The state in the parcel owner's address.
    • StreetDirection; string; 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; The street name in the parcel owner's address used during a search.
    • StreetNumber; string; The street number in the parcel owner's address.
    • StreetType; string; The street type designation used during a search. For example, alley, boulevard, avenue, lane, street, loop, and so on.
    • UnitNumber; string; The exact unit in a building used in an address search. For example, Apartment 208A or Suite 300.
    • WorkPhoneCountry; string; The country code for the work telephone number of the parcel owner.
    • WorkPhoneNumber; string; The work telephone number of the parcel owner.
  • The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
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.

There's no request body for this operation.

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 : publicSectorRecords-RecordParcel-ParcelOwner
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : publicSectorRecords-RecordParcel-ParcelOwner-item-response
Type: object
Show Source
  • Title: Address Line 1
    Maximum Length: 240
    The first or main address of the parcel owner.
  • Title: Address Line 2
    Maximum Length: 240
    The second address of the parcel owner, if present.
  • Title: Address Line 3
    Maximum Length: 240
    The third address of the parcel owner, if present.
  • Title: Address Line 4
    Maximum Length: 240
    The fourth address of the parcel owner, if present.
  • Title: Agency ID
    Default Value: 1
    The unique identifier for a public sector agency associated with a parcel owner.
  • Title: Building
    Maximum Length: 20
    The building type of building used in an address search. For example, Tower A or Block 3.
  • Title: Cell Phone Country
    Maximum Length: 10
    The country code for the cell phone number of parcel owner.
  • Title: Cell Phone
    Maximum Length: 40
    The cell phone number of the parcel owner.
  • Title: City
    Maximum Length: 60
    The city in the parcel owner's address.
  • Title: Country
    Maximum Length: 60
    The country in the parcel owner's address.
  • Title: County
    Maximum Length: 60
    The county in the parcel owner's address.
  • Title: Creation Date
    Read Only: true
    The date when the parcel owner was created.
  • Title: Document
    Maximum Length: 50
    The County Recorder's office document number for the transfer of ownership.
  • Title: Email
    Maximum Length: 50
    The email address of the parcel owner.
  • Title: Fax Country
    Maximum Length: 10
    The country code for the fax number of the parcel owner.
  • Title: Fax
    Maximum Length: 40
    The fax number of the parcel owner.
  • Title: Floor
    Maximum Length: 20
    The floor or level in an address search. For example, mezzanine level, penthouse, or garage level C.
  • Title: Home Phone Country
    Maximum Length: 10
    The country code for the home telephone number of the parcel owner.
  • Title: Home Phone
    Maximum Length: 40
    The home telephone number of the parcel owner.
  • Title: Last Transfer Date
    The date of the last transfer of ownership.
  • Title: Last Transfer Type
    Maximum Length: 50
    The type of last transfer of ownership. For example, grant deed, gift deed, or regular sale.
  • Title: Last Updated Date
    Read Only: true
    The date when the parcel owner was last updated.
  • Links
  • Title: Record ID
    Maximum Length: 50
    The unique identifier for the application record.
  • Title: Record
    The unique identifier for the record associated with the parcel.
  • Title: Owner
    Maximum Length: 150
    The name of the first or main owner.
  • Title: Owner
    The unique identifier for the parcel owner.
  • Title: Owner Key
    The unique identifier for a record parcel owner.
  • Title: Ownership Type
    Maximum Length: 20
    The type of ownership. For example, business or private person.
  • Title: Parcel
    The unique identifier for the parcel.
  • Title: Parcel Key
    The unique identifier for the record parcel.
  • Title: Postal Code
    Maximum Length: 60
    The postal code in the parcel owner's address.
  • Title: Postal Plus 4 Code
    Maximum Length: 20
    An extended postal code in the parcel owner's address.
  • Title: Primary
    Maximum Length: 1
    The primary parcel owner. If the value is Y, the parcel owner is the primary owner. The default value is N.
  • Title: Province
    Maximum Length: 60
    The province in the parcel owner's address.
  • Title: Secondary Owner
    Maximum Length: 150
    The name of the secondary owner.
  • Title: State
    Maximum Length: 60
    The state in the parcel owner's address.
  • 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.
  • Title: Street
    Maximum Length: 240
    The street name in the parcel owner's address used during a search.
  • Title: Street Number
    Maximum Length: 20
    The street number in the parcel owner's address.
  • 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.
  • Title: Unit
    Maximum Length: 30
    The exact unit in a building used in an address search. For example, Apartment 208A or Suite 300.
  • Title: Work Phone Country
    Maximum Length: 10
    The country code for the work telephone number of the parcel owner.
  • Title: Work Phone
    Maximum Length: 40
    The work telephone number of the parcel owner.
Back to Top