Jump to

• Request
• Response

Get all planning and zoning application contacts details

get

/fscmRestApi/resources/11.13.18.05/publicSectorPZApplicationContacts

Request

Query Parameters

• dependency: string
  This parameter specifies dependencies which are attributes that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The attributes specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the attributes will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency attributes. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource attributes. Only the specified attributes are returned, which means that if no attributes are specified, no attributes 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 attributes. 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.
• 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 attributes. 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
• 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".

Back to Top

Response

Supported Media Types

• application/vnd.oracle.adf.resourcecollection+json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : publicSectorPZApplicationContacts

Type: object

Show Source

• count(optional): integer
  Title: Count

  The number of resource instances returned in the current range.
• hasMore(optional): boolean
  Title: HasMore

  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(optional): array Items
  Title: Items

  The items in the collection.
• limit(optional): integer
  Title: Limit

  The actual paging size used by the server.
• links(optional): array Items
  Title: Items

  The link relations associated with the resource instance.
• offset(optional): integer
  Title: Offset

  The offset value used in the current page.

{
    "properties":{
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range.",
            "title":"Count"
        },
        "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.",
            "title":"HasMore"
        },
        "items":{
            "items":{
                "$ref":"#/definitions/publicSectorPZApplicationContacts-item"
            },
            "type":"array",
            "description":"The items in the collection.",
            "title":"Items"
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server.",
            "title":"Limit"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "title":"Items"
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page.",
            "title":"Offset"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object publicSectorPZApplicationContacts-item

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

Nested Schema : Items

Type: array

Title: Items

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : publicSectorPZApplicationContacts-item

Type: object

Show Source

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

  Identifies the accepted date for the planning application.
• AddressKey(optional): integer(int64)
  The parcel address key.
• AgencyId(optional): integer(int32)
  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(optional): integer(int64)
  The party ID of the planning applicant.
• Applicantaddressone(optional): string
  Title: Applicant Address Line 1

  Maximum Length: 240

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

  Maximum Length: 240

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

  Maximum Length: 60

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

  Maximum Length: 3

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

  Maximum Length: 60

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

  Maximum Length: 320

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

  Maximum Length: 320

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

  Maximum Length: 450

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

  Maximum Length: 60

  The full phone number including the phone country code, area code, and phone number for the applicant..
• Applicantphoneareacode(optional): string
  Maximum Length: 10

  The area code in the phone number of the applicant.
• Applicantphonecountrycode(optional): string
  Maximum Length: 10

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

  Maximum Length: 20

  The phone number extension for the applicant.
• Applicantphonenumber(optional): string
  Maximum Length: 40

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

  Maximum Length: 60

  The postal code in the applicant address.
• ApplicantProfileId(optional): integer(int64)
  The user profile of the applicant.
• Applicantprovince(optional): string
  Title: Applicant Province

  Maximum Length: 60

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

  Maximum Length: 60

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

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

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

  Maximum Length: 1000

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

  Maximum Length: 100

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

  Maximum Length: 100

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

  Maximum Length: 80

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

  Maximum Length: 1

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

  Maximum Length: 240

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

  Maximum Length: 240

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

  Maximum Length: 60

  The alternate phone number with country code for the contact person.
• Contactaltphoneareacode(optional): string
  Maximum Length: 10

  The alternate phone area code for the contact person.
• Contactaltphonecountrycode(optional): string
  Maximum Length: 10

  The alternate phone country code for the contact person.
• Contactaltphonenumber(optional): string
  Maximum Length: 40

  The alternate phone number for the contact person.
• ContactBizPartyId(optional): integer(int64)
  The contact list business party ID.
• Contactbusinessname(optional): string
  Title: Contact Business Name

  Maximum Length: 360

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

  Maximum Length: 60

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

  Maximum Length: 3

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

  Maximum Length: 60

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

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

  Maximum Length: 320

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

  Maximum Length: 150

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

  Maximum Length: 450

  The contact's full name.
• ContactId(optional): integer(int64)
  The unique identifier of the contact.
• ContactKey(optional): integer(int64)
  The unique identifier for the contact.
• Contactlastname(optional): string
  Title: Contact Last Name

  Maximum Length: 150

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

  Maximum Length: 60

  The contact's middle name.
• ContactPartyId(optional): integer(int64)
  The contact list party ID.
• Contactphone(optional): string
  Title: Contact Phone

  Maximum Length: 60

  The full phone number including the phone country code, area code, and phone number for the contact person.
• Contactphoneareacode(optional): string
  Maximum Length: 10

  The phone area code for the contact person.
• Contactphonecountrycode(optional): string
  Maximum Length: 10

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

  Maximum Length: 20

  The phone extension for the contact person.
• Contactphonenumber(optional): string
  Maximum Length: 40

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

  Maximum Length: 60

  The postal code for the contact person's address.
• ContactProfileId(optional): integer(int64)
  The profile ID of the contact.
• Contactstate(optional): string
  Title: Contact State

  Maximum Length: 60

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

  Maximum Length: 30

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

  Maximum Length: 100

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

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

  The date the planning certificate was issued.
• links(optional): array Items
  Title: Items

  Link Relations
• LnpRecordId(optional): string
  Title: Record ID

  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(optional): integer(int64)
  The unique identifier for the record.
• OrganizationName(optional): string
  Title: Organization Name

  Maximum Length: 360

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

  Maximum Length: 150

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

  Maximum Length: 50

  The parcel owner email address.
• OwnerId(optional): integer(int64)
  The owner ID of the record parcel owner.
• OwnerKey(optional): integer(int64)
  The owner key of the record parcel owner.
• Parceladdressone(optional): string
  Title: Property Address Line 1

  Maximum Length: 240

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

  Maximum Length: 240

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

  Maximum Length: 60

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

  Maximum Length: 60

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

  Maximum Length: 60

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

  The identifier of the record parcel.
• ParcelKey(optional): integer(int64)
  The key of the record parcel.
• Parcelpostalcode(optional): string
  Title: Property Postal Code

  Maximum Length: 60

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

  Maximum Length: 60

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

  Maximum Length: 60

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

  Maximum Length: 30

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

  Maximum Length: 150

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

  Maximum Length: 150

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

  Maximum Length: 60

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

  Maximum Length: 60

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

  Maximum Length: 1

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

  Maximum Length: 240

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

  Identifies the received date for the planning application.
• RecordStatus(optional): string
  Maximum Length: 15

  The status of the record which is corresponding to the planning application status.
• RecordTypeId(optional): string
  Maximum Length: 30

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

  Maximum Length: 150

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

  Maximum Length: 80

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

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

  Maximum Length: 15

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

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

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

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : link

Type: object

Show Source

• href(optional): string
  Title: hyperlink reference

  The URI to the related resource.
• rel(optional): string
  Title: relation

  The name of the relation to the resource instance. Example: self.

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Back to Top