Jump to

• Request
• Response

Get a provisional parcel row

get

/fscmRestApi/resources/11.13.18.05/publicSectorProvisionalParcelLists/{ParcelId}

Request

Path Parameters

• ParcelId: integer
  The unique identifier for the parcel.

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

Back to Top

Response

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• application/json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : publicSectorProvisionalParcelLists-item

Type: object

Show Source

• Address1(optional): string
  Maximum Length: 240

  The first line of the parcel address.
• AddressPrimary(optional): string
  Maximum Length: 1

  Indicates whether the parcel address is marked as primary for that parcel.
• BlockNum(optional): string
  Maximum Length: 30

  The block number of the parcel.
• BookNum(optional): string
  Maximum Length: 30

  The book number of the parcel.
• City(optional): string
  Maximum Length: 60

  The city of the parcel address.
• CreationDate(optional): string(date-time)
  Indicates the date on which the provisional parcel was created.
• EnabledFlag(optional): string
  Maximum Length: 1

  Indicates if the parcel is enabled or not.
• links(optional): array Items
  Title: Items

  Link Relations
• LotNum(optional): string
  Maximum Length: 30

  The lot number of the parcel.
• MapBookPage(optional): string
  Maximum Length: 50

  The map book page of the parcel.
• OwnerName(optional): string
  Maximum Length: 150

  The name of the primary owner.
• OwnerPrimary(optional): string
  Maximum Length: 1

  Indicates whether the parcel owner is marked as primary for that parcel.
• PageNum(optional): string
  Maximum Length: 30

  The page number of the parcel.
• ParcelId(optional): integer(int64)
  The unique identifier for the parcel.
• ParcelIdEntered(optional): string
  Maximum Length: 30

  The parcel number.
• ParcelStatus(optional): string
  Maximum Length: 80

  The status of the parcel which can be either Final or Provisional or Retired.
• SectionNum(optional): string
  Maximum Length: 30

  The section number of the parcel.
• StreeName(optional): string
  Maximum Length: 240

  The street name of the parcel address.
• StreetDirection(optional): string
  Maximum Length: 10

  The street direction of the parcel address.
• StreetNumber(optional): string
  Maximum Length: 20

  The street number of the parcel address.
• StreetType(optional): string
  Maximum Length: 20

  The street type of the parcel address.
• UnitNumber(optional): string
  Maximum Length: 30

  The unit number of the parcel.

{
    "properties":{
        "Address1":{
            "maxLength":240,
            "type":"string",
            "description":"The first line of the parcel address."
        },
        "AddressPrimary":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the parcel address is marked as primary for that parcel."
        },
        "BlockNum":{
            "maxLength":30,
            "type":"string",
            "description":"The block number of the parcel."
        },
        "BookNum":{
            "maxLength":30,
            "type":"string",
            "description":"The book number of the parcel."
        },
        "City":{
            "maxLength":60,
            "type":"string",
            "description":"The city of the parcel address."
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"Indicates the date on which the provisional parcel was created."
        },
        "EnabledFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates if the parcel is enabled or not."
        },
        "LotNum":{
            "maxLength":30,
            "type":"string",
            "description":"The lot number of the parcel."
        },
        "MapBookPage":{
            "maxLength":50,
            "type":"string",
            "description":"The map book page of the parcel."
        },
        "OwnerName":{
            "maxLength":150,
            "type":"string",
            "description":"The name of the primary owner."
        },
        "OwnerPrimary":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the parcel owner is marked as primary for that parcel."
        },
        "PageNum":{
            "maxLength":30,
            "type":"string",
            "description":"The page number of the parcel."
        },
        "ParcelId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for the parcel."
        },
        "ParcelIdEntered":{
            "maxLength":30,
            "type":"string",
            "description":"The parcel number."
        },
        "ParcelStatus":{
            "maxLength":80,
            "type":"string",
            "description":"The status of the parcel which can be either Final or Provisional or Retired."
        },
        "SectionNum":{
            "maxLength":30,
            "type":"string",
            "description":"The section number of the parcel."
        },
        "StreeName":{
            "maxLength":240,
            "type":"string",
            "description":"The street name of the parcel address."
        },
        "StreetDirection":{
            "maxLength":10,
            "type":"string",
            "description":"The street direction of the parcel address."
        },
        "StreetNumber":{
            "maxLength":20,
            "type":"string",
            "description":"The street number of the parcel address."
        },
        "StreetType":{
            "maxLength":20,
            "type":"string",
            "description":"The street type of the parcel address."
        },
        "UnitNumber":{
            "maxLength":30,
            "type":"string",
            "description":"The unit number of the parcel."
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : link

Type: object

Show Source

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

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Back to Top