Get a parcel owner
get
/fscmRestApi/resources/11.13.18.05/publicSectorParcelOwners/{publicSectorParcelOwnersUniqID}
Request
Path Parameters
-
publicSectorParcelOwnersUniqID: integer
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 attributes that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The attributes 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 attributes 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 attributes. 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 attributes. Only the specified attributes are returned, which means that if no attributes are specified, no attributes 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 attributes. 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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
Response
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
Default Response
The following table describes the default response for this task.
Root Schema : publicSectorParcelOwners-item
Type:
Show Source
object
-
Address1(optional):
string
Maximum Length:
240
The first line of the parcel owner address. -
Address2(optional):
string
Maximum Length:
240
The second line of the parcel owner address. -
Address3(optional):
string
Maximum Length:
240
The third line of the parcel owner address. -
Address4(optional):
string
Maximum Length:
240
The fourth line of the parcel owner address. -
BuildingType(optional):
string
Maximum Length:
20
The building type of the parcel owner. -
CellPhoneCountry(optional):
string
Maximum Length:
10
Tthe cell phone country code of the parcel owner. -
CellPhoneNumber(optional):
string
Maximum Length:
40
The cell phone number of the parcel owner. -
City(optional):
string
Maximum Length:
60
The city of the parcel owner. -
Country(optional):
string
Maximum Length:
3
The country of the parcel owner. -
County(optional):
string
Maximum Length:
60
The county of the parcel owner. -
DocumentNumber(optional):
string
Title:
Document Number
Maximum Length:50
The document number of the parcel owner. -
EmailId(optional):
string
Maximum Length:
50
The email address for the parcel owner. -
EnabledFlag(optional):
boolean
Indicates whether the parcel owner is available to be used. The default value is N.
-
FaxCountry(optional):
string
Maximum Length:
10
The fax country code of the parcel owner. -
FaxNumber(optional):
string
Maximum Length:
40
The fax phone number of the parcel owner. -
Floor(optional):
string
Maximum Length:
20
The floor the parcel owner is on. -
HomePhoneCountry(optional):
string
Maximum Length:
10
The home phone country code of the parcel owner. -
HomePhoneNumber(optional):
string
Maximum Length:
40
The home phone number of the parcel owner. -
LastTransferType(optional):
string
Title:
Last Transfer Type
Maximum Length:50
The last transfer type of the parcel owner. -
links(optional):
array Items
Title:
Items
Link Relations -
OwnerCode(optional):
string
Maximum Length:
32
The code of the parcel owner. -
OwnerId(optional):
integer(int64)
Title:
Owner ID
The unique identifier for the parcel owner. -
OwnerName(optional):
string
Title:
Owner
Maximum Length:150
The name of the primary parcel owner. -
OwnerType(optional):
string
Title:
Owner Type
Maximum Length:20
The type of parcel owner. -
ParcelId(optional):
integer(int64)
The unique identifier for the parcel.
-
PostalCode(optional):
string
Maximum Length:
60
The postal code of the parcel owner. -
PostalPlus4Code(optional):
string
Maximum Length:
10
The postal plus 4 code of the parcel owner. -
PrimaryFlag(optional):
boolean
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(optional):
string
Maximum Length:
60
The province of the parcel owner. -
SecondaryOwnerName(optional):
string
Title:
Secondary Owner
Maximum Length:150
The name of the secondary parcel owner. -
State(optional):
string
Maximum Length:
60
The state of the parcel owner. -
StreeName(optional):
string
Maximum Length:
240
The street name of the parcel owner. -
StreetDirection(optional):
string
Maximum Length:
10
The street direction of the parcel owner. -
StreetNumber(optional):
string
Maximum Length:
20
The street number of the parcel owner. -
StreetType(optional):
string
Maximum Length:
20
The street type of the parcel owner. -
UnitNumber(optional):
string
Maximum Length:
30
The unit number of the parcel owner. -
WorkPhoneCountry(optional):
string
Maximum Length:
10
The work phone country code of the parcel owner. -
WorkPhoneNumber(optional):
string
Maximum Length:
40
The work phone number of the parcel owner.
Nested Schema : link
Type:
Show Source
object
-
href(optional):
string
Title:
hyperlink reference
The URI to the related resource. -
rel(optional):
string
Title:
relation
The name of the relation to the resource instance. Example: self.