Jump to

• Request
• Response

Get a parcel genealogy transaction owner

get

/fscmRestApi/resources/11.13.18.05/publicSectorParcelTransactionDetails/{ParcelTrxDtlKey}/child/TransactionOwner/{ParcelTrxOwnKey}

Request

Path Parameters

• ParcelTrxDtlKey(required): integer(int64)
  The new identifier for parcel genealogy transaction detail.
• ParcelTrxOwnKey(required): integer(int64)
  The new identifier for a parcel genealogy transaction owner.

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: string
  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: string
  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 : publicSectorParcelTransactionDetails-TransactionOwner-item-response

Type: object

Show Source

• Address1: string
  Maximum Length: 240

  The first line of the parcel owner address.
• Address2: string
  Maximum Length: 240

  The second line of the parcel owner address.
• Address3: string
  Maximum Length: 240

  The third line of the parcel owner address.
• Address4: string
  Maximum Length: 240

  The fourth line of the parcel owner address.
• AddressFieldOne: string
  Maximum Length: 20

  The first line of the parcel owner address.
• AddressFieldThree: string
  Maximum Length: 20

  The third line of the parcel owner address.
• AddressFieldTwo: string
  Maximum Length: 20

  The second line of the parcel owner address.
• AssignedToChildParcel: string
  Maximum Length: 50

  Indicates whether the owner is assigned to the parcel.
• BuildingType: string
  Maximum Length: 20

  The building type of the parcel owner.
• CellPhoneCountry: string
  Maximum Length: 10

  Tthe cell phone country code of the parcel owner.
• CellPhoneNumber: string
  Maximum Length: 40

  The cell phone number of the parcel owner.
• City: string
  Maximum Length: 60

  The city of the parcel owner.
• Country: string
  Maximum Length: 3

  The country of the parcel owner.
• County: string
  Maximum Length: 60

  The county of the parcel owner.
• CreationDate: string (date-time)
  Read Only: true

  The date and time that the parcel genealogy transaction owner was created.
• DisplayParentParcel: string
  Maximum Length: 50

  Parent parcel information.
• DocumentNumber: string
  Maximum Length: 50

  The document number of the parcel owner.
• EmailId: string
  Maximum Length: 50

  The email address for the parcel owner.
• EnabledFlag: string
  Maximum Length: 1

  Indicates whether the parcel owner is available to be used. The default value is N.
• FaxCountry: string
  Maximum Length: 10

  The fax country code of the parcel owner.
• FaxNumber: string
  Maximum Length: 40

  The fax phone number of the parcel owner.
• FinalParcelIdEntered: string
  Maximum Length: 50

  The final parcel number.
• Floor: string
  Maximum Length: 20

  The floor the parcel owner is on.
• HomePhoneCountry: string
  Maximum Length: 10

  The home phone country code of the parcel owner.
• HomePhoneNumber: string
  Maximum Length: 40

  The home phone number of the parcel owner.
• LastTransferDate: string (date)
  The last transfer date of the parcel owner.
• LastTransferType: string
  Maximum Length: 50

  The last transfer type of the parcel owner.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date and time that the parcel genealogy transaction owner was last updated.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OwnerCode: string
  Maximum Length: 32

  The code of the parcel owner.
• OwnerId: integer (int64)
  The unique identifier for the parcel owner.
• OwnerName: string
  Maximum Length: 150

  The name of the primary parcel owner.
• OwnerType: string
  Maximum Length: 20

  The type of parcel owner.
• ParcelIdEntered: string
  Maximum Length: 50

  Identifier entered by the user for the parcel of real estate. In the USA, this is the Assessor Parcel Number.
• ParcelTrxDtlKey: integer (int64)
  The new identifier for parcel genealogy transaction detail.
• ParcelTrxDtlPuid: string
  Maximum Length: 480

  The public unique identifier for parcel genealogy transaction detail. Used to import data.
