Create a project
post
/fscmRestApi/resources/11.13.18.05/publicSectorProjects
Request
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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
AgencyId: integer
(int32)
Default Value:
1
The unique identifier for a public sector agency. -
CurrencyCode: string
Title:
Currency Code
Maximum Length:3
The currency code used for creating the project. The default is the public sector agency currency code. -
EndDate: string
(date-time)
Title:
End Date
The end date of the project. -
EstimatedValuation: number
Title:
Estimated Valuation
The estimated valuation of the project. -
ProjectAdmin: integer
(int64)
Title:
Primary Contact
The project manager for the project. -
ProjectAdminBizProfileId: integer
(int64)
The unique identifier for the business profile of the project manager.
-
ProjectAdminProfileId: integer
(int64)
The unique identifier for the project manager's personal profile.
-
ProjectCode(required): string
Title:
Project ID
Maximum Length:30
The unique identifier for a project. -
ProjectContact: array
Project Contacts
Title:
Project Contacts
The project contacts resource is used to create, view, or update the contacts related to a project. -
ProjectName(required): string
Title:
Name
Maximum Length:50
A user-friendly name for the project. -
ProjectParcel: array
Project Parcels
Title:
Project Parcels
The project parcels resource is used to create, view, or update the parcels related to a project. -
ProjectSummary(required): string
Title:
Project Summary
Maximum Length:500
A brief desription of the project. -
ProjectType(required): string
Title:
Project Type
Maximum Length:50
The project type. This can be anything that is configured in the project type setup. -
StartDate(required): string
(date-time)
Title:
Start Date
The start date of the project. -
Status(required): string
Title:
Status
Maximum Length:7
The 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:
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-post-request
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. -
AgencyId: integer
(int32)
Default Value:
1
The unique identifier for a public sector agency. -
City: string
Title:
City
Maximum Length:60
The city of the project contact address. -
ContactBizPartyId: integer
(int64)
The party ID of the business associated with the project contact.
-
ContactBizProfileId: integer
(int64)
The unique identifier for the business profile of the project contact.
-
ContactId: integer
(int64)
The unique identifier for the project contact.
-
ContactKey: integer
(int64)
The unique identifier for a project contact.
-
ContactPartyId: integer
(int64)
The party ID of the project contact.
-
ContactProfileId: integer
(int64)
The unique identifier for the personal profile of the project contact.
-
ContactType: string
Title:
Contact Type
Maximum Length:30
The type of contact. -
Country: string
Title:
Country
Maximum Length:3
The country of the project contact address. -
County: string
Title:
County
Maximum Length:60
The county of the project contact address. -
EmailAddress: string
Title:
Email
Maximum Length:320
The email address of the contact. -
OrganizationName: string
Title:
Organization Name
Maximum Length:360
The name of the organization of the project contact. -
PersonFirstName: string
Title:
First Name
Maximum Length:150
The first name of the project contact. -
PersonLastName: string
Title:
Last Name
Maximum Length:150
The last name of the project contact. -
PersonMiddleName: string
Title:
Middle Name
Maximum Length:60
The middle name of the project contact. -
PersonName: string
Title:
Name
Maximum Length:450
The full name of the project contact. -
PersonNameSuffix: string
Maximum Length:
30
The name suffix of the project contact. -
PersonPreNameAdjunct: string
Maximum Length:
30
The prefix for the project contact name. For example, Dr., Professor, etc. -
PersonTitle: string
Title:
Title
Maximum Length:60
The title of the project contact. -
PhoneAreaCode: string
Maximum Length:
10
The area code of the contact phone number. -
PhoneCountryCode: string
Maximum Length:
10
The country code of the contact phone number. -
PhoneExtension: string
Maximum Length:
20
The extension of the contact phone number. -
PhoneNumber: string
Maximum Length:
40
The phone number of the contact. -
PostalCode: string
Title:
Postal Code
Maximum Length:60
The postal code of the project contact address. -
PostalPlus4Code: string
Title:
Postal Plus 4 Code
Maximum Length:10
The postal plus four code of the project contact address. -
PrimaryFlag: boolean
Title:
Primary
Maximum Length:1
Indicates the primary project contact. If the value is Y, then the project contact is the primary project contact. 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 of the project contact address. -
State: string
Title:
State
Maximum Length:60
The state of the project contact address.
Nested Schema : publicSectorProjects-ProjectParcel-item-post-request
Type:
Show Source
object
-
AgencyId: integer
(int32)
Default Value:
1
The unique identifier for a public sector agency. -
BlockNum: string
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). -
BookNum: string
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). -
BoundaryDescription: string
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. -
CoordinateX: number
Title:
X Coordinate
The x-axis coordinate for the project parcel. -
CoordinateY: number
Title:
Y Coordinate
The y-axis coordinate for the project parcel. -
DistrictName: string
Maximum Length:
50
The district name of the parcel. -
Jurisdiction: string
Title:
Jurisdiction
Maximum Length:50
The name of the city, if incorporated, or the name of the county, if unincorporated. -
LandUseCode: string
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). -
Latitude: number
Title:
Latitude
The geographic location of the parcel that is north or south of the equator. -
Longitude: number
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. -
LotNum: string
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). -
MapBookPage: string
Title:
Map Book Page
Maximum Length:50
The recorded map book and page. -
MapName: string
Title:
Map Name
Maximum Length:50
The recorded map name. For example, Public Works. -
PageNum: string
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). -
ParcelId(required): integer
(int64)
Title:
Parcel ID
The identifier for the project parcel. -
ParcelIdEntered(required): string
Title:
Parcel ID
Maximum Length:30
The identifier for the project parcel. -
ParcelKey: integer
(int64)
The unique identifier for the project parcel.
-
ParcelType: string
Title:
Parcel Type
Maximum Length:30
The type of the parcel. For example, commercial, residential, or government. -
ParentParcelId: integer
(int64)
Title:
Parent Parcel ID
The unique identifier for the parent parcel. -
PrimaryFlag: boolean
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. -
PrimaryZoningId: string
Title:
Primary Zoning ID
Maximum Length:30
The primary zoning ID of the zoning for the parcel. -
PrjParcelOwner: array
Project Parcel Owners
Title:
Project Parcel Owners
The resource is used to create, view, or update the project parcel owners related to a project. -
ProjectAddress: array
Project Addresses
Title:
Project Addresses
The resource is used to create, view, or update the project parcel addresses related to a project. -
ProjectCode(required): string
Title:
Project ID
Maximum Length:30
The unique identifier for a project. -
PropertyDescription: string
Title:
Property Description
Maximum Length:240
The property description. -
SectionNum: string
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). -
Srid: integer
(int64)
Title:
SRID
The GIS coordinate system in use. -
Subdivision: string
Title:
Subdivision
Maximum Length:30
The subdivision of the parcel in the Detail Land Information, which is part of the Assessor Parcel Number (APN). -
UnitNum: string
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). -
ZoningDescription: string
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 : schema
Type:
Show Source
object
-
Address1: string
Title:
Address
Maximum Length:240
The first or main address of the project parcel owner. -
Address2: string
Title:
Address Line 2
Maximum Length:240
The second address of the project parcel owner, if present. -
Address3: string
Title:
Address Line 3
Maximum Length:240
The third address of the project parcel owner, if present. -
Address4: string
Title:
Address Line 4
Maximum Length:240
The fourth address of the project parcel owner, if present. -
AddressField1: string
Title:
Address Field 1
Maximum Length:20
The address field of the project parcel owner search. -
AddressField2: string
Title:
Address Field 2
Maximum Length:20
The address field of the project parcel owner search. -
AddressField3: string
Title:
Address Field 3
Maximum Length:20
The address field of the project parcel owner search. -
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 in the project parcel owner search. For example, Tower A or Block 3. -
CellPhoneCountry: string
Title:
Cell Phone Country Code
Maximum Length:10
The cell phone country code of the project parcel owner. -
CellPhoneNum: string
Title:
Cell Phone Number
Maximum Length:40
The cell phone number of the project parcel owner. -
City: string
Title:
City
Maximum Length:60
The city of the project parcel owner address. -
Country: string
Title:
Country
Maximum Length:60
The country of the project parcel owner address. -
County: string
Title:
County
Maximum Length:60
The county of the project parcel owner address. -
DocumentNum: string
Title:
Document Number
Maximum Length:50
The document number of the project parcel owner. -
EmailId: string
Title:
Email Address
Maximum Length:50
The email ID of the project parcel owner. -
FaxCountry: string
Title:
Fax Country Code
Maximum Length:10
The fax country code of the project parcel owner. -
FaxNum: string
Title:
Fax Number
Maximum Length:40
The fax number of the project parcel owner. -
Floor: string
Title:
Floor
Maximum Length:20
The floor of the building. For example, mezzanine level, penthouse, or garage level C. -
HomePhoneCountry: string
Title:
Home Phone Country Code
Maximum Length:10
The home phone country code of the project parcel owner. -
HomePhoneNum: string
Title:
Home Phone Number
Maximum Length:40
The home phone number of the project parcel owner. -
LastTransferDate: string
(date)
Title:
Last Transfer Date
The last transfer date of the project parcel owner. -
LastTransferType: string
Title:
Last Transfer Type
Maximum Length:50
The last transfer type of the project parcel owner. -
Name1: string
Title:
Name 1
Maximum Length:150
The first name of the parcel owner. -
Name2: string
Title:
Name 2
Maximum Length:150
The second name of the parcel owner. -
OwnerId: integer
(int64)
Title:
Owner ID
The identifier of the parcel owner. -
OwnerKey: integer
(int64)
Title:
Owner ID
The unique identifier for the project parcel owner. -
OwnerType: string
Title:
Owner Type
Maximum Length:20
The type of parcel owner. -
ParcelId: integer
(int64)
Title:
Parcel ID
The identifier of the parcel. -
ParcelKey: integer
(int64)
Title:
Parcel ID
The unique identifier for the project parcel. -
PostalCode: string
Title:
Postal Code
Maximum Length:60
The postal code of the project parcel owner address. -
PostalPlus4Code: string
Title:
Postal Plus 4 Code
Maximum Length:20
The postal plus four code of the project parcel owner address. -
PrimaryFlag: boolean
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. -
ProjectCode: string
Title:
Project ID
Maximum Length:30
The unique identifier for a project. -
Province: string
Title:
Province
Maximum Length:60
The province of the project parcel owner address. -
State: string
Title:
State
Maximum Length:60
The state of the project parcel owner address. -
StreetDirection: string
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. -
StreetName: string
Title:
Street Name
Maximum Length:240
The street name of the address in the project parcel owner search. -
StreetNumber: string
Title:
Street Name
Maximum Length:20
The street number of the address in the project parcel owner search. -
StreetType: string
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. -
UnitNumber: string
Title:
Unit Number
Maximum Length:30
The exact unit in a building. For example, Apartment 208A or Suite 300. -
WorkPhoneCountry: string
Title:
Work Phone Country Code
Maximum Length:10
The work phone country code of the project parcel owner. -
WorkPhoneNum: string
Title:
Work Phone Number
Maximum Length:40
The work phone number of the project parcel owner.
Nested Schema : schema
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. -
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. -
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. -
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.
Response
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-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
Default Value:
1
The unique identifier for a public sector agency. -
CreatedByName: string
Title:
Created By
Read Only:true
The name of the user who created the project. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the project was created. -
CurrencyCode: string
Title:
Currency Code
Maximum Length:3
The currency code used for creating the project. The default is the public sector agency currency code. -
EndDate: string
(date-time)
Title:
End Date
The end date of the project. -
EstimatedValuation: number
Title:
Estimated Valuation
The estimated valuation of the project. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date when the project was last updated. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Meaning: string
Read Only:
true
Maximum Length:80
The actual meaning of the project status. For example, active, canceled, completed, and so on. -
ProjectAdmin: integer
(int64)
Title:
Primary Contact
The project manager for the project. -
ProjectAdminBizProfileId: integer
(int64)
The unique identifier for the business profile of the project manager.
-
ProjectAdminProfileId: integer
(int64)
The unique identifier for the project manager's personal profile.
-
ProjectCode: string
Title:
Project ID
Maximum Length:30
The unique identifier for a project. -
ProjectContact: array
Project Contacts
Title:
Project Contacts
The project contacts resource is used to create, view, or update the contacts related to a project. -
ProjectName: string
Title:
Name
Maximum Length:50
A user-friendly name for the project. -
ProjectParcel: array
Project Parcels
Title:
Project Parcels
The project parcels resource is used to create, view, or update the parcels related to a project. -
ProjectSummary: string
Title:
Project Summary
Maximum Length:500
A brief desription of the project. -
ProjectType: string
Title:
Project Type
Maximum Length:50
The project type. This can be anything that is configured in the project type setup. -
StartDate: string
(date-time)
Title:
Start Date
The start date of the project. -
Status: string
Title:
Status
Maximum Length:7
The status of the project. The status can be active, inactive, on hold, completed, or canceled. The default value is active.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
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 : 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.
Nested Schema : publicSectorProjects-ProjectContact-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. -
AgencyId: integer
(int32)
Default Value:
1
The unique identifier for a public sector agency. -
City: string
Title:
City
Maximum Length:60
The city of the project contact address. -
ContactBizPartyId: integer
(int64)
The party ID of the business associated with the project contact.
-
ContactBizProfileId: integer
(int64)
The unique identifier for the business profile of the project contact.
-
ContactId: integer
(int64)
The unique identifier for the project contact.
-
ContactKey: integer
(int64)
The unique identifier for a project contact.
-
ContactPartyId: integer
(int64)
The party ID of the project contact.
-
ContactProfileId: integer
(int64)
The unique identifier for the personal profile of the project contact.
-
ContactType: string
Title:
Contact Type
Maximum Length:30
The type of contact. -
ContactTypeName: string
Title:
Contact Type
Read Only:true
Maximum Length:255
The name of the project contact type. -
Country: string
Title:
Country
Maximum Length:3
The country of the project contact address. -
County: string
Title:
County
Maximum Length:60
The county of the project contact address. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the project contact. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the project contact was created. -
EmailAddress: string
Title:
Email
Maximum Length:320
The email address of the contact. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date when the project contact was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the project contact. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OrganizationName: string
Title:
Organization Name
Maximum Length:360
The name of the organization of the project contact. -
PersonFirstName: string
Title:
First Name
Maximum Length:150
The first name of the project contact. -
PersonLastName: string
Title:
Last Name
Maximum Length:150
The last name of the project contact. -
PersonMiddleName: string
Title:
Middle Name
Maximum Length:60
The middle name of the project contact. -
PersonName: string
Title:
Name
Maximum Length:450
The full name of the project contact. -
PersonNameSuffix: string
Maximum Length:
30
The name suffix of the project contact. -
PersonPreNameAdjunct: string
Maximum Length:
30
The prefix for the project contact name. For example, Dr., Professor, etc. -
PersonTitle: string
Title:
Title
Maximum Length:60
The title of the project contact. -
PhoneAreaCode: string
Maximum Length:
10
The area code of the contact phone number. -
PhoneCountryCode: string
Maximum Length:
10
The country code of the contact phone number. -
PhoneExtension: string
Maximum Length:
20
The extension of the contact phone number. -
PhoneNumber: string
Maximum Length:
40
The phone number of the contact. -
PostalCode: string
Title:
Postal Code
Maximum Length:60
The postal code of the project contact address. -
PostalPlus4Code: string
Title:
Postal Plus 4 Code
Maximum Length:10
The postal plus four code of the project contact address. -
PrimaryFlag: boolean
Title:
Primary
Maximum Length:1
Indicates the primary project contact. If the value is Y, then the project contact is the primary project contact. 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 of the project contact address. -
State: string
Title:
State
Maximum Length:60
The state of the project contact address.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorProjects-ProjectParcel-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
Default Value:
1
The unique identifier for a public sector agency. -
BlockNum: string
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). -
BookNum: string
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). -
BoundaryDescription: string
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. -
CoordinateX: number
Title:
X Coordinate
The x-axis coordinate for the project parcel. -
CoordinateY: number
Title:
Y Coordinate
The y-axis coordinate for the project parcel. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the project parcel. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the project parcel was created. -
DistrictName: string
Maximum Length:
50
The district name of the parcel. -
Jurisdiction: string
Title:
Jurisdiction
Maximum Length:50
The name of the city, if incorporated, or the name of the county, if unincorporated. -
LandUseCode: string
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). -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The user who last updated the project parcel. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The date when the project parcel 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. -
Latitude: number
Title:
Latitude
The geographic location of the parcel that is north or south of the equator. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Longitude: number
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. -
LotNum: string
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). -
MapBookPage: string
Title:
Map Book Page
Maximum Length:50
The recorded map book and page. -
MapName: string
Title:
Map Name
Maximum Length:50
The recorded map name. For example, Public Works. -
PageNum: string
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). -
ParcelId: integer
(int64)
Title:
Parcel ID
The identifier for the project parcel. -
ParcelIdEntered: string
Title:
Parcel ID
Maximum Length:30
The identifier for the project parcel. -
ParcelKey: integer
(int64)
The unique identifier for the project parcel.
-
ParcelType: string
Title:
Parcel Type
Maximum Length:30
The type of the parcel. For example, commercial, residential, or government. -
ParentParcelId: integer
(int64)
Title:
Parent Parcel ID
The unique identifier for the parent parcel. -
PrimaryFlag: boolean
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. -
PrimaryZoningId: string
Title:
Primary Zoning ID
Maximum Length:30
The primary zoning ID of the zoning for the parcel. -
PrjParcelOwner: array
Project Parcel Owners
Title:
Project Parcel Owners
The resource is used to create, view, or update the project parcel owners related to a project. -
ProjectAddress: array
Project Addresses
Title:
Project Addresses
The resource is used to create, view, or update the project parcel addresses related to a project. -
ProjectCode: string
Title:
Project ID
Maximum Length:30
The unique identifier for a project. -
PropertyDescription: string
Title:
Property Description
Maximum Length:240
The property description. -
SectionNum: string
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). -
Srid: integer
(int64)
Title:
SRID
The GIS coordinate system in use. -
Subdivision: string
Title:
Subdivision
Maximum Length:30
The subdivision of the parcel in the Detail Land Information, which is part of the Assessor Parcel Number (APN). -
UnitNum: string
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). -
ZoningDescription: string
Title:
Zoning Description
Maximum Length:240
The zoning description.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
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:
Show Source
object
-
Address1: string
Title:
Address
Maximum Length:240
The first or main address of the project parcel owner. -
Address2: string
Title:
Address Line 2
Maximum Length:240
The second address of the project parcel owner, if present. -
Address3: string
Title:
Address Line 3
Maximum Length:240
The third address of the project parcel owner, if present. -
Address4: string
Title:
Address Line 4
Maximum Length:240
The fourth address of the project parcel owner, if present. -
AddressField1: string
Title:
Address Field 1
Maximum Length:20
The address field of the project parcel owner search. -
AddressField2: string
Title:
Address Field 2
Maximum Length:20
The address field of the project parcel owner search. -
AddressField3: string
Title:
Address Field 3
Maximum Length:20
The address field of the project parcel owner search. -
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 in the project parcel owner search. For example, Tower A or Block 3. -
CellPhoneCountry: string
Title:
Cell Phone Country Code
Maximum Length:10
The cell phone country code of the project parcel owner. -
CellPhoneNum: string
Title:
Cell Phone Number
Maximum Length:40
The cell phone number of the project parcel owner. -
City: string
Title:
City
Maximum Length:60
The city of the project parcel owner address. -
Country: string
Title:
Country
Maximum Length:60
The country of the project parcel owner address. -
County: string
Title:
County
Maximum Length:60
The county of the project parcel owner address. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the project parcel owner. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the project parcel owner was created. -
DocumentNum: string
Title:
Document Number
Maximum Length:50
The document number of the project parcel owner. -
EmailId: string
Title:
Email Address
Maximum Length:50
The email ID of the project parcel owner. -
FaxCountry: string
Title:
Fax Country Code
Maximum Length:10
The fax country code of the project parcel owner. -
FaxNum: string
Title:
Fax Number
Maximum Length:40
The fax number of the project parcel owner. -
Floor: string
Title:
Floor
Maximum Length:20
The floor of the building. For example, mezzanine level, penthouse, or garage level C. -
HomePhoneCountry: string
Title:
Home Phone Country Code
Maximum Length:10
The home phone country code of the project parcel owner. -
HomePhoneNum: string
Title:
Home Phone Number
Maximum Length:40
The home phone number of the project parcel owner. -
LastTransferDate: string
(date)
Title:
Last Transfer Date
The last transfer date of the project parcel owner. -
LastTransferType: string
Title:
Last Transfer Type
Maximum Length:50
The last transfer type of the project parcel owner. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The user who last updated the project parcel owner. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The date when the project parcel owner 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 owner. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Name1: string
Title:
Name 1
Maximum Length:150
The first name of the parcel owner. -
Name2: string
Title:
Name 2
Maximum Length:150
The second name of the parcel owner. -
OwnerId: integer
(int64)
Title:
Owner ID
The identifier of the parcel owner. -
OwnerKey: integer
(int64)
Title:
Owner ID
The unique identifier for the project parcel owner. -
OwnerType: string
Title:
Owner Type
Maximum Length:20
The type of parcel owner. -
ParcelId: integer
(int64)
Title:
Parcel ID
The identifier of the parcel. -
ParcelKey: integer
(int64)
Title:
Parcel ID
The unique identifier for the project parcel. -
PostalCode: string
Title:
Postal Code
Maximum Length:60
The postal code of the project parcel owner address. -
PostalPlus4Code: string
Title:
Postal Plus 4 Code
Maximum Length:20
The postal plus four code of the project parcel owner address. -
PrimaryFlag: boolean
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. -
ProjectCode: string
Title:
Project ID
Maximum Length:30
The unique identifier for a project. -
Province: string
Title:
Province
Maximum Length:60
The province of the project parcel owner address. -
State: string
Title:
State
Maximum Length:60
The state of the project parcel owner address. -
StreetDirection: string
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. -
StreetName: string
Title:
Street Name
Maximum Length:240
The street name of the address in the project parcel owner search. -
StreetNumber: string
Title:
Street Name
Maximum Length:20
The street number of the address in the project parcel owner search. -
StreetType: string
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. -
UnitNumber: string
Title:
Unit Number
Maximum Length:30
The exact unit in a building. For example, Apartment 208A or Suite 300. -
WorkPhoneCountry: string
Title:
Work Phone Country Code
Maximum Length:10
The work phone country code of the project parcel owner. -
WorkPhoneNum: string
Title:
Work Phone Number
Maximum Length:40
The work phone number of the project parcel owner.
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
Links
- ProjectContact
-
Parameters:
- publicSectorProjectsUniqID:
$request.path.publicSectorProjectsUniqID
The project contacts resource is used to create, view, or update the contacts related to a project. - publicSectorProjectsUniqID:
- ProjectParcel
-
Parameters:
- publicSectorProjectsUniqID:
$request.path.publicSectorProjectsUniqID
The project parcels resource is used to create, view, or update the parcels related to a project. - publicSectorProjectsUniqID: