Get a fee record for a fee communication event
get
/fscmRestApi/resources/11.13.18.05/publicSectorFeeCommunications/{publicSectorFeeCommunicationsUniqID}
Request
Path Parameters
-
publicSectorFeeCommunicationsUniqID(required): string
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 fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields 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 fields 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 fields. 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 fields. Only the specified fields are returned, which means that if no fields are specified, no fields 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 fields. 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 -
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version(required):
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : publicSectorFeeCommunications-item-response
Type:
Show Source
object
-
Address1: string
Title:
Applicant Address Line 1
Read Only:true
Maximum Length:240
The first line of the permit applicant address. -
Address2: string
Title:
Applicant Address Line 2
Read Only:true
Maximum Length:240
The second line of the permit applicant address. -
Address3: string
Read Only:
true
Maximum Length:240
The third line of the permit applicant address. -
Address4: string
Read Only:
true
Maximum Length:240
The fourth line of the permit applicant address. -
ApplExpirationDate: string
(date-time)
Title:
Application Expiration Date
Read Only:true
The date when the application expires. -
Applicant: integer
(int64)
Read Only:
true
The party ID of the person applying for the application. -
ApplicantBizProfileId: integer
(int64)
Read Only:
true
The business profile used by the applicant. -
ApplicantProfileId: integer
(int64)
Read Only:
true
The user profile ID used by the applicant. -
ApplicantUserId: string
Title:
Applicant User ID
Read Only:true
Maximum Length:20
The permit applicant user ID. -
AssessedDate: string
(date-time)
Title:
Assessed Date
Read Only:true
The date when the fee item was assessed. -
City: string
Title:
Applicant City
Read Only:true
Maximum Length:60
The city in the permit applicant address. -
Classification: string
Title:
Classification
Read Only:true
Maximum Length:3
The type of record. -
Country: string
Title:
Applicant Country
Read Only:true
Maximum Length:3
The country in the permit applicant address. -
County: string
Title:
Applicant County
Read Only:true
Maximum Length:60
The county in the permit applicant address. -
CurrencyCode: string
Title:
Currency
Read Only:true
Maximum Length:3
The default currency code for the fee schedule. -
DelinquentDate: string
(date-time)
Title:
Delinquent Date
Read Only:true
The date when the fee becomes delinquent. -
DepartmentDescription: string
Title:
Department
Read Only:true
Maximum Length:255
The description of the department. -
EmailAddress1: string
Title:
Applicant Email 1
Read Only:true
Maximum Length:320
The first email address of the permit applicant. -
EmailAddress2: string
Title:
Applicant Email 2
Read Only:true
Maximum Length:320
The second email address of the permit applicant. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
Read Only:true
The date when the permit is no longer valid. -
FeeAmount: number
Title:
Amount
Read Only:true
The fee amount. -
FeeDescription: string
Title:
Fee Description
Read Only:true
Maximum Length:50
The description of the fee item. -
FeeItemId: string
Title:
Fee Item
Read Only:true
Maximum Length:30
The unique identifier for a fee that can be assessed for one or more record types. -
FeeMemo: string
Title:
Memo
Read Only:true
Maximum Length:200
The memo content for the fee item. -
FeeRecordKey: integer
Read Only:
true
The fee record key. -
FeeStatus: string
Title:
Status
Read Only:true
Maximum Length:6
The fee status. -
Invoice: string
Title:
Invoice
Read Only:true
Maximum Length:50
The fee invoice number. -
InvoiceLine: integer
(int32)
Title:
Invoice Line
Read Only:true
The fee invoice line number. -
IssueDate: string
(date-time)
Title:
Issue Date
Read Only:true
The date when the permit was issued. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LnpRecordId: string
Title:
Permit ID
Read Only:true
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: integer
(int64)
Read Only:
true
The key of one record. -
OrganizationName: string
Title:
Business Name
Read Only:true
Maximum Length:360
The name of the applicant business. For example, a contractor would enter the name of his or her contracting business. -
PersonFirstName: string
Read Only:
true
Maximum Length:150
The first name of the permit applicant. -
PersonLastName: string
Read Only:
true
Maximum Length:150
The last name of the permit applicant. -
PersonMiddleName: string
Read Only:
true
Maximum Length:60
The middle name of the permit applicant. -
PersonName: string
Title:
Applicant Name
Read Only:true
Maximum Length:450
The permit applicant name. -
PersonNameSuffix: string
Title:
Suffix
Read Only:true
Maximum Length:30
The suffix for the permit applicant. For example, Jr. or Sr. -
PersonPreNameAdjunct: string
Title:
Salutation
Read Only:true
Maximum Length:30
The salutation for the applicant. For example, Mr. or Mrs. -
PersonTitle: string
Read Only:
true
Maximum Length:60
The title of the permit applicant. -
PhoneAreaCode: string
Read Only:
true
Maximum Length:10
The area code for the permit applicant phone number. -
PhoneCountryCode: string
Read Only:
true
Maximum Length:10
The country code for the permit applicant phone number. -
PhoneExtension: string
Title:
Applicant Phone Extension
Read Only:true
Maximum Length:20
The permit applicant phone number extension. -
PhoneNumber: string
Title:
Applicant Phone Number
Read Only:true
Maximum Length:40
The permit applicant phone number. -
PostalCode: string
Title:
Applicant Postal Code
Read Only:true
Maximum Length:60
The postal code in the permit applicant address. -
Province: string
Title:
Applicant Province
Read Only:true
Maximum Length:60
The province in the permit applicant address. -
RecordDescription: string
Title:
Permit Description
Read Only:true
Maximum Length:300
The description of the type of permit. -
RecordStatus: string
Title:
Permit Status
Read Only:true
Maximum Length:100
The status of the permit record. -
RecordType: string
Title:
Permit Type
Read Only:true
Maximum Length:100
The type of the permit. For example, Residential Addition. -
RenewalDate: string
(date-time)
Title:
Renewal Date
Read Only:true
The date when the permit was renewed. -
State: string
Title:
Applicant State
Read Only:true
Maximum Length:60
The state in the permit applicant address. -
SubmitDate: string
(date-time)
Title:
Submission Date
Read Only:true
The date when the permit application was submitted. -
Url: string
Title:
URL
Read Only:true
The permit URL used within a communications template. -
UrlLabel: string
Title:
Communications URL Label
Read Only:true
The label displayed for a permit URL used within a communications template.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.