Get all project parcel addresses
get
/fscmRestApi/resources/11.13.18.05/publicSectorProjects/{publicSectorProjectsUniqID}/child/ProjectParcel/{ParcelKey}/child/ProjectAddress
Request
Path Parameters
-
ParcelKey(required): integer(int64)
The unique identifier for the project parcel.
-
publicSectorProjectsUniqID(required): string
This is the hash key of the attributes which make up the composite key--- AgencyId and ProjectCode ---for the Project Lists resource and used to uniquely identify an instance of Project Lists. The client should not generate the hash key value. Instead, the client should query on the Project Lists collection resource with a filter on the primary key values in order to navigate to a specific instance of Project Lists.
For example: publicSectorProjects?q=AgencyId=<value1>;ProjectCode=<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 -
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:- PrimaryKey: Finds a project address by the primary key criteria.
Finder Variables:- AddressKey; integer; The unique identifier for a project address.
- PrimaryKey: Finds a project address by the primary key criteria.
-
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 or main address.
- Address2; string; The second address, if present.
- Address3; string; The third address, if present.
- Address4; string; The fourth address, if present.
- AddressField1; string; Additional information for the first address or main address of the parcel.
- AddressField2; string; Additional information for the second address of the parcel, if present.
- AddressField3; string; Additional information for the third address of the parcel, if present.
- AddressId; integer; The identifier of the parcel address.
- AddressKey; integer; The unique identifier of the project address.
- AddressType; string; The address type used for delivery point validation (DPV). For example, main address, side address, or virtual address.
- AgencyId; integer; The unique identifier for a public sector agency.
- BuildingType; string; The building type used in an address search. For example, Tower A or Block 3.
- CellPhoneCountry; string; The country code for the cell phone number of parcel contact.
- CellPhoneNum; string; The cell phone number of the parcel address contact.
- City; string; The city in the parcel address.
- CoordinateX; number; The x-axis coordinate of the project parcel address.
- CoordinateY; number; The y-axis coordinate of the project parcel address.
- Country; string; The country in the parcel address.
- County; string; The county in the parcel address.
- CreatedBy; string; The user who created the project parcel address.
- CreationDate; string; The date when the project parcel address was created.
- EmailId; string; The email address of the parcel address contact.
- FaxCountry; string; The country code for the fax number of the parcel contact.
- FaxNum; string; The fax number of the parcel address contact.
- Floor; string; The floor or level in an address search. For example, mezzanine level, penthouse, or garage level C.
- HomePhoneCountry; string; The country code for the home telephone number of the parcel address contact.
- HomePhoneNum; string; The home telephone number of the parcel address contact.
- InputSource; string; Indicates how the data were entered or loaded into the application. The values are S for system data and U for user-entered data.
- LastUpdateDate; string; The user who last updated the project parcel address.
- LastUpdateLogin; string; The login ID of the user who last updated the project parcel address.
- LastUpdatedBy; string; The date when the project parcel address was last updated.
- Latitude; number; The latitude of the parcel address. A geographic location typically identifies a specific entrance area within a large parcel, for example, a security checkpoint gate, delivery entrance, or employee entrance.
- Longitude; number; The longitude of the parcel address. A geographic location typically identifies a specific entrance area within a large parcel, for example, a security checkpoint gate, delivery entrance, or employee entrance.
- MunicipalityId; string; The municipality identifier if the parcel is not managed at the county level.
- ParcelId; integer; The identifier of the parcel.
- ParcelKey; integer; The unique identifier of the project parcel.
- PostalCode; string; The postal code in the parcel address.
- PostalPlus4Code; string; The postal plus four code of the parcel address.
- PrimaryFlag; boolean; Indicates whether the current project address is the primary address. If the value is Y, then the address is the primary project address. The default value is N.
- ProjectCode; string; The unique identifier for a project.
- Province; string; The province in the parcel address.
- Srid; integer; The SRID of the parcel address. This attribute indicates the Spatial Reference System Identifier (SRID), which is a unique value that identifies projected, unprojected, and local spatial coordinate system definitions. Used in all GIS systems.
- State; string; The state in the parcel address.
- StreetDirection; string; The street direction in an address search. Values are compass directions, such as N, S, E, W, NW, SE, and so on. For example, use street direction N to find all parcels with an address that is north of the city center.
- StreetName; string; The street name in the parcel address used during a search.
- StreetNumber; string; The street number in the parcel address.
- StreetType; string; The street type designation used during a search. For example, alley, boulevard, avenue, lane, street, loop, and so on.
- UnitNumber; string; The exact unit in a building used in an address search. For example, Apartment 208A or Suite 300.
- WorkPhoneCountry; string; The country code for the work telephone number of the parcel contact.
- WorkPhoneNum; string; The work telephone number of the parcel address contact.
-
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 : publicSectorProjects-ProjectParcel-ProjectAddress
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 : publicSectorProjects-ProjectParcel-ProjectAddress-item-response
Type:
Show Source
object
-
Address1: string
Title:
Address Line 1
Maximum Length:240
The first or main address. -
Address2: string
Title:
Address Line 2
Maximum Length:240
The second address, if present. -
Address3: string
Title:
Address Line 3
Maximum Length:240
The third address, if present. -
Address4: string
Title:
Address Line 4
Maximum Length:240
The fourth address, if present. -
AddressField1: string
Title:
Address Field 1
Maximum Length:20
Additional information for the first address or main address of the parcel. -
AddressField2: string
Title:
Address Field 2
Maximum Length:20
Additional information for the second address of the parcel, if present. -
AddressField3: string
Title:
Address Field 3
Maximum Length:20
Additional information for the third address of the parcel, if present. -
AddressId: integer
(int64)
Title:
Address ID
The identifier of the parcel address. -
AddressKey: integer
(int64)
Title:
Address ID
The unique identifier of the project address. -
AddressType: string
Title:
Address Type
Maximum Length:20
The address type used for delivery point validation (DPV). For example, main address, side address, or virtual address. -
AgencyId: integer
(int32)
Default Value:
1
The unique identifier for a public sector agency. -
BuildingType: string
Title:
Building Type
Maximum Length:20
The building type used in an address search. For example, Tower A or Block 3. -
CellPhoneCountry: string
Title:
Cell Phone Country Code
Maximum Length:10
The country code for the cell phone number of parcel contact. -
CellPhoneNum: string
Title:
Cell Phone Number
Maximum Length:40
The cell phone number of the parcel address contact. -
City: string
Title:
City
Maximum Length:60
The city in the parcel address. -
CoordinateX: number
Title:
X Coordinate
The x-axis coordinate of the project parcel address. -
CoordinateY: number
Title:
Y Coordinate
The y-axis coordinate of the project parcel address. -
Country: string
Title:
Country
Maximum Length:60
The country in the parcel address. -
County: string
Title:
County
Maximum Length:60
The county in the parcel address. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the project parcel address. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the project parcel address was created. -
EmailId: string
Title:
Email Address
Maximum Length:50
The email address of the parcel address contact. -
FaxCountry: string
Title:
Fax Country Code
Maximum Length:10
The country code for the fax number of the parcel contact. -
FaxNum: string
Title:
Fax Number
Maximum Length:40
The fax number of the parcel address contact. -
Floor: string
Title:
Floor
Maximum Length:20
The floor or level in an address search. For example, mezzanine level, penthouse, or garage level C. -
HomePhoneCountry: string
Title:
Home Phone Country Code
Maximum Length:10
The country code for the home telephone number of the parcel address contact. -
HomePhoneNum: string
Title:
Home Phone Number
Maximum Length:40
The home telephone number of the parcel address contact. -
InputSource: string
Title:
Input Source
Maximum Length:1
Indicates how the data were entered or loaded into the application. The values are S for system data and U for user-entered data. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The user who last updated the project parcel address. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The date when the project parcel address was last updated. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The login ID of the user who last updated the project parcel address. -
Latitude: number
Title:
Latitude
The latitude of the parcel address. A geographic location typically identifies a specific entrance area within a large parcel, for example, a security checkpoint gate, delivery entrance, or employee entrance. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Longitude: number
Title:
Longitude
The longitude of the parcel address. A geographic location typically identifies a specific entrance area within a large parcel, for example, a security checkpoint gate, delivery entrance, or employee entrance. -
MunicipalityId: string
Title:
Municipality ID
Maximum Length:20
The municipality identifier if the parcel is not managed at the county level. -
ParcelId: integer
(int64)
Title:
Parcel ID
The identifier of the parcel. -
ParcelKey: integer
(int64)
Title:
Parcel ID
The unique identifier of the project parcel. -
PostalCode: string
Title:
Postal Code
Maximum Length:60
The postal code in the parcel address. -
PostalPlus4Code: string
Title:
Postal Plus 4 Code
Maximum Length:20
The postal plus four code of the parcel address. -
PrimaryFlag: boolean
Title:
Primary
Maximum Length:1
Default Value:false
Indicates whether the current project address is the primary address. If the value is Y, then the address is the primary project address. The default value is N. -
ProjectCode: string
Title:
Project ID
Maximum Length:30
The unique identifier for a project. -
Province: string
Title:
Province
Maximum Length:60
The province in the parcel address. -
Srid: integer
(int64)
Title:
SRID
The SRID of the parcel address. This attribute indicates the Spatial Reference System Identifier (SRID), which is a unique value that identifies projected, unprojected, and local spatial coordinate system definitions. Used in all GIS systems. -
State: string
Title:
State
Maximum Length:60
The state in the parcel address. -
StreetDirection: string
Title:
Street Direction
Maximum Length:10
The street direction in an address search. Values are compass directions, such as N, S, E, W, NW, SE, and so on. For example, use street direction N to find all parcels with an address that is north of the city center. -
StreetName: string
Title:
Street Name
Maximum Length:240
The street name in the parcel address used during a search. -
StreetNumber: string
Title:
Street Number
Maximum Length:20
The street number in the parcel address. -
StreetType: string
Title:
Street Type
Maximum Length:20
The street type designation used during a search. For example, alley, boulevard, avenue, lane, street, loop, and so on. -
UnitNumber: string
Title:
Unit Number
Maximum Length:30
The exact unit in a building used in an address search. For example, Apartment 208A or Suite 300. -
WorkPhoneCountry: string
Title:
Work Phone Country Code
Maximum Length:10
The country code for the work telephone number of the parcel contact. -
WorkPhoneNum: string
Title:
Work Phone Number
Maximum Length:40
The work telephone number of the parcel address contact.
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.