Create a set of credential groups
post
/fscmRestApi/resources/11.13.18.05/publicSectorCredentialGroups
Request
Header Parameters
-
Effective-Of:
This header accepts a string value. The string is a semi-colon separated list of
= . It is used to perform effective date range operations. The accepted parameters are RangeMode, RangeSpan, RangeStartDate, RangeEndDate, RangeStartSequence and RangeEndSequence. The parameter values are always strings. The possible values for RangeMode are SET_LOGICAL_START, SET_LOGICAL_END, END_DATE, SET_EFFECTIVE_START, SET_EFFECTIVE_END, REPLACE_CORRECTION, REPLACE_UPDATE, RECONCILE_CORRECTION, CORRECTION, RECONCILE_UPDATE, UPDATE, ZAP and DELETE_CHANGES. The possible values for RangeSpan are PHYSICAL_ROW_END_DATE and LOGICAL_ROW_END_DATE. The values for RangeStartDate and RangeEndDate have to be a string representation of a date in yyyy-MM-dd format. The value for RangeStartSequence and RangeEndSequence must be strings such that when parsed they yield positive integers. -
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 unique identifier for a public sector agency. -
BusLicensingFlag: string
Maximum Length:
1
Default Value:Y
Indicates whether the credential group is applicable for business license application or not. -
CredentialGroupDetail: array
Credential Group Details
Title:
Credential Group Details
The credential group details resource is used to view, add, delete, and modify information for a credential group details. -
CredGroupId(required): string
Maximum Length:
50
A unique name that identifies a credential group. -
Description: string
Maximum Length:
200
The long description of the credential group. -
EffectiveEndDate(required): string
(date)
The date at the end of the date range within which the credential group is effective.
-
EffectiveStartDate(required): string
(date)
The date at the beginning of the date range within which the credential group is effective.
-
EnabledFlag: string
Maximum Length:
1
Default Value:Y
Indicates whether the credential group is enabled or not. -
GroupName(required): string
Maximum Length:
100
The short description of the credential group.
Nested Schema : Credential Group Details
Type:
array
Title:
Credential Group Details
The credential group details resource is used to view, add, delete, and modify information for a credential group details.
Show Source
Nested Schema : publicSectorCredentialGroups-CredentialGroupDetail-item-post-request
Type:
Show Source
object
-
AgencyId: integer
(int32)
Default Value:
1
The unique identifier for a public sector agency. -
AmendmentFlag: string
Maximum Length:
1
Default Value:N
Indicates whether the credential is applicable for the business license amendment activity. -
CredCode: string
Title:
Credential
Maximum Length:30
A unique name that identifies the credential. -
CredCodeDescr: string
The description of the credential.
-
CredCodeShortDescr: string
The short description of the credential.
-
CredGroupId: string
Maximum Length:
50
A unique name that identifies a credential group. -
DisplaySequence: integer
(int64)
The display sequence of the credential.
-
EffectiveEndDate: string
(date)
The date at the end of the date range within which the credential group is effective.
-
EffectiveStartDate: string
(date)
The date at the beginning of the date range within which the credential group is effective.
-
EnabledFlag: string
Maximum Length:
1
Default Value:Y
Indicates whether the credential is enabled or not for the group. -
OriginationFlag: string
Maximum Length:
1
Default Value:N
Indicates whether the credential is applicable for the business license origination activity. -
RenewalFlag: string
Maximum Length:
1
Default Value:N
Indicates whether the credential is applicable for the business license renewal activity.
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.
Root Schema : publicSectorCredentialGroups-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
Default Value:
1
The unique identifier for a public sector agency. -
BusLicensingFlag: string
Maximum Length:
1
Default Value:Y
Indicates whether the credential group is applicable for business license application or not. -
CredentialGroupDetail: array
Credential Group Details
Title:
Credential Group Details
The credential group details resource is used to view, add, delete, and modify information for a credential group details. -
CredGroupId: string
Maximum Length:
50
A unique name that identifies a credential group. -
Description: string
Maximum Length:
200
The long description of the credential group. -
EffectiveEndDate: string
(date)
The date at the end of the date range within which the credential group is effective.
-
EffectiveStartDate: string
(date)
The date at the beginning of the date range within which the credential group is effective.
-
EnabledFlag: string
Maximum Length:
1
Default Value:Y
Indicates whether the credential group is enabled or not. -
GroupName: string
Maximum Length:
100
The short description of the credential group. -
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : Credential Group Details
Type:
array
Title:
Credential Group Details
The credential group details resource is used to view, add, delete, and modify information for a credential group details.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorCredentialGroups-CredentialGroupDetail-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
Default Value:
1
The unique identifier for a public sector agency. -
AmendmentFlag: string
Maximum Length:
1
Default Value:N
Indicates whether the credential is applicable for the business license amendment activity. -
CredCode: string
Title:
Credential
Maximum Length:30
A unique name that identifies the credential. -
CredCodeDescr: string
The description of the credential.
-
CredCodeShortDescr: string
The short description of the credential.
-
CredGroupId: string
Maximum Length:
50
A unique name that identifies a credential group. -
DisplaySequence: integer
(int64)
The display sequence of the credential.
-
EffectiveEndDate: string
(date)
The date at the end of the date range within which the credential group is effective.
-
EffectiveStartDate: string
(date)
The date at the beginning of the date range within which the credential group is effective.
-
EnabledFlag: string
Maximum Length:
1
Default Value:Y
Indicates whether the credential is enabled or not for the group. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OriginationFlag: string
Maximum Length:
1
Default Value:N
Indicates whether the credential is applicable for the business license origination activity. -
RenewalFlag: string
Maximum Length:
1
Default Value:N
Indicates whether the credential is applicable for the business license renewal activity.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
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.
Links
- CredentialGroupDetail
-
Parameters:
- publicSectorCredentialGroupsUniqID:
$request.path.publicSectorCredentialGroupsUniqID
The credential group details resource is used to view, add, delete, and modify information for a credential group details. - publicSectorCredentialGroupsUniqID: