Create a NAICS group
post
/fscmRestApi/resources/11.13.18.05/publicSectorNAICSGroups
Request
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
Root Schema : schema
Type:
Show Source
object
-
AgencyId: integer
(int32)
Default Value:
1
The agency identifier of the public sector entity to which the NAICS group applies. -
Description(required): string
Title:
Description
Maximum Length:500
The long description value for a NAICS code. -
EnabledFlag(required): string
Title:
Enabled
Maximum Length:1
Indicates whether the NAICS group is enabled. The default value is true. -
NaicsGroup(required): string
Title:
NAICS Group
Maximum Length:25
The description value for a NAICS group. -
NaicsGroupCode(required): 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.
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
Nested Schema : publicSectorNAICSGroups-NAICSGroupCodeAccessor-item-post-request
Type:
Show Source
object
-
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. -
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.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
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(required):
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.
Root Schema : publicSectorNAICSGroups-item-response
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
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
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : publicSectorNAICSGroups-NAICSGroupCodeAccessor-item-response
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- 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. - publicSectorNAICSGroupsUniqID: