Update a user setup
patch
/fscmRestApi/resources/11.13.18.05/publicSectorUserSetups/{UserSetupId}
Request
Path Parameters
-
UserSetupId(required): string
Identifies the row in the public user setup table. The only valid value is PSC.
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
Root Schema : schema
Type:
Show Source
object
-
AllowAttachments: string
Maximum Length:
1
Indicates whether users can attach documents in account management. If the value is Y, users can attach documents. The default value is N. -
AllowDelegation: string
Maximum Length:
1
When this option is enabled, registered users can delegate transactions to other users. Delegation can be for all transactions for a profile or for individual transactions. The default value is N. -
AllowDeleteAttachments: string
Maximum Length:
1
Indicates whether registered public users can delete documents in account management. -
AllowIvrAccess: string
Maximum Length:
1
Default Value:N
Indicates whether a registered user can enter a code into an interactive voice response system to access permit records and maintain inspection schedules The default value is N. -
AllowNumDelegates: integer
(int32)
Identifies the number of delegates allowed per profile. The limit is 999.
-
AllowTextCommunication: string
Maximum Length:
1
Indicates whether a registered user can choose to receive communications as text messages. The default value is N. -
AllowUpdAllTrans: string
Maximum Length:
1
Indicates whether a registered user can delegate the ability to manage all transactions for an account profile. The default value is N. -
AllowUpdSpecificTrans: string
Maximum Length:
1
Indicates whether a registered user can delegate the ability to manage individual transactions. The default value is N. -
AllowViewAllTrans: string
Maximum Length:
1
Indicates whether a registered user can delegate view-only access for all transactions for an account profile. The default value is N. -
AllowViewProfAttach: string
Maximum Length:
1
Indicates whether a user with delegated access to all transactions in a profile can also view attachments for the profile. The default value is N. -
AllowViewProfContacts: string
Maximum Length:
1
Indicates whether a user with delegated access to all transactions in a profile can also view contacts for the profile. The default value is N. -
AllowViewProfLicense: string
Maximum Length:
1
Indicates whether a user with delegated access to all transactions in a profile can also view licenses for the profile. The default value is N. -
AllowViewSpecificTrans: string
Maximum Length:
1
Indicates whether a registered user can delegate view-only access for individual transactions. The default value is N. -
DeletedFlag: boolean
Maximum Length:
1
Indicates whether the record is logically deleted. If the value is Y, the record has been logically deleted. The default value is N. -
DocGroupId: string
Title:
Document Group ID
Maximum Length:30
Indicates the attachment document group. -
InvitationExpiryOpt: string
Maximum Length:
30
Identifies the unit of time for the delegation invitation expiration period. The options are Days, Weeks, or Months. -
InviteExpiryNum: integer
(int32)
Identifies the number of days, weeks or months for the delegation invitation expiration period. This attribute is just for the number. Use the Invitation Expiry Option attribute to define the type of time period.
-
RequestDelegateProjMgr: string
Maximum Length:
1
Indicates whether registered users who are the primary contact for a project can request delegation. The default value is N. -
SeedDataLock: integer
(int32)
Indicates whether the row is seed data. Valid values are 0 for data that is customer data, 1 for seed data that cannot be modified, and 2 for seed data that customers can modify.
-
SensitiveFlagAll: string
Maximum Length:
1
Default Value:N
Indicates whether an agency can hide contact information for all applicants from public view. The default value is N. -
SensitiveFlagOn: string
Maximum Length:
1
Indicates whether registered users can hide contact information from public view. If the value is Y, data for users who choose to hide contact information may require special handling. The default value is N. -
SuppressEmail: string
Maximum Length:
1
Indicates whether a profile or transaction owner can suppress emails for actions performed by a delegate. The default value is N. -
TermsOfUseOn: string
Maximum Length:
1
Indicates whether users need to accept terms of use when registering. If the value is Y, the user needs to accept the terms. The default value is N. -
UserCategory: string
Maximum Length:
240
Category to be assigned to a user for system access notifications and for URL redirection after the user creates an initial password. -
UserTermsOfUseId: string
Title:
Terms of Use ID
Maximum Length:15
Identifier for the terms of use, if any, that the user needs to accept during registration.
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 : publicSectorUserSetups-item-response
Type:
Show Source
object
-
AllowAttachments: string
Maximum Length:
1
Indicates whether users can attach documents in account management. If the value is Y, users can attach documents. The default value is N. -
AllowDelegation: string
Maximum Length:
1
When this option is enabled, registered users can delegate transactions to other users. Delegation can be for all transactions for a profile or for individual transactions. The default value is N. -
AllowDeleteAttachments: string
Maximum Length:
1
Indicates whether registered public users can delete documents in account management. -
AllowIvrAccess: string
Maximum Length:
1
Default Value:N
Indicates whether a registered user can enter a code into an interactive voice response system to access permit records and maintain inspection schedules The default value is N. -
AllowNumDelegates: integer
(int32)
Identifies the number of delegates allowed per profile. The limit is 999.
-
AllowTextCommunication: string
Maximum Length:
1
Indicates whether a registered user can choose to receive communications as text messages. The default value is N. -
AllowUpdAllTrans: string
Maximum Length:
1
Indicates whether a registered user can delegate the ability to manage all transactions for an account profile. The default value is N. -
AllowUpdSpecificTrans: string
Maximum Length:
1
Indicates whether a registered user can delegate the ability to manage individual transactions. The default value is N. -
AllowViewAllTrans: string
Maximum Length:
1
Indicates whether a registered user can delegate view-only access for all transactions for an account profile. The default value is N. -
AllowViewProfAttach: string
Maximum Length:
1
Indicates whether a user with delegated access to all transactions in a profile can also view attachments for the profile. The default value is N. -
AllowViewProfContacts: string
Maximum Length:
1
Indicates whether a user with delegated access to all transactions in a profile can also view contacts for the profile. The default value is N. -
AllowViewProfLicense: string
Maximum Length:
1
Indicates whether a user with delegated access to all transactions in a profile can also view licenses for the profile. The default value is N. -
AllowViewSpecificTrans: string
Maximum Length:
1
Indicates whether a registered user can delegate view-only access for individual transactions. The default value is N. -
DeletedFlag: boolean
Maximum Length:
1
Indicates whether the record is logically deleted. If the value is Y, the record has been logically deleted. The default value is N. -
DocGroupId: string
Title:
Document Group ID
Maximum Length:30
Indicates the attachment document group. -
InvitationExpiryOpt: string
Maximum Length:
30
Identifies the unit of time for the delegation invitation expiration period. The options are Days, Weeks, or Months. -
InviteExpiryNum: integer
(int32)
Identifies the number of days, weeks or months for the delegation invitation expiration period. This attribute is just for the number. Use the Invitation Expiry Option attribute to define the type of time period.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Meaning: string
Read Only:
true
Maximum Length:80
Identifies the meaning that is associated with the Invitation Expiry Option lookup value. -
RequestDelegateProjMgr: string
Maximum Length:
1
Indicates whether registered users who are the primary contact for a project can request delegation. The default value is N. -
SeedDataLock: integer
(int32)
Indicates whether the row is seed data. Valid values are 0 for data that is customer data, 1 for seed data that cannot be modified, and 2 for seed data that customers can modify.
-
SensitiveFlagAll: string
Maximum Length:
1
Default Value:N
Indicates whether an agency can hide contact information for all applicants from public view. The default value is N. -
SensitiveFlagOn: string
Maximum Length:
1
Indicates whether registered users can hide contact information from public view. If the value is Y, data for users who choose to hide contact information may require special handling. The default value is N. -
SuppressEmail: string
Maximum Length:
1
Indicates whether a profile or transaction owner can suppress emails for actions performed by a delegate. The default value is N. -
TermsOfUseOn: string
Maximum Length:
1
Indicates whether users need to accept terms of use when registering. If the value is Y, the user needs to accept the terms. The default value is N. -
UserCategory: string
Maximum Length:
240
Category to be assigned to a user for system access notifications and for URL redirection after the user creates an initial password. -
UserSetupId: string
Maximum Length:
3
Identifies the row in the public user setup table. The only valid value is PSC. -
UserTermsOfUseId: string
Title:
Terms of Use ID
Maximum Length:15
Identifier for the terms of use, if any, that the user needs to accept during registration.
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.