Get all contractor validation options
get
/fscmRestApi/resources/11.13.18.05/publicSectorContractorOptions
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 contractor validation option that matches the primary keys specified.
Finder Variables:- AgencyId; integer; The agency ID for a contractor validation option.
- LicenseSetupCode; string; The license setup code for a contractor validation option.
- simpleSearchFinder: Finds the contractor validation option that matches the specified filter values.
Finder Variables:- value; string; The filter value to be applied when finding the contractor validation option. Filtering options include Setup Code and Description.
- PrimaryKey: Finds the contractor validation option 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 identifier for the agency that is maintaining contractor license validation.
- Description; string; Descriptive statement about the set of configuration options.
- DocGroupId; string; The identifier of the document group for the contractor license attachments.
- IntegrationEnabled; string; Indicates whether a set of contractor license configuration options includes integration with external source.
- LicenseSetupCode; string; The code that identifies a set of configuration options for validating contractor licenses. For example, a code might represent configuration options that include integration with the state licensing board in California.
- LimitLicenseUsage; string; A user can select licenses in an application where the user is an active contact for the license in the agency records.
- SelectFacts; string; Indicates whether detail sections should be included when contractor license information is displayed.
- SetupEnabled; string; Indicates whether a set of contractor license configuration options is enabled or disabled. Only one set of configuration options can be enabled at a time.
- UseClassifications; string; Indicates whether classifications should be included when contractor license information is displayed.
- UseContractorList; string; Indicates that the user can only select a license for a contractor included in agency's list when filling in the intake form. The default value is N.
- UseLicenseType; string; Indicates whether license types should be included when contractor license information is displayed.
- UseStatusMapping; string; Indicates whether contractor license external status to internal status mapping is needed.
-
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 : publicSectorContractorOptions
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 : publicSectorContractorOptions-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
Default Value:
1
The identifier for the agency that is maintaining contractor license validation. -
ContractorOptionClassifications: array
Contractor Option Classifications
Title:
Contractor Option Classifications
The contractor option classifications resource is used to view, add, delete, and modify contractor license classifications. -
ContractorOptionFacts: array
Contractor Option Facts
Title:
Contractor Option Facts
The contractor option facts resource is used to view, add, delete, and modify contractor license options that control which license information sections are enabled. -
ContractorOptionInsuranceTypes: array
Contractor Option Insurance Types
Title:
Contractor Option Insurance Types
The contractor option insurance types resource is used to view, add, delete, and modify contractor license insurance types. -
ContractorOptionIntegrations: array
Contractor Option Integrations
Title:
Contractor Option Integrations
The contractor option integrations resource is used to view, add, delete, and modify integration to an external source that validates contractor license information. -
ContractorOptionLicenseTypes: array
Contractor Option License Types
Title:
Contractor Option License Types
The contractor option license types resource is used to view, add, delete, and modify contractor license types. -
ContractorOptionOwnershipTypes: array
Contractor Option Ownership Types
Title:
Contractor Option Ownership Types
The contractor option ownership types resource is used to view, add, delete, and modify contractor license ownership types. -
ContractorOptionStatusMappings: array
Contractor Option Status Mappings
Title:
Contractor Option Status Mappings
The contractor option status mappings resource is used to view, add, delete, and modify contractor validation status mappings. -
Description: string
Title:
Description
Maximum Length:100
Descriptive statement about the set of configuration options. -
DocGroupId: string
Maximum Length:
30
The identifier of the document group for the contractor license attachments. -
IntegrationEnabled: string
Title:
Integrated with External Source
Maximum Length:1
Indicates whether a set of contractor license configuration options includes integration with external source. -
LicenseSetupCode: string
Title:
Code
Maximum Length:30
The code that identifies a set of configuration options for validating contractor licenses. For example, a code might represent configuration options that include integration with the state licensing board in California. -
LimitLicenseUsage: string
Maximum Length:
1
A user can select licenses in an application where the user is an active contact for the license in the agency records. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
SelectFacts: string
Title:
Choose Sections to Display
Maximum Length:1
Default Value:N
Indicates whether detail sections should be included when contractor license information is displayed. -
SetupEnabled: string
Title:
Setup Enabled
Maximum Length:1
Indicates whether a set of contractor license configuration options is enabled or disabled. Only one set of configuration options can be enabled at a time. -
UseClassifications: string
Title:
Use License Classifications
Maximum Length:1
Default Value:N
Indicates whether classifications should be included when contractor license information is displayed. -
UseContractorList: string
Title:
Limit to Contractor List
Maximum Length:1
Default Value:N
Indicates that the user can only select a license for a contractor included in agency's list when filling in the intake form. The default value is N. -
UseLicenseType: string
Title:
Select License Type
Maximum Length:1
Default Value:N
Indicates whether license types should be included when contractor license information is displayed. -
UseStatusMapping: string
Title:
Use Status Rules
Maximum Length:1
Default Value:N
Indicates whether contractor license external status to internal status mapping is needed.
Nested Schema : Contractor Option Classifications
Type:
array
Title:
Contractor Option Classifications
The contractor option classifications resource is used to view, add, delete, and modify contractor license classifications.
Show Source
Nested Schema : Contractor Option Facts
Type:
array
Title:
Contractor Option Facts
The contractor option facts resource is used to view, add, delete, and modify contractor license options that control which license information sections are enabled.
Show Source
Nested Schema : Contractor Option Insurance Types
Type:
array
Title:
Contractor Option Insurance Types
The contractor option insurance types resource is used to view, add, delete, and modify contractor license insurance types.
Show Source
Nested Schema : Contractor Option Integrations
Type:
array
Title:
Contractor Option Integrations
The contractor option integrations resource is used to view, add, delete, and modify integration to an external source that validates contractor license information.
Show Source
Nested Schema : Contractor Option License Types
Type:
array
Title:
Contractor Option License Types
The contractor option license types resource is used to view, add, delete, and modify contractor license types.
Show Source
Nested Schema : Contractor Option Ownership Types
Type:
array
Title:
Contractor Option Ownership Types
The contractor option ownership types resource is used to view, add, delete, and modify contractor license ownership types.
Show Source
Nested Schema : Contractor Option Status Mappings
Type:
array
Title:
Contractor Option Status Mappings
The contractor option status mappings resource is used to view, add, delete, and modify contractor validation status mappings.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorContractorOptions-ContractorOptionClassifications-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
Identifier for the agency that is maintaining contractor license information.
-
Description: string
Title:
Description
Maximum Length:100
Contractor license classification description for the classification section in a set of contractor options. -
Enabled: string
Title:
Enabled
Maximum Length:1
Indicates whether a specific contractor license classification is available to be shown when a contractor license information is displayed. -
LicClassification: string
Title:
Code
Maximum Length:30
Contractor license classification code for the classification section in a set of contractor options. -
LicenseSetupCode: string
Maximum Length:
20
Code that identifies a set of configuration options for contractor licenses. For example, a code might represent configuration options that include integration with the state licensing board in California. -
links: array
Links
Title:
Links
The link relations associated with the resource instance.
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.
Nested Schema : publicSectorContractorOptions-ContractorOptionFacts-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
Default Value:
1
Identifier for the agency that is maintaining contractor license information. -
Description: string
Read Only:
true
The description of a specific contractor license detail within a detail section. -
FactSection: string
Title:
Section
Maximum Length:30
The type of detail record for the contractor data. For example, contractor information for a specific state might include sections for license classifications. -
LicenseSetupCode: string
Maximum Length:
30
Code that identifies a set of configuration options for contractor licenses. For example, a code might represent configuration options that include integration with the state licensing board in California. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
SectionEnabled: string
Title:
Enabled
Maximum Length:1
Indicates whether a specific detail section should be included when contractor license information is displayed.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorContractorOptions-ContractorOptionInsuranceTypes-item-response
Type:
Show Source
object
-
AgencyId: string
Maximum Length:
8
The identifier for the agency that is maintaining contractor license information. -
Description: string
Title:
Description
Maximum Length:100
The description for the type of insurance associated with a contractor license. -
Enabled: string
Title:
Enabled
Maximum Length:1
The status for the insurance type that indicates whether the insurance type is active or inactive. -
InsuranceType: string
Title:
Insurance Type
Maximum Length:30
The code for the type of insurance associated with a contractor license. -
LicenseSetupCode: string
Maximum Length:
30
The code that identifies a set of configuration options for contractor licenses. For example, a code might represent configuration options that include integration with the state licensing board in California. -
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorContractorOptions-ContractorOptionIntegrations-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
Identifier for the agency that is maintaining contractor license information.
-
IntegrationEnabled: string
Title:
Integration Enabled
Maximum Length:1
Indicates whether a specific named contractor license integration is active. -
IntegrationKey: string
Title:
Key
Maximum Length:100
The integration source key that some external sites require for contractor license integration. -
IntegrationName: string
Title:
Integration Name
Maximum Length:1000
Name of an integration that maps contractor license information to the corresponding license information from an external site. -
IntegrationParameter: string
Title:
Integration Parameter
Maximum Length:100
Name of the query parameter that needs to be added to the integration end point. -
IntegrationType: string
Title:
Type
Maximum Length:30
Identifies the type of integration such as online or batch. -
IntegrationVersion: string
Title:
Integration Version
Maximum Length:50
Version number of the integration that maps contractor license information to the corresponding license information from an external site. -
LicenseSetupCode: string
Maximum Length:
30
Code that identifies a set of configuration options for contractor licenses. For example, a code might represent configuration options that include integration with the state licensing board in California. -
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorContractorOptions-ContractorOptionLicenseTypes-item-response
Type:
Show Source
object
-
AgencyId: string
Maximum Length:
8
Identifier for the agency that is maintaining contractor license information. -
Description: string
Title:
Description
Maximum Length:100
Descriptive statement about the license type. -
Enabled: string
Title:
Enabled
Maximum Length:1
Status of the license type that indicates if the license type is active or inactive. -
LicenseSetupCode: string
Maximum Length:
30
Code that identifies a set of configuration options for contractor licenses. For example, a code might represent configuration options that include integration with the state licensing board in California. -
LicType: string
Title:
License Type
Maximum Length:30
Identifies the type of contractor license. -
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorContractorOptions-ContractorOptionOwnershipTypes-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
The identifier for the agency that is maintaining license validation.
-
Description: string
Title:
Description
Maximum Length:100
The description for the ownership type associated with a contractor license. -
Enabled: string
Title:
Enabled
Maximum Length:1
The status for the ownership type that indicates whether the insurance type is active or inactive. -
LicenseSetupCode: string
Maximum Length:
30
The code that identifies a set of configuration options for contractor licenses. For example, a code might represent configuration options that include integration with the state licensing board in California. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OwnershipType: string
Title:
Ownership Type
Maximum Length:15
The code for the ownership type associated with a contractor license.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorContractorOptions-ContractorOptionStatusMappings-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
Identifier for the agency that is maintaining contractor license information.
-
DeclineApplication: string
Title:
Decline Application
Maximum Length:1
Indicates if applications that are associated with the specified contractor license status should be declined. -
Enabled: string
Title:
Enabled
Maximum Length:1
Status of the mapping that indicates if the mapping is active or inactive. -
InternalStatus: string
Title:
Status
Maximum Length:30
The agency-assigned status for a contractor license that corresponds to the status assigned by the third-party licensing body. -
LicenseSetupCode: string
Maximum Length:
30
Code that identifies a set of configuration options for contractor licenses. For example, a code might represent configuration options that include integration with the state licensing board in California. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
SourceStatus: string
Title:
Source Status
Maximum Length:100
Contractor license status that is assigned by a third party licensing body.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source