Get an IVR record type
get
/fscmRestApi/resources/11.13.18.05/publicSectorIVRRecordTypes/{RecordTypeId}
Request
Path Parameters
-
RecordTypeId(required): string
The unique identifier for the record type.
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 : publicSectorIVRRecordTypes-item-response
Type:
Show Source
object
-
AgencyId: integer
Read Only:
true
The identifier for a public sector agency associated with the record type. -
ApplGroup: string
Read Only:
true
Maximum Length:30
The highest level of categorization to which the record type belongs. -
BillType: string
Read Only:
true
Maximum Length:15
The bill type associated with the record type. -
Category: string
Read Only:
true
Maximum Length:30
The record type category. -
CitizenEnabled: string
Read Only:
true
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: string
Read Only:
true
Maximum Length:3
The classification of the record type. -
DepartmentId: string
Read Only:
true
Maximum Length:30
The department associated with the record type. -
Description: string
Read Only:
true
Maximum Length:1000
The long description for the record type. -
DocGroupId: string
Read Only:
true
Maximum Length:30
Indicates the document group, which is defined by a set of attachment document categories. -
FeeScheduleId: string
Read Only:
true
Maximum Length:20
The identifier for the fee schedule associated with the record type. -
HearingOption: string
Read Only:
true
Maximum Length:10
Indicates whether a public hearing is applicable for the transaction type. -
InspectionGroup: string
Read Only:
true
Maximum Length:15
The group of inspections if multiple inspections are required for the record type. -
InspectionGroupAmend: string
Read Only:
true
Maximum Length:15
The group of inspections for business license amendments if multiple inspections are required for the record type. -
InspectionGroupRenew: string
Read Only:
true
Maximum Length:15
The group of inspections for business license renewals if multiple inspections are required for the record type. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LnpRecordId: string
Read Only:
true
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: integer
(int64)
Read Only:
true
The unique identifier for an application record. The record is for a permit, business license, professional license, or planning and zoning, and is determined by the classification. -
PlanReview: string
Read Only:
true
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: string
Read Only:
true
Maximum Length:100
The user-friendly name for the record type. -
RecordTypeCode: string
Read Only:
true
Maximum Length:20
The unique alphanumeric code or short name for the record type. -
RecordTypeId: string
Read Only:
true
Maximum Length:30
The unique identifier for the record type. -
RecordTypeState: string
Read Only:
true
Maximum Length:10
The status of the record type. The default value is preliminary. -
RenewalRuleId: string
Read Only:
true
Maximum Length:20
The rule used when renewing the record type. -
RuleId: string
Read Only:
true
Maximum Length:20
The autonumber rule used to create the identifier for record transactions. -
Subcategory: string
Read Only:
true
Maximum Length:30
The record type subcategory. -
Subclassification: string
Read Only:
true
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: string
Read Only:
true
Maximum Length:15
The terms and use ID associated with the record type. -
ValidFromDate: string
(date)
Read Only:
true
The date when the record type is valid to use. -
ValidToDate: string
(date)
Read Only:
true
The date when the record type is no longer valid to use.
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.