Jump to

• Request
• Response

Update a NAICS group

patch

/fscmRestApi/resources/11.13.18.05/publicSectorNAICSGroups/{publicSectorNAICSGroupsUniqID}

Request

Path Parameters

• publicSectorNAICSGroupsUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- AgencyId and NaicsGroupCode ---for the NAICS Groups resource and used to uniquely identify an instance of NAICS Groups. The client should not generate the hash key value. Instead, the client should query on the NAICS Groups collection resource with a filter on the primary key values in order to navigate to a specific instance of NAICS Groups.
  
  For example: publicSectorNAICSGroups?q=AgencyId=<value1>;NaicsGroupCode=<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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• Description: string
  Title: Description

  Maximum Length: 500

  The long description value for a NAICS code.
• EnabledFlag: string
  Title: Enabled

  Maximum Length: 1

  Indicates whether the NAICS group is enabled. The default value is true.
• NaicsGroup: string
  Title: NAICS Group

  Maximum Length: 25

  The description value for a NAICS group.
• NAICSGroupCodeAccessor: array NAICS Group Codes
  Title: NAICS Group Codes

  Use the NAICS group codes resource to assign NAICS codes to a group. These values are known as industry classification codes and are logically grouped for ease of selection when applying for a business license.

{
    "type":"object",
    "properties":{
        "NAICSGroupCodeAccessor":{
            "title":"NAICS Group Codes",
            "type":"array",
            "description":"Use the NAICS group codes resource to assign NAICS codes to a group. These values are known as industry classification codes and are logically grouped for ease of selection when applying for a business license.",
            "items":{
                "$ref":"#/components/schemas/publicSectorNAICSGroups-NAICSGroupCodeAccessor-item-patch-request"
            }
        },
        "Description":{
            "title":"Description",
            "maxLength":"500",
            "type":"string",
            "description":"The long description value for a NAICS code.",
            "nullable":false
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the NAICS group is enabled. The default value is true.",
            "nullable":false
        },
        "NaicsGroup":{
            "title":"NAICS Group",
            "maxLength":"25",
            "type":"string",
            "description":"The description value for a NAICS group.",
            "nullable":false
        }
    }
}

Nested Schema : NAICS Group Codes

Type: array

Title: NAICS Group Codes

Use the NAICS group codes resource to assign NAICS codes to a group. These values are known as industry classification codes and are logically grouped for ease of selection when applying for a business license.

Show Source

• Array of: object publicSectorNAICSGroups-NAICSGroupCodeAccessor-item-patch-request

{
    "title":"NAICS Group Codes",
    "type":"array",
    "description":"Use the NAICS group codes resource to assign NAICS codes to a group. These values are known as industry classification codes and are logically grouped for ease of selection when applying for a business license.",
    "items":{
        "$ref":"#/components/schemas/publicSectorNAICSGroups-NAICSGroupCodeAccessor-item-patch-request"
    }
}

Nested Schema : publicSectorNAICSGroups-NAICSGroupCodeAccessor-item-patch-request

Type: object

Show Source

• EnabledFlag: string
  Title: Enabled

  Maximum Length: 1

  Indicates whether the NAICS group code is enabled. The default value is true.

{
    "type":"object",
    "properties":{
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the NAICS group code is enabled. The default value is true.",
            "nullable":false
        }
    }
}

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 : publicSectorNAICSGroups-item-response

Type: object

Show Source

• AgencyId: integer (int32)
  Default Value: 1

  The agency identifier of the public sector entity to which the NAICS group applies.
• Description: string
  Title: Description

  Maximum Length: 500

  The long description value for a NAICS code.
• EnabledFlag: string
  Title: Enabled

  Maximum Length: 1

  Indicates whether the NAICS group is enabled. The default value is true.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• NaicsGroup: string
  Title: NAICS Group

  Maximum Length: 25

  The description value for a NAICS group.
• NaicsGroupCode: string
  Title: NAICS Group ID

  Maximum Length: 30

  The unique identifier for a NAICS group.
• NAICSGroupCodeAccessor: array NAICS Group Codes
  Title: NAICS Group Codes

  Use the NAICS group codes resource to assign NAICS codes to a group. These values are known as industry classification codes and are logically grouped for ease of selection when applying for a business license.

