Jump to

• Request
• Response

Create a set of contractor validation options

post

/fscmRestApi/resources/11.13.18.05/publicSectorContractorOptions

Request

Supported Media Types

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

Body ()

The following table describes the body parameters in the request for this task.

Root Schema : publicSectorContractorOptions-item

Type: object

Show Source

• AgencyId(optional): integer(int32)
  Identifier for the agency that is maintaining contractor license validation.
• ContractorOptionClassifications(optional): array Contractor Option Classifications
  Title: Contractor Option Classifications

  The contractor option resource is used to view, add, delete and modify contractor license options for validating licenses.
• ContractorOptionFacts(optional): array Contractor Option Facts
  Title: Contractor Option Facts

  The contractor option resource is used to view, add, delete and modify contractor license options for validating licenses.
• ContractorOptionIntegrations(optional): array Contractor Option Integrations
  Title: Contractor Option Integrations

  The contractor option resource is used to view, add, delete and modify contractor license options for validating licenses.
• ContractorOptionLicenseTypes(optional): array Contractor Option License Types
  Title: Contractor Option License Types

  The contractor option resource is used to view, add, delete and modify contractor license options for validating licenses.
• ContractorOptionStatusMappings(optional): array Contractor Option Status Mappings
  Title: Contractor Option Status Mappings

  The contractor option resource is used to view, add, delete and modify contractor license options for validating licenses.
• 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

  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 fact 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.
• 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":"Identifier for the agency that is maintaining contractor license validation."
        },
        "ContractorOptionClassifications":{
            "items":{
                "$ref":"#/definitions/publicSectorContractorOptions-ContractorOptionClassifications-item"
            },
            "type":"array",
            "description":"The contractor option resource is used to view, add, delete and modify contractor license options for validating licenses.",
            "title":"Contractor Option Classifications"
        },
        "ContractorOptionFacts":{
            "items":{
                "$ref":"#/definitions/publicSectorContractorOptions-ContractorOptionFacts-item"
            },
            "type":"array",
            "description":"The contractor option resource is used to view, add, delete and modify contractor license options for validating licenses.",
            "title":"Contractor Option Facts"
        },
        "ContractorOptionIntegrations":{
            "items":{
                "$ref":"#/definitions/publicSectorContractorOptions-ContractorOptionIntegrations-item"
            },
            "type":"array",
            "description":"The contractor option resource is used to view, add, delete and modify contractor license options for validating licenses.",
            "title":"Contractor Option Integrations"
        },
        "ContractorOptionLicenseTypes":{
            "items":{
                "$ref":"#/definitions/publicSectorContractorOptions-ContractorOptionLicenseTypes-item"
            },
            "type":"array",
            "description":"The contractor option resource is used to view, add, delete and modify contractor license options for validating licenses.",
            "title":"Contractor Option License Types"
        },
        "ContractorOptionStatusMappings":{
            "items":{
                "$ref":"#/definitions/publicSectorContractorOptions-ContractorOptionStatusMappings-item"
            },
            "type":"array",
            "description":"The contractor option resource is used to view, add, delete and modify contractor license options for validating licenses.",
            "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":"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 fact 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."
        },
        "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 resource is used to view, add, delete and modify contractor license options for validating licenses.

Show Source

• Array of: object publicSectorContractorOptions-ContractorOptionClassifications-item

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

Nested Schema : Contractor Option Facts

Type: array

Title: Contractor Option Facts

The contractor option resource is used to view, add, delete and modify contractor license options for validating licenses.

Show Source

• Array of: object publicSectorContractorOptions-ContractorOptionFacts-item

{
    "items":{
        "$ref":"#/definitions/publicSectorContractorOptions-ContractorOptionFacts-item"
    },
    "type":"array",
    "description":"The contractor option resource is used to view, add, delete and modify contractor license options for validating licenses.",
    "title":"Contractor Option Facts"
}

Nested Schema : Contractor Option Integrations

Type: array

Title: Contractor Option Integrations

The contractor option resource is used to view, add, delete and modify contractor license options for validating licenses.

Show Source

• Array of: object publicSectorContractorOptions-ContractorOptionIntegrations-item

{
    "items":{
        "$ref":"#/definitions/publicSectorContractorOptions-ContractorOptionIntegrations-item"
    },
    "type":"array",
    "description":"The contractor option resource is used to view, add, delete and modify contractor license options for validating licenses.",
    "title":"Contractor Option Integrations"
}

Nested Schema : Contractor Option License Types

Type: array

Title: Contractor Option License Types

The contractor option resource is used to view, add, delete and modify contractor license options for validating licenses.

Show Source

• Array of: object publicSectorContractorOptions-ContractorOptionLicenseTypes-item

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

Nested Schema : Contractor Option Status Mappings

Type: array

Title: Contractor Option Status Mappings

The contractor option resource is used to view, add, delete and modify contractor license options for validating licenses.

Show Source

• Array of: object publicSectorContractorOptions-ContractorOptionStatusMappings-item

