Jump to

• Request
• Response

Create a set of ownership types for a contractor validation option

post

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

Request

Path Parameters

• publicSectorRegContractorOptionsUniqID(required): string
  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>

Header Parameters

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
• Upsert-Mode:
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

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

  Maximum Length: 100

  The description for the ownership type associated with a contractor license.
• Enabled: string
  Title: Enabled

  Maximum Length: 1

  The status for the ownership type that indicates whether the insurance type is active or inactive.
• LicenseSetupCode: string
  Maximum Length: 30

  The code that identifies a set of configuration options for contractor licenses. For example, a code might represent configuration options that include integration with the state licensing board in California.
• OwnershipType: string
  Title: Ownership Type

  Maximum Length: 15

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

{
    "type":"object",
    "properties":{
        "OwnershipType":{
            "title":"Ownership Type",
            "maxLength":"15",
            "type":"string",
            "description":"The code for the ownership type associated with a contractor license.",
            "nullable":false
        },
        "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.",
            "nullable":false
        },
        "Enabled":{
            "title":"Enabled",
            "maxLength":"1",
            "type":"string",
            "description":"The status for the ownership type that indicates whether the insurance type is active or inactive.",
            "nullable":false
        },
        "Description":{
            "title":"Description",
            "maxLength":"100",
            "type":"string",
            "description":"The description for the ownership type associated with a contractor license.",
            "nullable":false
        },
        "AgencyId":{
            "type":"integer",
            "description":"The identifier for the agency that is maintaining license validation.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"8"
            }
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : publicSectorRegContractorOptions-ContractorOptionOwnershipTypes-item-response

Type: object

Show Source

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

  Maximum Length: 100

  The description for the ownership type associated with a contractor license.
• Enabled: string
  Title: Enabled

  Maximum Length: 1

  The status for the ownership type that indicates whether the insurance type is active or inactive.
• LicenseSetupCode: string
  Maximum Length: 30

  The code that identifies a set of configuration options for contractor licenses. For example, a code might represent configuration options that include integration with the state licensing board in California.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OwnershipType: string
  Title: Ownership Type

  Maximum Length: 15

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

{
    "type":"object",
    "properties":{
        "OwnershipType":{
            "title":"Ownership Type",
            "maxLength":"15",
            "type":"string",
            "description":"The code for the ownership type associated with a contractor license.",
            "nullable":false,
            "x-queryable":true
        },
        "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.",
            "nullable":false,
            "x-queryable":true
        },
        "Enabled":{
            "title":"Enabled",
            "maxLength":"1",
            "type":"string",
            "description":"The status for the ownership type that indicates whether the insurance type is active or inactive.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "Description":{
            "title":"Description",
            "maxLength":"100",
            "type":"string",
            "description":"The description for the ownership type associated with a contractor license.",
            "nullable":false,
            "x-queryable":true
        },
        "AgencyId":{
            "type":"integer",
            "description":"The identifier for the agency that is maintaining license validation.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"8"
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

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

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top