Get all projects

get

/fscmRestApi/resources/11.13.18.05/publicSectorProjects

Request

Query Parameters
  • 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).
  • 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
  • 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 by the primary key criteria.
      Finder Variables:
      • AgencyId; integer; The identifier for the agency to which a project belongs.
      • ProjectCode; string; The unique identifier string for a project.
    • simpleSearchFinder: Finds a project that matches the specified keyword.
      Finder Variables:
      • value; string; The keyword used to find a project by project code, project name, project summary, project type, status, estimated valuation, project contact person name, phone country code, phone area code, or the phone number.
  • 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.
  • 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
  • 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.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • 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
  • 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:
    • AgencyId; integer; The unique identifier for a public sector agency.
    • CreatedByName; string; The name of the user who created the project.
    • CreationDate; string; The date when the project was created.
    • CurrencyCode; string; The currency code used for creating the project. The default is the public sector agency currency code.
    • EndDate; string; The end date of the project.
    • EstimatedValuation; number; The estimated valuation of the project.
    • LastUpdateDate; string; The date when the project was last updated.
    • Meaning; string; The actual meaning of the project status. For example, active, canceled, completed, and so on.
    • ProjectAdmin; integer; The project manager for the project.
    • ProjectAdminBizProfileId; integer; The unique identifier for the business profile of the project manager.
    • ProjectAdminProfileId; integer; The unique identifier for the project manager's personal profile.
    • ProjectCode; string; The unique identifier for a project.
    • ProjectName; string; A user-friendly name for the project.
    • ProjectSummary; string; A brief desription of the project.
    • ProjectType; string; The project type. This can be anything that is configured in the project type setup.
    • StartDate; string; The start date of the project.
    • Status; string; The status of the project. The status can be active, inactive, on hold, completed, or canceled. The default value is active.
  • 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
  • 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".
  • 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 Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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.