{
    "items":{
        "$ref":"#/definitions/publicSectorContractorOptions-ContractorOptionStatusMappings-item"
    },
    "type":"array",
    "description":"The contractor option resource is used to view, add, delete and modify contractor license options for validating licenses.",
    "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 fact within a fact section.
• FactSection(optional): string
  Maximum Length: 30

  The type of fact 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 fact 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 fact within a fact section."
        },
        "FactSection":{
            "maxLength":30,
            "type":"string",
            "description":"The type of fact 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 fact 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-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-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

Response

Supported Media Types

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

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : publicSectorContractorOptions-item

Type: object

Show Source

• AgencyId(optional): integer(int32)
  Identifier for the agency that is maintaining contractor license validation.
• ContractorOptionClassifications(optional): array Contractor Option Classifications
  Title: Contractor Option Classifications

  The contractor option resource is used to view, add, delete and modify contractor license options for validating licenses.
• ContractorOptionFacts(optional): array Contractor Option Facts
  Title: Contractor Option Facts

  The contractor option resource is used to view, add, delete and modify contractor license options for validating licenses.
• ContractorOptionIntegrations(optional): array Contractor Option Integrations
  Title: Contractor Option Integrations

  The contractor option resource is used to view, add, delete and modify contractor license options for validating licenses.
• ContractorOptionLicenseTypes(optional): array Contractor Option License Types
  Title: Contractor Option License Types

  The contractor option resource is used to view, add, delete and modify contractor license options for validating licenses.
• ContractorOptionStatusMappings(optional): array Contractor Option Status Mappings
  Title: Contractor Option Status Mappings

  The contractor option resource is used to view, add, delete and modify contractor license options for validating licenses.
• 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

  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 fact 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.
• 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":"Identifier for the agency that is maintaining contractor license validation."
        },
        "ContractorOptionClassifications":{
            "items":{
                "$ref":"#/definitions/publicSectorContractorOptions-ContractorOptionClassifications-item"
            },
            "type":"array",
            "description":"The contractor option resource is used to view, add, delete and modify contractor license options for validating licenses.",
            "title":"Contractor Option Classifications"
        },
        "ContractorOptionFacts":{
            "items":{
                "$ref":"#/definitions/publicSectorContractorOptions-ContractorOptionFacts-item"
            },
            "type":"array",
            "description":"The contractor option resource is used to view, add, delete and modify contractor license options for validating licenses.",
            "title":"Contractor Option Facts"
        },
        "ContractorOptionIntegrations":{
            "items":{
                "$ref":"#/definitions/publicSectorContractorOptions-ContractorOptionIntegrations-item"
            },
            "type":"array",
            "description":"The contractor option resource is used to view, add, delete and modify contractor license options for validating licenses.",
            "title":"Contractor Option Integrations"
        },
        "ContractorOptionLicenseTypes":{
            "items":{
                "$ref":"#/definitions/publicSectorContractorOptions-ContractorOptionLicenseTypes-item"
            },
            "type":"array",
            "description":"The contractor option resource is used to view, add, delete and modify contractor license options for validating licenses.",
            "title":"Contractor Option License Types"
        },
        "ContractorOptionStatusMappings":{
            "items":{
                "$ref":"#/definitions/publicSectorContractorOptions-ContractorOptionStatusMappings-item"
            },
            "type":"array",
            "description":"The contractor option resource is used to view, add, delete and modify contractor license options for validating licenses.",
            "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":"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 fact 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."
        },
        "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 resource is used to view, add, delete and modify contractor license options for validating licenses.

Show Source

• Array of: object publicSectorContractorOptions-ContractorOptionClassifications-item

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

Nested Schema : Contractor Option Facts

Type: array

Title: Contractor Option Facts

The contractor option resource is used to view, add, delete and modify contractor license options for validating licenses.

Show Source

• Array of: object publicSectorContractorOptions-ContractorOptionFacts-item

{
    "items":{
        "$ref":"#/definitions/publicSectorContractorOptions-ContractorOptionFacts-item"
    },
    "type":"array",
    "description":"The contractor option resource is used to view, add, delete and modify contractor license options for validating licenses.",
    "title":"Contractor Option Facts"
}

Nested Schema : Contractor Option Integrations

Type: array

Title: Contractor Option Integrations

The contractor option resource is used to view, add, delete and modify contractor license options for validating licenses.

Show Source

• Array of: object publicSectorContractorOptions-ContractorOptionIntegrations-item

{
    "items":{
        "$ref":"#/definitions/publicSectorContractorOptions-ContractorOptionIntegrations-item"
    },
    "type":"array",
    "description":"The contractor option resource is used to view, add, delete and modify contractor license options for validating licenses.",
    "title":"Contractor Option Integrations"
}

Nested Schema : Contractor Option License Types

Type: array

Title: Contractor Option License Types

The contractor option resource is used to view, add, delete and modify contractor license options for validating licenses.

Show Source

• Array of: object publicSectorContractorOptions-ContractorOptionLicenseTypes-item

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

Nested Schema : Contractor Option Status Mappings

Type: array

Title: Contractor Option Status Mappings

The contractor option resource is used to view, add, delete and modify contractor license options for validating licenses.

Show Source

• Array of: object publicSectorContractorOptions-ContractorOptionStatusMappings-item

{
    "items":{
        "$ref":"#/definitions/publicSectorContractorOptions-ContractorOptionStatusMappings-item"
    },
    "type":"array",
    "description":"The contractor option resource is used to view, add, delete and modify contractor license options for validating licenses.",
    "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 fact within a fact section.
• FactSection(optional): string
  Maximum Length: 30

  The type of fact 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 fact 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 fact within a fact section."
        },
        "FactSection":{
            "maxLength":30,
            "type":"string",
            "description":"The type of fact 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 fact 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-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-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