Get all record types
get
/fscmRestApi/resources/11.13.18.05/publicSectorRecordTypePrompts
Request
Query Parameters
-
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 -
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 all the related transactions that match the Record Type identifier.
Finder Variables:- RecordTypeId; string; The unique identifier of the record type.
- PrimaryKey: Finds all the related transactions that match the Record Type identifier.
-
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.
-
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 -
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 fields. 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
You can use these queryable attributes to filter this collection resource using the q query parameter:- AgencyId; integer; The identifier of the agency.
- ApplGroup; string; The application group of the permit, planning application, or business license type.
- Applgroupdescription; string; The description of the permit, planning application, or business license type application group.
- BillType; string; The bill type for the permit, planning application, or business license type.
- Category; string; The category of the permit, planning application, or business license type.
- Categorydescription; string; The description of the permit, planning application, or business license type category.
- CitizenEnabled; string; A flag to determine whether permit, planning application, or business license type is enabled for public users.
- Classification; string; The classification of record type like PMT, PZ or LIC.
- DepartmentId; string; The department of the permit, planning application, or business license type.
- DocGroupId; string; The document group of the permit, planning application, or business license type.
- FeeScheduleId; string; The fee schedule of the permit, planning application, or business license type.
- HearingOption; string; A flag to determine whether Hearing is enabled for the pre-application type.
- InspectionGroup; string; The inspection group of the permit, planning application, or business license origination type.
- InspectionGroupAmend; string; The group of inspections for business license amendments.
- InspectionGroupRenew; string; The group of inspections for business license renewals.
- Meaning; string; The description of permit, planning application, or business license type.
- PlanReview; string; The plan review type of the permit, planning application, or business license type.
- RecordType; string; The name of the permit, planning application, or business license application type.
- RecordTypeCode; string; The code of the permit, planning application, or business license application type.
- RecordTypeId; string; The unique identifier of the Permit, Planning application, or Business License application type.
- RecordTypeState; string; The status of the permit, planning application, or business license application type such as Preliminary, Ready, or Void.
- RenewalRuleId; string; The renewal rule defined for the permit, planning application, or business license application type.
- RuleId; string; The autonumber rule defined for the permit, planning application, or business license application type.
- Subcategory; string; The subcategory of the permit, planning application, or business license type.
- Subcategorydescription; string; The description of the permit, planning application, or business license type subcategory.
- Subclassification; string; The subclassification of the record type such as Pre-Application or Consultation.
- TermsUseId; string; The terms of use defined for the permit, planning application, or business license type.
- ValidFromDate; string; The valid from date of the permit, planning application, or business license type.
- ValidToDate; string; The valid to date of the permit, planning application, or business license type.
-
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".
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 : publicSectorRecordTypePrompts
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
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: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorRecordTypePrompts-item-response
Type:
Show Source
object
-
AgencyId: integer
Read Only:
true
The identifier of the agency. -
ApplGroup: string
Title:
Permit Group
Read Only:true
Maximum Length:30
The application group of the permit, planning application, or business license type. -
Applgroupdescription: string
Read Only:
true
Maximum Length:100
The description of the permit, planning application, or business license type application group. -
BillType: string
Read Only:
true
Maximum Length:15
The bill type for the permit, planning application, or business license type. -
Category: string
Read Only:
true
Maximum Length:30
The category of the permit, planning application, or business license type. -
Categorydescription: string
Read Only:
true
Maximum Length:100
The description of the permit, planning application, or business license type category. -
CitizenEnabled: string
Read Only:
true
Maximum Length:1
A flag to determine whether permit, planning application, or business license type is enabled for public users. -
Classification: string
Title:
Classification
Read Only:true
Maximum Length:3
The classification of record type like PMT, PZ or LIC. -
DepartmentId: string
Read Only:
true
Maximum Length:30
The department of the permit, planning application, or business license type. -
DocGroupId: string
Read Only:
true
Maximum Length:30
The document group of the permit, planning application, or business license type. -
FeeScheduleId: string
Read Only:
true
Maximum Length:20
The fee schedule of the permit, planning application, or business license type. -
HearingOption: string
Read Only:
true
Maximum Length:10
A flag to determine whether Hearing is enabled for the pre-application type. -
InspectionGroup: string
Read Only:
true
Maximum Length:15
The inspection group of the permit, planning application, or business license origination type. -
InspectionGroupAmend: string
Read Only:
true
Maximum Length:15
The group of inspections for business license amendments. -
InspectionGroupRenew: string
Read Only:
true
Maximum Length:15
The group of inspections for business license renewals. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Meaning: string
Read Only:
true
Maximum Length:80
The description of permit, planning application, or business license type. -
PlanReview: string
Read Only:
true
Maximum Length:10
The plan review type of the permit, planning application, or business license type. -
RecordType: string
Title:
Record Type
Read Only:true
Maximum Length:100
The name of the permit, planning application, or business license application type. -
RecordTypeCode: string
Title:
Original Permit Type Code
Read Only:true
Maximum Length:20
The code of the permit, planning application, or business license application type. -
RecordTypeId: string
Title:
Record Type ID
Read Only:true
Maximum Length:30
The unique identifier of the Permit, Planning application, or Business License application type. -
RecordTypeState: string
Read Only:
true
Maximum Length:10
The status of the permit, planning application, or business license application type such as Preliminary, Ready, or Void. -
RenewalRuleId: string
Read Only:
true
Maximum Length:20
The renewal rule defined for the permit, planning application, or business license application type. -
RuleId: string
Read Only:
true
Maximum Length:20
The autonumber rule defined for the permit, planning application, or business license application type. -
Subcategory: string
Read Only:
true
Maximum Length:30
The subcategory of the permit, planning application, or business license type. -
Subcategorydescription: string
Read Only:
true
Maximum Length:100
The description of the permit, planning application, or business license type subcategory. -
Subclassification: string
Read Only:
true
Maximum Length:10
The subclassification of the record type such as Pre-Application or Consultation. -
TermsUseId: string
Read Only:
true
Maximum Length:15
The terms of use defined for the permit, planning application, or business license type. -
ValidFromDate: string
(date)
Read Only:
true
The valid from date of the permit, planning application, or business license type. -
ValidToDate: string
(date)
Read Only:
true
The valid to date of the permit, planning application, or business license type.
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.