Get a fee record for a fee communication event
get
/fscmRestApi/resources/11.13.18.05/publicSectorFeeCommunications/{publicSectorFeeCommunicationsUniqID}
Request
Path Parameters
-
publicSectorFeeCommunicationsUniqID: integer
This is the hash key of the attributes which make up the composite key--- FeeRecordKey and LnpRecordKey ---for the Fee Communications resource and used to uniquely identify an instance of Fee Communications. The client should not generate the hash key value. Instead, the client should query on the Fee Communications collection resource with a filter on the primary key values in order to navigate to a specific instance of Fee Communications.
For example: publicSectorFeeCommunications?q=FeeRecordKey=<value1>;LnpRecordKey=<value2>
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 : publicSectorFeeCommunications-item
Type:
Show Source
object-
Address1(optional):
string
Title:
Applicant Address Line 1Maximum Length:240The first line of the permit applicant address. -
Address2(optional):
string
Title:
Applicant Address Line 2Maximum Length:240The second line of the permit applicant address. -
Address3(optional):
string
Maximum Length:
240The third line of the permit applicant address. -
Address4(optional):
string
Maximum Length:
240The fourth line of the permit applicant address. -
ApplExpirationDate(optional):
string(date-time)
Title:
Application Expiration DateThe date when the application expires. -
Applicant(optional):
integer(int64)
Title:
ApplicantThe party ID of the person applying for the application. -
ApplicantBizProfileId(optional):
integer(int64)
Title:
Business ProfileThe business profile used by the applicant. -
ApplicantProfileId(optional):
integer(int64)
Title:
Applicant ProfileThe user profile ID used by the applicant. -
ApplicantUserId(optional):
string
Title:
Applicant User IDMaximum Length:20The permit applicant user ID. -
AssessedDate(optional):
string(date-time)
Title:
Assessed DateThe date when the fee item was assessed. -
City(optional):
string
Title:
Applicant CityMaximum Length:60The city in the permit applicant address. -
Classification(optional):
string
Title:
ClassificationMaximum Length:3The type of record. -
Country(optional):
string
Title:
Applicant CountryMaximum Length:3The country in the permit applicant address. -
County(optional):
string
Title:
Applicant CountyMaximum Length:60The county in the permit applicant address. -
CurrencyCode(optional):
string
Title:
CurrencyMaximum Length:3The default currency code for the fee schedule. -
DelinquentDate(optional):
string(date-time)
Title:
Delinquent DateThe date when the fee becomes delinquent. -
DepartmentDescription(optional):
string
Title:
DepartmentMaximum Length:255The description of the department. -
EmailAddress1(optional):
string
Title:
Applicant Email 1Maximum Length:320The first email address of the permit applicant. -
EmailAddress2(optional):
string
Title:
Applicant Email 2Maximum Length:320The second email address of the permit applicant. -
ExpirationDate(optional):
string(date-time)
Title:
Expiration DateThe date when the permit is no longer valid. -
FeeAmount(optional):
number
Title:
AmountThe fee amount. -
FeeDescription(optional):
string
Title:
Fee DescriptionMaximum Length:50The description of the fee item. -
FeeItemId(optional):
string
Title:
Fee ItemMaximum Length:30The unique identifier for a fee that can be assessed for one or more record types. -
FeeMemo(optional):
string
Title:
MemoMaximum Length:200The memo content for the fee item. -
FeeRecordKey(optional):
integer(int64)
The fee record key.
-
FeeStatus(optional):
string
Title:
StatusMaximum Length:6The fee status. -
Invoice(optional):
string
Title:
InvoiceMaximum Length:50The fee invoice number. -
InvoiceLine(optional):
integer(int32)
Title:
Invoice LineThe fee invoice line number. -
IssueDate(optional):
string(date-time)
Title:
Issue DateThe date when the permit was issued. -
links(optional):
array Items
Title:
ItemsLink Relations -
LnpRecordId(optional):
string
Title:
Permit IDMaximum Length:50The identifier for the building permit record. For example, a permit number with a value such as Building Permit ID RA-2017-00029. -
LnpRecordKey(optional):
integer(int64)
The key of one record.
-
OrganizationName(optional):
string
Title:
Business NameMaximum Length:360The name of the applicant business. For example, a contractor would enter the name of his or her contracting business. -
PersonFirstName(optional):
string
Maximum Length:
150The first name of the permit applicant. -
PersonLastName(optional):
string
Maximum Length:
150The last name of the permit applicant. -
PersonMiddleName(optional):
string
Maximum Length:
60The middle name of the permit applicant. -
PersonName(optional):
string
Title:
Applicant NameMaximum Length:450The permit applicant name. -
PersonNameSuffix(optional):
string
Title:
SuffixMaximum Length:30The suffix for the permit applicant. For example, Jr. or Sr. -
PersonPreNameAdjunct(optional):
string
Title:
SalutationMaximum Length:30The salutation for the applicant. For example, Mr. or Mrs. -
PersonTitle(optional):
string
Maximum Length:
60The title of the permit applicant. -
PhoneAreaCode(optional):
string
Title:
Applicant Phone Area CodeMaximum Length:10The area code for the permit applicant phone number. -
PhoneCountryCode(optional):
string
Title:
Applicant Phone Country CodeMaximum Length:10The country code for the permit applicant phone number. -
PhoneExtension(optional):
string
Title:
Applicant Phone ExtensionMaximum Length:20The permit applicant phone number extension. -
PhoneNumber(optional):
string
Title:
Applicant Phone NumberMaximum Length:40The permit applicant phone number. -
PostalCode(optional):
string
Title:
Applicant Postal CodeMaximum Length:60The postal code in the permit applicant address. -
Province(optional):
string
Title:
Applicant ProvinceMaximum Length:60The province in the permit applicant address. -
RecordDescription(optional):
string
Title:
Permit DescriptionMaximum Length:300The description of the type of permit. -
RecordStatus(optional):
string
Title:
Permit StatusMaximum Length:100The status of the permit record. -
RecordType(optional):
string
Title:
Permit TypeMaximum Length:100The type of the permit. For example, Residential Addition. -
RenewalDate(optional):
string(date-time)
Title:
Renewal DateThe date when the permit was renewed. -
State(optional):
string
Title:
Applicant StateMaximum Length:60The state in the permit applicant address. -
SubmitDate(optional):
string(date-time)
Title:
Submission DateThe date when the permit application was submitted. -
Url(optional):
string
Title:
URLThe permit URL used within a communications template. -
UrlLabel(optional):
string
Title:
Communications URL LabelThe label displayed for a permit URL used within a communications template.
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.