Get all validation groups
get
/fscmRestApi/resources/11.13.18.05/publicSectorValidationGroups
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 the validation group that matches the primary keys specified.
Finder Variables:- AgencyId; integer; The unique identifier for the agency.
- ValidationGroupId; string; The unique identifier for a validation group.
- simpleSearchFinder: Finds the validation group that matches the specified filter values.
Finder Variables:- value; string; The filter value to be applied when finding the validation group.
- PrimaryKey: Finds the validation group that matches the primary keys 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 for the agency.
- AllowOverrideFlag; string; Indicates whether the agency staff can override the application validation.
- AllowSubmitFlag; string; Indicates whether applicants can submit the application if requirements aren't met. The default is Y for yes.
- Description; string; The description of the validation group.
- EnabledFlag; string; Indicates whether the validation group is enabled or not. The default value is Y for yes.
- GroupName; string; The name of the validation group.
- ValidationGroupId; string; The unique identifier for a validation group.
- ValidationGroupUsage; string; Indicates the usage value for the validation group. Valid values are ORA_PERMIT, ORA_BL, ORA_PNZ.
- ValidationType; string; The type of validation. For example, contractor validation.
-
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:
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.
Root Schema : publicSectorValidationGroups
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 : publicSectorValidationGroups-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
Title:
Agency ID
Default Value:1
The unique identifier for the agency. -
AllowOverrideFlag: string
Title:
Agency staff can override
Maximum Length:1
Default Value:N
Indicates whether the agency staff can override the application validation. -
AllowSubmitFlag: string
Title:
Allow Application Submit
Maximum Length:1
Default Value:Y
Indicates whether applicants can submit the application if requirements aren't met. The default is Y for yes. -
Description: string
Title:
Description
Maximum Length:200
The description of the validation group. -
EnabledFlag: string
Title:
Enabled
Maximum Length:1
Default Value:Y
Indicates whether the validation group is enabled or not. The default value is Y for yes. -
GroupName: string
Title:
Group Name
Maximum Length:100
The name of the validation group. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ValidationGroupDetails: array
Validation Group Details
Title:
Validation Group Details
The validation group details resource is used to view, add, delete, and modify the validation options. -
ValidationGroupId: string
Title:
Group ID
Maximum Length:50
The unique identifier for a validation group. -
ValidationGroupUsage: string
Title:
Usage
Maximum Length:30
Indicates the usage value for the validation group. Valid values are ORA_PERMIT, ORA_BL, ORA_PNZ. -
ValidationType: string
Title:
Validation Type
Maximum Length:30
The type of validation. For example, contractor validation.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Validation Group Details
Type:
array
Title:
Validation Group Details
The validation group details resource is used to view, add, delete, and modify the validation options.
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.
Nested Schema : publicSectorValidationGroups-ValidationGroupDetails-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
Title:
Agency ID
Default Value:1
The unique identifier for the agency. -
ApplyValidation: string
Title:
Apply Validation
Maximum Length:30
Indicates whether the validation should be applied to all licenses or any license. -
EnabledFlag: string
Title:
Enabled
Maximum Length:1
Default Value:Y
Indicates whether the validation criteria are enabled. The default is Y for yes. -
GracePeriod: integer
(int64)
Title:
Grace Period
The grace period duration. -
GracePeriodUom: string
Title:
Grace Period UOM
Maximum Length:30
The unit of time of the grace period duration. -
LastUpdateDate: string
(date-time)
Title:
Last Updated
Read Only:true
The date and time when the row was last updated. -
LastUpdatedByName: string
Title:
Last Updated By
Read Only:true
The user who last updated the row. -
LicenseMustHave: string
Title:
License Requirements
Maximum Length:30
Indicates whether the contractor license must have all or at least one of the specified values. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ValidationGroupDetailValues: array
Validation Group Detail Values
Title:
Validation Group Detail Values
The validation group detail values resource is used to view, add, delete, and modify the validation values for validation options such as insurance. -
ValidationGroupDetailValueSets: array
Validation Group Detail Value Sets
Title:
Validation Group Detail Value Sets
Used to configure job cost and insurances that must be validated for license classifications and license types while submitting an application. -
ValidationGroupId: string
Title:
Group ID
Maximum Length:50
The unique identifier for a validation group. -
ValidationOption: string
Title:
Option
Maximum Length:30
Indicates the type of validation, such as the contractor license type or insurance.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Validation Group Detail Values
Type:
array
Title:
Validation Group Detail Values
The validation group detail values resource is used to view, add, delete, and modify the validation values for validation options such as insurance.
Show Source
Nested Schema : Validation Group Detail Value Sets
Type:
array
Title:
Validation Group Detail Value Sets
Used to configure job cost and insurances that must be validated for license classifications and license types while submitting an application.
Show Source
Nested Schema : publicSectorValidationGroups-ValidationGroupDetails-ValidationGroupDetailValues-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
Title:
Agency ID
Default Value:1
The unique identifier for the agency using the validation group. -
ApplyValidation: string
Title:
Apply Validation
Maximum Length:30
Indicates whether the validation should be applied to all licenses or any license. -
EnabledFlag: string
Title:
Enabled
Maximum Length:1
Default Value:Y
Indicates whether the validation criteria are enabled or not. The default value is Y for yes. -
ExpirationBasis: string
Title:
Expiration Basis
Maximum Length:30
The date that is the basis for the expiration rule. -
GracePeriod: integer
(int64)
Title:
Grace Period
The grace period duration. -
GracePeriodUom: string
Title:
Grace Period UOM
Maximum Length:30
The unit of time of the grace period duration. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ValidateExpFlag: string
Title:
Expiration Validation
Maximum Length:1
Default Value:N
Indicates whether the expiration must be validated. The default value is N for no. -
ValidationGroupId: string
Title:
Group ID
Maximum Length:50
The unique identifier for a validation group. -
ValidationOption: string
Title:
Option
Maximum Length:30
Indicates the type of validation, such as contractor license type or insurance. -
ValidationValue: string
Title:
Validation Criteria
Maximum Length:30
The contractor license criteria that must be validated.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorValidationGroups-ValidationGroupDetails-ValidationGroupDetailValueSets-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
Default Value:
1
Used to indicate agency ID. -
CurrencyCode: string
Maximum Length:
3
The currency used for the job cost. -
EnabledFlag: string
Maximum Length:
1
Default Value:N
Indicates whether the configuration row is enabled. Valid values are "Y" and "N". -
ExpirationBasis: string
Title:
Expiration Basis
Maximum Length:30
The date that is the basis for the insurance expiration rule. Valid values are ORA_EFFECTIVE_DATE for effective date, ORA_EXPIRATION_DATE for expiration date. -
GracePeriod: integer
(int64)
Title:
Grace Period
The number that indicates the grace period duration. -
GracePeriodUom: string
Title:
Grace Period UOM
Maximum Length:30
The grace period duration unit of measure. Valid values are ORA_DAYS for day, ORA_WEEKS for weeks , ORA_MONTHS for month, ORA_YEARS for years. -
JobCostOne: number
Title:
Job Cost One
The job cost or minimum value for a job cost range. -
JobCostTwo: number
Title:
Job Cost Two
The maximum value for a job cost range. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ValidateExpFlag: string
Title:
Expiration Validation
Maximum Length:1
Default Value:N
Indicates whether the insurance expiration must be validated. Valid values are "Y" and "N". -
ValidationDetType: string
Maximum Length:
30
The type of validation. It can be job cost or insurance. -
ValidationDetValue: string
Maximum Length:
30
The job cost type value or insurance type value. Valid values are ORA_BETWEEN, ORA_NOT_BETWEEN, ORA_LESS_THAN, ORA_LESS_THAN_EQUAL_TO, ORA_MORE_THAN, ORA_MORE_THAN_EQUAL_TO, ORA_NOT_APPLICABLE, ORA_NO_LIMIT. -
ValidationGroupId: string
Maximum Length:
50
A unique name that identifies a validation group. -
ValidationOption: string
Maximum Length:
30
Indicates the type of validation such as contractor license type or insurance. Valid values are ORA_CNT_INSURANCE, ORA_CNT_CLASSIFICATION, ORA_CNT_LICENSE_TYPE, ORA_CNT_EXPIRATION. -
ValidationValue: string
Maximum Length:
30
Indicates the contractor license criteria that must be validated. Valid value are license classification value or license type value or ORA_ALL.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source