Jump to

• Request
• Response

Get all contractor validation options

get

/fscmRestApi/resources/11.13.18.05/publicSectorContractorOptions

Request

Query Parameters

• dependency: string
  This parameter specifies dependencies which are attributes that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The attributes specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the attributes will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency attributes. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• 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 attributes. Only the specified attributes are returned, which means that if no attributes are specified, no attributes 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 attributes. 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:
  
  

  • 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. Finder Variables:
    • AgencyId; integer; The agency ID for a contractor validation option.
    • LicenseSetupCode; string; The license setup code for a contractor validation option.
• 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.
• 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 attributes. 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
• 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".

Back to Top

Response

Supported Media Types

• application/vnd.oracle.adf.resourcecollection+json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : publicSectorContractorOptions

Type: object

Show Source

• count(optional): integer
  Title: Count

  The number of resource instances returned in the current range.
• hasMore(optional): boolean
  Title: HasMore

  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(optional): array Items
  Title: Items

  The items in the collection.
• limit(optional): integer
  Title: Limit

  The actual paging size used by the server.
• links(optional): array Items
  Title: Items

  The link relations associated with the resource instance.
• offset(optional): integer
  Title: Offset

  The offset value used in the current page.

{
    "properties":{
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range.",
            "title":"Count"
        },
        "hasMore":{
            "type":"boolean",
            "description":"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.",
            "title":"HasMore"
        },
        "items":{
            "items":{
                "$ref":"#/definitions/publicSectorContractorOptions-item"
            },
            "type":"array",
            "description":"The items in the collection.",
            "title":"Items"
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server.",
            "title":"Limit"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "title":"Items"
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page.",
            "title":"Offset"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object publicSectorContractorOptions-item

{
    "items":{
        "$ref":"#/definitions/publicSectorContractorOptions-item"
    },
    "type":"array",
    "description":"The items in the collection.",
    "title":"Items"
}

Nested Schema : Items

Type: array

Title: Items

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "title":"Items"
}

Nested Schema : publicSectorContractorOptions-item

Type: object

Show Source

• AgencyId(optional): integer(int32)
  The identifier for the agency that is maintaining contractor license validation.
• ContractorOptionClassifications(optional): 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(optional): 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(optional): 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(optional): 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(optional): 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(optional): 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(optional): 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(optional): string
  Maximum Length: 100

  Descriptive statement about the set of configuration options.
• IntegrationEnabled(optional): string
  Maximum Length: 1

  Indicates whether a set of contractor license configuration options includes integration with external source.
• LicenseSetupCode(optional): string
  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.
• links(optional): array Items
  Title: Items

  Link Relations
• SelectFacts(optional): string
  Maximum Length: 1

  Indicates whether detail sections should be included when contractor license information is displayed.
• SetupEnabled(optional): string
  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(optional): string
  Maximum Length: 1

  Indicates whether classifications should be included when contractor license information is displayed.
• UseContractorList(optional): string
  Maximum Length: 1

  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(optional): string
  Maximum Length: 1

  Indicates whether license types should be included when contractor license information is displayed.
• UseStatusMapping(optional): string
  Maximum Length: 1

  Indicates whether contractor license external status to internal status mapping is needed.

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The identifier for the agency that is maintaining contractor license validation."
        },
        "ContractorOptionClassifications":{
            "items":{
                "$ref":"#/definitions/publicSectorContractorOptions-ContractorOptionClassifications-item"
            },
            "type":"array",
            "description":"The contractor option classifications resource is used to view, add, delete, and modify contractor license classifications.",
            "title":"Contractor Option Classifications"
        },
        "ContractorOptionFacts":{
            "items":{
                "$ref":"#/definitions/publicSectorContractorOptions-ContractorOptionFacts-item"
            },
            "type":"array",
            "description":"The contractor option facts resource is used to view, add, delete, and modify contractor license options that control which license information sections are enabled.",
            "title":"Contractor Option Facts"
        },
        "ContractorOptionInsuranceTypes":{
            "items":{
                "$ref":"#/definitions/publicSectorContractorOptions-ContractorOptionInsuranceTypes-item"
            },
            "type":"array",
            "description":"The contractor option insurance types resource is used to view, add, delete, and modify contractor license insurance types.",
            "title":"Contractor Option Insurance Types"
        },
        "ContractorOptionIntegrations":{
            "items":{
                "$ref":"#/definitions/publicSectorContractorOptions-ContractorOptionIntegrations-item"
            },
            "type":"array",
            "description":"The contractor option integrations resource is used to view, add, delete, and modify integration to an external source that validates contractor license information.",
            "title":"Contractor Option Integrations"
        },
        "ContractorOptionLicenseTypes":{
            "items":{
                "$ref":"#/definitions/publicSectorContractorOptions-ContractorOptionLicenseTypes-item"
            },
            "type":"array",
            "description":"The contractor option license types resource is used to view, add, delete, and modify contractor license types.",
            "title":"Contractor Option License Types"
        },
        "ContractorOptionOwnershipTypes":{
            "items":{
                "$ref":"#/definitions/publicSectorContractorOptions-ContractorOptionOwnershipTypes-item"
            },
            "type":"array",
            "description":"The contractor option ownership types resource is used to view, add, delete, and modify contractor license ownership types.",
            "title":"Contractor Option Ownership Types"
        },
        "ContractorOptionStatusMappings":{
            "items":{
                "$ref":"#/definitions/publicSectorContractorOptions-ContractorOptionStatusMappings-item"
            },
            "type":"array",
            "description":"The contractor option status mappings resource is used to view, add, delete, and modify contractor validation status mappings.",
            "title":"Contractor Option Status Mappings"
        },
        "Description":{
            "maxLength":100,
            "type":"string",
            "description":"Descriptive statement about the set of configuration options."
        },
        "IntegrationEnabled":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether a set of contractor license configuration options includes integration with external source."
        },
        "LicenseSetupCode":{
            "maxLength":30,
            "type":"string",
            "description":"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."
        },
        "SelectFacts":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether detail sections should be included when contractor license information is displayed."
        },
        "SetupEnabled":{
            "maxLength":1,
            "type":"string",
            "description":"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":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether classifications should be included when contractor license information is displayed."
        },
        "UseContractorList":{
            "maxLength":1,
            "type":"string",
            "description":"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":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether license types should be included when contractor license information is displayed."
        },
        "UseStatusMapping":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether contractor license external status to internal status mapping is needed."
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

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

