Jump to

• Request
• Response

Get a planning application

get

/fscmRestApi/resources/11.13.18.05/publicSectorPlannerAssignmentCommunications/{LnpRecordKey}

Request

Path Parameters

• LnpRecordKey(required): integer(int64)
  Key identifier for the main record.

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields 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 fields 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 fields. 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 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
• 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
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

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

Body ()

Root Schema : publicSectorPlannerAssignmentCommunications-item-response

Type: object

Show Source

• AboutToExpireDate: string (date-time)
  Title: About to Expire Date

  Read Only: true

  The about to expire date of the planning application.
• AddressKey: integer (int64)
  Title: Address Key

  Read Only: true

  The address identifier of the property.
• AgencyId: integer (int32)
  Title: Agency ID

  Read Only: true

  The agency identifier of the transaction.
• Applicant: integer (int64)
  Title: Applicant ID

  Read Only: true

  The applicant identifier of the application.
• ApplicantAddress1: string
  Title: Applicant Address Line 1

  Read Only: true

  Maximum Length: 240

  The first line of the applicant's address in the application.
• ApplicantAddress2: string
  Title: Applicant Address Line 2

  Read Only: true

  Maximum Length: 240

  The second line of the applicant's address in the application.
• ApplicantBizProfileId: integer (int64)
  Title: Business Profile

  Read Only: true

  The business profile ID of the applicant submitting the planning application.
• ApplicantCity: string
  Title: Applicant City

  Read Only: true

  Maximum Length: 60

  The applicant's city in the application.
• ApplicantCountry: string
  Title: Applicant Country

  Read Only: true

  Maximum Length: 3

  The applicant's country in the application.
• ApplicantCounty: string
  Title: Applicant County

  Read Only: true

  Maximum Length: 60

  The applicant's county in the application.
• ApplicantEmailAddress1: string
  Title: Applicant Email 1

  Read Only: true

  Maximum Length: 320

  The applicant's primary email ID in the application.
• ApplicantEmailAddress2: string
  Title: Applicant Email 2

  Read Only: true

  Maximum Length: 320

  The applicant's secondary email ID in the application.
• ApplicantFirstName: string
  Read Only: true

  Maximum Length: 150

  The first name of the person filling the application form for submission.
• ApplicantLastName: string
  Read Only: true

  Maximum Length: 150

  The last name of the person filling the application form for submission.
• ApplicantMiddleName: string
  Read Only: true

  Maximum Length: 60

  The middle name of the person filling the application form for submission.
• ApplicantName: string
  Title: Applicant Name

  Read Only: true

  Maximum Length: 450

  The name of the person filling the application form for submission.
• ApplicantPhoneExtension: string
  Title: Applicant Phone Extension

  Read Only: true

  Maximum Length: 20

  The applicant's phone number extension in the application.
• ApplicantPhoneNumber: string
  Title: Applicant Phone Number

  Read Only: true

  Maximum Length: 65

  The applicant's phone number in the application.
• ApplicantPostalCode: string
  Title: Applicant Postal Code

  Read Only: true

  Maximum Length: 60

  The applicant's postal code in the application.
• ApplicantProfileId: integer (int64)
  Title: Applicant Profile

  Read Only: true

  The profile ID of the applicant submitting the planning application.
• ApplicantProvince: string
  Title: Applicant Province

  Read Only: true

  Maximum Length: 60

  The applicant's province in the application.
• ApplicantState: string
  Title: Applicant State

  Read Only: true

  Maximum Length: 60

  The applicant's state in the application.
• ApplicantTitle: string
  Read Only: true

  Maximum Length: 60

  The title of the person filling the application form for submission.
• AssigneeEmail: string
  Title: Assigned Planner Email

  Read Only: true

  Maximum Length: 240

  The email of the planner assigned to the transaction.
• AssigneeName: string
  Title: Assigned Planner Name

  Read Only: true

  Maximum Length: 240

  The name of the planner assigned to the transaction.
• AssigneePhone: string
  Title: Assigned Planner Phone

  Read Only: true

  Maximum Length: 60

  The phone number of the planner assigned to the transaction.
• AssigneeUserid: string
  Title: Assigned Planner User ID

  Read Only: true

  Maximum Length: 64

  The identifier of the planner assigned to the transaction.
• AssignmentStatus: string
  Read Only: true

  Maximum Length: 8

  The planner assignment status of the transaction.