• ParcelTrxKey: integer (int64)
  The new identifier for a parcel genealogy transaction.
• ParcelTrxOwnKey: integer (int64)
  The new identifier for a parcel genealogy transaction owner.
• ParcelTrxOwnPuid: string
  Maximum Length: 480

  The public unique identifier for a parcel genealogy transaction owner. Used to import data.
• ParentParcelId: integer (int64)
  Unique identifier of the parent parcel.
• ParentParcelIdEntered: string
  Maximum Length: 50

  Parent parcel Assessor Parcel Number.
• PostalCode: string
  Maximum Length: 60

  The postal code of the parcel owner.
• PostalPlus4Code: string
  Maximum Length: 10

  The postal plus 4 code of the parcel owner.
• PreviousState: string
  Maximum Length: 20

  The previous state of this row.
• PrimaryFlag: string
  Maximum Length: 1

  Indicates whether the parcel owner is the primary owner for the parcel. If the value is Y, the parcel owner is the primary owner. The default value is N.
• Province: string
  Maximum Length: 60

  The province of the parcel owner.
• ProvisionalParcelIdEntered: string
  Maximum Length: 50

  The provisional parcel number.
• SecondaryOwnerName: string
  Maximum Length: 150

  The name of the secondary parcel owner.
• Selected: string
  Maximum Length: 1

  Indicates whether the owner is assigned to the parcel.
• State: string
  Maximum Length: 60

  The state of the parcel owner.
• StreeName: string
  Maximum Length: 240

  The street name of the parcel owner.
• StreetDirection: string
  Maximum Length: 10

  The street direction of the parcel owner.
• StreetNumber: string
  Maximum Length: 20

  The street number of the parcel owner.
• StreetType: string
  Maximum Length: 20

  The street type of the parcel owner.
• SummaryRow: string
  Maximum Length: 1

  Indicates whether the row summarizes parcel owner information.
• Temporary: string
  Maximum Length: 1

  Indicates whether the data in this row is temporary.
• UnitNumber: string
  Maximum Length: 30

  The unit number of the parcel owner.
• WorkPhoneCountry: string
  Maximum Length: 10

  The work phone country code of the parcel owner.
• WorkPhoneNumber: string
  Maximum Length: 40

  The work phone number of the parcel owner.

