Update a registered public user account profile
patch
/fscmRestApi/resources/11.13.18.05/publicSectorUserProfiles/{ProfileId}
Request
Path Parameters
-
ProfileId(required): integer(int64)
The unique identifier for a registered public user account profile.
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
-
BusinessName: string
Title:
Business Name
Maximum Length:60
The business name in a business profile. -
BusinessType: string
Title:
Business Type
Maximum Length:30
The business type in a business profile. -
CntrctrVerificationStatus: string
Title:
Status
Maximum Length:2
The verification status of a registered public user's standing as a contractor. -
HiddenPersonalProfile: string
Maximum Length:
1
Default Value:N
Indicates whether the personal profile for an account should be hidden. When a user registers for a business, the personal profile is hidden by default. Valid values are Y for yes and N for no. -
IsContractor: string
Maximum Length:
1
Default Value:N
Indicates whether a profile has contractor status. Valid values are Y for yes and N for no. -
JobTitle: string
Maximum Length:
60
The registered public user's job title in a business profile. -
PersonType: string
Maximum Length:
10
The type of person. The only valid value is Public for a public user. -
PreferredContactMethod: string
Maximum Length:
30
Registered public user's preferred contact method for a profile. -
ProfileName: string
Title:
Profile Name
Maximum Length:60
The descriptive name of a registered public user account profile. -
ProfileStatus: string
Title:
Status
Maximum Length:1
Default Value:A
The profile status. Valid values are A (active) and I (inactive). -
SensitiveFlag: string
Maximum Length:
1
Default Value:N
Indicates whether the registered public user is a member of a law enforcement or a judicial agency. Valid values are Y for yes and N for no. -
SensitiveVerificationStatus: string
Maximum Length:
2
The verification status of a registered public user's standing as a member of law enforcement or a judicial agency.
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 : publicSectorUserProfiles-item-response
Type:
Show Source
object
-
BusinessName: string
Title:
Business Name
Maximum Length:60
The business name in a business profile. -
BusinessType: string
Title:
Business Type
Maximum Length:30
The business type in a business profile. -
CntrctrVerificationStatus: string
Title:
Status
Maximum Length:2
The verification status of a registered public user's standing as a contractor. -
HiddenPersonalProfile: string
Maximum Length:
1
Default Value:N
Indicates whether the personal profile for an account should be hidden. When a user registers for a business, the personal profile is hidden by default. Valid values are Y for yes and N for no. -
IsContractor: string
Maximum Length:
1
Default Value:N
Indicates whether a profile has contractor status. Valid values are Y for yes and N for no. -
JobTitle: string
Maximum Length:
60
The registered public user's job title in a business profile. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PartyId: integer
(int64)
The person party ID for the registered public user.
-
PersonType: string
Maximum Length:
10
The type of person. The only valid value is Public for a public user. -
PreferredContactMethod: string
Maximum Length:
30
Registered public user's preferred contact method for a profile. -
ProfileId: integer
(int64)
The unique identifier for a registered public user account profile.
-
ProfileName: string
Title:
Profile Name
Maximum Length:60
The descriptive name of a registered public user account profile. -
ProfileStatus: string
Title:
Status
Maximum Length:1
Default Value:A
The profile status. Valid values are A (active) and I (inactive). -
ProfileType: string
Title:
Profile Type
Maximum Length:20
The type of profile. Valid values are Personal and Business. -
PscUserId: integer
(int64)
The unique identifier for a registered public user reference row.
-
SensitiveFlag: string
Maximum Length:
1
Default Value:N
Indicates whether the registered public user is a member of a law enforcement or a judicial agency. Valid values are Y for yes and N for no. -
SensitiveVerificationStatus: string
Maximum Length:
2
The verification status of a registered public user's standing as a member of law enforcement or a judicial agency.
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.