Body ()
Root Schema : publicSectorProjects
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : publicSectorProjects-item-response
Type: object
Show Source
Nested Schema : Project Contacts
Type: array
Title: Project Contacts
The project contacts resource is used to create, view, or update the contacts related to a project.
Show Source
Nested Schema : Project Parcels
Type: array
Title: Project Parcels
The project parcels resource is used to create, view, or update the parcels related to a project.
Show Source
Nested Schema : publicSectorProjects-ProjectContact-item-response
Type: object
Show Source
Nested Schema : publicSectorProjects-ProjectParcel-item-response
Type: object
Show Source
  • Default Value: 1
    The unique identifier for a public sector agency.
  • Title: Block Number
    Maximum Length: 30
    The block number of the parcel in the Detail Land Information, which is part of the Assessor Parcel Number (APN).
  • Title: Book Number
    Maximum Length: 30
    The book number of the parcel in the Detail Land Information, which is part of the Assessor Parcel Number (APN).
  • Title: Boundary Description
    Maximum Length: 480
    A textual description of the property boundaries. This is not a listing of coordinates. For example, SMITH LOT - COME E 155 FT FROM SW CORNER OF LOT 206 THEN 77.5 FT N TO A LINE WHICH EXTENDS FROM A PT N 309.91 FT AND E 55.25 FT FROM BEG TO A PT E 155 FT FROM LOT 206.
  • Title: X Coordinate
    The x-axis coordinate for the project parcel.
  • Title: Y Coordinate
    The y-axis coordinate for the project parcel.
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    The user who created the project parcel.
  • Title: Creation Date
    Read Only: true
    The date when the project parcel was created.
  • Maximum Length: 50
    The district name of the parcel.
  • Title: Jurisdiction
    Maximum Length: 50
    The name of the city, if incorporated, or the name of the county, if unincorporated.
  • Title: Land Use Code
    Maximum Length: 30
    The land use code of the parcel in the Detail Land Information, which is part of the Assessor Parcel Number (APN).
  • Title: Last Updated Date
    Read Only: true
    The user who last updated the project parcel.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    The date when the project parcel was last updated.
  • Title: Last Update Login
    Read Only: true
    Maximum Length: 32
    The login ID of the user who last updated the project parcel.
  • Title: Latitude
    The geographic location of the parcel that is north or south of the equator.
  • Links
  • Title: Longitude
    The geographic location of the parcel address that is east or west of the meridian. It typically points to a specific entrance area within a large parcel, for example, a security checkpoint gate, delivery entrance, or employee entrance.
  • Title: Lot Number
    Maximum Length: 30
    The lot number of the parcel in the Detail Land Information, which is part of the Assessor Parcel Number (APN).
  • Title: Map Book Page
    Maximum Length: 50
    The recorded map book and page.
  • Title: Map Name
    Maximum Length: 50
    The recorded map name. For example, Public Works.
  • Title: Page Number
    Maximum Length: 30
    The page number of the parcel in the Detail Land Information, which is part of the Assessor Parcel Number (APN).
  • Title: Parcel ID
    The identifier for the project parcel.
  • Title: Parcel ID
    Maximum Length: 30
    The identifier for the project parcel.
  • The unique identifier for the project parcel.
  • Title: Parcel Type
    Maximum Length: 30
    The type of the parcel. For example, commercial, residential, or government.
  • Title: Parent Parcel ID
    The unique identifier for the parent parcel.
  • Title: Primary
    Maximum Length: 1
    Default Value: false
    Indicates the primary project parcel. If the value is Y, then the parcel is the primary parcel. The default value is N.
  • Title: Primary Zoning ID
    Maximum Length: 30
    The primary zoning ID of the zoning for the parcel.
  • Project Parcel Owners
    Title: Project Parcel Owners
    The resource is used to create, view, or update the project parcel owners related to a project.
  • Project Addresses
    Title: Project Addresses
    The resource is used to create, view, or update the project parcel addresses related to a project.
  • Title: Project ID
    Maximum Length: 30
    The unique identifier for a project.
  • Title: Property Description
    Maximum Length: 240
    The property description.
  • Title: Section Number
    Maximum Length: 30
    The section number of the parcel in the Detail Land Information, which is part of the Assessor Parcel Number (APN).
  • Title: SRID
    The GIS coordinate system in use.
  • Title: Subdivision
    Maximum Length: 30
    The subdivision of the parcel in the Detail Land Information, which is part of the Assessor Parcel Number (APN).
  • Title: Unit Number
    Maximum Length: 30
    The unit number of the parcel in the Detail Land Information, which is part of the Assessor Parcel Number (APN).
  • Title: Zoning Description
    Maximum Length: 240
    The zoning description.
