Get a planning application
get
/fscmRestApi/resources/11.13.18.05/publicSectorPlannerAssignmentCommunications/{LnpRecordKey}
Request
Path Parameters
-
LnpRecordKey: integer
Key identifier for the main record.
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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
Response
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
Default Response
The following table describes the default response for this task.
Root Schema : publicSectorPlannerAssignmentCommunications-item
Type:
Show Source
object
-
AboutToExpireDate(optional):
string(date-time)
Title:
About to Expire Date
The about to expire date of the planning application. -
AddressKey(optional):
integer(int64)
Title:
Address Key
The address identifier of the property. -
AgencyId(optional):
integer(int32)
Title:
Agency ID
The agency identifier of the transaction. -
Applicant(optional):
integer(int64)
Title:
Applicant ID
The applicant identifier of the application. -
ApplicantAddress1(optional):
string
Title:
Applicant Address Line 1
Maximum Length:240
The first line of the applicant's address in the application. -
ApplicantAddress2(optional):
string
Title:
Applicant Address Line 2
Maximum Length:240
The second line of the applicant's address in the application. -
ApplicantBizProfileId(optional):
integer(int64)
Title:
Business Profile
The business profile ID of the applicant submitting the planning application. -
ApplicantCity(optional):
string
Title:
Applicant City
Maximum Length:60
The applicant's city in the application. -
ApplicantCountry(optional):
string
Title:
Applicant Country
Maximum Length:3
The applicant's country in the application. -
ApplicantCounty(optional):
string
Title:
Applicant County
Maximum Length:60
The applicant's county in the application. -
ApplicantEmailAddress1(optional):
string
Title:
Applicant Email 1
Maximum Length:320
The applicant's primary email ID in the application. -
ApplicantEmailAddress2(optional):
string
Title:
Applicant Email 2
Maximum Length:320
The applicant's secondary email ID in the application. -
ApplicantFirstName(optional):
string
Maximum Length:
150
The first name of the person filling the application form for submission. -
ApplicantLastName(optional):
string
Maximum Length:
150
The last name of the person filling the application form for submission. -
ApplicantMiddleName(optional):
string
Maximum Length:
60
The middle name of the person filling the application form for submission. -
ApplicantName(optional):
string
Title:
Applicant Name
Maximum Length:450
The name of the person filling the application form for submission. -
ApplicantPhoneExtension(optional):
string
Title:
Applicant Phone Extension
Maximum Length:20
The applicant's phone number extension in the application. -
ApplicantPhoneNumber(optional):
string
Title:
Applicant Phone Number
Maximum Length:65
The applicant's phone number in the application. -
ApplicantPostalCode(optional):
string
Title:
Applicant Postal Code
Maximum Length:60
The applicant's postal code in the application. -
ApplicantProfileId(optional):
integer(int64)
Title:
Applicant Profile
The profile ID of the applicant submitting the planning application. -
ApplicantProvince(optional):
string
Title:
Applicant Province
Maximum Length:60
The applicant's province in the application. -
ApplicantState(optional):
string
Title:
Applicant State
Maximum Length:60
The applicant's state in the application. -
ApplicantTitle(optional):
string
Maximum Length:
60
The title of the person filling the application form for submission. -
AssigneeEmail(optional):
string
Title:
Assigned Planner Email
Maximum Length:240
The email of the planner assigned to the transaction. -
AssigneeName(optional):
string
Title:
Assigned Planner Name
Maximum Length:240
The name of the planner assigned to the transaction. -
AssigneePhone(optional):
string
Title:
Assigned Planner Phone
Maximum Length:60
The phone number of the planner assigned to the transaction. -
AssigneeUserid(optional):
string
Title:
Assigned Planner User ID
Maximum Length:64
The identifier of the planner assigned to the transaction. -
AssignmentStatus(optional):
string
Maximum Length:
8
The planner assignment status of the transaction. -
BalanceDue(optional):
number
Title:
Balance Due
The balance amount due for the transaction. -
CancelledByEmail(optional):
string
Title:
Canceled by Email
Maximum Length:240
Identifies the user who canceled the application by the phone number. -
CancelledById(optional):
string
Title:
Canceled by User ID
Maximum Length:64
Identifies the user who canceled the application by the user ID. -
CancelledByName(optional):
string
Title:
Canceled by Name
Maximum Length:240
Identifies the user who canceled the application by the name. -
CancelledByPhone(optional):
string
Title:
Canceled by Phone
Maximum Length:60
Identifies the user who canceled the application by the email address. -
Classification(optional):
string
Title:
Classification
Maximum Length:3
The classification of the transaction. -
CreatedBy(optional):
string
Title:
Created by User ID
Maximum Length:64
Identifies the user ID of the person who created the application. -
CreatedByEmail(optional):
string
Title:
Created by Email
Maximum Length:240
Identifies the user who created the application by the email address. -
CreatedByName(optional):
string
Title:
Created by Name
Maximum Length:240
Identifies the person who created the application. -
CreatedByPhone(optional):
string
Title:
Created by Phone
Maximum Length:60
Identifies the user who created the application by the phone number. -
CreationDate(optional):
string(date-time)
Title:
Creation Date
The date on which the transaction was created. -
DelinquentDate(optional):
string(date-time)
Title:
Delinquent Date
The date on which the planning application becomes delinquent. -
DistrictName(optional):
string
Title:
District
Maximum Length:50
The district in which the property exists. -
ExpirationDate(optional):
string(date-time)
Title:
Expiration Date
The planning application expiration date. -
ExpirationGraceDate(optional):
string(date-time)
Title:
Expiration Grace Date
The date of expiration of the grace period for the planning application. -
ExpirationGracePeriod(optional):
string
Title:
Expiration Grace Period
Maximum Length:121
The expiration grace period of the planning application. -
ExtensionsCount(optional):
integer(int32)
Title:
Extensions Count
The number of extensions given for the planning application. -
IssueDate(optional):
string(date-time)
Title:
Issue Date
The planning application issue date. -
LastUpdateDate(optional):
string(date-time)
Title:
Last Updated Date
The date on which the transaction was last updated. -
LastUpdatedBy(optional):
string
Title:
Last Updated by User ID
Maximum Length:64
Identifies the user ID of the person who last updated the application. -
LastUpdatedByEmail(optional):
string
Title:
Last Updated by Email
Maximum Length:240
Identifies the user who last updated the application by the email address. -
LastUpdatedByName(optional):
string
Title:
Last Updated by Name
Maximum Length:240
Identifies the person who last updated the application. -
LastUpdatedByPhone(optional):
string
Title:
Last Updated by Phone
Maximum Length:60
Identifies the user who last updated the application by the phone number. -
links(optional):
array Items
Title:
Items
Link Relations -
LnpRecordKey(optional):
integer(int64)
Key identifier for the main record.
-
OrganizationName(optional):
string
Title:
Business Name
Maximum Length:360
The applicant's organization name in the application. -
Owner(optional):
string
Title:
Owner Name
Maximum Length:150
The name of the property owner in the application. -
OwnerEmailId(optional):
string
Title:
Owner Email
Maximum Length:50
The email address of the property owner in the application. -
ParcelAddress1(optional):
string
Title:
Parcel Address Line 1
Maximum Length:240
The first line in the parcel address of the property in the application. -
ParcelAddress2(optional):
string
Title:
Parcel Address Line 2
Maximum Length:240
The second line in the parcel address of the property in the application. -
ParcelCity(optional):
string
Title:
Parcel City
Maximum Length:60
The parcel city of the property in the application. -
ParcelCountry(optional):
string
Title:
Parcel Country
Maximum Length:60
The parcel country of the property in the application. -
ParcelCounty(optional):
string
Title:
Parcel County
Maximum Length:60
The parcel county of the property in the application. -
ParcelId(optional):
integer(int64)
Title:
Parcel ID
The parcel ID of the planning application. -
ParcelIdEntered(optional):
string
Title:
Parcel
Maximum Length:30
The parcel name of the planning application as entered by the user. -
ParcelKey(optional):
integer(int64)
Title:
Parcel Key
The parcel key for the planning application. -
ParcelPostalCode(optional):
string
Title:
Parcel Postal Code
Maximum Length:60
The parcel postal code of the property in the application. -
ParcelProvince(optional):
string
Title:
Parcel Province
Maximum Length:60
The parcel province of the property in the application. -
ParcelState(optional):
string
Title:
Parcel State
Maximum Length:60
The parcel state of the property in the application. -
ParcelType(optional):
string
Title:
Parcel Type
Maximum Length:30
The parcel type for the planning application. -
PersonName(optional):
string
Title:
Primary Contact Name
Maximum Length:450
The primary contact name in the application. -
PrimaryContactEmail(optional):
string
Title:
Primary Contact Email
Maximum Length:320
The email of the primary contact in the application. -
PrimaryContactPhone(optional):
string
Title:
Primary Contact Phone
Maximum Length:65
The phone number of the primary contact in the application. -
ProcessId(optional):
number
Title:
Process ID
The identifier of the workflow process of the transaction. -
ProjectId(optional):
integer(int64)
Title:
Project ID
The transaction's project ID in the application. -
PropertyDescription(optional):
string
Title:
Property Description
Maximum Length:240
The description of the property in the planning application. -
ReceivedDate(optional):
string(date-time)
Title:
Received Date
The received date of the transaction application. -
RenewalDate(optional):
string(date-time)
Title:
Renewal Date
The transaction renewal date of the application. -
RowType(optional):
string
Title:
Row Type
Maximum Length:30
The category of the transaction. -
SecondaryOwner(optional):
string
Title:
Secondary Owner
Maximum Length:150
The name of the secondary owner of the property in the application. -
Subclassification(optional):
string
Title:
Subclassification
Maximum Length:10
The subclassification of the transaction. -
SubmitDate(optional):
string(date-time)
Title:
Submission Date
The submission date of the transaction application. -
SubmittedBy(optional):
string
Title:
Submitted by User ID
Maximum Length:64
Identifies the user who submitted the application by the user ID. -
SubmittedByEmail(optional):
string
Title:
Submitted by Email
Maximum Length:240
Identifies the user who submitted the application by the email address. -
SubmittedByName(optional):
string
Title:
Submitted by Name
Maximum Length:240
Identifies the user who submitted the application by the name. -
SubmittedByPhone(optional):
string
Title:
Submitted by Phone
Maximum Length:60
Identifies the user who submitted the application by the phone number. -
TransactionDescription(optional):
string
Title:
Application Description
Maximum Length:1000
The description of the transaction. -
TransactionId(optional):
string
Title:
Transaction ID
Maximum Length:50
Unique identifier for the main transaction record. -
TransactionKey(optional):
integer(int64)
Title:
Transaction Key
Identifier for the main transaction record. -
TransactionStatus(optional):
string
Title:
Application Status
Maximum Length:15
The status of the transaction. -
TransactionType(optional):
string
Title:
Transaction Type
Maximum Length:100
The type of the transaction. -
TransactionTypeId(optional):
string
Title:
Transaction Type ID
Maximum Length:30
The identifier for the transaction type. -
WithdrawnByEmail(optional):
string
Title:
Withdrawn by Email
Maximum Length:240
Identifies the user who withdrew the application by the phone number. -
WithdrawnById(optional):
string
Title:
Withdrawn by User ID
Maximum Length:64
Identifies the user who withdrew the application by the user ID. -
WithdrawnByName(optional):
string
Title:
Withdrawn by Name
Maximum Length:240
Identifies the user who withdrew the application by the name. -
WithdrawnByPhone(optional):
string
Title:
Withdrawn by Phone
Maximum Length:60
Identifies the user who withdrew the application by the email address.
Nested Schema : link
Type:
Show Source
object
-
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.