• Array of: object publicSectorContractorOptions-ContractorOptionClassifications-item

{
    "items":{
        "$ref":"#/definitions/publicSectorContractorOptions-ContractorOptionClassifications-item"
    },
    "type":"array",
    "description":"The contractor option classifications resource is used to view, add, delete, and modify contractor license classifications.",
    "title":"Contractor Option Classifications"
}

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

• Array of: object publicSectorContractorOptions-ContractorOptionFacts-item

{
    "items":{
        "$ref":"#/definitions/publicSectorContractorOptions-ContractorOptionFacts-item"
    },
    "type":"array",
    "description":"The contractor option facts resource is used to view, add, delete, and modify contractor license options that control which license information sections are enabled.",
    "title":"Contractor Option Facts"
}

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

• Array of: object publicSectorContractorOptions-ContractorOptionInsuranceTypes-item

{
    "items":{
        "$ref":"#/definitions/publicSectorContractorOptions-ContractorOptionInsuranceTypes-item"
    },
    "type":"array",
    "description":"The contractor option insurance types resource is used to view, add, delete, and modify contractor license insurance types.",
    "title":"Contractor Option Insurance Types"
}

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

• Array of: object publicSectorContractorOptions-ContractorOptionIntegrations-item

{
    "items":{
        "$ref":"#/definitions/publicSectorContractorOptions-ContractorOptionIntegrations-item"
    },
    "type":"array",
    "description":"The contractor option integrations resource is used to view, add, delete, and modify integration to an external source that validates contractor license information.",
    "title":"Contractor Option Integrations"
}

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

• Array of: object publicSectorContractorOptions-ContractorOptionLicenseTypes-item

{
    "items":{
        "$ref":"#/definitions/publicSectorContractorOptions-ContractorOptionLicenseTypes-item"
    },
    "type":"array",
    "description":"The contractor option license types resource is used to view, add, delete, and modify contractor license types.",
    "title":"Contractor Option License Types"
}

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

• Array of: object publicSectorContractorOptions-ContractorOptionOwnershipTypes-item

{
    "items":{
        "$ref":"#/definitions/publicSectorContractorOptions-ContractorOptionOwnershipTypes-item"
    },
    "type":"array",
    "description":"The contractor option ownership types resource is used to view, add, delete, and modify contractor license ownership types.",
    "title":"Contractor Option Ownership Types"
}

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

• Array of: object publicSectorContractorOptions-ContractorOptionStatusMappings-item

