Get an IVR record type
get
/fscmRestApi/resources/11.13.18.05/publicSectorIVRRecordTypes/{RecordTypeId}
Request
Path Parameters
-
RecordTypeId: string
The unique identifier for the record type.
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 : publicSectorIVRRecordTypes-item
Type:
Show Source
object
-
AgencyId(optional):
integer(int64)
The identifier for a public sector agency associated with the record type.
-
ApplGroup(optional):
string
Maximum Length:
30
The highest level of categorization to which the record type belongs. -
BillType(optional):
string
Maximum Length:
15
The bill type associated with the record type. -
Category(optional):
string
Maximum Length:
30
The record type category. -
CitizenEnabled(optional):
string
Maximum Length:
1
Indicates whether public users can submit an application form with this record type. The default value is not enabled for public users. -
Classification(optional):
string
Maximum Length:
3
The classification of the record type. -
DepartmentId(optional):
string
Maximum Length:
30
The department associated with the record type. -
Description(optional):
string
Maximum Length:
1000
The long description for the record type. -
DocGroupId(optional):
string
Maximum Length:
30
Indicates the document group, which is defined by a set of attachment document categories. -
FeeScheduleId(optional):
string
Maximum Length:
20
The identifier for the fee schedule associated with the record type. -
HearingOption(optional):
string
Maximum Length:
10
Indicates whether a public hearing is applicable for the transaction type. -
InspectionGroup(optional):
string
Maximum Length:
15
The group of inspections if multiple inspections are required for the record type. -
links(optional):
array Items
Title:
Items
Link Relations -
LnpRecordId(optional):
string
Maximum Length:
50
The unique identifier for an application record. This identifier is automatically generated based on the rules configured for the record type. -
LnpRecordKey(optional):
integer(int64)
The unique identifier for a record. The record is for a permit, business license, professional license, or planning and zoning, and is determined by the classification.
-
PlanReview(optional):
string
Maximum Length:
10
Indicates the type of plan review that can be created for the transaction type.The plan review type can be manual or electronic document review. -
RecordType(optional):
string
Maximum Length:
100
The user-friendly name for the record type. -
RecordTypeCode(optional):
string
Maximum Length:
20
The unique alphanumeric code or short name for the record type. -
RecordTypeId(optional):
string
Maximum Length:
30
The unique identifier for the record type. -
RecordTypeState(optional):
string
Maximum Length:
10
The status of the record type. The default value is preliminary. -
RenewalRuleId(optional):
string
Maximum Length:
20
The rule used when renewing the record type. -
RuleId(optional):
string
Maximum Length:
20
The autonumber rule used to create the identifier for record transactions. -
Subcategory(optional):
string
Maximum Length:
30
The record type subcategory. -
Subclassification(optional):
string
Maximum Length:
10
The subclassification for the transaction type, which indicates that the pre-application process is included in addition to the hearing process. -
TermsUseId(optional):
string
Maximum Length:
15
The terms and use ID associated with the record type. -
ValidFromDate(optional):
string(date)
The date when the record type is valid to use.
-
ValidToDate(optional):
string(date)
The date when the record type is no longer valid to use.
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.