Jump to

• Request
• Response

Get all parcel addresses

get

/fscmRestApi/resources/11.13.18.05/publicSectorParcelAddresses

Request

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
• finder: string
  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:
  
  

  • simpleSearchFinder: Finds a parcel address that matches the specified value. Finder Variables:
    • value; string; The unique identifier for the address.
  • PrimaryKey: Finds a parcel address that matches the specified primary key criteria. Finder Variables:
    • AddressId; integer; The unique identifier for the address.
    • ParcelId; integer; The unique identifier for the parcel.
  • AltKey: Finds a parcel address that matches the specified alternate key. Finder Variables:
    • Address1; string; The first line of the parcel address.
    • Address2; string; The second line of the parcel address.
    • AddressCode; string; The parcel address code.
    • PostalCode; string; The postal code of the parcel address.
• limit: integer
  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.
• offset: integer
  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.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified attributes. 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
• q: string
  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
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

Back to Top

Response

Supported Media Types

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

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : publicSectorParcelAddresses

Type: object

Show Source

• count(optional): integer
  Title: Count

  The number of resource instances returned in the current range.
• hasMore(optional): boolean
  Title: HasMore

  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items(optional): array Items
  Title: Items

  The items in the collection.
• limit(optional): integer
  Title: Limit

  The actual paging size used by the server.
• links(optional): array Items
  Title: Items

  The link relations associated with the resource instance.
• offset(optional): integer
  Title: Offset

  The offset value used in the current page.

