Jump to

• Request
• Response

Get all planning and zoning application contacts details

get

/fscmRestApi/resources/11.13.18.05/publicSectorPZApplicationContacts

Request

Query Parameters

• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• finder: string
  Used as a predefined finder to search the collection.
  
  Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables:
  
  

  • PrimaryKey: Finds the application contact details that matches the specified record key.
    Finder Variables:
    • ContactKey; integer; The unique identifier for the contact key.
    • LnpRecordKey; integer; The unique identifier for the record key.
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • AcceptanceDate; string; Identifies the accepted date for the planning application.
  • AddressKey; integer; The parcel address key.
  • AgencyId; integer; The identifier for a public sector agency. This is usually an alphanumeric identifier for a city, county, or state, but it can also be the name of a city, county, or state.
  • Applicant; integer; The party ID of the planning applicant.
  • ApplicantProfileId; integer; The user profile of the applicant.
  • ApplicantUserId; string; The user ID of the applicant.
  • Applicantaddressone; string; The first line of the applicant address.
  • Applicantaddresstwo; string; The second line of the applicant address.
  • Applicantcity; string; The city in the applicant address.
  • Applicantcountry; string; The country in the applicant address.
  • Applicantcounty; string; The county in the applicant address.
  • Applicantemailaddressone; string; The first email address of the applicant.
  • Applicantemailaddresstwo; string; The second email address of the applicant.
  • Applicantpersonname; string; The planning applicant name.
  • Applicantphone; string; The full phone number including the phone country code, area code, and phone number for the applicant..
  • Applicantphoneareacode; string; The area code in the phone number of the applicant.
  • Applicantphonecountrycode; string; The country code in the phone number of the applicant.
  • Applicantphoneextension; string; The phone number extension for the applicant.
  • Applicantphonenumber; string; The applicant phone number.
  • Applicantpostalcode; string; The postal code in the applicant address.
  • Applicantprovince; string; The province in the applicant address.
  • Applicantstate; string; The state in the applicant address.
  • ApplicationAccess; string; Indicates whether the contact person has full access to the application similar to the applicant.
  • Applicationdescription; string; The description of the planning application type.
  • Applicationstatus; string; The status of the planning application.
  • Applicationtype; string; The planning application type. Agencies define the types of planning application that they administer, for example, Residential Addition.
  • Classification; string; The planning application classification.
  • ContactBizPartyId; integer; The contact list business party ID.
  • ContactId; integer; The unique identifier of the contact.
  • ContactKey; integer; The unique identifier for the contact.
  • ContactPartyId; integer; The contact list party ID.
  • ContactProfileId; integer; The profile ID of the contact.
  • Contactactive; string; Indicates whether the contact is active or inactive related to the planning application.
  • Contactaddressone; string; The first address line for the contact person.
  • Contactaddresstwo; string; The second address line for the contact person.
  • Contactaltphone; string; The alternate phone number with country code for the contact person.
  • Contactaltphoneareacode; string; The alternate phone area code for the contact person.
  • Contactaltphonecountrycode; string; The alternate phone country code for the contact person.
  • Contactaltphonenumber; string; The alternate phone number for the contact person.
  • Contactbusinessname; string; The contact's business name.
  • Contactcity; string; The city for the contact person's address.
  • Contactcountry; string; The country for the contact person's address.
  • Contactcounty; string; The county for the contact person's address.
  • Contactcreationdate; string; The date when the contact person is added to the planning application.
  • Contactemailaddressone; string; The email address information for the contact person.
  • Contactfirstname; string; The contact's first name.
  • Contactfullname; string; The contact's full name.
  • Contactlastname; string; The contact's last name.
  • Contactmiddlename; string; The contact's middle name.
  • Contactphone; string; The full phone number including the phone country code, area code, and phone number for the contact person.
  • Contactphoneareacode; string; The phone area code for the contact person.
  • Contactphonecountrycode; string; The phone country code for the contact person.
  • Contactphoneextension; string; The phone extension for the contact person.
  • Contactphonenumber; string; The phone number for the contact person.
  • Contactpostalcode; string; The postal code for the contact person's address.
  • Contactstate; string; The state for the contact person's address.
  • Contacttype; string; Identifies the contact type of the primary contact of the planning application.
  • Contactuserid; string; The user ID of the contact.
  • CreationDate; string; Identifies the date on which the planning application was created.
  • IssueDate; string; The date the planning certificate was issued.
  • LnpRecordId; string; The identifier for the building planning application. For example, a planning application number with a value such as Building planning application ID RA-2017-00029.
  • LnpRecordKey; integer; The unique identifier for the record.
  • OrganizationName; string; The business name of the applicant. For example, a contractor enters his or her contracting business name.
  • Owner; string; The primary or only owner of the parcel or property.
  • OwnerId; integer; The owner ID of the record parcel owner.
  • OwnerKey; integer; The owner key of the record parcel owner.
  • Owneremailid; string; The parcel owner email address.
  • ParcelId; integer; The identifier of the record parcel.
  • ParcelKey; integer; The key of the record parcel.
  • Parceladdressone; string; The first line of the parcel or property address.
  • Parceladdresstwo; string; The second line of the parcel or property address.
  • Parcelcity; string; The city in the parcel or property address.
  • Parcelcountry; string; The country in the parcel or property address.
  • Parcelcounty; string; The county in the parcel or property address.
  • Parcelpostalcode; string; The postal code in the parcel or property address.
  • Parcelprovince; string; The province in the parcel or property address.
  • Parcelstate; string; The state in the parcel or property address.
  • Parceltype; string; The type of the current parcel.
  • Personfirstname; string; The applicant's first name.
  • Personlastname; string; The applicant's last name.
  • Personmiddlename; string; The applicant's middle name.
  • Persontitle; string; The title of the contact.
  • Primaryflag; string; Indicates the primary contact in the contact details.
  • Propertydescription; string; The property description.
  • ReceivedDate; string; Identifies the received date for the planning application.
  • RecordStatus; string; The status of the record which is corresponding to the planning application status.
  • RecordTypeId; string; The identifier for a record type.
  • Secondaryowner; string; The secondary owner of the parcel or property.
  • Subclassification; string; The subclassification of the planning application type.
  • SubmitDate; string; The date the planning application was submitted.
  • SystemStatus; string; Identifies the system status of the planning application.
  • URL; string; The URL to access the overview page of the planning application.
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