{
    "items":{
        "$ref":"#/definitions/publicSectorContractorOptions-ContractorOptionStatusMappings-item"
    },
    "type":"array",
    "description":"The contractor option status mappings resource is used to view, add, delete, and modify contractor validation status mappings.",
    "title":"Contractor Option Status Mappings"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : publicSectorContractorOptions-ContractorOptionClassifications-item

Type: object

Show Source

• AgencyId(optional): integer(int32)
  Identifier for the agency that is maintaining contractor license information.
• Description(optional): string
  Maximum Length: 100

  Contractor license classification description for the classification section in a set of contractor options.
• Enabled(optional): string
  Maximum Length: 1

  Indicates whether a specific contractor license classification is available to be shown when a contractor license information is displayed.
• LicClassification(optional): string
  Maximum Length: 30

  Contractor license classification code for the classification section in a set of contractor options.
• LicenseSetupCode(optional): 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(optional): array Items
  Title: Items

  Link Relations

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"Identifier for the agency that is maintaining contractor license information."
        },
        "Description":{
            "maxLength":100,
            "type":"string",
            "description":"Contractor license classification description for the classification section in a set of contractor options."
        },
        "Enabled":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether a specific contractor license classification is available to be shown when a contractor license information is displayed."
        },
        "LicClassification":{
            "maxLength":30,
            "type":"string",
            "description":"Contractor license classification code for the classification section in a set of contractor options."
        },
        "LicenseSetupCode":{
            "maxLength":20,
            "type":"string",
            "description":"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":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : link

Type: object

Show Source

• href(optional): string
  Title: hyperlink reference

  The URI to the related resource.
• rel(optional): string
  Title: relation

  The name of the relation to the resource instance. Example: self.

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Nested Schema : publicSectorContractorOptions-ContractorOptionFacts-item

Type: object

Show Source

• AgencyId(optional): integer(int32)
  Identifier for the agency that is maintaining contractor license information.
• Description(optional): string
  The description of a specific contractor license detail within a detail section.
• FactSection(optional): string
  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(optional): 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(optional): array Items
  Title: Items

  Link Relations
• SectionEnabled(optional): string
  Maximum Length: 1

  Indicates whether a specific detail section should be included when contractor license information is displayed.

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"Identifier for the agency that is maintaining contractor license information."
        },
        "Description":{
            "type":"string",
            "description":"The description of a specific contractor license detail within a detail section."
        },
        "FactSection":{
            "maxLength":30,
            "type":"string",
            "description":"The type of detail record for the contractor data. For example, contractor information for a specific state might include sections for license classifications."
        },
        "LicenseSetupCode":{
            "maxLength":30,
            "type":"string",
            "description":"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."
        },
        "SectionEnabled":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether a specific detail section should be included when contractor license information is displayed."
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : publicSectorContractorOptions-ContractorOptionInsuranceTypes-item

Type: object

Show Source

• AgencyId(optional): string
  Maximum Length: 8

  The identifier for the agency that is maintaining contractor license information.
• Description(optional): string
  Maximum Length: 100

  The description for the type of insurance associated with a contractor license.
• Enabled(optional): string
  Maximum Length: 1

  The status for the insurance type that indicates whether the insurance type is active or inactive.
• InsuranceType(optional): string
  Maximum Length: 30

  The code for the type of insurance associated with a contractor license.
• LicenseSetupCode(optional): 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(optional): array Items
  Title: Items

  Link Relations