Nested Schema : Project Parcel Owners
Type: array
Title: Project Parcel Owners
The resource is used to create, view, or update the project parcel owners related to a project.
Show Source
Nested Schema : Project Addresses
Type: array
Title: Project Addresses
The resource is used to create, view, or update the project parcel addresses related to a project.
Show Source
Nested Schema : publicSectorProjects-ProjectParcel-PrjParcelOwner-item-response
Type: object
Show Source
  • Title: Address
    Maximum Length: 240
    The first or main address of the project parcel owner.
  • Title: Address Line 2
    Maximum Length: 240
    The second address of the project parcel owner, if present.
  • Title: Address Line 3
    Maximum Length: 240
    The third address of the project parcel owner, if present.
  • Title: Address Line 4
    Maximum Length: 240
    The fourth address of the project parcel owner, if present.
  • Title: Address Field 1
    Maximum Length: 20
    The address field of the project parcel owner search.
  • Title: Address Field 2
    Maximum Length: 20
    The address field of the project parcel owner search.
  • Title: Address Field 3
    Maximum Length: 20
    The address field of the project parcel owner search.
  • Default Value: 1
    The unique identifier for a public sector agency.
  • Title: Building Type
    Maximum Length: 20
    The building type in the project parcel owner search. For example, Tower A or Block 3.
  • Title: Cell Phone Country Code
    Maximum Length: 10
    The cell phone country code of the project parcel owner.
  • Title: Cell Phone Number
    Maximum Length: 40
    The cell phone number of the project parcel owner.
  • Title: City
    Maximum Length: 60
    The city of the project parcel owner address.
  • Title: Country
    Maximum Length: 60
    The country of the project parcel owner address.
  • Title: County
    Maximum Length: 60
    The county of the project parcel owner address.
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    The user who created the project parcel owner.
  • Title: Creation Date
    Read Only: true
    The date when the project parcel owner was created.
  • Title: Document Number
    Maximum Length: 50
    The document number of the project parcel owner.
  • Title: Email Address
    Maximum Length: 50
    The email ID of the project parcel owner.
  • Title: Fax Country Code
    Maximum Length: 10
    The fax country code of the project parcel owner.
  • Title: Fax Number
    Maximum Length: 40
    The fax number of the project parcel owner.
  • Title: Floor
    Maximum Length: 20
    The floor of the building. For example, mezzanine level, penthouse, or garage level C.
  • Title: Home Phone Country Code
    Maximum Length: 10
    The home phone country code of the project parcel owner.
  • Title: Home Phone Number
    Maximum Length: 40
    The home phone number of the project parcel owner.
  • Title: Last Transfer Date
    The last transfer date of the project parcel owner.
  • Title: Last Transfer Type
    Maximum Length: 50
    The last transfer type of the project parcel owner.
  • Title: Last Updated Date
    Read Only: true
    The user who last updated the project parcel owner.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    The date when the project parcel owner was last updated.
  • Title: Last Update Login
    Read Only: true
    Maximum Length: 32
    The login ID of the user who last updated the project parcel owner.
  • Links
  • Title: Name 1
    Maximum Length: 150
    The first name of the parcel owner.
  • Title: Name 2
    Maximum Length: 150
    The second name of the parcel owner.
  • Title: Owner ID
    The identifier of the parcel owner.
  • Title: Owner ID
    The unique identifier for the project parcel owner.
  • Title: Owner Type
    Maximum Length: 20
    The type of parcel owner.
  • Title: Parcel ID
    The identifier of the parcel.
  • Title: Parcel ID
    The unique identifier for the project parcel.
  • Title: Postal Code
    Maximum Length: 60
    The postal code of the project parcel owner address.
  • Title: Postal Plus 4 Code
    Maximum Length: 20
    The postal plus four code of the project parcel owner address.
  • Title: Primary
    Maximum Length: 1
    Default Value: false
    Indicates the primary project parcel owner. If the value is Y, then the parcel owner is the primary parcel owner. The default value is N.
  • Title: Project ID
    Maximum Length: 30
    The unique identifier for a project.
  • Title: Province
    Maximum Length: 60
    The province of the project parcel owner address.
  • Title: State
    Maximum Length: 60
    The state of the project parcel owner address.
  • Title: Street Direction
    Maximum Length: 10
    The street direction of the address in an project parcel owner search. Values are compass directions, such as N, S, E, W, NW, SE, and so on.
  • Title: Street Name
    Maximum Length: 240
    The street name of the address in the project parcel owner search.
  • Title: Street Name
    Maximum Length: 20
    The street number of the address in the project parcel owner search.
  • Title: Street Type
    Maximum Length: 20
    The street type of the address in the project parcel owner search. For example, alley, boulevard, avenue, lane, street, loop, and so on.
  • Title: Unit Number
    Maximum Length: 30
    The exact unit in a building. For example, Apartment 208A or Suite 300.
  • Title: Work Phone Country Code
    Maximum Length: 10
    The work phone country code of the project parcel owner.
  • Title: Work Phone Number
    Maximum Length: 40
    The work phone number of the project parcel owner.
