Get all record type display groups
get
/fscmRestApi/resources/11.13.18.05/publicSectorDisplayGroups
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 a display group that matches the primary key criteria specified.
Finder Variables:- AgencyId; integer; The unique identifier for a public sector agency.
- DisplayGroup; string; The unique identifier for the record type display group.
- simpleSearchFinder: Finds a record type display group using the specified key criteria.
Finder Variables:- value; string; The key criteria used to find a display group or the description to find a record type display group.
- usePermitAndCitizenFinder: Finds a record type display group that matches the specified search criteria.
Finder Variables:- citizenEnabled; string; Indicates whether the record type of one display group is enabled for a public user to submit the application form.
- citizenEnabled2; string; Indicates whether the record type of one display group is enabled for a public user to submit the application form.
- citizenEnabled3; string; Indicates whether the record type of one display group is enabled for a public user to submit the application form.
- usePermit; string; Indicates whether the display group is used for the Permits service or not.
- PrimaryKey: Finds a display group that matches the primary key criteria specified.
-
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 unique identifier of a public sector agency.
- CreationDate; string; The date when the record type display group was created.
- Description; string; The short description of the record type display group.
- DisplayGroup; string; The unique identifier of the record type display group.
- EnabledFlag; boolean; Indicates whether the record type display group is available to be used or not. The default value is false.
- LastUpdateDate; string; The date when the record type display group was last updated.
- LongDescription; string; The long description of the record type display group.
- UseBusLicensing; string; Indicates whether the display group is used for the business licensing service or not. The default value is no.
- UsePermitting; string; Indicates whether the display group is used for the permits service or not. The default value is yes.
- UsePlanning; string; Indicates whether the display group is used for the planning and zoning service or not. The default value is no.
- UsePolLicensing; string; Indicates whether the display group is used for the professional licensing service or not. The default value is no.
-
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 : publicSectorDisplayGroups
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 : publicSectorDisplayGroups-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
Title:
Agency ID
Default Value:1
The unique identifier of a public sector agency. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the record type display group was created. -
Description: string
Title:
Display Group
Maximum Length:100
The short description of the record type display group. -
DisplayGroup: string
Title:
Display Group ID
Maximum Length:30
The unique identifier of the record type display group. -
DisplayGroupLine: array
Record Type Display Group lines
Title:
Record Type Display Group lines
The display group lines resource is used to view, create, modify, or delete a display group line. A record type display group line indicates a record type included within a display group. -
EnabledFlag: boolean
Title:
Enabled
Maximum Length:1
Indicates whether the record type display group is available to be used or not. The default value is false. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date when the record type display group was last updated. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LongDescription: string
Title:
Description
Maximum Length:1000
The long description of the record type display group. -
Url: string
Title:
URL
The URL provides a link that the user can click to navigate to other pages with more information. -
UseBusLicensing: string
Title:
Business Licenses
Maximum Length:1
Indicates whether the display group is used for the business licensing service or not. The default value is no. -
UsePermitting: string
Title:
Permits
Maximum Length:1
Indicates whether the display group is used for the permits service or not. The default value is yes. -
UsePlanning: string
Title:
Planning and Zoning
Maximum Length:1
Indicates whether the display group is used for the planning and zoning service or not. The default value is no. -
UsePolLicensing: string
Title:
Professional Licenses
Maximum Length:1
Indicates whether the display group is used for the professional licensing service or not. The default value is no.
Nested Schema : Record Type Display Group lines
Type:
array
Title:
Record Type Display Group lines
The display group lines resource is used to view, create, modify, or delete a display group line. A record type display group line indicates a record type included within a display group.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorDisplayGroups-DisplayGroupLine-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
Title:
Agency ID
Default Value:1
The unique identifier of a public sector agency. -
CitizenEnabled: string
Title:
Public User Enabled
Read Only:true
Maximum Length:1
Indicates whether the record type is enabled for the public user to submit the application form. The default value is not enabled for public users. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the record type display group line. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the record type display group line was created. -
Description: string
Title:
Description
Read Only:true
Maximum Length:1000
The long description for the record type included in the display group line. -
DisplayGroup: string
Title:
Display Group ID
Maximum Length:30
The display group to which the group line belongs. -
DisplayOrder: integer
(int64)
Title:
Display Order
The display number for the display group line. -
isRecordTypeActive: boolean
Read Only:
true
Indicates whether the record type is active or not. The default value is active. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date when the record type display group line was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the record type display group line. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
RecordType: string
Title:
Record Type
Read Only:true
Maximum Length:100
The display name for the record type included in the display group line. -
RecordTypeCode: string
Title:
Record Type Code
Maximum Length:20
The short name of the record type included in the display group line. -
RecordTypeId: string
Title:
Record Type ID
Maximum Length:30
The unique identifier of the record type included in the display group line. -
RecordTypeState: string
Read Only:
true
Maximum Length:10
Indicates the status of the record type. The default value is active. -
Url: string
Title:
URL
Read Only:true
The URL provides a link that the user can click to navigate to other pages with more information about 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.