Get all validation group details

get

/fscmRestApi/resources/11.13.18.05/publicSectorValidationGroupDetails

Request

Query Parameters
  • 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).
  • 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
  • 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 details that match the primary keys specified.
      Finder Variables:
      • AgencyId; integer; The unique identifier for the agency.
      • ValidationGroupId; string; The unique identifier for a validation group.
      • ValidationOption; string; Indicates the type of validation, such as contractor license type or insurance.
  • 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.
  • 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
  • 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.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • 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
  • 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.
    • ApplyValidation; string; Indicates whether the validation should be applied to all licenses or any license.
    • EnabledFlag; string; Indicates whether the validation criteria are enabled. The default is Y for yes.
    • GracePeriod; integer; The grace period duration.
    • GracePeriodUom; string; The unit of time of the grace period duration.
    • LastUpdateDate; string; The date and time when the row was last updated.
    • LicenseMustHave; string; Indicates whether the contractor license must have all or at least one of the specified values.
    • ValidationGroupId; string; The unique identifier for a validation group.
    • ValidationOption; string; Indicates the type of validation, such as the contractor license type or insurance.
  • 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
  • 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".
  • 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 Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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.
Body ()
Root Schema : publicSectorValidationGroupDetails
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : publicSectorValidationGroupDetails-item-response
Type: object
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
The validation group detail value sets is used to view, add, delete, and modify the job cost and insurances that must be validated for the license classifications and license types.
Show Source
Nested Schema : publicSectorValidationGroupDetails-ValidationGroupDetailValues-item-response
Type: object
Show Source
  • Title: Agency ID
    Default Value: 1
    The unique identifier for the agency using the validation group.
  • Title: Apply Validation
    Maximum Length: 30
    Indicates whether the validation should be applied to all licenses or any license.
  • Title: Enabled
    Maximum Length: 1
    Default Value: Y
    Indicates whether the validation criteria are enabled or not. The default value is Y for yes.
  • Title: Expiration Basis
    Maximum Length: 30
    The date that is the basis for the expiration rule.
  • Title: Grace Period
    The grace period duration.
  • Title: Grace Period UOM
    Maximum Length: 30
    The unit of time of the grace period duration.
  • Links
  • Title: Expiration Validation
    Maximum Length: 1
    Default Value: N
    Indicates whether the expiration must be validated. The default value is N for no.
  • Title: Group ID
    Maximum Length: 50
    The unique identifier for a validation group.
  • Title: Option
    Maximum Length: 30
    Indicates the type of validation, such as contractor license type or insurance.
  • Title: Validation Criteria
    Maximum Length: 30
    The contractor license criteria that must be validated.
Nested Schema : publicSectorValidationGroupDetails-ValidationGroupDetailValueSets-item-response
Type: object
Show Source
  • Default Value: 1
    The agency identifier.
  • Maximum Length: 3
    The currency used for the job cost.
  • Maximum Length: 1
    Default Value: N
    Indicates whether the configuration row is enabled. Valid values are "Y" and "N".
  • 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.
  • Title: Grace Period
    The number indicating the grace period duration.
  • 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.
  • Title: Job Cost One
    The job cost or minimum value for a job cost range.
  • Title: Job Cost Two
    The maximum value for a job cost range.
  • Links
  • Title: Expiration Validation
    Maximum Length: 1
    Default Value: N
    Indicates whether the insurance expiration needs to be validated. Valid values are "Y" and "N".
  • Maximum Length: 30
    The type of validation. It can be job cost or insurance.
  • 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.
  • Maximum Length: 50
    A unique name that identifies a validation group.
  • 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.
  • 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.
Back to Top