Get all parcel addresses
get
/fscmRestApi/resources/11.13.18.05/publicSectorParcelAddresses
Request
Query Parameters
-
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 -
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:- 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.
- 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.
- simpleSearchFinder: Finds a parcel address that matches the specified value.
Finder Variables:- value; string; The unique identifier for the address.
- AltKey: Finds a parcel address that matches the specified alternate key.
-
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.
-
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 -
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 fields. 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
You can use these queryable attributes to filter this collection resource using the q query parameter:- Address1; string; The first line of the parcel address.
- Address2; string; The second line of the parcel address.
- Address3; string; The third line of the parcel address.
- Address4; string; The fourth line of the parcel address.
- AddressCode; string; The address code of the parcel address.
- AddressId; integer; The unique identifier for the parcel address.
- AddressType; string; The type of the parcel address.
- BuildingType; string; The building type of the parcel address.
- CellPhoneCountry; string; The cell phone country code of the parcel address.
- CellPhoneNumber; string; The cell phone number of the parcel address.
- City; string; The city of the parcel address.
- CoordinateX; number; The x coordinate of the parcel address.
- CoordinateY; number; The y coordinate of the parcel address.
- Country; string; The country of the parcel address.
- County; string; The county of the parcel address.
- CrossroadOne; string; The first crossroad of the intersection.
- CrossroadTwo; string; The second crossroad of the intersection.
- EmailId; string; The email address of the parcel address.
- EnabledFlag; boolean; Indicates whether the parcel address is available to be used.
- FaxCountry; string; The fax country code of the parcel address.
- FaxNumber; string; The fax phone number of the parcel address.
- Floor; string; The floor the parcel address is on.
- HomePhoneCountry; string; The home phone country code of the parcel address.
- HomePhoneNumber; string; The home phone number of the parcel address.
- InputSource; string; The input source of the parcel address.
- Landmark; string; The landmark associated with the address.
- Latitude; number; The latitude of the parcel address.
- Longitude; number; The longitude of the parcel address.
- MunicipalityId; string; The unique identifier for the municipality of the parcel address.
- Name; string; The name of the first contact person.
- ParcelId; integer; The unique identifier for the parcel.
- ParcelIdEntered; string; The parcel number.
- ParcelNumber; string; The parcel associated with the address.
- PostalCode; string; The postal code of the parcel address.
- PostalPlus4Code; string; The postal plus 4 code of the parcel address.
- PrimaryFlag; boolean; Indicates whether the parcel address is marked as primary for that parcel.
- Province; string; The province of the parcel address.
- SecondaryName; string; The name of the second contact person.
- Srid; integer; 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; string; The state of the parcel address.
- StreeName; string; The street name of the parcel address.
- StreetDirection; string; The street direction of the parcel address.
- StreetNameConcat; string; Indicates the concatenated value of the street name corresponding to the parcel address. The concatenated value of the street name is obtained by concatenating direction prefix, street name, street suffix and direction suffix.
- StreetNumber; string; The street number of the parcel address.
- StreetNumberAlpha; string; Indicates the alphabetic portion of the street number in the parcel address.
- StreetNumberNumeric; integer; Indicates the numerical portion of the street number in the parcel address.
- StreetSuffix; string; The streeet suffix that further describes that street like Drive, Avenue etc.
- StreetType; string; The street type of the parcel address.
- UnitNumber; string; The unit number of the parcel address.
- WorkPhoneCountry; string; The work phone country code of the parcel address.
- WorkPhoneNumber; string; The work phone number of the parcel address.
-
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".
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 TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
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(required):
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.
Root Schema : publicSectorParcelAddresses
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
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: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorParcelAddresses-item-response
Type:
Show Source
object
-
Address1: string
Title:
Address Line 1
Maximum Length:240
The first line of the parcel address. -
Address2: string
Title:
Address Line 2
Maximum Length:240
The second line of the parcel address. -
Address3: string
Title:
Address Line 3
Read Only:true
Maximum Length:240
The third line of the parcel address. -
Address4: string
Title:
Address Line 4
Read Only:true
Maximum Length:240
The fourth line of the parcel address. -
AddressCode: string
Maximum Length:
480
The address code of the parcel address. -
AddressId: integer
(int64)
Title:
Address ID
The unique identifier for the parcel address. -
AddressType: string
Title:
Address Type
Read Only:true
Maximum Length:20
The type of the parcel address. -
BuildingType: string
Title:
Address Type
Maximum Length:20
The building type of the parcel address. -
CellPhoneCountry: string
Title:
Cell Phone Country Code
Read Only:true
Maximum Length:10
The cell phone country code of the parcel address. -
CellPhoneNumber: string
Title:
Cell Phone Number
Maximum Length:40
The cell phone number of the parcel address. -
City: string
Title:
City
Maximum Length:60
The city of the parcel address. -
CoordinateX: number
The x coordinate of the parcel address.
-
CoordinateY: number
The y coordinate of the parcel address.
-
Country: string
Title:
Country
Maximum Length:3
The country of the parcel address. -
County: string
Title:
County
Maximum Length:60
The county of the parcel address. -
CrossroadOne: string
Title:
Crossroad
Maximum Length:240
The first crossroad of the intersection. -
CrossroadTwo: string
Title:
Crossroad 2
Maximum Length:240
The second crossroad of the intersection. -
EmailId: string
Title:
Email Address
Maximum Length:50
The email address of the parcel address. -
EnabledFlag: boolean
Maximum Length:
1
Indicates whether the parcel address is available to be used. -
FaxCountry: string
Title:
Fax Country Code
Read Only:true
Maximum Length:10
The fax country code of the parcel address. -
FaxNumber: string
Title:
Fax Number
Maximum Length:40
The fax phone number of the parcel address. -
Floor: string
Title:
Floor
Maximum Length:20
The floor the parcel address is on. -
HomePhoneCountry: string
Title:
Home Phone Country Code
Read Only:true
Maximum Length:10
The home phone country code of the parcel address. -
HomePhoneNumber: string
Title:
Home Phone Number
Maximum Length:40
The home phone number of the parcel address. -
InputSource: string
Maximum Length:
1
The input source of the parcel address. -
Landmark: string
Title:
Landmark
Maximum Length:200
The landmark associated with the address. -
Latitude: number
The latitude of the parcel address.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Longitude: number
The longitude of the parcel address.
-
MunicipalityId: string
Read Only:
true
Maximum Length:20
The unique identifier for the municipality of the parcel address. -
Name: string
Title:
Name 1
Maximum Length:150
The name of the first contact person. -
ParcelId: integer
(int64)
The unique identifier for the parcel.
-
ParcelIdEntered: string
Title:
Parcel Number
Maximum Length:30
The parcel number. -
ParcelNumber: string
Title:
Parcel Number
Read Only:true
Maximum Length:30
The parcel associated with the address. -
PostalCode: string
Title:
Postal Code
Maximum Length:60
The postal code of the parcel address. -
PostalPlus4Code: string
Read Only:
true
Maximum Length:10
The postal plus 4 code of the parcel address. -
PrimaryFlag: boolean
Title:
Primary
Maximum Length:1
Indicates whether the parcel address is marked as primary for that parcel. -
Province: string
Read Only:
true
Maximum Length:60
The province of the parcel address. -
SecondaryName: string
Title:
Name 2
Maximum Length:150
The name of the second contact person. -
Srid: integer
(int64)
Read Only:
true
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: string
Title:
State
Maximum Length:60
The state of the parcel address. -
StreeName: string
Title:
Street Name
Maximum Length:240
The street name of the parcel address. -
StreetDirection: string
Title:
Direction Prefix
Maximum Length:10
The street direction of the parcel address. -
StreetNameConcat: string
Read Only:
true
Maximum Length:350
Indicates the concatenated value of the street name corresponding to the parcel address. The concatenated value of the street name is obtained by concatenating direction prefix, street name, street suffix and direction suffix. -
StreetNumber: string
Title:
Street Number
Maximum Length:20
The street number of the parcel address. -
StreetNumberAlpha: string
Read Only:
true
Maximum Length:20
Indicates the alphabetic portion of the street number in the parcel address. -
StreetNumberNumeric: integer
(int64)
Read Only:
true
Indicates the numerical portion of the street number in the parcel address. -
StreetSuffix: string
Title:
Direction Suffix
Maximum Length:20
The streeet suffix that further describes that street like Drive, Avenue etc. -
StreetType: string
Title:
Street Suffix
Maximum Length:20
The street type of the parcel address. -
UnitNumber: string
Title:
Unit
Maximum Length:30
The unit number of the parcel address. -
WorkPhoneCountry: string
Title:
Work Phone Country Code
Read Only:true
Maximum Length:10
The work phone country code of the parcel address. -
WorkPhoneNumber: string
Title:
Work Phone Number
Maximum Length:40
The work phone number of the parcel address.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.