• BalanceDue: number
  Title: Balance Due

  Read Only: true

  The balance amount due for the transaction.
• CancelledByEmail: string
  Title: Canceled by Email

  Read Only: true

  Maximum Length: 240

  Identifies the user who canceled the application by the phone number.
• CancelledById: string
  Title: Canceled by User ID

  Read Only: true

  Maximum Length: 64

  Identifies the user who canceled the application by the user ID.
• CancelledByName: string
  Title: Canceled by Name

  Read Only: true

  Maximum Length: 240

  Identifies the user who canceled the application by the name.
• CancelledByPhone: string
  Title: Canceled by Phone

  Read Only: true

  Maximum Length: 60

  Identifies the user who canceled the application by the email address.
• Classification: string
  Title: Classification

  Read Only: true

  Maximum Length: 3

  The classification of the transaction.
• CreatedBy: string
  Title: Created by User ID

  Read Only: true

  Maximum Length: 64

  Identifies the user ID of the person who created the application.
• CreatedByEmail: string
  Title: Created by Email

  Read Only: true

  Maximum Length: 240

  Identifies the user who created the application by the email address.
• CreatedByName: string
  Title: Created by Name

  Read Only: true

  Maximum Length: 240

  Identifies the person who created the application.
• CreatedByPhone: string
  Title: Created by Phone

  Read Only: true

  Maximum Length: 60

  Identifies the user who created the application by the phone number.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date on which the transaction was created.
• DelinquentDate: string (date-time)
  Title: Delinquent Date

  Read Only: true

  The date on which the planning application becomes delinquent.
• DistrictName: string
  Title: District

  Read Only: true

  Maximum Length: 50

  The district in which the property exists.
• ExpirationDate: string (date-time)
  Title: Expiration Date

  Read Only: true

  The planning application expiration date.
• ExpirationGraceDate: string (date-time)
  Title: Expiration Grace Date

  Read Only: true

  The date of expiration of the grace period for the planning application.
• ExpirationGracePeriod: string
  Title: Expiration Grace Period

  Read Only: true

  Maximum Length: 121

  The expiration grace period of the planning application.
• ExtensionsCount: integer (int32)
  Title: Extensions Count

  Read Only: true

  The number of extensions given for the planning application.
• IssueDate: string (date-time)
  Title: Issue Date

  Read Only: true

  The planning application issue date.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date on which the transaction was last updated.
• LastUpdatedBy: string
  Title: Last Updated by User ID

  Read Only: true

  Maximum Length: 64

  Identifies the user ID of the person who last updated the application.
• LastUpdatedByEmail: string
  Title: Last Updated by Email

  Read Only: true

  Maximum Length: 240

  Identifies the user who last updated the application by the email address.
• LastUpdatedByName: string
  Title: Last Updated by Name

  Read Only: true

  Maximum Length: 240

  Identifies the person who last updated the application.
• LastUpdatedByPhone: string
  Title: Last Updated by Phone

  Read Only: true

  Maximum Length: 60

  Identifies the user who last updated the application by the phone number.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LnpRecordKey: integer (int64)
  Read Only: true

  Key identifier for the main record.
• OrganizationName: string
  Title: Business Name

  Read Only: true

  Maximum Length: 360

  The applicant's organization name in the application.
• Owner: string
  Title: Owner Name

  Read Only: true

  Maximum Length: 150

  The name of the property owner in the application.
• OwnerEmailId: string
  Title: Owner Email

  Read Only: true

  Maximum Length: 50

  The email address of the property owner in the application.
• ParcelAddress1: string
  Title: Parcel Address Line 1

  Read Only: true

  Maximum Length: 240

  The first line in the parcel address of the property in the application.
• ParcelAddress2: string
  Title: Parcel Address Line 2

  Read Only: true

  Maximum Length: 240

  The second line in the parcel address of the property in the application.
• ParcelCity: string
  Title: Parcel City

  Read Only: true

  Maximum Length: 60

  The parcel city of the property in the application.
• ParcelCountry: string
  Title: Parcel Country

  Read Only: true

  Maximum Length: 60

  The parcel country of the property in the application.
• ParcelCounty: string
  Title: Parcel County

  Read Only: true

  Maximum Length: 60

  The parcel county of the property in the application.
• ParcelId: integer (int64)
  Title: Parcel ID

  Read Only: true

  The parcel ID of the planning application.