{
    "type":"object",
    "properties":{
        "Description":{
            "title":"Description",
            "maxLength":"500",
            "type":"string",
            "description":"The long description value for a NAICS code.",
            "nullable":false,
            "x-queryable":true
        },
        "AgencyId":{
            "type":"integer",
            "description":"The agency identifier of the public sector entity to which the NAICS group applies.",
            "format":"int32",
            "nullable":false,
            "default":"1",
            "x-hints":{
                "precision":"8"
            },
            "x-queryable":true
        },
        "NaicsGroup":{
            "title":"NAICS Group",
            "maxLength":"25",
            "type":"string",
            "description":"The description value for a NAICS group.",
            "nullable":false,
            "x-queryable":true
        },
        "NAICSGroupCodeAccessor":{
            "title":"NAICS Group Codes",
            "type":"array",
            "description":"Use the NAICS group codes resource to assign NAICS codes to a group. These values are known as industry classification codes and are logically grouped for ease of selection when applying for a business license.",
            "items":{
                "$ref":"#/components/schemas/publicSectorNAICSGroups-NAICSGroupCodeAccessor-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "NaicsGroupCode":{
            "title":"NAICS Group ID",
            "maxLength":"30",
            "type":"string",
            "description":"The unique identifier for a NAICS group.",
            "nullable":false,
            "x-queryable":true
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the NAICS group is enabled. The default value is true.",
            "nullable":false,
            "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 : NAICS Group Codes

Type: array

Title: NAICS Group Codes

Use the NAICS group codes resource to assign NAICS codes to a group. These values are known as industry classification codes and are logically grouped for ease of selection when applying for a business license.

Show Source

• Array of: object publicSectorNAICSGroups-NAICSGroupCodeAccessor-item-response

{
    "title":"NAICS Group Codes",
    "type":"array",
    "description":"Use the NAICS group codes resource to assign NAICS codes to a group. These values are known as industry classification codes and are logically grouped for ease of selection when applying for a business license.",
    "items":{
        "$ref":"#/components/schemas/publicSectorNAICSGroups-NAICSGroupCodeAccessor-item-response"
    }
}

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."
        }
    }
}

Nested Schema : publicSectorNAICSGroups-NAICSGroupCodeAccessor-item-response

Type: object

Show Source

• AgencyId: integer (int32)
  Default Value: 1

  The agency identifier of the public sector entity to which the NAICS group code applies.
• EnabledFlag: string
  Title: Enabled

  Maximum Length: 1

  Indicates whether the NAICS group code is enabled. The default value is true.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• NaicsCode: string
  Title: NAICS Code

  Maximum Length: 30

  The unique identifier for a NAICS code.
• NaicsGroupCode: string
  Maximum Length: 30

  The unique identifier for a NAICS group.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AgencyId":{
            "type":"integer",
            "description":"The agency identifier of the public sector entity to which the NAICS group code applies.",
            "format":"int32",
            "nullable":false,
            "default":"1",
            "x-hints":{
                "precision":"8"
            },
            "x-queryable":true
        },
        "NaicsGroupCode":{
            "maxLength":"30",
            "type":"string",
            "description":"The unique identifier for a NAICS group.",
            "nullable":false,
            "x-queryable":true
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the NAICS group code is enabled. The default value is true.",
            "nullable":false,
            "x-queryable":true
        },
        "NaicsCode":{
            "title":"NAICS Code",
            "maxLength":"30",
            "type":"string",
            "description":"The unique identifier for a NAICS code.",
            "nullable":false,
            "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"
    }
}

Links

NAICSGroupCodeAccessor

Operation: /fscmRestApi/resources/11.13.18.05/publicSectorNAICSGroups/{publicSectorNAICSGroupsUniqID}/child/NAICSGroupCodeAccessor

Parameters:

• publicSectorNAICSGroupsUniqID: $request.path.publicSectorNAICSGroupsUniqID

Use the NAICS group codes resource to assign NAICS codes to a group. These values are known as industry classification codes and are logically grouped for ease of selection when applying for a business license.

Back to Top