{
    "type":"object",
    "properties":{
        "Address1":{
            "maxLength":240,
            "type":"string",
            "description":"The first line of the parcel owner address.",
            "nullable":true,
            "x-queryable":true
        },
        "Address2":{
            "maxLength":240,
            "type":"string",
            "description":"The second line of the parcel owner address.",
            "nullable":true,
            "x-queryable":true
        },
        "Address3":{
            "maxLength":240,
            "type":"string",
            "description":"The third line of the parcel owner address.",
            "nullable":true,
            "x-queryable":true
        },
        "Address4":{
            "maxLength":240,
            "type":"string",
            "description":"The fourth line of the parcel owner address.",
            "nullable":true,
            "x-queryable":true
        },
        "AddressFieldOne":{
            "maxLength":20,
            "type":"string",
            "description":"The first line of the parcel owner address.",
            "nullable":true,
            "x-queryable":true
        },
        "AddressFieldThree":{
            "maxLength":20,
            "type":"string",
            "description":"The third line of the parcel owner address.",
            "nullable":true,
            "x-queryable":true
        },
        "AddressFieldTwo":{
            "maxLength":20,
            "type":"string",
            "description":"The second line of the parcel owner address.",
            "nullable":true,
            "x-queryable":true
        },
        "AssignedToChildParcel":{
            "maxLength":50,
            "type":"string",
            "description":"Indicates whether the owner is assigned to the parcel.",
            "nullable":true,
            "x-queryable":true
        },
        "BuildingType":{
            "maxLength":20,
            "type":"string",
            "description":"The building type of the parcel owner.",
            "nullable":true,
            "x-queryable":true
        },
        "CellPhoneCountry":{
            "maxLength":10,
            "type":"string",
            "description":"Tthe cell phone country code of the parcel owner.",
            "nullable":true,
            "x-queryable":true
        },
        "CellPhoneNumber":{
            "maxLength":40,
            "type":"string",
            "description":"The cell phone number of the parcel owner.",
            "nullable":true,
            "x-queryable":true
        },
        "City":{
            "maxLength":60,
            "type":"string",
            "description":"The city of the parcel owner.",
            "nullable":true,
            "x-queryable":true
        },
        "Country":{
            "maxLength":3,
            "type":"string",
            "description":"The country of the parcel owner.",
            "nullable":true,
            "x-queryable":true
        },
        "County":{
            "maxLength":60,
            "type":"string",
            "description":"The county of the parcel owner.",
            "nullable":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time that the parcel genealogy transaction owner was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DisplayParentParcel":{
            "maxLength":50,
            "type":"string",
            "description":"Parent parcel information.",
            "nullable":true,
            "x-queryable":true
        },
        "DocumentNumber":{
            "maxLength":50,
            "type":"string",
            "description":"The document number of the parcel owner.",
            "nullable":true,
            "x-queryable":true
        },
        "EmailId":{
            "maxLength":50,
            "type":"string",
            "description":"The email address for the parcel owner.",
            "nullable":true,
            "x-queryable":true
        },
        "EnabledFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the parcel owner is available to be used. The default value is N.",
            "nullable":true,
            "x-queryable":true
        },
        "FaxCountry":{
            "maxLength":10,
            "type":"string",
            "description":"The fax country code of the parcel owner.",
            "nullable":true,
            "x-queryable":true
        },
        "FaxNumber":{
            "maxLength":40,
            "type":"string",
            "description":"The fax phone number of the parcel owner.",
            "nullable":true,
            "x-queryable":true
        },
        "FinalParcelIdEntered":{
            "maxLength":50,
            "type":"string",
            "description":"The final parcel number.",
            "nullable":true,
            "x-queryable":true
        },
        "Floor":{
            "maxLength":20,
            "type":"string",
            "description":"The floor the parcel owner is on.",
            "nullable":true,
            "x-queryable":true
        },
        "HomePhoneCountry":{
            "maxLength":10,
            "type":"string",
            "description":"The home phone country code of the parcel owner.",
            "nullable":true,
            "x-queryable":true
        },
        "HomePhoneNumber":{
            "maxLength":40,
            "type":"string",
            "description":"The home phone number of the parcel owner.",
            "nullable":true,
            "x-queryable":true
        },
        "LastTransferDate":{
            "type":"string",
            "description":"The last transfer date of the parcel owner.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "LastTransferType":{
            "maxLength":50,
            "type":"string",
            "description":"The last transfer type of the parcel owner.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time that the parcel genealogy transaction owner was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OwnerCode":{
            "maxLength":32,
            "type":"string",
            "description":"The code of the parcel owner.",
            "nullable":true,
            "x-queryable":true
        },
        "OwnerId":{
            "type":"integer",
            "description":"The unique identifier for the parcel owner.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OwnerName":{
            "maxLength":150,
            "type":"string",
            "description":"The name of the primary parcel owner.",
            "nullable":true,
            "x-queryable":true
        },
        "OwnerType":{
            "maxLength":20,
            "type":"string",
            "description":"The type of parcel owner.",
            "nullable":true,
            "x-queryable":true
        },
        "ParcelIdEntered":{
            "maxLength":50,
            "type":"string",
            "description":"Identifier entered by the user for the parcel of real estate. In the USA, this is the Assessor Parcel Number.",
            "nullable":true,
            "x-queryable":true
        },
        "ParcelTrxDtlKey":{
            "type":"integer",
            "description":"The new identifier for parcel genealogy transaction detail.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ParcelTrxDtlPuid":{
            "maxLength":480,
            "type":"string",
            "description":"The public unique identifier for parcel genealogy transaction detail. Used to import data.",
            "nullable":true,
            "x-queryable":true
        },
        "ParcelTrxKey":{
            "type":"integer",
            "description":"The new identifier for a parcel genealogy transaction.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ParcelTrxOwnKey":{
            "type":"integer",
            "description":"The new identifier for a parcel genealogy transaction owner.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ParcelTrxOwnPuid":{
            "maxLength":480,
            "type":"string",
            "description":"The public unique identifier for a parcel genealogy transaction owner. Used to import data.",
            "nullable":true,
            "x-queryable":true
        },
        "ParentParcelId":{
            "type":"integer",
            "description":"Unique identifier of the parent parcel.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ParentParcelIdEntered":{
            "maxLength":50,
            "type":"string",
            "description":"Parent parcel Assessor Parcel Number.",
            "nullable":true,
            "x-queryable":true
        },
        "PostalCode":{
            "maxLength":60,
            "type":"string",
            "description":"The postal code of the parcel owner.",
            "nullable":true,
            "x-queryable":true
        },
        "PostalPlus4Code":{
            "maxLength":10,
            "type":"string",
            "description":"The postal plus 4 code of the parcel owner.",
            "nullable":true,
            "x-queryable":true
        },
        "PreviousState":{
            "maxLength":20,
            "type":"string",
            "description":"The previous state of this row.",
            "nullable":true,
            "x-queryable":true
        },
        "PrimaryFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the parcel owner is the primary owner for the parcel. If the value is Y, the parcel owner is the primary owner. The default value is N.",
            "nullable":true,
            "x-queryable":true
        },
        "Province":{
            "maxLength":60,
            "type":"string",
            "description":"The province of the parcel owner.",
            "nullable":true,
            "x-queryable":true
        },
        "ProvisionalParcelIdEntered":{
            "maxLength":50,
            "type":"string",
            "description":"The provisional parcel number.",
            "nullable":true,
            "x-queryable":true
        },
        "SecondaryOwnerName":{
            "maxLength":150,
            "type":"string",
            "description":"The name of the secondary parcel owner.",
            "nullable":true,
            "x-queryable":true
        },
        "Selected":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the owner is assigned to the parcel.",
            "nullable":true,
            "x-queryable":true
        },
        "State":{
            "maxLength":60,
            "type":"string",
            "description":"The state of the parcel owner.",
            "nullable":true,
            "x-queryable":true
        },
        "StreeName":{
            "maxLength":240,
            "type":"string",
            "description":"The street name of the parcel owner.",
            "nullable":true,
            "x-queryable":true
        },
        "StreetDirection":{
            "maxLength":10,
            "type":"string",
            "description":"The street direction of the parcel owner.",
            "nullable":true,
            "x-queryable":true
        },
        "StreetNumber":{
            "maxLength":20,
            "type":"string",
            "description":"The street number of the parcel owner.",
            "nullable":true,
            "x-queryable":true
        },
        "StreetType":{
            "maxLength":20,
            "type":"string",
            "description":"The street type of the parcel owner.",
            "nullable":true,
            "x-queryable":true
        },
        "SummaryRow":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the row summarizes parcel owner information.",
            "nullable":true,
            "x-queryable":true
        },
        "Temporary":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the data in this row is temporary.",
            "nullable":true,
            "x-queryable":true
        },
        "UnitNumber":{
            "maxLength":30,
            "type":"string",
            "description":"The unit number of the parcel owner.",
            "nullable":true,
            "x-queryable":true
        },
        "WorkPhoneCountry":{
            "maxLength":10,
            "type":"string",
            "description":"The work phone country code of the parcel owner.",
            "nullable":true,
            "x-queryable":true
        },
        "WorkPhoneNumber":{
            "maxLength":40,
            "type":"string",
            "description":"The work phone number of the parcel owner.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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