Header Parameters

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• 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.

Body ()

Root Schema : publicSectorPZApplicationContacts

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/publicSectorPZApplicationContacts-item-response"
            }
        }
    },
    "x-hints":{
        "subgroup":"PlanningandZoning",
        "usage":"BusinessObject",
        "group":"psc"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object publicSectorPZApplicationContacts-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/publicSectorPZApplicationContacts-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : publicSectorPZApplicationContacts-item-response

Type: object

Show Source

• AcceptanceDate: string (date-time)
  Title: Acceptance Date

  Read Only: true

  Identifies the accepted date for the planning application.
• AddressKey: integer (int64)
  Read Only: true

  The parcel address key.
• AgencyId: integer (int32)
  Read Only: true

  The identifier for a public sector agency. This is usually an alphanumeric identifier for a city, county, or state, but it can also be the name of a city, county, or state.
• Applicant: integer (int64)
  Read Only: true

  The party ID of the planning applicant.
• Applicantaddressone: string
  Title: Applicant Address Line 1

  Read Only: true

  Maximum Length: 240

  The first line of the applicant address.
• Applicantaddresstwo: string
  Title: Applicant Address Line 2

  Read Only: true

  Maximum Length: 240

  The second line of the applicant address.
• Applicantcity: string
  Title: Applicant City

  Read Only: true

  Maximum Length: 60

  The city in the applicant address.
• Applicantcountry: string
  Title: Applicant Country

  Read Only: true

  Maximum Length: 3

  The country in the applicant address.
• Applicantcounty: string
  Title: Applicant County

  Read Only: true

  Maximum Length: 60

  The county in the applicant address.
• Applicantemailaddressone: string
  Title: Applicant Email 1

  Read Only: true

  Maximum Length: 320

  The first email address of the applicant.
• Applicantemailaddresstwo: string
  Title: Applicant Email 2

  Read Only: true

  Maximum Length: 320

  The second email address of the applicant.
• Applicantpersonname: string
  Title: Applicant Full Name

  Read Only: true

  Maximum Length: 450

  The planning applicant name.
• Applicantphone: string
  Title: Applicant Phone

  Read Only: true

  Maximum Length: 60

  The full phone number including the phone country code, area code, and phone number for the applicant..
• Applicantphoneareacode: string
  Read Only: true

  Maximum Length: 10

  The area code in the phone number of the applicant.
• Applicantphonecountrycode: string
  Read Only: true

  Maximum Length: 10

  The country code in the phone number of the applicant.
• Applicantphoneextension: string
  Title: Applicant Phone Extension

  Read Only: true

  Maximum Length: 20

  The phone number extension for the applicant.
• Applicantphonenumber: string
  Read Only: true

  Maximum Length: 40

  The applicant phone number.
• Applicantpostalcode: string
  Title: Applicant Postal Code

  Read Only: true

  Maximum Length: 60

  The postal code in the applicant address.
• ApplicantProfileId: integer (int64)
  Read Only: true

  The user profile of the applicant.
• Applicantprovince: string
  Title: Applicant Province

  Read Only: true

  Maximum Length: 60

  The province in the applicant address.
• Applicantstate: string
  Title: Applicant State

  Read Only: true

  Maximum Length: 60

  The state in the applicant address.
• ApplicantUserId: string
  Title: Applicant User ID

  Read Only: true

  The user ID of the applicant.
• ApplicationAccess: string
  Title: Planning Application Access

  Read Only: true

  Indicates whether the contact person has full access to the application similar to the applicant.
• Applicationdescription: string
  Title: Application Description

  Read Only: true

  Maximum Length: 1000

  The description of the planning application type.
• Applicationstatus: string
  Title: Application Status

  Read Only: true

  Maximum Length: 100

  The status of the planning application.
• Applicationtype: string
  Title: Application Type

  Read Only: true

  Maximum Length: 100

  The planning application type. Agencies define the types of planning application that they administer, for example, Residential Addition.
• Classification: string
  Title: Classification

  Read Only: true

  Maximum Length: 80

  The planning application classification.
• Contactactive: string
  Title: Contact Active Status

  Read Only: true

  Maximum Length: 1

  Indicates whether the contact is active or inactive related to the planning application.
• Contactaddressone: string
  Title: Contact Address Line 1

  Read Only: true

  Maximum Length: 240

  The first address line for the contact person.
• Contactaddresstwo: string
  Title: Contact Address Line 2

  Read Only: true

  Maximum Length: 240

  The second address line for the contact person.
• Contactaltphone: string
  Title: Contact Alternate Phone

  Read Only: true

  Maximum Length: 60

  The alternate phone number with country code for the contact person.
• Contactaltphoneareacode: string
  Read Only: true

  Maximum Length: 10

  The alternate phone area code for the contact person.
• Contactaltphonecountrycode: string
  Read Only: true

  Maximum Length: 10

  The alternate phone country code for the contact person.
• Contactaltphonenumber: string
  Read Only: true

  Maximum Length: 40

  The alternate phone number for the contact person.
• ContactBizPartyId: integer (int64)
  Read Only: true

  The contact list business party ID.
• Contactbusinessname: string
  Title: Contact Business Name

  Read Only: true

  Maximum Length: 360

  The contact's business name.
• Contactcity: string
  Title: Contact City

  Read Only: true

  Maximum Length: 60

  The city for the contact person's address.
• Contactcountry: string
  Title: Contact Country

  Read Only: true

  Maximum Length: 3

  The country for the contact person's address.
• Contactcounty: string
  Title: Contact County

  Read Only: true

  Maximum Length: 60

  The county for the contact person's address.
• Contactcreationdate: string (date-time)
  Title: Contact Creation Date

  Read Only: true

  The date when the contact person is added to the planning application.
• Contactemailaddressone: string
  Title: Contact Email

  Read Only: true

  Maximum Length: 320

  The email address information for the contact person.
• Contactfirstname: string
  Title: Contact First Name

  Read Only: true

  Maximum Length: 150

  The contact's first name.
• Contactfullname: string
  Title: Contact Full Name

  Read Only: true

  Maximum Length: 450

  The contact's full name.
• ContactId: integer (int64)
  Read Only: true

  The unique identifier of the contact.
• ContactKey: integer (int64)
  Read Only: true

  The unique identifier for the contact.
• Contactlastname: string
  Title: Contact Last Name

  Read Only: true

  Maximum Length: 150

  The contact's last name.
• Contactmiddlename: string
  Title: Contact Middle Name

  Read Only: true

  Maximum Length: 60

  The contact's middle name.
• ContactPartyId: integer (int64)
  Read Only: true

  The contact list party ID.
• Contactphone: string
  Title: Contact Phone

  Read Only: true

  Maximum Length: 60

  The full phone number including the phone country code, area code, and phone number for the contact person.
• Contactphoneareacode: string
  Read Only: true

  Maximum Length: 10

  The phone area code for the contact person.
• Contactphonecountrycode: string
  Read Only: true

  Maximum Length: 10

  The phone country code for the contact person.
• Contactphoneextension: string
  Title: Contact Phone Extension

  Read Only: true

  Maximum Length: 20

  The phone extension for the contact person.
• Contactphonenumber: string
  Read Only: true

  Maximum Length: 40

  The phone number for the contact person.
• Contactpostalcode: string
  Title: Contact Postal Code

  Read Only: true

  Maximum Length: 60

  The postal code for the contact person's address.
• ContactProfileId: integer (int64)
  Read Only: true

  The profile ID of the contact.
• Contactstate: string
  Title: Contact State

  Read Only: true

  Maximum Length: 60

  The state for the contact person's address.
• Contacttype: string
  Title: Contact Type

  Read Only: true

  Maximum Length: 30

  Identifies the contact type of the primary contact of the planning application.
• Contactuserid: string
  Title: Contact User ID

  Read Only: true

  Maximum Length: 100

  The user ID of the contact.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  Identifies the date on which the planning application was created.
• IssueDate: string (date-time)
  Title: Issue Date

  Read Only: true

  The date the planning certificate was issued.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LnpRecordId: string
  Title: Record ID

  Read Only: true

  Maximum Length: 50

  The identifier for the building planning application. For example, a planning application number with a value such as Building planning application ID RA-2017-00029.
• LnpRecordKey: integer
  Read Only: true

  The unique identifier for the record.
• OrganizationName: string
  Title: Organization Name

  Read Only: true

  Maximum Length: 360

  The business name of the applicant. For example, a contractor enters his or her contracting business name.
• Owner: string
  Title: Property Owner Name

  Read Only: true

  Maximum Length: 150

  The primary or only owner of the parcel or property.
• Owneremailid: string
  Title: Property Owner Email

  Read Only: true

  Maximum Length: 50

  The parcel owner email address.
• OwnerId: integer (int64)
  Read Only: true

  The owner ID of the record parcel owner.
• OwnerKey: integer (int64)
  Read Only: true

  The owner key of the record parcel owner.
• Parceladdressone: string
  Title: Property Address Line 1

  Read Only: true

  Maximum Length: 240

  The first line of the parcel or property address.
• Parceladdresstwo: string
  Title: Property Address Line 2

  Read Only: true

  Maximum Length: 240

  The second line of the parcel or property address.
• Parcelcity: string
  Title: Property City

  Read Only: true

  Maximum Length: 60

  The city in the parcel or property address.
• Parcelcountry: string
  Title: Property Country

  Read Only: true

  Maximum Length: 60

  The country in the parcel or property address.
• Parcelcounty: string
  Title: Property County

  Read Only: true

  Maximum Length: 60

  The county in the parcel or property address.
• ParcelId: integer (int64)
  Title: Parcel

  Read Only: true

  The identifier of the record parcel.
• ParcelKey: integer (int64)
  Read Only: true

  The key of the record parcel.
• Parcelpostalcode: string
  Title: Property Postal Code

  Read Only: true

  Maximum Length: 60

  The postal code in the parcel or property address.
• Parcelprovince: string
  Title: Property Province

  Read Only: true

  Maximum Length: 60

  The province in the parcel or property address.
• Parcelstate: string
  Title: Property State

  Read Only: true

  Maximum Length: 60

  The state in the parcel or property address.
• Parceltype: string
  Title: Parcel Type

  Read Only: true

  Maximum Length: 30

  The type of the current parcel.
• Personfirstname: string
  Title: Applicant First Name

  Read Only: true

  Maximum Length: 150

  The applicant's first name.
• Personlastname: string
  Title: Applicant Last Name

  Read Only: true

  Maximum Length: 150

  The applicant's last name.
• Personmiddlename: string
  Title: Applicant Middle Name

  Read Only: true

  Maximum Length: 60

  The applicant's middle name.
• Persontitle: string
  Title: Applicant Title

  Read Only: true

  Maximum Length: 60

  The title of the contact.
• Primaryflag: string
  Title: Primary Contact

  Read Only: true

  Maximum Length: 1

  Indicates the primary contact in the contact details.
• Propertydescription: string
  Title: Property Description

  Read Only: true

  Maximum Length: 240

  The property description.
• ReceivedDate: string (date-time)
  Title: Received Date

  Read Only: true

  Identifies the received date for the planning application.
• RecordStatus: string
  Read Only: true

  Maximum Length: 15

  The status of the record which is corresponding to the planning application status.
• RecordTypeId: string
  Read Only: true

  Maximum Length: 30

  The identifier for a record type.
• Secondaryowner: string
  Title: Property Secondary Owner

  Read Only: true

  Maximum Length: 150

  The secondary owner of the parcel or property.
• Subclassification: string
  Title: Subclassification

  Read Only: true

  Maximum Length: 80

  The subclassification of the planning application type.
• SubmitDate: string (date-time)
  Title: Submission Date

  Read Only: true

  The date the planning application was submitted.
• SystemStatus: string
  Title: Application System Status

  Read Only: true

  Maximum Length: 15

  Identifies the system status of the planning application.
• URL: string
  Title: Planning Application Overview URL

  Read Only: true

  The URL to access the overview page of the planning application.

{
    "type":"object",
    "properties":{
        "Subclassification":{
            "title":"Subclassification",
            "maxLength":"80",
            "type":"string",
            "description":"The subclassification of the planning application type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Identifies the date on which the planning application was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Contactstate":{
            "title":"Contact State",
            "maxLength":"60",
            "type":"string",
            "description":"The state for the contact person's address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ApplicantUserId":{
            "title":"Applicant User ID",
            "type":"string",
            "description":"The user ID of the applicant.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "UserID":"Y",
                "Recipient":"Y",
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "Owner":{
            "title":"Property Owner Name",
            "maxLength":"150",
            "type":"string",
            "description":"The primary or only owner of the parcel or property.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Contactemailaddressone":{
            "title":"Contact Email",
            "maxLength":"320",
            "type":"string",
            "description":"The email address information for the contact person.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "Email":"Y",
                "Recipient":"Y",
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "Applicantaddresstwo":{
            "title":"Applicant Address Line 2",
            "maxLength":"240",
            "type":"string",
            "description":"The second line of the applicant address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SubmitDate":{
            "title":"Submission Date",
            "type":"string",
            "description":"The date the planning application was submitted.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Parcelpostalcode":{
            "title":"Property Postal Code",
            "maxLength":"60",
            "type":"string",
            "description":"The postal code in the parcel or property address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Contactphoneareacode":{
            "maxLength":"10",
            "type":"string",
            "description":"The phone area code for the contact person.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Applicantcountry":{
            "title":"Applicant Country",
            "maxLength":"3",
            "type":"string",
            "description":"The country in the applicant address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Contactcity":{
            "title":"Contact City",
            "maxLength":"60",
            "type":"string",
            "description":"The city for the contact person's address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Applicantpersonname":{
            "title":"Applicant Full Name",
            "maxLength":"450",
            "type":"string",
            "description":"The planning applicant name.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ContactProfileId":{
            "type":"integer",
            "description":"The profile ID of the contact.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Parcelstate":{
            "title":"Property State",
            "maxLength":"60",
            "type":"string",
            "description":"The state in the parcel or property address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Personfirstname":{
            "title":"Applicant First Name",
            "maxLength":"150",
            "type":"string",
            "description":"The applicant's first name.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Personmiddlename":{
            "title":"Applicant Middle Name",
            "maxLength":"60",
            "type":"string",
            "description":"The applicant's middle name.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Contactphone":{
            "title":"Contact Phone",
            "maxLength":"60",
            "type":"string",
            "description":"The full phone number including the phone country code, area code, and phone number for the contact person.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "Phone":"Y",
                "Recipient":"Y",
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "Contactaddressone":{
            "title":"Contact Address Line 1",
            "maxLength":"240",
            "type":"string",
            "description":"The first address line for the contact person.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ContactBizPartyId":{
            "type":"integer",
            "description":"The contact list business party ID.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Contactphonenumber":{
            "maxLength":"40",
            "type":"string",
            "description":"The phone number for the contact person.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Classification":{
            "title":"Classification",
            "maxLength":"80",
            "type":"string",
            "description":"The planning application classification.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Owneremailid":{
            "title":"Property Owner Email",
            "maxLength":"50",
            "type":"string",
            "description":"The parcel owner email address.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "Email":"Y",
                "Recipient":"Y",
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "ContactKey":{
            "type":"integer",
            "description":"The unique identifier for the contact.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ParcelKey":{
            "type":"integer",
            "description":"The key of the record parcel.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ContactPartyId":{
            "type":"integer",
            "description":"The contact list party ID.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Contactmiddlename":{
            "title":"Contact Middle Name",
            "maxLength":"60",
            "type":"string",
            "description":"The contact's middle name.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Applicationtype":{
            "title":"Application Type",
            "maxLength":"100",
            "type":"string",
            "description":"The planning application type. Agencies define the types of planning application that they administer, for example, Residential Addition.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Parcelcounty":{
            "title":"Property County",
            "maxLength":"60",
            "type":"string",
            "description":"The county in the parcel or property address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ApplicantProfileId":{
            "type":"integer",
            "description":"The user profile of the applicant.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Contactlastname":{
            "title":"Contact Last Name",
            "maxLength":"150",
            "type":"string",
            "description":"The contact's last name.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Parcelprovince":{
            "title":"Property Province",
            "maxLength":"60",
            "type":"string",
            "description":"The province in the parcel or property address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Applicantpostalcode":{
            "title":"Applicant Postal Code",
            "maxLength":"60",
            "type":"string",
            "description":"The postal code in the applicant address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Applicantphonecountrycode":{
            "maxLength":"10",
            "type":"string",
            "description":"The country code in the phone number of the applicant.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Contactphonecountrycode":{
            "maxLength":"10",
            "type":"string",
            "description":"The phone country code for the contact person.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Contactcountry":{
            "title":"Contact Country",
            "maxLength":"3",
            "type":"string",
            "description":"The country for the contact person's address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Contactphoneextension":{
            "title":"Contact Phone Extension",
            "maxLength":"20",
            "type":"string",
            "description":"The phone extension for the contact person.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "AddressKey":{
            "type":"integer",
            "description":"The parcel address key.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LnpRecordKey":{
            "type":"integer",
            "description":"The unique identifier for the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Persontitle":{
            "title":"Applicant Title",
            "maxLength":"60",
            "type":"string",
            "description":"The title of the contact.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AcceptanceDate":{
            "title":"Acceptance Date",
            "type":"string",
            "description":"Identifies the accepted date for the planning application.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Personlastname":{
            "title":"Applicant Last Name",
            "maxLength":"150",
            "type":"string",
            "description":"The applicant's last name.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReceivedDate":{
            "title":"Received Date",
            "type":"string",
            "description":"Identifies the received date for the planning application.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Applicantphonenumber":{
            "maxLength":"40",
            "type":"string",
            "description":"The applicant phone number.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Applicantphone":{
            "title":"Applicant Phone",
            "maxLength":"60",
            "type":"string",
            "description":"The full phone number including the phone country code, area code, and phone number for the applicant..",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "Phone":"Y",
                "Recipient":"Y",
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "OwnerKey":{
            "type":"integer",
            "description":"The owner key of the record parcel owner.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Secondaryowner":{
            "title":"Property Secondary Owner",
            "maxLength":"150",
            "type":"string",
            "description":"The secondary owner of the parcel or property.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Contactaddresstwo":{
            "title":"Contact Address Line 2",
            "maxLength":"240",
            "type":"string",
            "description":"The second address line for the contact person.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ApplicationAccess":{
            "title":"Planning Application Access",
            "type":"string",
            "description":"Indicates whether the contact person has full access to the application similar to the applicant.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Applicant":{
            "type":"integer",
            "description":"The party ID of the planning applicant.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Parcelcity":{
            "title":"Property City",
            "maxLength":"60",
            "type":"string",
            "description":"The city in the parcel or property address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Contactcounty":{
            "title":"Contact County",
            "maxLength":"60",
            "type":"string",
            "description":"The county for the contact person's address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrganizationName":{
            "title":"Organization Name",
            "maxLength":"360",
            "type":"string",
            "description":"The business name of the applicant. For example, a contractor enters his or her contracting business name.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Applicantemailaddressone":{
            "title":"Applicant Email 1",
            "maxLength":"320",
            "type":"string",
            "description":"The first email address of the applicant.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "Email":"Y",
                "Recipient":"Y",
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "AgencyId":{
            "type":"integer",
            "description":"The identifier for a public sector agency. This is usually an alphanumeric identifier for a city, county, or state, but it can also be the name of a city, county, or state.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"8"
            },
            "x-queryable":true
        },
        "Applicantstate":{
            "title":"Applicant State",
            "maxLength":"60",
            "type":"string",
            "description":"The state in the applicant address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Contactfirstname":{
            "title":"Contact First Name",
            "maxLength":"150",
            "type":"string",
            "description":"The contact's first name.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Applicantphoneareacode":{
            "maxLength":"10",
            "type":"string",
            "description":"The area code in the phone number of the applicant.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Contactcreationdate":{
            "title":"Contact Creation Date",
            "type":"string",
            "description":"The date when the contact person is added to the planning application.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Contactaltphonecountrycode":{
            "maxLength":"10",
            "type":"string",
            "description":"The alternate phone country code for the contact person.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ContactId":{
            "type":"integer",
            "description":"The unique identifier of the contact.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "URL":{
            "title":"Planning Application Overview URL",
            "type":"string",
            "description":"The URL to access the overview page of the planning application.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "Contactfullname":{
            "title":"Contact Full Name",
            "maxLength":"450",
            "type":"string",
            "description":"The contact's full name.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Parceltype":{
            "title":"Parcel Type",
            "maxLength":"30",
            "type":"string",
            "description":"The type of the current parcel.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Contactaltphone":{
            "title":"Contact Alternate Phone",
            "maxLength":"60",
            "type":"string",
            "description":"The alternate phone number with country code for the contact person.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "Phone":"Y",
                "Recipient":"Y",
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "Contacttype":{
            "title":"Contact Type",
            "maxLength":"30",
            "type":"string",
            "description":"Identifies the contact type of the primary contact of the planning application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Applicationdescription":{
            "title":"Application Description",
            "maxLength":"1000",
            "type":"string",
            "description":"The description of the planning application type.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "OwnerId":{
            "type":"integer",
            "description":"The owner ID of the record parcel owner.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Applicantcounty":{
            "title":"Applicant County",
            "maxLength":"60",
            "type":"string",
            "description":"The county in the applicant address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RecordTypeId":{
            "maxLength":"30",
            "type":"string",
            "description":"The identifier for a record type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Parcelcountry":{
            "title":"Property Country",
            "maxLength":"60",
            "type":"string",
            "description":"The country in the parcel or property address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Contactpostalcode":{
            "title":"Contact Postal Code",
            "maxLength":"60",
            "type":"string",
            "description":"The postal code for the contact person's address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Applicantprovince":{
            "title":"Applicant Province",
            "maxLength":"60",
            "type":"string",
            "description":"The province in the applicant address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RecordStatus":{
            "maxLength":"15",
            "type":"string",
            "description":"The status of the record which is corresponding to the planning application status.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SystemStatus":{
            "title":"Application System Status",
            "maxLength":"15",
            "type":"string",
            "description":"Identifies the system status of the planning application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Applicantphoneextension":{
            "title":"Applicant Phone Extension",
            "maxLength":"20",
            "type":"string",
            "description":"The phone number extension for the applicant.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "LnpRecordId":{
            "title":"Record ID",
            "maxLength":"50",
            "type":"string",
            "description":"The identifier for the building planning application. For example, a planning application number with a value such as Building planning application ID RA-2017-00029.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ParcelId":{
            "title":"Parcel",
            "type":"integer",
            "description":"The identifier of the record parcel.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Applicantcity":{
            "title":"Applicant City",
            "maxLength":"60",
            "type":"string",
            "description":"The city in the applicant address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Contactbusinessname":{
            "title":"Contact Business Name",
            "maxLength":"360",
            "type":"string",
            "description":"The contact's business name.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Contactactive":{
            "title":"Contact Active Status",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the contact is active or inactive related to the planning application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Contactaltphoneareacode":{
            "maxLength":"10",
            "type":"string",
            "description":"The alternate phone area code for the contact person.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IssueDate":{
            "title":"Issue Date",
            "type":"string",
            "description":"The date the planning certificate was issued.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Parceladdresstwo":{
            "title":"Property Address Line 2",
            "maxLength":"240",
            "type":"string",
            "description":"The second line of the parcel or property address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Applicantaddressone":{
            "title":"Applicant Address Line 1",
            "maxLength":"240",
            "type":"string",
            "description":"The first line of the applicant address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Propertydescription":{
            "title":"Property Description",
            "maxLength":"240",
            "type":"string",
            "description":"The property description.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "Contactaltphonenumber":{
            "maxLength":"40",
            "type":"string",
            "description":"The alternate phone number for the contact person.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Applicationstatus":{
            "title":"Application Status",
            "maxLength":"100",
            "type":"string",
            "description":"The status of the planning application.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Parceladdressone":{
            "title":"Property Address Line 1",
            "maxLength":"240",
            "type":"string",
            "description":"The first line of the parcel or property address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Primaryflag":{
            "title":"Primary Contact",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates the primary contact in the contact details.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Contactuserid":{
            "title":"Contact User ID",
            "maxLength":"100",
            "type":"string",
            "description":"The user ID of the contact.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "UserId":"Y",
                "Recipient":"Y",
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "Applicantemailaddresstwo":{
            "title":"Applicant Email 2",
            "maxLength":"320",
            "type":"string",
            "description":"The second email address of the applicant.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "Email":"Y",
                "Recipient":"Y",
                "brf:Hide":"true"
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top