{
    "properties":{
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range.",
            "title":"Count"
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.",
            "title":"HasMore"
        },
        "items":{
            "items":{
                "$ref":"#/definitions/publicSectorParcelAddresses-item"
            },
            "type":"array",
            "description":"The items in the collection.",
            "title":"Items"
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server.",
            "title":"Limit"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "title":"Items"
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page.",
            "title":"Offset"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object publicSectorParcelAddresses-item

{
    "items":{
        "$ref":"#/definitions/publicSectorParcelAddresses-item"
    },
    "type":"array",
    "description":"The items in the collection.",
    "title":"Items"
}

Nested Schema : Items

Type: array

Title: Items

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "title":"Items"
}

Nested Schema : publicSectorParcelAddresses-item

Type: object

Show Source

• Address1(optional): string
  Title: Address Line 1

  Maximum Length: 240

  The first line of the parcel address.
• Address2(optional): string
  Title: Address Line 2

  Maximum Length: 240

  The second line of the parcel address.
• Address3(optional): string
  Title: Address Line 3

  Maximum Length: 240

  The third line of the parcel address.
• Address4(optional): string
  Title: Address Line 4

  Maximum Length: 240

  The fourth line of the parcel address.
• AddressCode(optional): string
  Maximum Length: 32

  The address code of the parcel address.
• AddressId(optional): integer(int64)
  Title: Address ID

  The unique identifier for the parcel address.
• AddressType(optional): string
  Title: Address Type

  Maximum Length: 20

  The type of the parcel address.
• BuildingType(optional): string
  Title: Building Type

  Maximum Length: 20

  The building type of the parcel address.
• CellPhoneCountry(optional): string
  Title: Cell Phone Country Code

  Maximum Length: 10

  The cell phone country code of the parcel address.
• CellPhoneNumber(optional): string
  Title: Cell Phone Number

  Maximum Length: 40

  The cell phone number of the parcel address.
• City(optional): string
  Title: City

  Maximum Length: 60

  The city of the parcel address.
• CoordinateX(optional): number
  The x coordinate of the parcel address.
• CoordinateY(optional): number
  The y coordinate of the parcel address.
• Country(optional): string
  Title: Country

  Maximum Length: 3

  The country of the parcel address.
• County(optional): string
  Title: County

  Maximum Length: 60

  The county of the parcel address.
• CrossroadOne(optional): string
  Title: Crossroad 1

  Maximum Length: 240

  The first crossroad of the intersection.
• CrossroadTwo(optional): string
  Title: Crossroad 2

  Maximum Length: 240

  The second crossroad of the intersection.
• EmailId(optional): string
  Title: Email Address

  Maximum Length: 50

  The email address of the parcel address.
• EnabledFlag(optional): boolean
  Indicates whether the parcel address is available to be used.
• FaxCountry(optional): string
  Title: Fax Country Code

  Maximum Length: 10

  The fax country code of the parcel address.
• FaxNumber(optional): string
  Title: Fax Number

  Maximum Length: 40

  The fax phone number of the parcel address.
• Floor(optional): string
  Title: Floor

  Maximum Length: 20

  The floor the parcel address is on.
• HomePhoneCountry(optional): string
  Title: Home Phone Country Code

  Maximum Length: 10

  The home phone country code of the parcel address.
• HomePhoneNumber(optional): string
  Title: Home Phone Number

  Maximum Length: 40

  The home phone number of the parcel address.
• InputSource(optional): string
  Maximum Length: 1

  The input source of the parcel address.
• Landmark(optional): string
  Title: Landmark

  Maximum Length: 200

  The landmark associated with the address.
• Latitude(optional): number
  The latitude of the parcel address.
• links(optional): array Items
  Title: Items

  Link Relations
• Longitude(optional): number
  The longitude of the parcel address.
• MunicipalityId(optional): string
  Maximum Length: 20

  The unique identifier for the municipality of the parcel address.
• Name(optional): string
  Title: Name 1

  Maximum Length: 150

  The name of the first contact person.
• ParcelId(optional): integer(int64)
  The unique identifier for the parcel.
• ParcelNumber(optional): string
  Title: Parcel Number

  Maximum Length: 30

  The parcel associated with the address.
• PostalCode(optional): string
  Title: Postal Code

  Maximum Length: 60

  The postal code of the parcel address.
• PostalPlus4Code(optional): string
  Maximum Length: 10

  The postal plus 4 code of the parcel address.
• PrimaryFlag(optional): boolean
  Title: Primary

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

  The province of the parcel address.
• SecondaryName(optional): string
  Title: Name 2

  Maximum Length: 150

  The name of the second contact person.
• Srid(optional): integer(int64)
  The spatial reference identifier. This is a unique coordinate identifier for a local, regional, or global system used to locate geographical or spatial entities within geographic information systems.
• State(optional): string
  Title: State

  Maximum Length: 60

  The state of the parcel address.
• StreeName(optional): string
  Title: Street Name

  Maximum Length: 240

  The street name of the parcel address.
• StreetDirection(optional): string
  Title: Street Direction

  Maximum Length: 10

  The street direction of the parcel address.
• StreetNumber(optional): string
  Title: Street Number

  Maximum Length: 20

  The street number of the parcel address.
• StreetSuffix(optional): string
  Title: Street Suffix

  Maximum Length: 20

  The streeet suffix that further describes that street like Drive, Avenue etc.
• StreetType(optional): string
  Title: Street Type

  Maximum Length: 20

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

  The unit number of the parcel address.
• WorkPhoneCountry(optional): string
  Title: Work Phone Country Code

  Maximum Length: 10

  The work phone country code of the parcel address.
• WorkPhoneNumber(optional): string
  Title: Work Phone Number

  Maximum Length: 40

  The work phone number of the parcel address.

{
    "properties":{
        "Address1":{
            "maxLength":240,
            "type":"string",
            "description":"The first line of the parcel address.",
            "title":"Address Line 1"
        },
        "Address2":{
            "maxLength":240,
            "type":"string",
            "description":"The second line of the parcel address.",
            "title":"Address Line 2"
        },
        "Address3":{
            "maxLength":240,
            "type":"string",
            "description":"The third line of the parcel address.",
            "title":"Address Line 3"
        },
        "Address4":{
            "maxLength":240,
            "type":"string",
            "description":"The fourth line of the parcel address.",
            "title":"Address Line 4"
        },
        "AddressCode":{
            "maxLength":32,
            "type":"string",
            "description":"The address code of the parcel address."
        },
        "AddressId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for the parcel address.",
            "title":"Address ID"
        },
        "AddressType":{
            "maxLength":20,
            "type":"string",
            "description":"The type of the parcel address.",
            "title":"Address Type"
        },
        "BuildingType":{
            "maxLength":20,
            "type":"string",
            "description":"The building type of the parcel address.",
            "title":"Building Type"
        },
        "CellPhoneCountry":{
            "maxLength":10,
            "type":"string",
            "description":"The cell phone country code of the parcel address.",
            "title":"Cell Phone Country Code"
        },
        "CellPhoneNumber":{
            "maxLength":40,
            "type":"string",
            "description":"The cell phone number of the parcel address.",
            "title":"Cell Phone Number"
        },
        "City":{
            "maxLength":60,
            "type":"string",
            "description":"The city of the parcel address.",
            "title":"City"
        },
        "CoordinateX":{
            "type":"number",
            "description":"The x coordinate of the parcel address."
        },
        "CoordinateY":{
            "type":"number",
            "description":"The y coordinate of the parcel address."
        },
        "Country":{
            "maxLength":3,
            "type":"string",
            "description":"The country of the parcel address.",
            "title":"Country"
        },
        "County":{
            "maxLength":60,
            "type":"string",
            "description":"The county of the parcel address.",
            "title":"County"
        },
        "CrossroadOne":{
            "maxLength":240,
            "type":"string",
            "description":"The first crossroad of the intersection.",
            "title":"Crossroad 1"
        },
        "CrossroadTwo":{
            "maxLength":240,
            "type":"string",
            "description":"The second crossroad of the intersection.",
            "title":"Crossroad 2"
        },
        "EmailId":{
            "maxLength":50,
            "type":"string",
            "description":"The email address of the parcel address.",
            "title":"Email Address"
        },
        "EnabledFlag":{
            "type":"boolean",
            "description":"Indicates whether the parcel address is available to be used."
        },
        "FaxCountry":{
            "maxLength":10,
            "type":"string",
            "description":"The fax country code of the parcel address.",
            "title":"Fax Country Code"
        },
        "FaxNumber":{
            "maxLength":40,
            "type":"string",
            "description":"The fax phone number of the parcel address.",
            "title":"Fax Number"
        },
        "Floor":{
            "maxLength":20,
            "type":"string",
            "description":"The floor the parcel address is on.",
            "title":"Floor"
        },
        "HomePhoneCountry":{
            "maxLength":10,
            "type":"string",
            "description":"The home phone country code of the parcel address.",
            "title":"Home Phone Country Code"
        },
        "HomePhoneNumber":{
            "maxLength":40,
            "type":"string",
            "description":"The home phone number of the parcel address.",
            "title":"Home Phone Number"
        },
        "InputSource":{
            "maxLength":1,
            "type":"string",
            "description":"The input source of the parcel address."
        },
        "Landmark":{
            "maxLength":200,
            "type":"string",
            "description":"The landmark associated with the address.",
            "title":"Landmark"
        },
        "Latitude":{
            "type":"number",
            "description":"The latitude of the parcel address."
        },
        "Longitude":{
            "type":"number",
            "description":"The longitude of the parcel address."
        },
        "MunicipalityId":{
            "maxLength":20,
            "type":"string",
            "description":"The unique identifier for the municipality of the parcel address."
        },
        "Name":{
            "maxLength":150,
            "type":"string",
            "description":"The name of the first contact person.",
            "title":"Name 1"
        },
        "ParcelId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for the parcel."
        },
        "ParcelNumber":{
            "maxLength":30,
            "type":"string",
            "description":"The parcel associated with the address.",
            "title":"Parcel Number"
        },
        "PostalCode":{
            "maxLength":60,
            "type":"string",
            "description":"The postal code of the parcel address.",
            "title":"Postal Code"
        },
        "PostalPlus4Code":{
            "maxLength":10,
            "type":"string",
            "description":"The postal plus 4 code of the parcel address."
        },
        "PrimaryFlag":{
            "type":"boolean",
            "description":"Indicates whether the parcel address is marked as primary for that parcel.",
            "title":"Primary"
        },
        "Province":{
            "maxLength":60,
            "type":"string",
            "description":"The province of the parcel address."
        },
        "SecondaryName":{
            "maxLength":150,
            "type":"string",
            "description":"The name of the second contact person.",
            "title":"Name 2"
        },
        "Srid":{
            "format":"int64",
            "type":"integer",
            "description":"The spatial reference identifier. This is a unique coordinate identifier for a local, regional, or global system used to locate geographical or spatial entities within geographic information systems."
        },
        "State":{
            "maxLength":60,
            "type":"string",
            "description":"The state of the parcel address.",
            "title":"State"
        },
        "StreeName":{
            "maxLength":240,
            "type":"string",
            "description":"The street name of the parcel address.",
            "title":"Street Name"
        },
        "StreetDirection":{
            "maxLength":10,
            "type":"string",
            "description":"The street direction of the parcel address.",
            "title":"Street Direction"
        },
        "StreetNumber":{
            "maxLength":20,
            "type":"string",
            "description":"The street number of the parcel address.",
            "title":"Street Number"
        },
        "StreetSuffix":{
            "maxLength":20,
            "type":"string",
            "description":"The streeet suffix that further describes that street like Drive, Avenue etc.",
            "title":"Street Suffix"
        },
        "StreetType":{
            "maxLength":20,
            "type":"string",
            "description":"The street type of the parcel address.",
            "title":"Street Type"
        },
        "UnitNumber":{
            "maxLength":30,
            "type":"string",
            "description":"The unit number of the parcel address."
        },
        "WorkPhoneCountry":{
            "maxLength":10,
            "type":"string",
            "description":"The work phone country code of the parcel address.",
            "title":"Work Phone Country Code"
        },
        "WorkPhoneNumber":{
            "maxLength":40,
            "type":"string",
            "description":"The work phone number of the parcel address.",
            "title":"Work Phone Number"
        },
        "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