Get all fee records for a fee communication event
get
/fscmRestApi/resources/11.13.18.05/publicSectorFeeCommunications
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 a fee record for fee communications using the specified key. Finder Variables:
- FeeRecordKey; integer; The fee record key.
- LnpRecordKey; integer; The unique identifier of the record.
- PrimaryKey: Finds a fee record for fee communications using the specified key. Finder Variables:
-
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".
Response
Supported Media Types
- application/vnd.oracle.adf.resourcecollection+json
Default Response
The following table describes the default response for this task.
Root Schema : publicSectorFeeCommunications
Type:
Show Source
object
-
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.
Nested Schema : Items
Type:
array
Title:
Items
The link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorFeeCommunications-item
Type:
Show Source
object
-
Address1(optional):
string
Title:
Applicant Address Line 1
Maximum Length:240
The first line of the permit applicant address. -
Address2(optional):
string
Title:
Applicant Address Line 2
Maximum Length:240
The second line of the permit applicant address. -
Address3(optional):
string
Title:
Applicant Address Line 3
Maximum Length:240
The third line of the permit applicant address. -
Address4(optional):
string
Title:
Applicant Address Line 4
Maximum Length:240
The fourth line of the permit applicant address. -
ApplExpirationDate(optional):
string(date-time)
Title:
Application Expiration Date
The date when the application expires. -
Applicant(optional):
integer(int64)
Title:
Applicant
The party ID of the person applying for the application. -
ApplicantBizProfileId(optional):
integer(int64)
Title:
Business Profile
The business profile used by the applicant. -
ApplicantProfileId(optional):
integer(int64)
Title:
Applicant Profile
The user profile ID used by the applicant. -
ApplicantUserId(optional):
string
Title:
Applicant User ID
Maximum Length:20
The permit applicant user ID. -
AssessedDate(optional):
string(date-time)
Title:
Assessed Date
The date when the fee item was assessed. -
City(optional):
string
Title:
Applicant City
Maximum Length:60
The city in the permit applicant address. -
Classification(optional):
string
Title:
Classification
Maximum Length:3
The type of record. -
Country(optional):
string
Title:
Applicant Country
Maximum Length:3
The country in the permit applicant address. -
County(optional):
string
Title:
Applicant County
Maximum Length:60
The county in the permit applicant address. -
CurrencyCode(optional):
string
Title:
Currency
Maximum Length:3
The default currency code for the fee schedule. -
DelinquentDate(optional):
string(date-time)
Title:
Delinquent Date
The date when the fee becomes delinquent. -
EmailAddress1(optional):
string
Title:
Applicant Email 1
Maximum Length:320
The first email address of the permit applicant. -
EmailAddress2(optional):
string
Title:
Applicant Email 2
Maximum Length:320
The second email address of the permit applicant. -
ExpirationDate(optional):
string(date-time)
Title:
Expiration Date
The date when the permit is no longer valid. -
FeeAmount(optional):
number
Title:
Amount
The fee amount. -
FeeDescription(optional):
string
Title:
Fee Description
Maximum Length:50
The description of the fee item. -
FeeItemId(optional):
string
Title:
Fee Item
Maximum Length:30
The unique identifier for a fee that can be assessed for one or more record types. -
FeeMemo(optional):
string
Title:
Memo
Maximum Length:200
The memo content for the fee item. -
FeeRecordKey(optional):
integer(int64)
Title:
Fee Record
The fee record key. -
FeeStatus(optional):
string
Title:
Status
Maximum Length:6
The fee status. -
Invoice(optional):
string
Title:
Invoice
Maximum Length:50
The fee invoice number. -
InvoiceLine(optional):
integer(int32)
Title:
Invoice Line
The fee invoice line number. -
IssueDate(optional):
string(date-time)
Title:
Issue Date
The date when the permit was issued. -
links(optional):
array Items
Title:
Items
Link Relations -
LnpRecordId(optional):
string
Title:
Permit ID
Maximum Length:50
The 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 Name
Maximum Length:360
The name of the applicant business. For example, a contractor would enter the name of his or her contracting business. -
PersonFirstName(optional):
string
Maximum Length:
150
The first name of the permit applicant. -
PersonLastName(optional):
string
Maximum Length:
150
The last name of the permit applicant. -
PersonMiddleName(optional):
string
Maximum Length:
60
The middle name of the permit applicant. -
PersonName(optional):
string
Title:
Applicant Name
Maximum Length:450
The permit applicant name. -
PersonNameSuffix(optional):
string
Title:
Suffix
Maximum Length:30
The suffix for the permit applicant. For example, Jr. or Sr. -
PersonPreNameAdjunct(optional):
string
Title:
Salutation
Maximum Length:30
The salutation for the applicant. For example, Mr. or Mrs. -
PersonTitle(optional):
string
Maximum Length:
60
The title of the permit applicant. -
PhoneAreaCode(optional):
string
Title:
Applicant Phone Area Code
Maximum Length:10
The area code for the permit applicant phone number. -
PhoneCountryCode(optional):
string
Title:
Applicant Phone Country Code
Maximum Length:10
The country code for the permit applicant phone number. -
PhoneExtension(optional):
string
Title:
Applicant Phone Extension
Maximum Length:20
The permit applicant phone number extension. -
PhoneNumber(optional):
string
Title:
Applicant Phone Number
Maximum Length:40
The permit applicant phone number. -
PostalCode(optional):
string
Title:
Applicant Postal Code
Maximum Length:60
The postal code in the permit applicant address. -
Province(optional):
string
Title:
Applicant Province
Maximum Length:60
The province in the permit applicant address. -
RecordDescription(optional):
string
Title:
Permit Description
Maximum Length:300
The description of the type of permit. -
RecordStatus(optional):
string
Title:
Permit Status
Maximum Length:100
The status of the permit record. -
RecordType(optional):
string
Title:
Permit Type
Maximum Length:100
The type of the permit. For example, Residential Addition. -
RenewalDate(optional):
string(date-time)
Title:
Renewal Date
The date when the permit was renewed. -
State(optional):
string
Title:
Applicant State
Maximum Length:60
The state in the permit applicant address. -
SubmitDate(optional):
string(date-time)
Title:
Submission Date
The date when the permit application was submitted. -
Url(optional):
string
Title:
URL
The permit URL used within a communications template. -
UrlLabel(optional):
string
Title:
Communications URL Label
The label displayed for a permit URL used within a communications template.
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.