Jump to

• Request
• Response

Get all planning and zoning workflow communication items

get

/fscmRestApi/resources/11.13.18.05/publicSectorPzWorkflowCommunications

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 workflow communication data with the specified key. Finder Variables:
    • 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 : publicSectorPzWorkflowCommunications

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/publicSectorPzWorkflowCommunications-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 publicSectorPzWorkflowCommunications-item

{
    "items":{
        "$ref":"#/definitions/publicSectorPzWorkflowCommunications-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 : publicSectorPzWorkflowCommunications-item

Type: object

Show Source

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

  The date when the notification about an expiring license or planning application is sent.
• 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.
• ApplExpirationDate(optional): string(date-time)
  Title: Application Expiration Date

  The date the application expires.
• Applicant(optional): integer(int64)
  Title: Applicant

  The party ID of the planning application applicant.
• ApplicantAddress1(optional): string
  Title: Applicant Address Line 1

  Maximum Length: 240

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

  Maximum Length: 240

  The second line of the planning application applicant address.
• ApplicantBizProfileId(optional): integer(int64)
  Title: Business Profile

  The business profile used by the applicant.
• ApplicantCity(optional): string
  Title: Applicant City

  Maximum Length: 60

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

  Maximum Length: 3

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

  Maximum Length: 60

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

  Maximum Length: 320

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

  Maximum Length: 320

  The second email address of the planning application applicant.
• ApplicantPersonName(optional): string
  Title: Applicant Name

  Maximum Length: 450

  The planning application applicant name.
• ApplicantPhoneAreaCode(optional): string
  Title: Applicant Phone Area Code

  Maximum Length: 10

  The area code in the phone number of the planning application applicant.
• ApplicantPhoneCountryCode(optional): string
  Title: Applicant Phone Country Code

  Maximum Length: 10

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

  Maximum Length: 20

  The phone number extension for the planning application applicant.
• ApplicantPhoneNumber(optional): string
  Title: Applicant Phone Number

  Maximum Length: 40

  The planning application applicant phone number.
• ApplicantPostalCode(optional): string
  Title: Applicant Postal Code

  Maximum Length: 60

  The postal code in the planning application applicant address.
• ApplicantProfileId(optional): integer(int64)
  Title: Applicant Profile

  The user profile of the applicant.
• ApplicantProvince(optional): string
  Title: Applicant Province

  Maximum Length: 60

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

  Maximum Length: 60

  The state in the planning application applicant address.
• AssigneeEmail(optional): string
  Title: Assigned Planner Email

  The email for the workflow task assignee.
• AssigneeName(optional): string
  Title: Assigned Planner Name

  The name of the workflow task assignee.
• AssigneePhone(optional): string
  Title: Assigned Planner Phone

  The phone for the workflow task assignee.
• AssigneeUserid(optional): string
  Title: Assigned Planner

  Maximum Length: 64

  The unique user ID of the agency staff assigned to the transaction.
• BalanceDue(optional): string
  Title: Balance Due

  The balance due for the planning application.
• CancellationReason(optional): string
  Title: Cancellation Reason

  Maximum Length: 1000

  Identifies the cancellation reason of the planning application.
• CancelledByUserID(optional): string
  Title: Canceled By

  Maximum Length: 64

  Identifies who cancelled the planning application.
• CancelledDate(optional): string(date-time)
  Title: Cancellation Date

  Identifies the cancellation date of the planning application.
• Classification(optional): string
  Title: Classification

  Maximum Length: 3

  The planning application classification.
• CreatedBy(optional): string
  Title: Created By

  Maximum Length: 64

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

  Identifies the creation date of the planning application.
• DelinquentDate(optional): string(date-time)
  Title: Delinquent Date

  The date the license becomes delinquent.
• ExpirationDate(optional): string(date-time)
  Title: Expiration Date

  The date the license or planning application is no longer valid.
• IssueDate(optional): string(date-time)
  Title: Issue Date

  The date the license or planning application was issued. Used in the application information component of the planning application Designer.
• LastUpdateDate(optional): string(date-time)
  Title: Last Updated Date

  Identifies the last update date of the planning application.
• LastUpdatedBy(optional): string
  Title: Last Updated By

  Maximum Length: 64

  Identifies the user who last updated the application by the login ID.
• links(optional): array Items
  Title: Items

  Link Relations
• LnpRecordId(optional): string
  Title: Application 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 planning application.
• OrganizationName(optional): string
  Title: Business 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: Owner

  Maximum Length: 150

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

  Maximum Length: 50

  The parcel owner's email.
• OwnerId(optional): integer(int64)
  Title: Owner ID

  The owner ID of the parcel owner.
• OwnerKey(optional): integer(int64)
  The owner key of the parcel owner.
• ParcelAddress1(optional): string
  Title: Parcel Address Line 1

  Maximum Length: 240

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

  Maximum Length: 240

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

  Maximum Length: 60

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

  Maximum Length: 60

  The country in the parcel or property address.
• ParcelCounty(optional): string
  Title: Parcel 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: Parcel Postal Code

  Maximum Length: 60

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

  Maximum Length: 60

  The province in the parcel or property address.
• ParcelState(optional): string
  Title: Parcel 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
  Maximum Length: 150

  The applicant first name.
• PersonLastName(optional): string
  Maximum Length: 150

  The applicant last name.
• PersonMiddleName(optional): string
  Maximum Length: 60

  The applicant middle name.
• PersonTitle(optional): string
  Maximum Length: 60

  The title of the contact.
• PlanningDescription(optional): string
  Title: Application Description

  Maximum Length: 300

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

  Maximum Length: 100

  The status of the planning application.
• ProjectKey(optional): integer(int64)
  Title: Project

  The project name information for a planning application.
• PropertyDescription(optional): string
  Title: Property Description

  Maximum Length: 240

  The property description.
• RecordStatus(optional): string
  Maximum Length: 15

  The status of the application.
• RecordType(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.
• RecordTypeId(optional): string
  Maximum Length: 30

  The identifier for a record type.
• RenewalDate(optional): string(date-time)
  Title: Renewal Date

  The renewal date for the license or planning application.
• RowType(optional): string
  Maximum Length: 30

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

  Maximum Length: 150

  The secondary owner of the parcel or property.
• SubmitDate(optional): string(date-time)
  Title: Submission Date

  The date the license and planning application transaction was submitted. Used in the application information component of the planning application Designer.
• SubmittedBy(optional): string
  Title: Submitted By

  Maximum Length: 64

  Identifies the user who submitted the application by the login ID.
• WithdrawalReason(optional): string
  Title: Withdrawal Reason

  Maximum Length: 1000

  Identifies the reason that a planning application was withdrawn.
• WithdrawnByUserID(optional): string
  Title: Withdrawn By

  Maximum Length: 64

  Identifies who withdrew the planning application.
• WithdrawnDate(optional): string(date-time)
  Title: Withdrawal Date

  Identifies the date that the planning application was withdrawn.

{
    "properties":{
        "AboutToExpireDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date when the notification about an expiring license or planning application is sent.",
            "title":"About to Expire 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."
        },
        "ApplExpirationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date the application expires.",
            "title":"Application Expiration Date"
        },
        "Applicant":{
            "format":"int64",
            "type":"integer",
            "description":"The party ID of the planning application applicant.",
            "title":"Applicant"
        },
        "ApplicantAddress1":{
            "maxLength":240,
            "type":"string",
            "description":"The first line of the planning application applicant address.",
            "title":"Applicant Address Line 1"
        },
        "ApplicantAddress2":{
            "maxLength":240,
            "type":"string",
            "description":"The second line of the planning application applicant address.",
            "title":"Applicant Address Line 2"
        },
        "ApplicantBizProfileId":{
            "format":"int64",
            "type":"integer",
            "description":"The business profile used by the applicant.",
            "title":"Business Profile"
        },
        "ApplicantCity":{
            "maxLength":60,
            "type":"string",
            "description":"The city in the planning application applicant address.",
            "title":"Applicant City"
        },
        "ApplicantCountry":{
            "maxLength":3,
            "type":"string",
            "description":"The country in the planning application applicant address.",
            "title":"Applicant Country"
        },
        "ApplicantCounty":{
            "maxLength":60,
            "type":"string",
            "description":"The county in the planning application applicant address.",
            "title":"Applicant County"
        },
        "ApplicantEmailAddress1":{
            "maxLength":320,
            "type":"string",
            "description":"The first email address of the planning application applicant.",
            "title":"Applicant Email 1"
        },
        "ApplicantEmailAddress2":{
            "maxLength":320,
            "type":"string",
            "description":"The second email address of the planning application applicant.",
            "title":"Applicant Email 2"
        },
        "ApplicantPersonName":{
            "maxLength":450,
            "type":"string",
            "description":"The planning application applicant name.",
            "title":"Applicant Name"
        },
        "ApplicantPhoneAreaCode":{
            "maxLength":10,
            "type":"string",
            "description":"The area code in the phone number of the planning application applicant.",
            "title":"Applicant Phone Area Code"
        },
        "ApplicantPhoneCountryCode":{
            "maxLength":10,
            "type":"string",
            "description":"The country code in the phone number of the planning application applicant.",
            "title":"Applicant Phone Country Code"
        },
        "ApplicantPhoneExtension":{
            "maxLength":20,
            "type":"string",
            "description":"The phone number extension for the planning application applicant.",
            "title":"Applicant Phone Extension"
        },
        "ApplicantPhoneNumber":{
            "maxLength":40,
            "type":"string",
            "description":"The planning application applicant phone number.",
            "title":"Applicant Phone Number"
        },
        "ApplicantPostalCode":{
            "maxLength":60,
            "type":"string",
            "description":"The postal code in the planning application applicant address.",
            "title":"Applicant Postal Code"
        },
        "ApplicantProfileId":{
            "format":"int64",
            "type":"integer",
            "description":"The user profile of the applicant.",
            "title":"Applicant Profile"
        },
        "ApplicantProvince":{
            "maxLength":60,
            "type":"string",
            "description":"The province in the planning application applicant address.",
            "title":"Applicant Province"
        },
        "ApplicantState":{
            "maxLength":60,
            "type":"string",
            "description":"The state in the planning application applicant address.",
            "title":"Applicant State"
        },
        "AssigneeEmail":{
            "type":"string",
            "description":"The email for the workflow task assignee.",
            "title":"Assigned Planner Email"
        },
        "AssigneeName":{
            "type":"string",
            "description":"The name of the workflow task assignee.",
            "title":"Assigned Planner Name"
        },
        "AssigneePhone":{
            "type":"string",
            "description":"The phone for the workflow task assignee.",
            "title":"Assigned Planner Phone"
        },
        "AssigneeUserid":{
            "maxLength":64,
            "type":"string",
            "description":"The unique user ID of the agency staff assigned to the transaction.",
            "title":"Assigned Planner"
        },
        "BalanceDue":{
            "type":"string",
            "description":"The balance due for the planning application.",
            "title":"Balance Due"
        },
        "CancellationReason":{
            "maxLength":1000,
            "type":"string",
            "description":"Identifies the cancellation reason of the planning application.",
            "title":"Cancellation Reason"
        },
        "CancelledByUserID":{
            "maxLength":64,
            "type":"string",
            "description":"Identifies who cancelled the planning application.",
            "title":"Canceled By"
        },
        "CancelledDate":{
            "format":"date-time",
            "type":"string",
            "description":"Identifies the cancellation date of the planning application.",
            "title":"Cancellation Date"
        },
        "Classification":{
            "maxLength":3,
            "type":"string",
            "description":"The planning application classification.",
            "title":"Classification"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Identifies the user who created the application by the login ID.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"Identifies the creation date of the planning application.",
            "title":"Creation Date"
        },
        "DelinquentDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date the license becomes delinquent.",
            "title":"Delinquent Date"
        },
        "ExpirationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date the license or planning application is no longer valid.",
            "title":"Expiration Date"
        },
        "IssueDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date the license or planning application was issued. Used in the application information component of the planning application Designer.",
            "title":"Issue Date"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"Identifies the last update date of the planning application.",
            "title":"Last Updated Date"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Identifies the user who last updated the application by the login ID.",
            "title":"Last Updated By"
        },
        "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":"Application ID"
        },
        "LnpRecordKey":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for the planning application."
        },
        "OrganizationName":{
            "maxLength":360,
            "type":"string",
            "description":"The business name of the applicant. For example, a contractor enters his or her contracting business name.",
            "title":"Business Name"
        },
        "Owner":{
            "maxLength":150,
            "type":"string",
            "description":"The primary or only owner of the parcel or property.",
            "title":"Owner"
        },
        "OwnerEmailId":{
            "maxLength":50,
            "type":"string",
            "description":"The parcel owner's email.",
            "title":"Owner Email"
        },
        "OwnerId":{
            "format":"int64",
            "type":"integer",
            "description":"The owner ID of the parcel owner.",
            "title":"Owner ID"
        },
        "OwnerKey":{
            "format":"int64",
            "type":"integer",
            "description":"The owner key of the parcel owner."
        },
        "ParcelAddress1":{
            "maxLength":240,
            "type":"string",
            "description":"The first line of the parcel or property address.",
            "title":"Parcel Address Line 1"
        },
        "ParcelAddress2":{
            "maxLength":240,
            "type":"string",
            "description":"The second line of the parcel or property address.",
            "title":"Parcel Address Line 2"
        },
        "ParcelCity":{
            "maxLength":60,
            "type":"string",
            "description":"The city in the parcel or property address.",
            "title":"Parcel City"
        },
        "ParcelCountry":{
            "maxLength":60,
            "type":"string",
            "description":"The country in the parcel or property address.",
            "title":"Parcel Country"
        },
        "ParcelCounty":{
            "maxLength":60,
            "type":"string",
            "description":"The county in the parcel or property address.",
            "title":"Parcel County"
        },
        "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."
        },
        "ParcelPostalCode":{
            "maxLength":60,
            "type":"string",
            "description":"The postal code in the parcel or property address.",
            "title":"Parcel Postal Code"
        },
        "ParcelProvince":{
            "maxLength":60,
            "type":"string",
            "description":"The province in the parcel or property address.",
            "title":"Parcel Province"
        },
        "ParcelState":{
            "maxLength":60,
            "type":"string",
            "description":"The state in the parcel or property address.",
            "title":"Parcel State"
        },
        "ParcelType":{
            "maxLength":30,
            "type":"string",
            "description":"The type of the current parcel.",
            "title":"Parcel Type"
        },
        "PersonFirstName":{
            "maxLength":150,
            "type":"string",
            "description":"The applicant first name."
        },
        "PersonLastName":{
            "maxLength":150,
            "type":"string",
            "description":"The applicant last name."
        },
        "PersonMiddleName":{
            "maxLength":60,
            "type":"string",
            "description":"The applicant middle name."
        },
        "PersonTitle":{
            "maxLength":60,
            "type":"string",
            "description":"The title of the contact."
        },
        "PlanningDescription":{
            "maxLength":300,
            "type":"string",
            "description":"The description of the planning application type.",
            "title":"Application Description"
        },
        "PlanningStatus":{
            "maxLength":100,
            "type":"string",
            "description":"The status of the planning application.",
            "title":"Application Status"
        },
        "ProjectKey":{
            "format":"int64",
            "type":"integer",
            "description":"The project name information for a planning application.",
            "title":"Project"
        },
        "PropertyDescription":{
            "maxLength":240,
            "type":"string",
            "description":"The property description.",
            "title":"Property Description"
        },
        "RecordStatus":{
            "maxLength":15,
            "type":"string",
            "description":"The status of the  application."
        },
        "RecordType":{
            "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"
        },
        "RecordTypeId":{
            "maxLength":30,
            "type":"string",
            "description":"The identifier for a record type."
        },
        "RenewalDate":{
            "format":"date-time",
            "type":"string",
            "description":"The renewal date for the license or planning application.",
            "title":"Renewal Date"
        },
        "RowType":{
            "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":"Secondary Owner"
        },
        "SubmitDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date the license and planning application transaction was submitted. Used in the application information component of the planning application Designer.",
            "title":"Submission Date"
        },
        "SubmittedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Identifies the user who submitted the application by the login ID.",
            "title":"Submitted By"
        },
        "WithdrawalReason":{
            "maxLength":1000,
            "type":"string",
            "description":"Identifies the reason that a planning application was withdrawn.",
            "title":"Withdrawal Reason"
        },
        "WithdrawnByUserID":{
            "maxLength":64,
            "type":"string",
            "description":"Identifies who withdrew the planning application.",
            "title":"Withdrawn By"
        },
        "WithdrawnDate":{
            "format":"date-time",
            "type":"string",
            "description":"Identifies the date that the planning application was withdrawn.",
            "title":"Withdrawal Date"
        },
        "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