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)
The about to expire date of the planning application.
-
AddressKey(optional):
integer(int64)
The address identifier of the property.
-
AgencyId(optional):
integer(int32)
The agency identifier of the transaction.
-
Applicant(optional):
integer(int64)
The applicant identifier of the application.
-
ApplicantAddress1(optional):
string
Maximum Length:
240The first line of the applicant's address in the application. -
ApplicantAddress2(optional):
string
Maximum Length:
240The second line of the applicant's address in the application. -
ApplicantBizProfileId(optional):
integer(int64)
The business profile ID of the applicant submitting the planning application.
-
ApplicantCity(optional):
string
Maximum Length:
60The applicant's city in the application. -
ApplicantCountry(optional):
string
Maximum Length:
3The applicant's country in the application. -
ApplicantCounty(optional):
string
Maximum Length:
60The applicant's county in the application. -
ApplicantEmailAddress1(optional):
string
Maximum Length:
320The applicant's primary email ID in the application. -
ApplicantEmailAddress2(optional):
string
Maximum Length:
320The applicant's secondary email ID in the application. -
ApplicantFirstName(optional):
string
Maximum Length:
150The first name of the person filling the application form for submission. -
ApplicantLastName(optional):
string
Maximum Length:
150The last name of the person filling the application form for submission. -
ApplicantMiddleName(optional):
string
Maximum Length:
60The middle name of the person filling the application form for submission. -
ApplicantName(optional):
string
Maximum Length:
450The name of the person filling the application form for submission. -
ApplicantPhoneExtension(optional):
string
Maximum Length:
20The applicant's phone number extension in the application. -
ApplicantPhoneNumber(optional):
string
Maximum Length:
65The applicant's phone number in the application. -
ApplicantPostalCode(optional):
string
Maximum Length:
60The applicant's postal code in the application. -
ApplicantProfileId(optional):
integer(int64)
The profile ID of the applicant submitting the planning application.
-
ApplicantProvince(optional):
string
Maximum Length:
60The applicant's province in the application. -
ApplicantState(optional):
string
Maximum Length:
60The applicant's state in the application. -
ApplicantTitle(optional):
string
Maximum Length:
60The title of the person filling the application form for submission. -
AssigneeEmail(optional):
string
Maximum Length:
240The email of the planner assigned to the transaction. -
AssigneeName(optional):
string
Maximum Length:
240The name of the planner assigned to the transaction. -
AssigneePhone(optional):
string
Maximum Length:
60The phone number of the planner assigned to the transaction. -
AssigneeUserid(optional):
string
Maximum Length:
64The identifier of the planner assigned to the transaction. -
AssignmentStatus(optional):
string
Maximum Length:
8The planner assignment status of the transaction. -
BalanceDue(optional):
number
The balance amount due for the transaction.
-
CancelledByEmail(optional):
string
Maximum Length:
240Identifies the user who canceled the application by the phone number. -
CancelledById(optional):
string
Maximum Length:
64Identifies the user who canceled the application by the user ID. -
CancelledByName(optional):
string
Maximum Length:
240Identifies the user who canceled the application by the name. -
CancelledByPhone(optional):
string
Maximum Length:
60Identifies the user who canceled the application by the email address. -
Classification(optional):
string
Maximum Length:
3The classification of the transaction. -
CreatedBy(optional):
string
Maximum Length:
64Identifies the user ID of the person who created the application. -
CreatedByEmail(optional):
string
Maximum Length:
240Identifies the user who created the application by the email address. -
CreatedByName(optional):
string
Maximum Length:
240Identifies the person who created the application. -
CreatedByPhone(optional):
string
Maximum Length:
60Identifies the user who created the application by the phone number. -
CreationDate(optional):
string(date-time)
The date on which the transaction was created.
-
DelinquentDate(optional):
string(date-time)
The date on which the planning application becomes delinquent.
-
DistrictName(optional):
string
Maximum Length:
50The district in which the property exists. -
ExpirationDate(optional):
string(date-time)
The planning application expiration date.
-
ExpirationGraceDate(optional):
string(date-time)
The date of expiration of the grace period for the planning application.
-
ExpirationGracePeriod(optional):
string
Maximum Length:
121The expiration grace period of the planning application. -
ExtensionsCount(optional):
integer(int32)
The number of extensions given for the planning application.
-
IssueDate(optional):
string(date-time)
The planning application issue date.
-
LastUpdateDate(optional):
string(date-time)
The date on which the transaction was last updated.
-
LastUpdatedBy(optional):
string
Maximum Length:
64Identifies the user ID of the person who last updated the application. -
LastUpdatedByEmail(optional):
string
Maximum Length:
240Identifies the user who last updated the application by the email address. -
LastUpdatedByName(optional):
string
Maximum Length:
240Identifies the person who last updated the application. -
LastUpdatedByPhone(optional):
string
Maximum Length:
60Identifies the user who last updated the application by the phone number. -
links(optional):
array Items
Title:
ItemsLink Relations -
LnpRecordKey(optional):
integer(int64)
Key identifier for the main record.
-
OrganizationName(optional):
string
Maximum Length:
360The applicant's organization name in the application. -
Owner(optional):
string
Maximum Length:
150The name of the property owner in the application. -
OwnerEmailId(optional):
string
Maximum Length:
50The email address of the property owner in the application. -
ParcelAddress1(optional):
string
Maximum Length:
240The first line in the parcel address of the property in the application. -
ParcelAddress2(optional):
string
Maximum Length:
240The second line in the parcel address of the property in the application. -
ParcelCity(optional):
string
Maximum Length:
60The parcel city of the property in the application. -
ParcelCountry(optional):
string
Maximum Length:
60The parcel country of the property in the application. -
ParcelCounty(optional):
string
Maximum Length:
60The parcel county of the property in the application. -
ParcelId(optional):
integer(int64)
The parcel ID of the planning application.
-
ParcelIdEntered(optional):
string
Maximum Length:
30The parcel name of the planning application as entered by the user. -
ParcelKey(optional):
integer(int64)
The parcel key for the planning application.
-
ParcelPostalCode(optional):
string
Maximum Length:
60The parcel postal code of the property in the application. -
ParcelProvince(optional):
string
Maximum Length:
60The parcel province of the property in the application. -
ParcelState(optional):
string
Maximum Length:
60The parcel state of the property in the application. -
ParcelType(optional):
string
Maximum Length:
30The parcel type for the planning application. -
PersonName(optional):
string
Maximum Length:
450The primary contact name in the application. -
PrimaryContactEmail(optional):
string
Maximum Length:
320The email of the primary contact in the application. -
PrimaryContactPhone(optional):
string
Maximum Length:
65The phone number of the primary contact in the application. -
ProcessId(optional):
number
The identifier of the workflow process of the transaction.
-
ProjectId(optional):
integer(int64)
The transaction's project ID in the application.
-
PropertyDescription(optional):
string
Maximum Length:
240The description of the property in the planning application. -
ReceivedDate(optional):
string(date-time)
The received date of the transaction application.
-
RenewalDate(optional):
string(date-time)
The transaction renewal date of the application.
-
RowType(optional):
string
Maximum Length:
30The category of the transaction. -
SecondaryOwner(optional):
string
Maximum Length:
150The name of the secondary owner of the property in the application. -
Subclassification(optional):
string
Maximum Length:
10The subclassification of the transaction. -
SubmitDate(optional):
string(date-time)
The submission date of the transaction application.
-
SubmittedBy(optional):
string
Maximum Length:
64Identifies the user who submitted the application by the user ID. -
SubmittedByEmail(optional):
string
Maximum Length:
240Identifies the user who submitted the application by the email address. -
SubmittedByName(optional):
string
Maximum Length:
240Identifies the user who submitted the application by the name. -
SubmittedByPhone(optional):
string
Maximum Length:
60Identifies the user who submitted the application by the phone number. -
TransactionDescription(optional):
string
Maximum Length:
1000The description of the transaction. -
TransactionId(optional):
string
Maximum Length:
50Unique identifier for the main transaction record. -
TransactionKey(optional):
integer(int64)
Identifier for the main transaction record.
-
TransactionStatus(optional):
string
Maximum Length:
15The status of the transaction. -
TransactionType(optional):
string
Maximum Length:
100The type of the transaction. -
TransactionTypeId(optional):
string
Maximum Length:
30The identifier for the transaction type. -
WithdrawnByEmail(optional):
string
Maximum Length:
240Identifies the user who withdrew the application by the phone number. -
WithdrawnById(optional):
string
Maximum Length:
64Identifies the user who withdrew the application by the user ID. -
WithdrawnByName(optional):
string
Maximum Length:
240Identifies the user who withdrew the application by the name. -
WithdrawnByPhone(optional):
string
Maximum Length:
60Identifies the user who withdrew the application by the email address.
Nested Schema : link
Type:
Show Source
object-
href(optional):
string
Title:
hyperlink referenceThe URI to the related resource. -
rel(optional):
string
Title:
relationThe name of the relation to the resource instance. Example: self.