Jump to

• Request
• Response

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

Request Body - application/json ()

The following table describes the body parameters in the request for this task.

Root Schema : schema

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "BusinessName":{
            "title":"Business Name",
            "maxLength":60,
            "type":"string",
            "description":"The business name in a business profile.",
            "nullable":true
        },
        "SensitiveVerificationStatus":{
            "maxLength":2,
            "type":"string",
            "description":"The verification status of a registered public user's standing as a member of law enforcement or a judicial agency.",
            "nullable":true
        },
        "BusinessType":{
            "title":"Business Type",
            "maxLength":30,
            "type":"string",
            "description":"The business type in a business profile.",
            "nullable":true
        },
        "ProfileStatus":{
            "title":"Status",
            "maxLength":1,
            "type":"string",
            "description":"The profile status. Valid values are  A (active) and I (inactive).",
            "nullable":false,
            "default":"A"
        },
        "ProfileName":{
            "title":"Profile Name",
            "maxLength":60,
            "type":"string",
            "description":"The descriptive name of a registered public user account profile.",
            "nullable":false
        },
        "PersonType":{
            "maxLength":10,
            "type":"string",
            "description":"The type of person. The only valid value is Public for a public user.",
            "nullable":false
        },
        "SensitiveFlag":{
            "maxLength":1,
            "type":"string",
            "description":"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.",
            "nullable":false,
            "default":"N"
        },
        "JobTitle":{
            "maxLength":60,
            "type":"string",
            "description":"The registered public user's job title in a business profile.",
            "nullable":true
        },
        "IsContractor":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether a profile has contractor status. Valid values are Y for yes and N for no.",
            "nullable":false,
            "default":"N"
        },
        "CntrctrVerificationStatus":{
            "title":"Status",
            "maxLength":2,
            "type":"string",
            "description":"The verification status of a registered public user's standing as a contractor.",
            "nullable":true
        },
        "HiddenPersonalProfile":{
            "maxLength":1,
            "type":"string",
            "description":"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.",
            "nullable":false,
            "default":"N"
        },
        "PreferredContactMethod":{
            "maxLength":30,
            "type":"string",
            "description":"Registered public user's preferred contact method for a profile.",
            "nullable":true
        }
    }
}

Back to Top

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.

Body ()

Root Schema : publicSectorUserProfiles-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "ProfileId":{
            "type":"integer",
            "description":"The unique identifier for a registered public user account profile.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ProfileType":{
            "title":"Profile Type",
            "maxLength":20,
            "type":"string",
            "description":"The type of profile. Valid values are Personal and Business.",
            "nullable":false,
            "x-queryable":true
        },
        "PscUserId":{
            "type":"integer",
            "description":"The unique identifier for a registered public user reference row.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BusinessName":{
            "title":"Business Name",
            "maxLength":60,
            "type":"string",
            "description":"The business name in a business profile.",
            "nullable":true,
            "x-queryable":true
        },
        "SensitiveVerificationStatus":{
            "maxLength":2,
            "type":"string",
            "description":"The verification status of a registered public user's standing as a member of law enforcement or a judicial agency.",
            "nullable":true,
            "x-queryable":true
        },
        "BusinessType":{
            "title":"Business Type",
            "maxLength":30,
            "type":"string",
            "description":"The business type in a business profile.",
            "nullable":true,
            "x-queryable":true
        },
        "ProfileStatus":{
            "title":"Status",
            "maxLength":1,
            "type":"string",
            "description":"The profile status. Valid values are  A (active) and I (inactive).",
            "nullable":false,
            "default":"A",
            "x-queryable":true
        },
        "ProfileName":{
            "title":"Profile Name",
            "maxLength":60,
            "type":"string",
            "description":"The descriptive name of a registered public user account profile.",
            "nullable":false,
            "x-queryable":true
        },
        "PersonType":{
            "maxLength":10,
            "type":"string",
            "description":"The type of person. The only valid value is Public for a public user.",
            "nullable":false,
            "x-queryable":true
        },
        "SensitiveFlag":{
            "maxLength":1,
            "type":"string",
            "description":"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.",
            "nullable":false,
            "default":"N",
            "x-queryable":true
        },
        "JobTitle":{
            "maxLength":60,
            "type":"string",
            "description":"The registered public user's job title in a business profile.",
            "nullable":true,
            "x-queryable":true
        },
        "PartyId":{
            "type":"integer",
            "description":"The person party ID for the registered public user.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "IsContractor":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether a profile has contractor status. Valid values are Y for yes and N for no.",
            "nullable":false,
            "default":"N",
            "x-queryable":true
        },
        "CntrctrVerificationStatus":{
            "title":"Status",
            "maxLength":2,
            "type":"string",
            "description":"The verification status of a registered public user's standing as a contractor.",
            "nullable":true,
            "x-queryable":true
        },
        "HiddenPersonalProfile":{
            "maxLength":1,
            "type":"string",
            "description":"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.",
            "nullable":false,
            "default":"N",
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PreferredContactMethod":{
            "maxLength":30,
            "type":"string",
            "description":"Registered public user's preferred contact method for a profile.",
            "nullable":true,
            "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 : 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."
        }
    }
}

Back to Top