{
    "properties":{
        "AgencyId":{
            "maxLength":8,
            "type":"string",
            "description":"The identifier for the agency that is maintaining contractor license information."
        },
        "Description":{
            "maxLength":100,
            "type":"string",
            "description":"The description for the type of insurance associated with a contractor license."
        },
        "Enabled":{
            "maxLength":1,
            "type":"string",
            "description":"The status for the insurance type that indicates whether the insurance type is active or inactive."
        },
        "InsuranceType":{
            "maxLength":30,
            "type":"string",
            "description":"The code for the type of insurance associated with a contractor license."
        },
        "LicenseSetupCode":{
            "maxLength":30,
            "type":"string",
            "description":"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":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : publicSectorContractorOptions-ContractorOptionIntegrations-item

Type: object

Show Source

• AgencyId(optional): integer(int32)
  Identifier for the agency that is maintaining contractor license information.
• IntegrationEnabled(optional): string
  Maximum Length: 1

  Indicates whether a specific named contractor license integration is active.
• IntegrationKey(optional): string
  Maximum Length: 100

  The integration source key that some external sites require for contractor license integration.
• IntegrationName(optional): string
  Maximum Length: 1000

  Name of an integration that maps contractor license information to the corresponding license information from an external site.
• IntegrationParameter(optional): string
  Maximum Length: 100

  Name of the query parameter that needs to be added to the integration end point.
• IntegrationType(optional): string
  Maximum Length: 30

  Identifies the type of integration such as online or batch.
• IntegrationVersion(optional): string
  Maximum Length: 50

  Version number of the integration that maps contractor license information to the corresponding license information from an external site.
• LicenseSetupCode(optional): 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(optional): array Items
  Title: Items

  Link Relations

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"Identifier for the agency that is maintaining contractor license information."
        },
        "IntegrationEnabled":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether a specific named contractor license integration is active."
        },
        "IntegrationKey":{
            "maxLength":100,
            "type":"string",
            "description":"The integration source key that some external sites require for contractor license integration."
        },
        "IntegrationName":{
            "maxLength":1000,
            "type":"string",
            "description":"Name of an integration that maps contractor license information to the corresponding license information from an external site."
        },
        "IntegrationParameter":{
            "maxLength":100,
            "type":"string",
            "description":"Name of the query parameter that needs to be added to the integration end point."
        },
        "IntegrationType":{
            "maxLength":30,
            "type":"string",
            "description":"Identifies the type of integration such as online or batch."
        },
        "IntegrationVersion":{
            "maxLength":50,
            "type":"string",
            "description":"Version number of the integration that maps contractor license information to the corresponding license information from an external site."
        },
        "LicenseSetupCode":{
            "maxLength":30,
            "type":"string",
            "description":"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":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : publicSectorContractorOptions-ContractorOptionLicenseTypes-item

Type: object

Show Source

• AgencyId(optional): string
  Maximum Length: 8

  Identifier for the agency that is maintaining contractor license information.
• Description(optional): string
  Maximum Length: 100

  Descriptive statement about the license type.
• Enabled(optional): string
  Maximum Length: 1

  Status of the license type that indicates if the license type is active or inactive.
• LicenseSetupCode(optional): 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(optional): string
  Maximum Length: 30

  Identifies the type of contractor license.
• links(optional): array Items
  Title: Items

  Link Relations

{
    "properties":{
        "AgencyId":{
            "maxLength":8,
            "type":"string",
            "description":"Identifier for the agency that is maintaining contractor license information."
        },
        "Description":{
            "maxLength":100,
            "type":"string",
            "description":"Descriptive statement about the license type."
        },
        "Enabled":{
            "maxLength":1,
            "type":"string",
            "description":"Status of the license type that indicates if the license type is active or inactive."
        },
        "LicType":{
            "maxLength":30,
            "type":"string",
            "description":"Identifies the type of contractor license."
        },
        "LicenseSetupCode":{
            "maxLength":30,
            "type":"string",
            "description":"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":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : publicSectorContractorOptions-ContractorOptionOwnershipTypes-item

Type: object

Show Source

• AgencyId(optional): integer(int32)
  The identifier for the agency that is maintaining license validation.
• Description(optional): string
  Maximum Length: 100

  The description for the ownership type associated with a contractor license.
• Enabled(optional): string
  Maximum Length: 1

  The status for the ownership type that indicates whether the insurance type is active or inactive.
• LicenseSetupCode(optional): 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(optional): array Items
  Title: Items

  Link Relations
• OwnershipType(optional): string
  Maximum Length: 15

  The code for the ownership type associated with a contractor license.

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The identifier for the agency that is maintaining license validation."
        },
        "Description":{
            "maxLength":100,
            "type":"string",
            "description":"The description for the ownership type associated with a contractor license."
        },
        "Enabled":{
            "maxLength":1,
            "type":"string",
            "description":"The status for the ownership type that indicates whether the insurance type is active or inactive."
        },
        "LicenseSetupCode":{
            "maxLength":30,
            "type":"string",
            "description":"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."
        },
        "OwnershipType":{
            "maxLength":15,
            "type":"string",
            "description":"The code for the ownership type associated with a contractor license."
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : publicSectorContractorOptions-ContractorOptionStatusMappings-item

Type: object

Show Source

• AgencyId(optional): integer(int32)
  Identifier for the agency that is maintaining contractor license information.
• DeclineApplication(optional): string
  Maximum Length: 1

  Indicates if applications that are associated with the specified contractor license status should be declined.
• Enabled(optional): string
  Maximum Length: 1

  Status of the mapping that indicates if the mapping is active or inactive.
• InternalStatus(optional): string
  Maximum Length: 30

  The agency-assigned status for a contractor license that corresponds to the status assigned by the third-party licensing body.
• LicenseSetupCode(optional): 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(optional): array Items
  Title: Items

  Link Relations
• SourceStatus(optional): string
  Maximum Length: 100

  Contractor license status that is assigned by a third party licensing body.

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"Identifier for the agency that is maintaining contractor license information."
        },
        "DeclineApplication":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates if applications that are associated with the specified contractor license status should be declined."
        },
        "Enabled":{
            "maxLength":1,
            "type":"string",
            "description":"Status of the mapping that indicates if the mapping is active or inactive."
        },
        "InternalStatus":{
            "maxLength":30,
            "type":"string",
            "description":"The agency-assigned status for a contractor license that corresponds to the status assigned by the third-party licensing body."
        },
        "LicenseSetupCode":{
            "maxLength":30,
            "type":"string",
            "description":"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."
        },
        "SourceStatus":{
            "maxLength":100,
            "type":"string",
            "description":"Contractor license status that is assigned by a third party licensing body."
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Back to Top