Jump to

• Request
• Response

Get a parcel owner

get

/fscmRestApi/resources/11.13.18.05/publicSectorParcelOwners/{publicSectorParcelOwnersUniqID}

Request

Path Parameters

• publicSectorParcelOwnersUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- ParcelId and OwnerId ---for the Parcel Owners resource and used to uniquely identify an instance of Parcel Owners. The client should not generate the hash key value. Instead, the client should query on the Parcel Owners collection resource with a filter on the primary key values in order to navigate to a specific instance of Parcel Owners.
  
  For example: publicSectorParcelOwners?q=ParcelId=<value1>;OwnerId=<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 : publicSectorParcelOwners-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
  Read Only: true

  Maximum Length: 240

  The third line of the parcel owner address.
• Address4: string
  Read Only: true

  Maximum Length: 240

  The fourth line of the parcel owner address.
• 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.
• DocumentNumber: string
  Title: Document Number

  Maximum Length: 50

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

  The email address for the parcel owner.
• EnabledFlag: boolean
  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.
• 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.
• LastTransferType: string
  Title: Last Transfer Type

  Maximum Length: 50

  The last transfer type of the parcel owner.
• links: array Links
  Title: Links

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

  The code of the parcel owner.
• OwnerId: integer (int64)
  Title: Owner ID

  The unique identifier for the parcel owner.
• OwnerName: string
  Title: Owner

  Maximum Length: 150

  The name of the primary parcel owner.
• OwnerType: string
  Title: Owner Type

  Maximum Length: 20

  The type of parcel owner.
• ParcelId: integer (int64)
  The unique identifier for the parcel.
• ParcelIdEntered: string
  Title: Parcel Number

  Maximum Length: 30

  The parcel number.
• PostalCode: string
  Maximum Length: 60

  The postal code of the parcel owner.
• PostalPlus4Code: string
  Read Only: true

  Maximum Length: 10

  The postal plus 4 code of the parcel owner.
• PrimaryFlag: boolean
  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
  Read Only: true

  Maximum Length: 60

  The province of the parcel owner.
• SecondaryOwnerName: string
  Title: Secondary Owner

  Maximum Length: 150

  The name of the secondary parcel owner.
• 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.
• 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":{
        "CellPhoneNumber":{
            "maxLength":"40",
            "type":"string",
            "description":"The cell phone number of the parcel owner.",
            "nullable":true,
            "x-queryable":true
        },
        "OwnerName":{
            "title":"Owner",
            "maxLength":"150",
            "type":"string",
            "description":"The name of the primary 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
        },
        "PrimaryFlag":{
            "maxLength":"1",
            "type":"boolean",
            "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
        },
        "WorkPhoneNumber":{
            "maxLength":"40",
            "type":"string",
            "description":"The work phone number of the parcel owner.",
            "nullable":true,
            "x-queryable":true
        },
        "FaxCountry":{
            "maxLength":"10",
            "type":"string",
            "description":"The fax country code of the parcel owner.",
            "nullable":true,
            "x-queryable":true
        },
        "PostalCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The postal code 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
        },
        "StreeName":{
            "maxLength":"240",
            "type":"string",
            "description":"The street name of the 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":{
            "maxLength":"20",
            "type":"string",
            "description":"The building type of the parcel owner.",
            "nullable":true,
            "x-queryable":true
        },
        "OwnerId":{
            "title":"Owner ID",
            "type":"integer",
            "description":"The unique identifier for the parcel owner.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "Address4":{
            "maxLength":"240",
            "type":"string",
            "description":"The fourth line of the parcel owner address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "HomePhoneNumber":{
            "maxLength":"40",
            "type":"string",
            "description":"The home phone 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
        },
        "FaxNumber":{
            "maxLength":"40",
            "type":"string",
            "description":"The fax phone number of the parcel owner.",
            "nullable":true,
            "x-queryable":true
        },
        "OwnerCode":{
            "maxLength":"480",
            "type":"string",
            "description":"The code of the parcel owner.",
            "nullable":true,
            "x-queryable":true
        },
        "ParcelIdEntered":{
            "title":"Parcel Number",
            "maxLength":"30",
            "type":"string",
            "description":"The parcel number.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SecondaryOwnerName":{
            "title":"Secondary Owner",
            "maxLength":"150",
            "type":"string",
            "description":"The name of the secondary 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
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "EnabledFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the parcel owner is available to be used. The default value is N.",
            "nullable":false,
            "x-queryable":true
        },
        "ParcelId":{
            "type":"integer",
            "description":"The unique identifier for the parcel.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Floor":{
            "maxLength":"20",
            "type":"string",
            "description":"The floor the parcel owner is on.",
            "nullable":true,
            "x-queryable":true
        },
        "EmailId":{
            "maxLength":"50",
            "type":"string",
            "description":"The email address for the parcel owner.",
            "nullable":true,
            "x-queryable":true
        },
        "LastTransferType":{
            "title":"Last Transfer Type",
            "maxLength":"50",
            "type":"string",
            "description":"The last transfer type of the parcel owner.",
            "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,
            "readOnly":true,
            "x-queryable":true
        },
        "Address1":{
            "maxLength":"240",
            "type":"string",
            "description":"The first line of the parcel owner address.",
            "nullable":true,
            "x-queryable":true
        },
        "City":{
            "maxLength":"60",
            "type":"string",
            "description":"The city 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
        },
        "DocumentNumber":{
            "title":"Document Number",
            "maxLength":"50",
            "type":"string",
            "description":"The document number of the parcel owner.",
            "nullable":true,
            "x-queryable":true
        },
        "Province":{
            "maxLength":"60",
            "type":"string",
            "description":"The province of the parcel owner.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PostalPlus4Code":{
            "maxLength":"10",
            "type":"string",
            "description":"The postal plus 4 code of the parcel owner.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "State":{
            "maxLength":"60",
            "type":"string",
            "description":"The state 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
        },
        "Country":{
            "maxLength":"3",
            "type":"string",
            "description":"The country of the parcel owner.",
            "nullable":true,
            "x-queryable":true
        },
        "UnitNumber":{
            "maxLength":"30",
            "type":"string",
            "description":"The unit number of the parcel owner.",
            "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
        }
    }
}

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