Create a project
post
/fscmRestApi/resources/11.13.18.05/publicSectorProjects
Request
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
The following table describes the body parameters in the request for this task.
Root Schema : publicSectorProjects-item
Type:
Show Source
object-
AgencyId(optional):
integer(int32)
The unique identifier for a public sector agency.
-
CreatedBy(optional):
string
Title:
Created ByMaximum Length:64The user who created the project. -
CreationDate(optional):
string(date-time)
Title:
Creation DateThe date when the project was created. -
CurrencyCode(optional):
string
Title:
Currency CodeMaximum Length:3The currency code used for creating the project. The default is the public sector agency currency code. -
EndDate(optional):
string(date-time)
Title:
End DateThe end date of the project. -
EstimatedValuation(optional):
number
Title:
Estimated ValuationThe estimated valuation of the project. -
LastUpdateDate(optional):
string(date-time)
Title:
Last Updated DateThe date when the project was last updated. -
LastUpdatedBy(optional):
string
Title:
Last Updated ByMaximum Length:64The user who last updated the project. -
links(optional):
array Items
Title:
ItemsLink Relations -
Meaning(optional):
string
Maximum Length:
80The actual meaning of the project status. For example, active, canceled, completed, and so on. -
ProjectAdmin(optional):
integer(int64)
Title:
Primary ContactThe project manager for the project. -
ProjectAdminBizProfileId(optional):
integer(int64)
The unique identifier for the business profile of the project manager.
-
ProjectAdminProfileId(optional):
integer(int64)
The unique identifier for the project manager's personal profile.
-
ProjectCode(optional):
string
Title:
Project IDMaximum Length:30The unique identifier for a project. -
ProjectContact(optional):
array Project Contacts
Title:
Project ContactsThe projects resource is used to create, view, or update a project. A project is an aggregrate of all the information related to a record for permits, planning and zoning, and so on. -
ProjectName(optional):
string
Title:
NameMaximum Length:50A user-friendly name for the project. -
ProjectParcel(optional):
array Project Parcels
Title:
Project ParcelsThe projects resource is used to create, view, or update a project. A project is an aggregrate of all the information related to a record for permits, planning and zoning, and so on. -
ProjectSummary(optional):
string
Title:
Project SummaryMaximum Length:500A brief desription of the project. -
ProjectType(optional):
string
Title:
Project TypeMaximum Length:50The project type. This can be anything that is configured in the project type setup. -
StartDate(optional):
string(date-time)
Title:
Start DateThe start date of the project. -
Status(optional):
string
Title:
StatusMaximum Length:7The status of the project. The status can be active, inactive, on hold, completed, or canceled. The default value is active.
Nested Schema : Project Contacts
Type:
arrayTitle:
Project ContactsThe projects resource is used to create, view, or update a project. A project is an aggregrate of all the information related to a record for permits, planning and zoning, and so on.
Show Source
Nested Schema : Project Parcels
Type:
arrayTitle:
Project ParcelsThe projects resource is used to create, view, or update a project. A project is an aggregrate of all the information related to a record for permits, planning and zoning, and so on.
Show Source
Nested Schema : link
Type:
Show Source
object-
href(optional):
string
Title:
hyperlink referenceThe URI to the related resource. -
rel(optional):
string
Title:
relationThe name of the relation to the resource instance. Example: self.
Nested Schema : publicSectorProjects-ProjectContact-item
Type:
Show Source
object-
Address1(optional):
string
Title:
Address Line 1Maximum Length:240The first or main address. -
Address2(optional):
string
Title:
Address Line 2Maximum Length:240The second address, if present. -
Address3(optional):
string
Title:
Address Line 3Maximum Length:240The third address, if present. -
Address4(optional):
string
Title:
Address Line 4Maximum Length:240The fourth address, if present. -
AgencyId(optional):
integer(int32)
The unique identifier for a public sector agency.
-
City(optional):
string
Title:
CityMaximum Length:60The city of the project contact address. -
ContactBizPartyId(optional):
integer(int64)
The party ID of the business associated with the project contact.
-
ContactBizProfileId(optional):
integer(int64)
The unique identifier for the business profile of the project contact.
-
ContactId(optional):
integer(int64)
The unique identifier for the project contact.
-
ContactKey(optional):
integer(int64)
The unique identifier for a project contact.
-
ContactPartyId(optional):
integer(int64)
The party ID of the project contact.
-
ContactProfileId(optional):
integer(int64)
The unique identifier for the personal profile of the project contact.
-
ContactType(optional):
string
Title:
Contact TypeMaximum Length:30The type of contact. -
Country(optional):
string
Title:
CountryMaximum Length:3The country of the project contact address. -
County(optional):
string
Title:
CountyMaximum Length:60The county of the project contact address. -
CreatedBy(optional):
string
Title:
Created ByMaximum Length:64The user who created the project contact. -
CreationDate(optional):
string(date-time)
Title:
Creation DateThe date when the project contact was created. -
EmailAddress(optional):
string
Title:
EmailMaximum Length:320The email address of the contact. -
LastUpdateDate(optional):
string(date-time)
Title:
Last Updated DateThe user who last updated the project contact. -
LastUpdatedBy(optional):
string
Title:
Last Updated ByMaximum Length:64The date when the project contact was last updated. -
links(optional):
array Items
Title:
ItemsLink Relations -
OrganizationName(optional):
string
Title:
Organization NameMaximum Length:360The name of the organization of the project contact. -
PersonFirstName(optional):
string
Title:
First NameMaximum Length:150The first name of the project contact. -
PersonLastName(optional):
string
Title:
Last NameMaximum Length:150The last name of the project contact. -
PersonMiddleName(optional):
string
Title:
Middle NameMaximum Length:60The middle name of the project contact. -
PersonName(optional):
string
Title:
NameMaximum Length:450The full name of the project contact. -
PersonNameSuffix(optional):
string
Maximum Length:
30The name suffix of the project contact. -
PersonPreNameAdjunct(optional):
string
Maximum Length:
30The prefix for the project contact name. For example, Dr., Professor, etc. -
PersonTitle(optional):
string
Title:
TitleMaximum Length:60The title of the project contact. -
PhoneAreaCode(optional):
string
Maximum Length:
10The area code of the contact phone number. -
PhoneCountryCode(optional):
string
Maximum Length:
10The country code of the contact phone number. -
PhoneExtension(optional):
string
Maximum Length:
20The extension of the contact phone number. -
PhoneNumber(optional):
string
Maximum Length:
40The phone number of the contact. -
PostalCode(optional):
string
Title:
Postal CodeMaximum Length:60The postal code of the project contact address. -
PostalPlus4Code(optional):
string
Title:
Postal Plus 4 CodeMaximum Length:10The postal plus four code of the project contact address. -
PrimaryFlag(optional):
string
Title:
PrimaryMaximum Length:1Indicates the primary project contact. If the value is Y, then the project contact is the primary project contact. The default value is N. -
ProjectCode(optional):
string
Title:
Project IDMaximum Length:30The unique identifier for a project. -
Province(optional):
string
Title:
ProvinceMaximum Length:60The province of the project contact address. -
State(optional):
string
Title:
StateMaximum Length:60The state of the project contact address.
Nested Schema : publicSectorProjects-ProjectParcel-item
Type:
Show Source
object-
AgencyId(optional):
integer(int32)
The unique identifier for a public sector agency.
-
BlockNum(optional):
string
Title:
Block NumberMaximum Length:30The block number of the parcel in the Detail Land Information, which is part of the Assessor Parcel Number (APN). -
BookNum(optional):
string
Title:
Book NumberMaximum Length:30The book number of the parcel in the Detail Land Information, which is part of the Assessor Parcel Number (APN). -
BoundaryDescription(optional):
string
Title:
Boundary DescriptionMaximum Length:480A 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. -
CoordinateX(optional):
number
Title:
X CoordinateThe x-axis coordinate for the project parcel. -
CoordinateY(optional):
number
Title:
Y CoordinateThe y-axis coordinate for the project parcel. -
CreatedBy(optional):
string
Title:
Created ByMaximum Length:64The user who created the project parcel. -
CreationDate(optional):
string(date-time)
Title:
Creation DateThe date when the project parcel was created. -
DistrictName(optional):
string
Maximum Length:
50The district name of the parcel. -
Jurisdiction(optional):
string
Title:
JurisdictionMaximum Length:50The name of the city, if incorporated, or the name of the county, if unincorporated. -
LandUseCode(optional):
string
Title:
Land Use CodeMaximum Length:30The land use code of the parcel in the Detail Land Information, which is part of the Assessor Parcel Number (APN). -
LastUpdateDate(optional):
string(date-time)
Title:
Last Updated DateThe user who last updated the project parcel. -
LastUpdatedBy(optional):
string
Title:
Last Updated ByMaximum Length:64The date when the project parcel was last updated. -
LastUpdateLogin(optional):
string
Title:
Last Update LoginMaximum Length:32The login ID of the user who last updated the project parcel. -
Latitude(optional):
number
Title:
LatitudeThe geographic location of the parcel that is north or south of the equator. -
links(optional):
array Items
Title:
ItemsLink Relations -
Longitude(optional):
number
Title:
LongitudeThe 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. -
LotNum(optional):
string
Title:
Lot NumberMaximum Length:30The lot number of the parcel in the Detail Land Information, which is part of the Assessor Parcel Number (APN). -
MapBookPage(optional):
string
Title:
Map Book PageMaximum Length:50The recorded map book and page. -
MapName(optional):
string
Title:
Map NameMaximum Length:50The recorded map name. For example, Public Works. -
PageNum(optional):
string
Title:
Page NumberMaximum Length:30The page number of the parcel in the Detail Land Information, which is part of the Assessor Parcel Number (APN). -
ParcelId(optional):
integer(int64)
Title:
Parcel IDThe identifier for the project parcel. -
ParcelIdEntered(optional):
string
Title:
Parcel IDMaximum Length:30The identifier for the project parcel. -
ParcelKey(optional):
integer(int64)
The unique identifier for the project parcel.
-
ParcelType(optional):
string
Title:
Parcel TypeMaximum Length:30The type of the parcel. For example, commercial, residential, or government. -
ParentParcelId(optional):
integer(int64)
Title:
Parent Parcel IDThe unique identifier for the parent parcel. -
PrimaryFlag(optional):
string
Title:
PrimaryMaximum Length:1Indicates the primary project parcel. If the value is Y, then the parcel is the primary parcel. The default value is N. -
PrimaryZoningId(optional):
string
Title:
Primary Zoning IDMaximum Length:30The primary zoning ID of the zoning for the parcel. -
PrjParcelOwner(optional):
array Project Parcel Owners
Title:
Project Parcel OwnersThe project parcels resource is used to create, view, or update the parcels related to a project. -
ProjectAddress(optional):
array Project Addresses
Title:
Project AddressesThe project parcels resource is used to create, view, or update the parcels related to a project. -
ProjectCode(optional):
string
Title:
Project IDMaximum Length:30The unique identifier for a project. -
PropertyDescription(optional):
string
Title:
Property DescriptionMaximum Length:240The property description. -
SectionNum(optional):
string
Title:
Section NumberMaximum Length:30The section number of the parcel in the Detail Land Information, which is part of the Assessor Parcel Number (APN). -
Srid(optional):
integer(int64)
Title:
SRIDThe GIS coordinate system in use. -
Subdivision(optional):
string
Title:
SubdivisionMaximum Length:30The subdivision of the parcel in the Detail Land Information, which is part of the Assessor Parcel Number (APN). -
UnitNum(optional):
string
Title:
Unit NumberMaximum Length:30The unit number of the parcel in the Detail Land Information, which is part of the Assessor Parcel Number (APN). -
ZoningDescription(optional):
string
Title:
Zoning DescriptionMaximum Length:240The zoning description.
Nested Schema : Project Parcel Owners
Type:
arrayTitle:
Project Parcel OwnersThe project parcels resource is used to create, view, or update the parcels related to a project.
Show Source
Nested Schema : Project Addresses
Type:
arrayTitle:
Project AddressesThe project parcels resource is used to create, view, or update the parcels related to a project.
Show Source
Nested Schema : publicSectorProjects-ProjectParcel-PrjParcelOwner-item
Type:
Show Source
object-
Address1(optional):
string
Title:
AddressMaximum Length:240The first or main address of the project parcel owner. -
Address2(optional):
string
Title:
Address Line 2Maximum Length:240The second address of the project parcel owner, if present. -
Address3(optional):
string
Title:
Address Line 3Maximum Length:240The third address of the project parcel owner, if present. -
Address4(optional):
string
Title:
Address Line 4Maximum Length:240The fourth address of the project parcel owner, if present. -
AddressField1(optional):
string
Title:
Address Field 1Maximum Length:20The address field of the project parcel owner search. -
AddressField2(optional):
string
Title:
Address Field 2Maximum Length:20The address field of the project parcel owner search. -
AddressField3(optional):
string
Title:
Address Field 3Maximum Length:20The address field of the project parcel owner search. -
AgencyId(optional):
integer(int32)
The unique identifier for a public sector agency.
-
BuildingType(optional):
string
Title:
Building TypeMaximum Length:20The building type in the project parcel owner search. For example, Tower A or Block 3. -
CellPhoneCountry(optional):
string
Title:
Cell Phone Country CodeMaximum Length:10The cell phone country code of the project parcel owner. -
CellPhoneNum(optional):
string
Title:
Cell Phone NumberMaximum Length:40The cell phone number of the project parcel owner. -
City(optional):
string
Title:
CityMaximum Length:60The city of the project parcel owner address. -
Country(optional):
string
Title:
CountryMaximum Length:60The country of the project parcel owner address. -
County(optional):
string
Title:
CountyMaximum Length:60The county of the project parcel owner address. -
CreatedBy(optional):
string
Title:
Created ByMaximum Length:64The user who created the project parcel owner. -
CreationDate(optional):
string(date-time)
Title:
Creation DateThe date when the project parcel owner was created. -
DocumentNum(optional):
string
Title:
Document NumberMaximum Length:50The document number of the project parcel owner. -
EmailId(optional):
string
Title:
Email AddressMaximum Length:50The email ID of the project parcel owner. -
FaxCountry(optional):
string
Title:
Fax Country CodeMaximum Length:10The fax country code of the project parcel owner. -
FaxNum(optional):
string
Title:
Fax NumberMaximum Length:40The fax number of the project parcel owner. -
Floor(optional):
string
Title:
FloorMaximum Length:20The floor of the building. For example, mezzanine level, penthouse, or garage level C. -
HomePhoneCountry(optional):
string
Title:
Home Phone Country CodeMaximum Length:10The home phone country code of the project parcel owner. -
HomePhoneNum(optional):
string
Title:
Home Phone NumberMaximum Length:40The home phone number of the project parcel owner. -
LastTransferDate(optional):
string(date)
Title:
Last Transfer DateThe last transfer date of the project parcel owner. -
LastTransferType(optional):
string
Title:
Last Transfer TypeMaximum Length:50The last transfer type of the project parcel owner. -
LastUpdateDate(optional):
string(date-time)
Title:
Last Updated DateThe user who last updated the project parcel owner. -
LastUpdatedBy(optional):
string
Title:
Last Updated ByMaximum Length:64The date when the project parcel owner was last updated. -
LastUpdateLogin(optional):
string
Title:
Last Update LoginMaximum Length:32The login ID of the user who last updated the project parcel owner. -
links(optional):
array Items
Title:
ItemsLink Relations -
Name1(optional):
string
Title:
Name 1Maximum Length:150The first name of the parcel owner. -
Name2(optional):
string
Title:
Name 2Maximum Length:150The second name of the parcel owner. -
OwnerId(optional):
integer(int64)
Title:
Owner IDThe identifier of the parcel owner. -
OwnerKey(optional):
integer(int64)
Title:
Owner IDThe unique identifier for the project parcel owner. -
OwnerType(optional):
string
Title:
Owner TypeMaximum Length:20The type of parcel owner. -
ParcelId(optional):
integer(int64)
Title:
Parcel IDThe identifier of the parcel. -
ParcelKey(optional):
integer(int64)
Title:
Parcel IDThe unique identifier for the project parcel. -
PostalCode(optional):
string
Title:
Postal CodeMaximum Length:60The postal code of the project parcel owner address. -
PostalPlus4Code(optional):
string
Title:
Postal Plus 4 CodeMaximum Length:20The postal plus four code of the project parcel owner address. -
PrimaryFlag(optional):
string
Title:
PrimaryMaximum Length:1Indicates the primary project parcel owner. If the value is Y, then the parcel owner is the primary parcel owner. The default value is N. -
ProjectCode(optional):
string
Title:
Project IDMaximum Length:30The unique identifier for a project. -
Province(optional):
string
Title:
ProvinceMaximum Length:60The province of the project parcel owner address. -
State(optional):
string
Title:
StateMaximum Length:60The state of the project parcel owner address. -
StreetDirection(optional):
string
Title:
Street DirectionMaximum Length:10The 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. -
StreetName(optional):
string
Title:
Street NameMaximum Length:240The street name of the address in the project parcel owner search. -
StreetNumber(optional):
string
Title:
Street NameMaximum Length:20The street number of the address in the project parcel owner search. -
StreetType(optional):
string
Title:
Street TypeMaximum Length:20The street type of the address in the project parcel owner search. For example, alley, boulevard, avenue, lane, street, loop, and so on. -
UnitNumber(optional):
string
Title:
Unit NumberMaximum Length:30The exact unit in a building. For example, Apartment 208A or Suite 300. -
WorkPhoneCountry(optional):
string
Title:
Work Phone Country CodeMaximum Length:10The work phone country code of the project parcel owner. -
WorkPhoneNum(optional):
string
Title:
Work Phone NumberMaximum Length:40The work phone number of the project parcel owner.
Nested Schema : publicSectorProjects-ProjectParcel-ProjectAddress-item
Type:
Show Source
object-
Address1(optional):
string
Title:
Address Line 1Maximum Length:240The first or main address. -
Address2(optional):
string
Title:
Address Line 2Maximum Length:240The second address, if present. -
Address3(optional):
string
Title:
Address Line 3Maximum Length:240The third address, if present. -
Address4(optional):
string
Title:
Address Line 4Maximum Length:240The fourth address, if present. -
AddressField1(optional):
string
Title:
Address Field 1Maximum Length:20Additional information for the first address or main address of the parcel. -
AddressField2(optional):
string
Title:
Address Field 2Maximum Length:20Additional information for the second address of the parcel, if present. -
AddressField3(optional):
string
Title:
Address Field 3Maximum Length:20Additional information for the third address of the parcel, if present. -
AddressId(optional):
integer(int64)
Title:
Address IDThe identifier of the parcel address. -
AddressKey(optional):
integer(int64)
Title:
Address IDThe unique identifier of the project address. -
AddressType(optional):
string
Title:
Address TypeMaximum Length:20The address type used for delivery point validation (DPV). For example, main address, side address, or virtual address. -
AgencyId(optional):
integer(int32)
The unique identifier for a public sector agency.
-
BuildingType(optional):
string
Title:
Building TypeMaximum Length:20The building type used in an address search. For example, Tower A or Block 3. -
CellPhoneCountry(optional):
string
Title:
Cell Phone Country CodeMaximum Length:10The country code for the cell phone number of parcel contact. -
CellPhoneNum(optional):
string
Title:
Cell Phone NumberMaximum Length:40The cell phone number of the parcel address contact. -
City(optional):
string
Title:
CityMaximum Length:60The city in the parcel address. -
CoordinateX(optional):
number
Title:
X CoordinateThe x-axis coordinate of the project parcel address. -
CoordinateY(optional):
number
Title:
Y CoordinateThe y-axis coordinate of the project parcel address. -
Country(optional):
string
Title:
CountryMaximum Length:60The country in the parcel address. -
County(optional):
string
Title:
CountyMaximum Length:60The county in the parcel address. -
CreatedBy(optional):
string
Title:
Created ByMaximum Length:64The user who created the project parcel address. -
CreationDate(optional):
string(date-time)
Title:
Creation DateThe date when the project parcel address was created. -
EmailId(optional):
string
Title:
Email AddressMaximum Length:50The email address of the parcel address contact. -
FaxCountry(optional):
string
Title:
Fax Country CodeMaximum Length:10The country code for the fax number of the parcel contact. -
FaxNum(optional):
string
Title:
Fax NumberMaximum Length:40The fax number of the parcel address contact. -
Floor(optional):
string
Title:
FloorMaximum Length:20The floor or level in an address search. For example, mezzanine level, penthouse, or garage level C. -
HomePhoneCountry(optional):
string
Title:
Home Phone Country CodeMaximum Length:10The country code for the home telephone number of the parcel address contact. -
HomePhoneNum(optional):
string
Title:
Home Phone NumberMaximum Length:40The home telephone number of the parcel address contact. -
InputSource(optional):
string
Title:
Input SourceMaximum Length:1Indicates how the data were entered or loaded into the application. The values are S for system data and U for user-entered data. -
LastUpdateDate(optional):
string(date-time)
Title:
Last Updated DateThe user who last updated the project parcel address. -
LastUpdatedBy(optional):
string
Title:
Last Updated ByMaximum Length:64The date when the project parcel address was last updated. -
LastUpdateLogin(optional):
string
Title:
Last Update LoginMaximum Length:32The login ID of the user who last updated the project parcel address. -
Latitude(optional):
number
Title:
LatitudeThe 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(optional):
array Items
Title:
ItemsLink Relations -
Longitude(optional):
number
Title:
LongitudeThe 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(optional):
string
Title:
Municipality IDMaximum Length:20The municipality identifier if the parcel is not managed at the county level. -
ParcelId(optional):
integer(int64)
Title:
Parcel IDThe identifier of the parcel. -
ParcelKey(optional):
integer(int64)
Title:
Parcel IDThe unique identifier of the project parcel. -
PostalCode(optional):
string
Title:
Postal CodeMaximum Length:60The postal code in the parcel address. -
PostalPlus4Code(optional):
string
Title:
Postal Plus 4 CodeMaximum Length:20The postal plus four code of the parcel address. -
PrimaryFlag(optional):
string
Title:
PrimaryMaximum Length:1Indicates 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(optional):
string
Title:
Project IDMaximum Length:30The unique identifier for a project. -
Province(optional):
string
Title:
ProvinceMaximum Length:60The province in the parcel address. -
Srid(optional):
integer(int64)
Title:
SRIDThe 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(optional):
string
Title:
StateMaximum Length:60The state in the parcel address. -
StreetDirection(optional):
string
Title:
Street DirectionMaximum Length:10The 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(optional):
string
Title:
Street NameMaximum Length:240The street name in the parcel address used during a search. -
StreetNumber(optional):
string
Title:
Street NumberMaximum Length:20The street number in the parcel address. -
StreetType(optional):
string
Title:
Street TypeMaximum Length:20The street type designation used during a search. For example, alley, boulevard, avenue, lane, street, loop, and so on. -
UnitNumber(optional):
string
Title:
Unit NumberMaximum Length:30The exact unit in a building used in an address search. For example, Apartment 208A or Suite 300. -
WorkPhoneCountry(optional):
string
Title:
Work Phone Country CodeMaximum Length:10The country code for the work telephone number of the parcel contact. -
WorkPhoneNum(optional):
string
Title:
Work Phone NumberMaximum Length:40The work telephone number of the parcel address contact.
Response
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
Default Response
The following table describes the default response for this task.
Root Schema : publicSectorProjects-item
Type:
Show Source
object-
AgencyId(optional):
integer(int32)
The unique identifier for a public sector agency.
-
CreatedBy(optional):
string
Title:
Created ByMaximum Length:64The user who created the project. -
CreationDate(optional):
string(date-time)
Title:
Creation DateThe date when the project was created. -
CurrencyCode(optional):
string
Title:
Currency CodeMaximum Length:3The currency code used for creating the project. The default is the public sector agency currency code. -
EndDate(optional):
string(date-time)
Title:
End DateThe end date of the project. -
EstimatedValuation(optional):
number
Title:
Estimated ValuationThe estimated valuation of the project. -
LastUpdateDate(optional):
string(date-time)
Title:
Last Updated DateThe date when the project was last updated. -
LastUpdatedBy(optional):
string
Title:
Last Updated ByMaximum Length:64The user who last updated the project. -
links(optional):
array Items
Title:
ItemsLink Relations -
Meaning(optional):
string
Maximum Length:
80The actual meaning of the project status. For example, active, canceled, completed, and so on. -
ProjectAdmin(optional):
integer(int64)
Title:
Primary ContactThe project manager for the project. -
ProjectAdminBizProfileId(optional):
integer(int64)
The unique identifier for the business profile of the project manager.
-
ProjectAdminProfileId(optional):
integer(int64)
The unique identifier for the project manager's personal profile.
-
ProjectCode(optional):
string
Title:
Project IDMaximum Length:30The unique identifier for a project. -
ProjectContact(optional):
array Project Contacts
Title:
Project ContactsThe projects resource is used to create, view, or update a project. A project is an aggregrate of all the information related to a record for permits, planning and zoning, and so on. -
ProjectName(optional):
string
Title:
NameMaximum Length:50A user-friendly name for the project. -
ProjectParcel(optional):
array Project Parcels
Title:
Project ParcelsThe projects resource is used to create, view, or update a project. A project is an aggregrate of all the information related to a record for permits, planning and zoning, and so on. -
ProjectSummary(optional):
string
Title:
Project SummaryMaximum Length:500A brief desription of the project. -
ProjectType(optional):
string
Title:
Project TypeMaximum Length:50The project type. This can be anything that is configured in the project type setup. -
StartDate(optional):
string(date-time)
Title:
Start DateThe start date of the project. -
Status(optional):
string
Title:
StatusMaximum Length:7The status of the project. The status can be active, inactive, on hold, completed, or canceled. The default value is active.
Nested Schema : Project Contacts
Type:
arrayTitle:
Project ContactsThe projects resource is used to create, view, or update a project. A project is an aggregrate of all the information related to a record for permits, planning and zoning, and so on.
Show Source
Nested Schema : Project Parcels
Type:
arrayTitle:
Project ParcelsThe projects resource is used to create, view, or update a project. A project is an aggregrate of all the information related to a record for permits, planning and zoning, and so on.
Show Source
Nested Schema : link
Type:
Show Source
object-
href(optional):
string
Title:
hyperlink referenceThe URI to the related resource. -
rel(optional):
string
Title:
relationThe name of the relation to the resource instance. Example: self.
Nested Schema : publicSectorProjects-ProjectContact-item
Type:
Show Source
object-
Address1(optional):
string
Title:
Address Line 1Maximum Length:240The first or main address. -
Address2(optional):
string
Title:
Address Line 2Maximum Length:240The second address, if present. -
Address3(optional):
string
Title:
Address Line 3Maximum Length:240The third address, if present. -
Address4(optional):
string
Title:
Address Line 4Maximum Length:240The fourth address, if present. -
AgencyId(optional):
integer(int32)
The unique identifier for a public sector agency.
-
City(optional):
string
Title:
CityMaximum Length:60The city of the project contact address. -
ContactBizPartyId(optional):
integer(int64)
The party ID of the business associated with the project contact.
-
ContactBizProfileId(optional):
integer(int64)
The unique identifier for the business profile of the project contact.
-
ContactId(optional):
integer(int64)
The unique identifier for the project contact.
-
ContactKey(optional):
integer(int64)
The unique identifier for a project contact.
-
ContactPartyId(optional):
integer(int64)
The party ID of the project contact.
-
ContactProfileId(optional):
integer(int64)
The unique identifier for the personal profile of the project contact.
-
ContactType(optional):
string
Title:
Contact TypeMaximum Length:30The type of contact. -
Country(optional):
string
Title:
CountryMaximum Length:3The country of the project contact address. -
County(optional):
string
Title:
CountyMaximum Length:60The county of the project contact address. -
CreatedBy(optional):
string
Title:
Created ByMaximum Length:64The user who created the project contact. -
CreationDate(optional):
string(date-time)
Title:
Creation DateThe date when the project contact was created. -
EmailAddress(optional):
string
Title:
EmailMaximum Length:320The email address of the contact. -
LastUpdateDate(optional):
string(date-time)
Title:
Last Updated DateThe user who last updated the project contact. -
LastUpdatedBy(optional):
string
Title:
Last Updated ByMaximum Length:64The date when the project contact was last updated. -
links(optional):
array Items
Title:
ItemsLink Relations -
OrganizationName(optional):
string
Title:
Organization NameMaximum Length:360The name of the organization of the project contact. -
PersonFirstName(optional):
string
Title:
First NameMaximum Length:150The first name of the project contact. -
PersonLastName(optional):
string
Title:
Last NameMaximum Length:150The last name of the project contact. -
PersonMiddleName(optional):
string
Title:
Middle NameMaximum Length:60The middle name of the project contact. -
PersonName(optional):
string
Title:
NameMaximum Length:450The full name of the project contact. -
PersonNameSuffix(optional):
string
Maximum Length:
30The name suffix of the project contact. -
PersonPreNameAdjunct(optional):
string
Maximum Length:
30The prefix for the project contact name. For example, Dr., Professor, etc. -
PersonTitle(optional):
string
Title:
TitleMaximum Length:60The title of the project contact. -
PhoneAreaCode(optional):
string
Maximum Length:
10The area code of the contact phone number. -
PhoneCountryCode(optional):
string
Maximum Length:
10The country code of the contact phone number. -
PhoneExtension(optional):
string
Maximum Length:
20The extension of the contact phone number. -
PhoneNumber(optional):
string
Maximum Length:
40The phone number of the contact. -
PostalCode(optional):
string
Title:
Postal CodeMaximum Length:60The postal code of the project contact address. -
PostalPlus4Code(optional):
string
Title:
Postal Plus 4 CodeMaximum Length:10The postal plus four code of the project contact address. -
PrimaryFlag(optional):
string
Title:
PrimaryMaximum Length:1Indicates the primary project contact. If the value is Y, then the project contact is the primary project contact. The default value is N. -
ProjectCode(optional):
string
Title:
Project IDMaximum Length:30The unique identifier for a project. -
Province(optional):
string
Title:
ProvinceMaximum Length:60The province of the project contact address. -
State(optional):
string
Title:
StateMaximum Length:60The state of the project contact address.
Nested Schema : publicSectorProjects-ProjectParcel-item
Type:
Show Source
object-
AgencyId(optional):
integer(int32)
The unique identifier for a public sector agency.
-
BlockNum(optional):
string
Title:
Block NumberMaximum Length:30The block number of the parcel in the Detail Land Information, which is part of the Assessor Parcel Number (APN). -
BookNum(optional):
string
Title:
Book NumberMaximum Length:30The book number of the parcel in the Detail Land Information, which is part of the Assessor Parcel Number (APN). -
BoundaryDescription(optional):
string
Title:
Boundary DescriptionMaximum Length:480A 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. -
CoordinateX(optional):
number
Title:
X CoordinateThe x-axis coordinate for the project parcel. -
CoordinateY(optional):
number
Title:
Y CoordinateThe y-axis coordinate for the project parcel. -
CreatedBy(optional):
string
Title:
Created ByMaximum Length:64The user who created the project parcel. -
CreationDate(optional):
string(date-time)
Title:
Creation DateThe date when the project parcel was created. -
DistrictName(optional):
string
Maximum Length:
50The district name of the parcel. -
Jurisdiction(optional):
string
Title:
JurisdictionMaximum Length:50The name of the city, if incorporated, or the name of the county, if unincorporated. -
LandUseCode(optional):
string
Title:
Land Use CodeMaximum Length:30The land use code of the parcel in the Detail Land Information, which is part of the Assessor Parcel Number (APN). -
LastUpdateDate(optional):
string(date-time)
Title:
Last Updated DateThe user who last updated the project parcel. -
LastUpdatedBy(optional):
string
Title:
Last Updated ByMaximum Length:64The date when the project parcel was last updated. -
LastUpdateLogin(optional):
string
Title:
Last Update LoginMaximum Length:32The login ID of the user who last updated the project parcel. -
Latitude(optional):
number
Title:
LatitudeThe geographic location of the parcel that is north or south of the equator. -
links(optional):
array Items
Title:
ItemsLink Relations -
Longitude(optional):
number
Title:
LongitudeThe 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. -
LotNum(optional):
string
Title:
Lot NumberMaximum Length:30The lot number of the parcel in the Detail Land Information, which is part of the Assessor Parcel Number (APN). -
MapBookPage(optional):
string
Title:
Map Book PageMaximum Length:50The recorded map book and page. -
MapName(optional):
string
Title:
Map NameMaximum Length:50The recorded map name. For example, Public Works. -
PageNum(optional):
string
Title:
Page NumberMaximum Length:30The page number of the parcel in the Detail Land Information, which is part of the Assessor Parcel Number (APN). -
ParcelId(optional):
integer(int64)
Title:
Parcel IDThe identifier for the project parcel. -
ParcelIdEntered(optional):
string
Title:
Parcel IDMaximum Length:30The identifier for the project parcel. -
ParcelKey(optional):
integer(int64)
The unique identifier for the project parcel.
-
ParcelType(optional):
string
Title:
Parcel TypeMaximum Length:30The type of the parcel. For example, commercial, residential, or government. -
ParentParcelId(optional):
integer(int64)
Title:
Parent Parcel IDThe unique identifier for the parent parcel. -
PrimaryFlag(optional):
string
Title:
PrimaryMaximum Length:1Indicates the primary project parcel. If the value is Y, then the parcel is the primary parcel. The default value is N. -
PrimaryZoningId(optional):
string
Title:
Primary Zoning IDMaximum Length:30The primary zoning ID of the zoning for the parcel. -
PrjParcelOwner(optional):
array Project Parcel Owners
Title:
Project Parcel OwnersThe project parcels resource is used to create, view, or update the parcels related to a project. -
ProjectAddress(optional):
array Project Addresses
Title:
Project AddressesThe project parcels resource is used to create, view, or update the parcels related to a project. -
ProjectCode(optional):
string
Title:
Project IDMaximum Length:30The unique identifier for a project. -
PropertyDescription(optional):
string
Title:
Property DescriptionMaximum Length:240The property description. -
SectionNum(optional):
string
Title:
Section NumberMaximum Length:30The section number of the parcel in the Detail Land Information, which is part of the Assessor Parcel Number (APN). -
Srid(optional):
integer(int64)
Title:
SRIDThe GIS coordinate system in use. -
Subdivision(optional):
string
Title:
SubdivisionMaximum Length:30The subdivision of the parcel in the Detail Land Information, which is part of the Assessor Parcel Number (APN). -
UnitNum(optional):
string
Title:
Unit NumberMaximum Length:30The unit number of the parcel in the Detail Land Information, which is part of the Assessor Parcel Number (APN). -
ZoningDescription(optional):
string
Title:
Zoning DescriptionMaximum Length:240The zoning description.
Nested Schema : Project Parcel Owners
Type:
arrayTitle:
Project Parcel OwnersThe project parcels resource is used to create, view, or update the parcels related to a project.
Show Source
Nested Schema : Project Addresses
Type:
arrayTitle:
Project AddressesThe project parcels resource is used to create, view, or update the parcels related to a project.
Show Source
Nested Schema : publicSectorProjects-ProjectParcel-PrjParcelOwner-item
Type:
Show Source
object-
Address1(optional):
string
Title:
AddressMaximum Length:240The first or main address of the project parcel owner. -
Address2(optional):
string
Title:
Address Line 2Maximum Length:240The second address of the project parcel owner, if present. -
Address3(optional):
string
Title:
Address Line 3Maximum Length:240The third address of the project parcel owner, if present. -
Address4(optional):
string
Title:
Address Line 4Maximum Length:240The fourth address of the project parcel owner, if present. -
AddressField1(optional):
string
Title:
Address Field 1Maximum Length:20The address field of the project parcel owner search. -
AddressField2(optional):
string
Title:
Address Field 2Maximum Length:20The address field of the project parcel owner search. -
AddressField3(optional):
string
Title:
Address Field 3Maximum Length:20The address field of the project parcel owner search. -
AgencyId(optional):
integer(int32)
The unique identifier for a public sector agency.
-
BuildingType(optional):
string
Title:
Building TypeMaximum Length:20The building type in the project parcel owner search. For example, Tower A or Block 3. -
CellPhoneCountry(optional):
string
Title:
Cell Phone Country CodeMaximum Length:10The cell phone country code of the project parcel owner. -
CellPhoneNum(optional):
string
Title:
Cell Phone NumberMaximum Length:40The cell phone number of the project parcel owner. -
City(optional):
string
Title:
CityMaximum Length:60The city of the project parcel owner address. -
Country(optional):
string
Title:
CountryMaximum Length:60The country of the project parcel owner address. -
County(optional):
string
Title:
CountyMaximum Length:60The county of the project parcel owner address. -
CreatedBy(optional):
string
Title:
Created ByMaximum Length:64The user who created the project parcel owner. -
CreationDate(optional):
string(date-time)
Title:
Creation DateThe date when the project parcel owner was created. -
DocumentNum(optional):
string
Title:
Document NumberMaximum Length:50The document number of the project parcel owner. -
EmailId(optional):
string
Title:
Email AddressMaximum Length:50The email ID of the project parcel owner. -
FaxCountry(optional):
string
Title:
Fax Country CodeMaximum Length:10The fax country code of the project parcel owner. -
FaxNum(optional):
string
Title:
Fax NumberMaximum Length:40The fax number of the project parcel owner. -
Floor(optional):
string
Title:
FloorMaximum Length:20The floor of the building. For example, mezzanine level, penthouse, or garage level C. -
HomePhoneCountry(optional):
string
Title:
Home Phone Country CodeMaximum Length:10The home phone country code of the project parcel owner. -
HomePhoneNum(optional):
string
Title:
Home Phone NumberMaximum Length:40The home phone number of the project parcel owner. -
LastTransferDate(optional):
string(date)
Title:
Last Transfer DateThe last transfer date of the project parcel owner. -
LastTransferType(optional):
string
Title:
Last Transfer TypeMaximum Length:50The last transfer type of the project parcel owner. -
LastUpdateDate(optional):
string(date-time)
Title:
Last Updated DateThe user who last updated the project parcel owner. -
LastUpdatedBy(optional):
string
Title:
Last Updated ByMaximum Length:64The date when the project parcel owner was last updated. -
LastUpdateLogin(optional):
string
Title:
Last Update LoginMaximum Length:32The login ID of the user who last updated the project parcel owner. -
links(optional):
array Items
Title:
ItemsLink Relations -
Name1(optional):
string
Title:
Name 1Maximum Length:150The first name of the parcel owner. -
Name2(optional):
string
Title:
Name 2Maximum Length:150The second name of the parcel owner. -
OwnerId(optional):
integer(int64)
Title:
Owner IDThe identifier of the parcel owner. -
OwnerKey(optional):
integer(int64)
Title:
Owner IDThe unique identifier for the project parcel owner. -
OwnerType(optional):
string
Title:
Owner TypeMaximum Length:20The type of parcel owner. -
ParcelId(optional):
integer(int64)
Title:
Parcel IDThe identifier of the parcel. -
ParcelKey(optional):
integer(int64)
Title:
Parcel IDThe unique identifier for the project parcel. -
PostalCode(optional):
string
Title:
Postal CodeMaximum Length:60The postal code of the project parcel owner address. -
PostalPlus4Code(optional):
string
Title:
Postal Plus 4 CodeMaximum Length:20The postal plus four code of the project parcel owner address. -
PrimaryFlag(optional):
string
Title:
PrimaryMaximum Length:1Indicates the primary project parcel owner. If the value is Y, then the parcel owner is the primary parcel owner. The default value is N. -
ProjectCode(optional):
string
Title:
Project IDMaximum Length:30The unique identifier for a project. -
Province(optional):
string
Title:
ProvinceMaximum Length:60The province of the project parcel owner address. -
State(optional):
string
Title:
StateMaximum Length:60The state of the project parcel owner address. -
StreetDirection(optional):
string
Title:
Street DirectionMaximum Length:10The 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. -
StreetName(optional):
string
Title:
Street NameMaximum Length:240The street name of the address in the project parcel owner search. -
StreetNumber(optional):
string
Title:
Street NameMaximum Length:20The street number of the address in the project parcel owner search. -
StreetType(optional):
string
Title:
Street TypeMaximum Length:20The street type of the address in the project parcel owner search. For example, alley, boulevard, avenue, lane, street, loop, and so on. -
UnitNumber(optional):
string
Title:
Unit NumberMaximum Length:30The exact unit in a building. For example, Apartment 208A or Suite 300. -
WorkPhoneCountry(optional):
string
Title:
Work Phone Country CodeMaximum Length:10The work phone country code of the project parcel owner. -
WorkPhoneNum(optional):
string
Title:
Work Phone NumberMaximum Length:40The work phone number of the project parcel owner.
Nested Schema : publicSectorProjects-ProjectParcel-ProjectAddress-item
Type:
Show Source
object-
Address1(optional):
string
Title:
Address Line 1Maximum Length:240The first or main address. -
Address2(optional):
string
Title:
Address Line 2Maximum Length:240The second address, if present. -
Address3(optional):
string
Title:
Address Line 3Maximum Length:240The third address, if present. -
Address4(optional):
string
Title:
Address Line 4Maximum Length:240The fourth address, if present. -
AddressField1(optional):
string
Title:
Address Field 1Maximum Length:20Additional information for the first address or main address of the parcel. -
AddressField2(optional):
string
Title:
Address Field 2Maximum Length:20Additional information for the second address of the parcel, if present. -
AddressField3(optional):
string
Title:
Address Field 3Maximum Length:20Additional information for the third address of the parcel, if present. -
AddressId(optional):
integer(int64)
Title:
Address IDThe identifier of the parcel address. -
AddressKey(optional):
integer(int64)
Title:
Address IDThe unique identifier of the project address. -
AddressType(optional):
string
Title:
Address TypeMaximum Length:20The address type used for delivery point validation (DPV). For example, main address, side address, or virtual address. -
AgencyId(optional):
integer(int32)
The unique identifier for a public sector agency.
-
BuildingType(optional):
string
Title:
Building TypeMaximum Length:20The building type used in an address search. For example, Tower A or Block 3. -
CellPhoneCountry(optional):
string
Title:
Cell Phone Country CodeMaximum Length:10The country code for the cell phone number of parcel contact. -
CellPhoneNum(optional):
string
Title:
Cell Phone NumberMaximum Length:40The cell phone number of the parcel address contact. -
City(optional):
string
Title:
CityMaximum Length:60The city in the parcel address. -
CoordinateX(optional):
number
Title:
X CoordinateThe x-axis coordinate of the project parcel address. -
CoordinateY(optional):
number
Title:
Y CoordinateThe y-axis coordinate of the project parcel address. -
Country(optional):
string
Title:
CountryMaximum Length:60The country in the parcel address. -
County(optional):
string
Title:
CountyMaximum Length:60The county in the parcel address. -
CreatedBy(optional):
string
Title:
Created ByMaximum Length:64The user who created the project parcel address. -
CreationDate(optional):
string(date-time)
Title:
Creation DateThe date when the project parcel address was created. -
EmailId(optional):
string
Title:
Email AddressMaximum Length:50The email address of the parcel address contact. -
FaxCountry(optional):
string
Title:
Fax Country CodeMaximum Length:10The country code for the fax number of the parcel contact. -
FaxNum(optional):
string
Title:
Fax NumberMaximum Length:40The fax number of the parcel address contact. -
Floor(optional):
string
Title:
FloorMaximum Length:20The floor or level in an address search. For example, mezzanine level, penthouse, or garage level C. -
HomePhoneCountry(optional):
string
Title:
Home Phone Country CodeMaximum Length:10The country code for the home telephone number of the parcel address contact. -
HomePhoneNum(optional):
string
Title:
Home Phone NumberMaximum Length:40The home telephone number of the parcel address contact. -
InputSource(optional):
string
Title:
Input SourceMaximum Length:1Indicates how the data were entered or loaded into the application. The values are S for system data and U for user-entered data. -
LastUpdateDate(optional):
string(date-time)
Title:
Last Updated DateThe user who last updated the project parcel address. -
LastUpdatedBy(optional):
string
Title:
Last Updated ByMaximum Length:64The date when the project parcel address was last updated. -
LastUpdateLogin(optional):
string
Title:
Last Update LoginMaximum Length:32The login ID of the user who last updated the project parcel address. -
Latitude(optional):
number
Title:
LatitudeThe 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(optional):
array Items
Title:
ItemsLink Relations -
Longitude(optional):
number
Title:
LongitudeThe 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(optional):
string
Title:
Municipality IDMaximum Length:20The municipality identifier if the parcel is not managed at the county level. -
ParcelId(optional):
integer(int64)
Title:
Parcel IDThe identifier of the parcel. -
ParcelKey(optional):
integer(int64)
Title:
Parcel IDThe unique identifier of the project parcel. -
PostalCode(optional):
string
Title:
Postal CodeMaximum Length:60The postal code in the parcel address. -
PostalPlus4Code(optional):
string
Title:
Postal Plus 4 CodeMaximum Length:20The postal plus four code of the parcel address. -
PrimaryFlag(optional):
string
Title:
PrimaryMaximum Length:1Indicates 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(optional):
string
Title:
Project IDMaximum Length:30The unique identifier for a project. -
Province(optional):
string
Title:
ProvinceMaximum Length:60The province in the parcel address. -
Srid(optional):
integer(int64)
Title:
SRIDThe 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(optional):
string
Title:
StateMaximum Length:60The state in the parcel address. -
StreetDirection(optional):
string
Title:
Street DirectionMaximum Length:10The 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(optional):
string
Title:
Street NameMaximum Length:240The street name in the parcel address used during a search. -
StreetNumber(optional):
string
Title:
Street NumberMaximum Length:20The street number in the parcel address. -
StreetType(optional):
string
Title:
Street TypeMaximum Length:20The street type designation used during a search. For example, alley, boulevard, avenue, lane, street, loop, and so on. -
UnitNumber(optional):
string
Title:
Unit NumberMaximum Length:30The exact unit in a building used in an address search. For example, Apartment 208A or Suite 300. -
WorkPhoneCountry(optional):
string
Title:
Work Phone Country CodeMaximum Length:10The country code for the work telephone number of the parcel contact. -
WorkPhoneNum(optional):
string
Title:
Work Phone NumberMaximum Length:40The work telephone number of the parcel address contact.