• ParcelIdEntered: string
  Title: Parcel

  Read Only: true

  Maximum Length: 30

  The parcel name of the planning application as entered by the user.
• ParcelKey: integer (int64)
  Title: Parcel Key

  Read Only: true

  The parcel key for the planning application.
• ParcelPostalCode: string
  Title: Parcel Postal Code

  Read Only: true

  Maximum Length: 60

  The parcel postal code of the property in the application.
• ParcelProvince: string
  Title: Parcel Province

  Read Only: true

  Maximum Length: 60

  The parcel province of the property in the application.
• ParcelState: string
  Title: Parcel State

  Read Only: true

  Maximum Length: 60

  The parcel state of the property in the application.
• ParcelType: string
  Title: Parcel Type

  Read Only: true

  Maximum Length: 30

  The parcel type for the planning application.
• PersonName: string
  Title: Primary Contact Name

  Read Only: true

  Maximum Length: 450

  The primary contact name in the application.
• PrimaryContactEmail: string
  Title: Primary Contact Email

  Read Only: true

  Maximum Length: 320

  The email of the primary contact in the application.
• PrimaryContactPhone: string
  Title: Primary Contact Phone

  Read Only: true

  Maximum Length: 65

  The phone number of the primary contact in the application.
• ProcessId: number
  Title: Process ID

  Read Only: true

  The identifier of the workflow process of the transaction.
• ProjectId: integer (int64)
  Title: Project ID

  Read Only: true

  The transaction's project ID in the application.
• PropertyDescription: string
  Title: Property Description

  Read Only: true

  Maximum Length: 240

  The description of the property in the planning application.
• ReceivedDate: string (date-time)
  Title: Received Date

  Read Only: true

  The received date of the transaction application.
• RenewalDate: string (date-time)
  Title: Renewal Date

  Read Only: true

  The transaction renewal date of the application.
• RowType: string
  Title: Row Type

  Read Only: true

  Maximum Length: 30

  The category of the transaction.
• SecondaryOwner: string
  Title: Secondary Owner

  Read Only: true

  Maximum Length: 150

  The name of the secondary owner of the property in the application.
• Subclassification: string
  Title: Subclassification

  Read Only: true

  Maximum Length: 10

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

  Read Only: true

  The submission date of the transaction application.
• SubmittedBy: string
  Title: Submitted by User ID

  Read Only: true

  Maximum Length: 64

  Identifies the user who submitted the application by the user ID.
• SubmittedByEmail: string
  Title: Submitted by Email

  Read Only: true

  Maximum Length: 240

  Identifies the user who submitted the application by the email address.
• SubmittedByName: string
  Title: Submitted by Name

  Read Only: true

  Maximum Length: 240

  Identifies the user who submitted the application by the name.
• SubmittedByPhone: string
  Title: Submitted by Phone

  Read Only: true

  Maximum Length: 60

  Identifies the user who submitted the application by the phone number.
• TransactionDescription: string
  Title: Application Description

  Read Only: true

  Maximum Length: 1000

  The description of the transaction.
• TransactionId: string
  Title: Transaction ID

  Read Only: true

  Maximum Length: 50

  Unique identifier for the main transaction record.
• TransactionKey: integer
  Title: Transaction Key

  Read Only: true

  Identifier for the main transaction record.
• TransactionStatus: string
  Title: Application Status

  Read Only: true

  Maximum Length: 15

  The status of the transaction.
• TransactionType: string
  Title: Transaction Type

  Read Only: true

  Maximum Length: 100

  The type of the transaction.
• TransactionTypeId: string
  Title: Transaction Type ID

  Read Only: true

  Maximum Length: 30

  The identifier for the transaction type.
• WithdrawnByEmail: string
  Title: Withdrawn by Email

  Read Only: true

  Maximum Length: 240

  Identifies the user who withdrew the application by the phone number.
• WithdrawnById: string
  Title: Withdrawn by User ID

  Read Only: true

  Maximum Length: 64

  Identifies the user who withdrew the application by the user ID.
• WithdrawnByName: string
  Title: Withdrawn by Name

  Read Only: true

  Maximum Length: 240

  Identifies the user who withdrew the application by the name.
• WithdrawnByPhone: string
  Title: Withdrawn by Phone

  Read Only: true

  Maximum Length: 60

  Identifies the user who withdrew the application by the email address.