Nested Schema : publicSectorProjects-ProjectParcel-ProjectAddress-item-response
Type: object
Show Source
  • Title: Address Line 1
    Maximum Length: 240
    The first or main address.
  • Title: Address Line 2
    Maximum Length: 240
    The second address, if present.
  • Title: Address Line 3
    Maximum Length: 240
    The third address, if present.
  • Title: Address Line 4
    Maximum Length: 240
    The fourth address, if present.
  • Title: Address Field 1
    Maximum Length: 20
    Additional information for the first address or main address of the parcel.
  • Title: Address Field 2
    Maximum Length: 20
    Additional information for the second address of the parcel, if present.
  • Title: Address Field 3
    Maximum Length: 20
    Additional information for the third address of the parcel, if present.
  • Title: Address ID
    The identifier of the parcel address.
  • Title: Address ID
    The unique identifier of the project address.
  • Title: Address Type
    Maximum Length: 20
    The address type used for delivery point validation (DPV). For example, main address, side address, or virtual address.
  • Default Value: 1
    The unique identifier for a public sector agency.
  • Title: Building Type
    Maximum Length: 20
    The building type used in an address search. For example, Tower A or Block 3.
  • Title: Cell Phone Country Code
    Maximum Length: 10
    The country code for the cell phone number of parcel contact.
  • Title: Cell Phone Number
    Maximum Length: 40
    The cell phone number of the parcel address contact.
  • Title: City
    Maximum Length: 60
    The city in the parcel address.
  • Title: X Coordinate
    The x-axis coordinate of the project parcel address.
  • Title: Y Coordinate
    The y-axis coordinate of the project parcel address.
  • Title: Country
    Maximum Length: 60
    The country in the parcel address.
  • Title: County
    Maximum Length: 60
    The county in the parcel address.
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    The user who created the project parcel address.
  • Title: Creation Date
    Read Only: true
    The date when the project parcel address was created.
  • Title: Email Address
    Maximum Length: 50
    The email address of the parcel address contact.
  • Title: Fax Country Code
    Maximum Length: 10
    The country code for the fax number of the parcel contact.
  • Title: Fax Number
    Maximum Length: 40
    The fax number of the parcel address contact.
  • Title: Floor
    Maximum Length: 20
    The floor or level in an address search. For example, mezzanine level, penthouse, or garage level C.
  • Title: Home Phone Country Code
    Maximum Length: 10
    The country code for the home telephone number of the parcel address contact.
  • Title: Home Phone Number
    Maximum Length: 40
    The home telephone number of the parcel address contact.
  • 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.
  • Title: Last Updated Date
    Read Only: true
    The user who last updated the project parcel address.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    The date when the project parcel address was last updated.
  • Title: Last Update Login
    Read Only: true
    Maximum Length: 32
    The login ID of the user who last updated the project parcel address.
  • 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
  • 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.
  • Title: Municipality ID
    Maximum Length: 20
    The municipality identifier if the parcel is not managed at the county level.
  • Title: Parcel ID
    The identifier of the parcel.
  • Title: Parcel ID
    The unique identifier of the project parcel.
  • Title: Postal Code
    Maximum Length: 60
    The postal code in the parcel address.
  • Title: Postal Plus 4 Code
    Maximum Length: 20
    The postal plus four code of the parcel address.
  • 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.
  • Title: Project ID
    Maximum Length: 30
    The unique identifier for a project.
  • Title: Province
    Maximum Length: 60
    The province in the parcel address.
  • 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.
  • Title: State
    Maximum Length: 60
    The state in the parcel address.
  • 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.
  • Title: Street Name
    Maximum Length: 240
    The street name in the parcel address used during a search.
  • Title: Street Number
    Maximum Length: 20
    The street number in the parcel address.
  • 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.
  • Title: Unit Number
    Maximum Length: 30
    The exact unit in a building used in an address search. For example, Apartment 208A or Suite 300.
  • Title: Work Phone Country Code
    Maximum Length: 10
    The country code for the work telephone number of the parcel contact.
  • Title: Work Phone Number
    Maximum Length: 40
    The work telephone number of the parcel address contact.
Back to Top