Jump to

• Request
• Response

Create a set of contractor validation option license types is not allowed is not allowed

post

/fscmRestApi/resources/11.13.18.05/publicSectorRegContractorOptions/{publicSectorRegContractorOptionsUniqID}/child/ContractorOptionLicenseTypes

Request

Supported Media Types

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

Path Parameters

• publicSectorRegContractorOptionsUniqID: integer
  This is the hash key of the attributes which make up the composite key--- LicenseSetupCode and AgencyId ---for the Contractor Options for Registered Users resource and used to uniquely identify an instance of Contractor Options for Registered Users. The client should not generate the hash key value. Instead, the client should query on the Contractor Options for Registered Users collection resource with a filter on the primary key values in order to navigate to a specific instance of Contractor Options for Registered Users.
  
  For example: publicSectorRegContractorOptions?q=LicenseSetupCode=<value1>;AgencyId=<value2>

Body ()

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

Root Schema : publicSectorRegContractorOptions-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 : 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"
}

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 : publicSectorRegContractorOptions-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 : 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"
}

Back to Top