{
    "type":"object",
    "properties":{
        "ApplicantFirstName":{
            "maxLength":150,
            "type":"string",
            "description":"The first name of the person filling the application form for submission.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Subclassification":{
            "title":"Subclassification",
            "maxLength":10,
            "type":"string",
            "description":"The subclassification of the transaction.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AboutToExpireDate":{
            "title":"About to Expire Date",
            "type":"string",
            "description":"The about to expire date of the planning application.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date on which the transaction was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Owner":{
            "title":"Owner Name",
            "maxLength":150,
            "type":"string",
            "description":"The name of the property owner in the application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssigneeUserid":{
            "title":"Assigned Planner User ID",
            "maxLength":64,
            "type":"string",
            "description":"The identifier of the planner assigned to the transaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SubmitDate":{
            "title":"Submission Date",
            "type":"string",
            "description":"The submission date of the transaction application.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TransactionTypeId":{
            "title":"Transaction Type ID",
            "maxLength":30,
            "type":"string",
            "description":"The identifier for the transaction type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ParcelAddress2":{
            "title":"Parcel Address Line 2",
            "maxLength":240,
            "type":"string",
            "description":"The second line in the parcel address of the property in the application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssigneeEmail":{
            "title":"Assigned Planner Email",
            "maxLength":240,
            "type":"string",
            "description":"The email of the planner assigned to the transaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TransactionStatus":{
            "title":"Application Status",
            "maxLength":15,
            "type":"string",
            "description":"The status of the transaction.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ParcelAddress1":{
            "title":"Parcel Address Line 1",
            "maxLength":240,
            "type":"string",
            "description":"The first line in the parcel address of the property in the application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryContactEmail":{
            "title":"Primary Contact Email",
            "maxLength":320,
            "type":"string",
            "description":"The email of the primary contact in the application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ParcelPostalCode":{
            "title":"Parcel Postal Code",
            "maxLength":60,
            "type":"string",
            "description":"The parcel postal code of the property in the application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedByEmail":{
            "title":"Last Updated by Email",
            "maxLength":240,
            "type":"string",
            "description":"Identifies the user who last updated the application by the email address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Classification":{
            "title":"Classification",
            "maxLength":3,
            "type":"string",
            "description":"The classification of the transaction.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SubmittedByPhone":{
            "title":"Submitted by Phone",
            "maxLength":60,
            "type":"string",
            "description":"Identifies the user who submitted the application by the phone number.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ParcelIdEntered":{
            "title":"Parcel",
            "maxLength":30,
            "type":"string",
            "description":"The parcel name of the planning application as entered by the user.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ParcelKey":{
            "title":"Parcel Key",
            "type":"integer",
            "description":"The parcel key for the planning application.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ApplicantProvince":{
            "title":"Applicant Province",
            "maxLength":60,
            "type":"string",
            "description":"The applicant's province in the application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SecondaryOwner":{
            "title":"Secondary Owner",
            "maxLength":150,
            "type":"string",
            "description":"The name of the secondary owner of the property in the application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ApplicantMiddleName":{
            "maxLength":60,
            "type":"string",
            "description":"The middle name of the person filling the application form for submission.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ParcelType":{
            "title":"Parcel Type",
            "maxLength":30,
            "type":"string",
            "description":"The parcel type for the planning application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated by User ID",
            "maxLength":64,
            "type":"string",
            "description":"Identifies the user ID of the person who last updated the application.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ApplicantAddress2":{
            "title":"Applicant Address Line 2",
            "maxLength":240,
            "type":"string",
            "description":"The second line of the applicant's address in the application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ParcelProvince":{
            "title":"Parcel Province",
            "maxLength":60,
            "type":"string",
            "description":"The parcel province of the property in the application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WithdrawnById":{
            "title":"Withdrawn by User ID",
            "maxLength":64,
            "type":"string",
            "description":"Identifies the user who withdrew the application by the user ID.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WithdrawnByEmail":{
            "title":"Withdrawn by Email",
            "maxLength":240,
            "type":"string",
            "description":"Identifies the user who withdrew the application by the phone number.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedByPhone":{
            "title":"Created by Phone",
            "maxLength":60,
            "type":"string",
            "description":"Identifies the user who created the application by the phone number.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TransactionDescription":{
            "title":"Application Description",
            "maxLength":1000,
            "type":"string",
            "description":"The description of the transaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ApplicantProfileId":{
            "title":"Applicant Profile",
            "type":"integer",
            "description":"The profile ID of the applicant submitting the planning application.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created by User ID",
            "maxLength":64,
            "type":"string",
            "description":"Identifies the user ID of the person who created the application.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ParcelCounty":{
            "title":"Parcel County",
            "maxLength":60,
            "type":"string",
            "description":"The parcel county of the property in the application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ApplicantName":{
            "title":"Applicant Name",
            "maxLength":450,
            "type":"string",
            "description":"The name of the person filling the application form for submission.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ApplicantState":{
            "title":"Applicant State",
            "maxLength":60,
            "type":"string",
            "description":"The applicant's state in the application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SubmittedBy":{
            "title":"Submitted by User ID",
            "maxLength":64,
            "type":"string",
            "description":"Identifies the user who submitted the application by the user ID.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedByEmail":{
            "title":"Created by Email",
            "maxLength":240,
            "type":"string",
            "description":"Identifies the user who created the application by the email address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ParcelState":{
            "title":"Parcel State",
            "maxLength":60,
            "type":"string",
            "description":"The parcel state of the property in the application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SubmittedByName":{
            "title":"Submitted by Name",
            "maxLength":240,
            "type":"string",
            "description":"Identifies the user who submitted the application by the name.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AddressKey":{
            "title":"Address Key",
            "type":"integer",
            "description":"The address identifier of the property.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ApplicantCounty":{
            "title":"Applicant County",
            "maxLength":60,
            "type":"string",
            "description":"The applicant's county in the application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LnpRecordKey":{
            "type":"integer",
            "description":"Key identifier for the main record.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CancelledByName":{
            "title":"Canceled by Name",
            "maxLength":240,
            "type":"string",
            "description":"Identifies the user who canceled the application by the name.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ExtensionsCount":{
            "title":"Extensions Count",
            "type":"integer",
            "description":"The number of extensions given for the planning application.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":4
            },
            "x-queryable":true
        },
        "TransactionId":{
            "title":"Transaction ID",
            "maxLength":50,
            "type":"string",
            "description":"Unique identifier for the main transaction record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ParcelCity":{
            "title":"Parcel City",
            "maxLength":60,
            "type":"string",
            "description":"The parcel city of the property in the application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PropertyDescription":{
            "title":"Property Description",
            "maxLength":240,
            "type":"string",
            "description":"The description of the property in the planning application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RenewalDate":{
            "title":"Renewal Date",
            "type":"string",
            "description":"The transaction renewal date of the application.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReceivedDate":{
            "title":"Received Date",
            "type":"string",
            "description":"The received date of the transaction application.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WithdrawnByName":{
            "title":"Withdrawn by Name",
            "maxLength":240,
            "type":"string",
            "description":"Identifies the user who withdrew the application by the name.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CancelledByEmail":{
            "title":"Canceled by Email",
            "maxLength":240,
            "type":"string",
            "description":"Identifies the user who canceled the application by the phone number.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ExpirationGraceDate":{
            "title":"Expiration Grace Date",
            "type":"string",
            "description":"The date of expiration of the grace period for the planning application.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Applicant":{
            "title":"Applicant ID",
            "type":"integer",
            "description":"The applicant identifier of the application.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdatedByPhone":{
            "title":"Last Updated by Phone",
            "maxLength":60,
            "type":"string",
            "description":"Identifies the user who last updated the application by the phone number.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ApplicantPhoneExtension":{
            "title":"Applicant Phone Extension",
            "maxLength":20,
            "type":"string",
            "description":"The applicant's phone number extension in the application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrganizationName":{
            "title":"Business Name",
            "maxLength":360,
            "type":"string",
            "description":"The applicant's organization name in the application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedByName":{
            "title":"Created by Name",
            "maxLength":240,
            "type":"string",
            "description":"Identifies the person who created the application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssigneePhone":{
            "title":"Assigned Planner Phone",
            "maxLength":60,
            "type":"string",
            "description":"The phone number of the planner assigned to the transaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TransactionType":{
            "title":"Transaction Type",
            "maxLength":100,
            "type":"string",
            "description":"The type of the transaction.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TransactionKey":{
            "title":"Transaction Key",
            "type":"integer",
            "description":"Identifier for the main transaction record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CancelledById":{
            "title":"Canceled by User ID",
            "maxLength":64,
            "type":"string",
            "description":"Identifies the user who canceled the application by the user ID.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The agency identifier of the transaction.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":8
            },
            "x-queryable":true
        },
        "ApplicantLastName":{
            "maxLength":150,
            "type":"string",
            "description":"The last name of the person filling the application form for submission.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ApplicantEmailAddress1":{
            "title":"Applicant Email 1",
            "maxLength":320,
            "type":"string",
            "description":"The applicant's primary email ID in the application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RowType":{
            "title":"Row Type",
            "maxLength":30,
            "type":"string",
            "description":"The category of the transaction.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ApplicantEmailAddress2":{
            "title":"Applicant Email 2",
            "maxLength":320,
            "type":"string",
            "description":"The applicant's secondary email ID in the application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ApplicantCity":{
            "title":"Applicant City",
            "maxLength":60,
            "type":"string",
            "description":"The applicant's city in the application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OwnerEmailId":{
            "title":"Owner Email",
            "maxLength":50,
            "type":"string",
            "description":"The email address of the property owner in the application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DelinquentDate":{
            "title":"Delinquent Date",
            "type":"string",
            "description":"The date on which the planning application becomes delinquent.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ApplicantPostalCode":{
            "title":"Applicant Postal Code",
            "maxLength":60,
            "type":"string",
            "description":"The applicant's postal code in the application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedByName":{
            "title":"Last Updated by Name",
            "maxLength":240,
            "type":"string",
            "description":"Identifies the person who last updated the application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ApplicantAddress1":{
            "title":"Applicant Address Line 1",
            "maxLength":240,
            "type":"string",
            "description":"The first line of the applicant's address in the application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryContactPhone":{
            "title":"Primary Contact Phone",
            "maxLength":65,
            "type":"string",
            "description":"The phone number of the primary contact in the application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CancelledByPhone":{
            "title":"Canceled by Phone",
            "maxLength":60,
            "type":"string",
            "description":"Identifies the user who canceled the application by the email address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssigneeName":{
            "title":"Assigned Planner Name",
            "maxLength":240,
            "type":"string",
            "description":"The name of the planner assigned to the transaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ExpirationGracePeriod":{
            "title":"Expiration Grace Period",
            "maxLength":121,
            "type":"string",
            "description":"The expiration grace period of the planning application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ParcelId":{
            "title":"Parcel ID",
            "type":"integer",
            "description":"The parcel ID of the planning application.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PersonName":{
            "title":"Primary Contact Name",
            "maxLength":450,
            "type":"string",
            "description":"The primary contact name in the application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ParcelCountry":{
            "title":"Parcel Country",
            "maxLength":60,
            "type":"string",
            "description":"The parcel country of the property in the application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ApplicantPhoneNumber":{
            "title":"Applicant Phone Number",
            "maxLength":65,
            "type":"string",
            "description":"The applicant's phone number in the application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProjectId":{
            "title":"Project ID",
            "type":"integer",
            "description":"The transaction's project ID in the application.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "IssueDate":{
            "title":"Issue Date",
            "type":"string",
            "description":"The planning application issue date.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WithdrawnByPhone":{
            "title":"Withdrawn by Phone",
            "maxLength":60,
            "type":"string",
            "description":"Identifies the user who withdrew the application by the email address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ApplicantCountry":{
            "title":"Applicant Country",
            "maxLength":3,
            "type":"string",
            "description":"The applicant's country in the application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ApplicantBizProfileId":{
            "title":"Business Profile",
            "type":"integer",
            "description":"The business profile ID of the applicant submitting the planning application.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DistrictName":{
            "title":"District",
            "maxLength":50,
            "type":"string",
            "description":"The district in which the property exists.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"The planning application expiration date.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BalanceDue":{
            "title":"Balance Due",
            "type":"number",
            "description":"The balance amount due for the transaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SubmittedByEmail":{
            "title":"Submitted by Email",
            "maxLength":240,
            "type":"string",
            "description":"Identifies the user who submitted the application by the email address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ApplicantTitle":{
            "maxLength":60,
            "type":"string",
            "description":"The title of the person filling the application form for submission.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProcessId":{
            "title":"Process ID",
            "type":"number",
            "description":"The identifier of the workflow process of the transaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssignmentStatus":{
            "maxLength":8,
            "type":"string",
            "description":"The planner assignment status of the transaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date on which the transaction was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":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