Jump to

• Request
• Response

Update a personal profile of a registered user

patch

/fscmRestApi/resources/11.13.18.05/publicSectorPersonalProfiles/{publicSectorPersonalProfilesUniqID}

Request

Path Parameters

• publicSectorPersonalProfilesUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Personal Profiles resource and used to uniquely identify an instance of Personal Profiles. The client should not generate the hash key value. Instead, the client should query on the Personal Profiles collection resource in order to navigate to a specific instance of Personal Profiles to get the hash key.

Header Parameters

• Metadata-Context: string
  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: string
  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 ()

Root Schema : schema

Type: object

Show Source

• BusinessName: string
  Maximum Length: 60

  The person's business name.
• BusinessType: string
  Maximum Length: 30

  The person's business type.
• CntrctrVerificationStatus: string
  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 should be hidden. When a user registers for a business, 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 a contractor status. Valid values are Y for yes and N for no.
• IvrAccessCode: string
  Title: IVR Access Code

  Maximum Length: 512

  The user's four digit code to access permit records and maintain inspection schedules using an interactive voice response system.
• JobTitle: string
  Maximum Length: 60

  The person's job title.
• PersonFirstName: string
  Title: First Name

  The person's first name.
• PersonInitials: string
  Title: Initials

  The person's initials.
• PersonLastName: string
  Title: Last Name

  The person's last name.
• PersonMiddleName: string
  Title: Middle Name

  The person's middle name.
• PersonNameSuffix: string
  Title: Suffix

  The person's name suffix.
• PersonPreNameAdjunct: string
  Title: Salutation

  The salutation such as Mr. or Mrs. that is used before the person's name.
• PersonTitle: string
  Title: Title

  The person's title.
• PreferredContactMethod: string
  Maximum Length: 30

  Applicant's preferred contact method. Valid values are EMAIL for email, and PHONE for phone.
• ProfileContactPointEmail: array Profile Emails
  Title: Profile Emails

  The profile emails resource is used to view, create, or modify email contact points for a registered public user account profile.
• ProfileContactPointPhone: array Profile Phones
  Title: Profile Phones

  The profile phones resource is used to view, create, or modify phone contact points for a registered public user account profile.
• ProfileLocation: array Profile Locations
  Title: Profile Locations

  The profile locations resource is used to view, create, or modify contact addresses for a registered public user account profile.
• ProfileName: string
  Maximum Length: 60

  The registered public user account profile name.
• ProfileStatus: string
  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 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":{
            "maxLength":60,
            "type":"string",
            "description":"The person's business name.",
            "nullable":true
        },
        "BusinessType":{
            "maxLength":30,
            "type":"string",
            "description":"The person's business type.",
            "nullable":true
        },
        "CntrctrVerificationStatus":{
            "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 should be hidden. When a user registers for a business, personal profile is hidden by default. Valid values are Y for yes and N for no.",
            "nullable":false,
            "default":"N"
        },
        "IsContractor":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether a profile has a contractor status. Valid values are Y for yes and N for no.",
            "nullable":false,
            "default":"N"
        },
        "IvrAccessCode":{
            "title":"IVR Access Code",
            "maxLength":512,
            "type":"string",
            "description":"The user's four digit code to access permit records and maintain inspection schedules using an interactive voice response system.",
            "nullable":true
        },
        "JobTitle":{
            "maxLength":60,
            "type":"string",
            "description":"The person's job title.",
            "nullable":true
        },
        "PersonFirstName":{
            "title":"First Name",
            "type":"string",
            "description":"The person's first name.",
            "nullable":true,
            "x-queryable":false
        },
        "PersonInitials":{
            "title":"Initials",
            "type":"string",
            "description":"The person's initials.",
            "nullable":true,
            "x-queryable":false
        },
        "PersonLastName":{
            "title":"Last Name",
            "type":"string",
            "description":"The person's last name.",
            "nullable":true,
            "x-queryable":false
        },
        "PersonMiddleName":{
            "title":"Middle Name",
            "type":"string",
            "description":"The person's middle name.",
            "nullable":true,
            "x-queryable":false
        },
        "PersonNameSuffix":{
            "title":"Suffix",
            "type":"string",
            "description":"The person's name suffix.",
            "nullable":true,
            "x-queryable":false
        },
        "PersonPreNameAdjunct":{
            "title":"Salutation",
            "type":"string",
            "description":"The salutation such as Mr. or Mrs. that is used before the person's name.",
            "nullable":true,
            "x-queryable":false
        },
        "PersonTitle":{
            "title":"Title",
            "type":"string",
            "description":"The person's title.",
            "nullable":true,
            "x-queryable":false
        },
        "PreferredContactMethod":{
            "maxLength":30,
            "type":"string",
            "description":"Applicant's preferred contact method. Valid values are EMAIL for email, and PHONE for phone.",
            "nullable":true
        },
        "ProfileContactPointEmail":{
            "title":"Profile Emails",
            "type":"array",
            "description":"The profile emails resource is used to view, create, or modify email contact points for a registered public user account profile.",
            "items":{
                "$ref":"#/components/schemas/publicSectorPersonalProfiles-ProfileContactPointEmail-item-patch-request"
            }
        },
        "ProfileContactPointPhone":{
            "title":"Profile Phones",
            "type":"array",
            "description":"The profile phones resource is used to view, create, or modify phone contact points for a registered public user account profile.",
            "items":{
                "$ref":"#/components/schemas/publicSectorPersonalProfiles-ProfileContactPointPhone-item-patch-request"
            }
        },
        "ProfileLocation":{
            "title":"Profile Locations",
            "type":"array",
            "description":"The profile locations resource is used to view, create, or modify contact addresses for a registered public user account profile.",
            "items":{
                "$ref":"#/components/schemas/publicSectorPersonalProfiles-ProfileLocation-item-patch-request"
            }
        },
        "ProfileName":{
            "maxLength":60,
            "type":"string",
            "description":"The registered public user account profile name.",
            "nullable":false
        },
        "ProfileStatus":{
            "maxLength":1,
            "type":"string",
            "description":"The profile status. Valid values are  A (active) and I (inactive).",
            "nullable":false,
            "default":"A"
        },
        "SensitiveFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the 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"
        },
        "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
        }
    }
}

Nested Schema : Profile Emails

Type: array

Title: Profile Emails

The profile emails resource is used to view, create, or modify email contact points for a registered public user account profile.

Show Source

• Array of: object schema

{
    "title":"Profile Emails",
    "type":"array",
    "description":"The profile emails resource is used to view, create, or modify email contact points for a registered public user account profile.",
    "items":{
        "$ref":"#/components/schemas/publicSectorPersonalProfiles-ProfileContactPointEmail-item-patch-request"
    }
}

Nested Schema : Profile Phones

Type: array

Title: Profile Phones

The profile phones resource is used to view, create, or modify phone contact points for a registered public user account profile.

Show Source

• Array of: object publicSectorPersonalProfiles-ProfileContactPointPhone-item-patch-request

{
    "title":"Profile Phones",
    "type":"array",
    "description":"The profile phones resource is used to view, create, or modify phone contact points for a registered public user account profile.",
    "items":{
        "$ref":"#/components/schemas/publicSectorPersonalProfiles-ProfileContactPointPhone-item-patch-request"
    }
}

Nested Schema : Profile Locations

Type: array

Title: Profile Locations

The profile locations resource is used to view, create, or modify contact addresses for a registered public user account profile.

Show Source

• Array of: object schema

{
    "title":"Profile Locations",
    "type":"array",
    "description":"The profile locations resource is used to view, create, or modify contact addresses for a registered public user account profile.",
    "items":{
        "$ref":"#/components/schemas/publicSectorPersonalProfiles-ProfileLocation-item-patch-request"
    }
}

Nested Schema : schema

Type: object

Show Source

• ContactPointPurpose: string
  Title: Type

  The email type. Valid values are BUSINESS for work and PERSONAL for home.
• EmailAddress: string
  Title: Email

  The email address for the email contact point.
• PrimaryFlag: string
  Title: Primary

  Maximum Length: 1

  Indicates whether an email is the primary email for the profile. Valid values are Y for yes and N for no.
• Status: string
  The status of the email contact point. Valid values are A for active and I for inactive.

{
    "type":"object",
    "properties":{
        "ContactPointPurpose":{
            "title":"Type",
            "type":"string",
            "description":"The email type. Valid values are BUSINESS for work and PERSONAL for home.",
            "nullable":true,
            "x-queryable":false
        },
        "EmailAddress":{
            "title":"Email",
            "type":"string",
            "description":"The email address for the email contact point.",
            "nullable":true,
            "x-queryable":false
        },
        "PrimaryFlag":{
            "title":"Primary",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether an email is the primary email for the profile. Valid values are Y for yes and N for no.",
            "nullable":false
        },
        "Status":{
            "type":"string",
            "description":"The status of the email contact point. Valid values are A for active and I for inactive.",
            "nullable":false,
            "x-queryable":false
        }
    }
}

Nested Schema : publicSectorPersonalProfiles-ProfileContactPointPhone-item-patch-request

Type: object

Show Source

• ContactPointPurpose: string
  Title: Type

  The phone type. Valid values are BUSINESS for work and PERSONAL for home.
• PhoneAreaCode: string
  The phone area code.
• PhoneCountryCode: string
  The phone country code.
• PhoneExtension: string
  The phone extension.
• PhoneNumber: string
  The phone number.
• PhoneType: string
  Title: Type

  The phone type. Valid values are WORK, HOME, and MOBILE.
• PrimaryFlag: string
  Title: Primary

  Maximum Length: 1

  Indicates whether a phone is the primary phone for the profile. Valid values are Y for yes and N for no.
• Status: string
  The status of the phone contact point. Valid values are A for active and I for inactive.

{
    "type":"object",
    "properties":{
        "ContactPointPurpose":{
            "title":"Type",
            "type":"string",
            "description":"The phone type. Valid values are BUSINESS for work and PERSONAL for home.",
            "nullable":true
        },
        "PhoneAreaCode":{
            "type":"string",
            "description":"The phone area code.",
            "nullable":true
        },
        "PhoneCountryCode":{
            "type":"string",
            "description":"The phone country code.",
            "nullable":true
        },
        "PhoneExtension":{
            "type":"string",
            "description":"The phone extension.",
            "nullable":true
        },
        "PhoneNumber":{
            "type":"string",
            "description":"The phone number.",
            "nullable":true
        },
        "PhoneType":{
            "title":"Type",
            "type":"string",
            "description":"The phone type. Valid values are WORK, HOME, and MOBILE.",
            "nullable":true,
            "x-queryable":false
        },
        "PrimaryFlag":{
            "title":"Primary",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether a phone is the primary phone for the profile. Valid values are Y for yes and N for no.",
            "nullable":false
        },
        "Status":{
            "type":"string",
            "description":"The status of the phone contact point. Valid values are A for active and I for inactive.",
            "nullable":false,
            "x-queryable":false
        }
    }
}

Nested Schema : schema

Type: object

Show Source

• Address1: string
  Address line 1.
• Address2: string
  Address line 2.
• Address3: string
  Address line 3.
• Address4: string
  Address line 4.
• City: string
  Address city.
• Country: string
  Address country.
• County: string
  Address county.
• OnlineFlag: string
  Maximum Length: 1

  Indicates whether this location has a website. Valid values are Y for yes and N for no.
• PostalCode: string
  Address postal code.
• PrimaryFlag: string
  Title: Primary

  Maximum Length: 1

  Indicates whether an address is the primary address for the profile. Valid values are Y for yes and N for no.
• Province: string
  The province of the address.
• SiteUseType: string
  Title: Type

  The address type. Valid values are BUSINESS for business and HOME for home.
• State: string
  Address state.
• Status: string
  The status of the address contact point. Valid values are A for active and I for inactive.

{
    "type":"object",
    "properties":{
        "Address1":{
            "type":"string",
            "description":"Address line 1.",
            "nullable":true,
            "x-queryable":false
        },
        "Address2":{
            "type":"string",
            "description":"Address line 2.",
            "nullable":true,
            "x-queryable":false
        },
        "Address3":{
            "type":"string",
            "description":"Address line 3.",
            "nullable":true,
            "x-queryable":false
        },
        "Address4":{
            "type":"string",
            "description":"Address line 4.",
            "nullable":true,
            "x-queryable":false
        },
        "City":{
            "type":"string",
            "description":"Address city.",
            "nullable":true,
            "x-queryable":false
        },
        "Country":{
            "type":"string",
            "description":"Address country.",
            "nullable":false,
            "x-queryable":false
        },
        "County":{
            "type":"string",
            "description":"Address county.",
            "nullable":true,
            "x-queryable":false
        },
        "OnlineFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether this location has a website. Valid values are Y for yes and N for no.",
            "nullable":false
        },
        "PostalCode":{
            "type":"string",
            "description":"Address postal code.",
            "nullable":true,
            "x-queryable":false
        },
        "PrimaryFlag":{
            "title":"Primary",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether an address is the primary address for the profile. Valid values are Y for yes and N for no.",
            "nullable":false
        },
        "Province":{
            "type":"string",
            "description":"The province of the address.",
            "nullable":true,
            "x-queryable":false
        },
        "SiteUseType":{
            "title":"Type",
            "type":"string",
            "description":"The address type. Valid values are BUSINESS for business and HOME for home.",
            "nullable":false,
            "x-queryable":false
        },
        "State":{
            "type":"string",
            "description":"Address state.",
            "nullable":true,
            "x-queryable":false
        },
        "Status":{
            "type":"string",
            "description":"The status of the address contact point. Valid values are A for active and I for inactive.",
            "nullable":false,
            "x-queryable":false
        }
    }
}

Back to Top

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.

Body ()

Root Schema : publicSectorPersonalProfiles-item-response

Type: object

Show Source

• BusinessName: string
  Maximum Length: 60

  The person's business name.
• BusinessType: string
  Maximum Length: 30

  The person's business type.
• CntrctrVerificationStatus: string
  Maximum Length: 2

  The verification status of a registered public user's standing as a contractor.
• EmailAddress: string
  Read Only: true

  The user's primary email address.
• HiddenPersonalProfile: string
  Maximum Length: 1

  Default Value: N

  Indicates whether the personal profile should be hidden. When a user registers for a business, 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 a contractor status. Valid values are Y for yes and N for no.
• IvrAccessCode: string
  Title: IVR Access Code

  Maximum Length: 512

  The user's four digit code to access permit records and maintain inspection schedules using an interactive voice response system.
• JobTitle: string
  Maximum Length: 60

  The person's job title.
• 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.
• PersonFirstName: string
  Title: First Name

  The person's first name.
• PersonInitials: string
  Title: Initials

  The person's initials.
• PersonLastName: string
  Title: Last Name

  The person's last name.
• PersonMiddleName: string
  Title: Middle Name

  The person's middle name.
• PersonName: string
  Title: Display Name

  Read Only: true

  The person's full name including first name, middle name, and last name.
• PersonNameSuffix: string
  Title: Suffix

  The person's name suffix.
• PersonPreNameAdjunct: string
  Title: Salutation

  The salutation such as Mr. or Mrs. that is used before the person's name.
• PersonTitle: string
  Title: Title

  The person's title.
• PreferredContactMethod: string
  Maximum Length: 30

  Applicant's preferred contact method. Valid values are EMAIL for email, and PHONE for phone.
• ProfileContactPointEmail: array Profile Emails
  Title: Profile Emails

  The profile emails resource is used to view, create, or modify email contact points for a registered public user account profile.
• ProfileContactPointPhone: array Profile Phones
  Title: Profile Phones

  The profile phones resource is used to view, create, or modify phone contact points for a registered public user account profile.
• ProfileId: integer (int64)
  The unique identifier for a registered public user account profile.
• ProfileLocation: array Profile Locations
  Title: Profile Locations

  The profile locations resource is used to view, create, or modify contact addresses for a registered public user account profile.
• ProfileName: string
  Maximum Length: 60

  The registered public user account profile name.
• ProfileStatus: string
  Maximum Length: 1

  Default Value: A

  The profile status. Valid values are A (active) and I (inactive).
• PscUserId: integer (int64)
  The unique identifier for a registered public user reference row.
• SensitiveFlag: string
  Maximum Length: 1

  Default Value: N

  Indicates whether the 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.
• UserId: integer
  Read Only: true

  The unique identifier for a user in the fusion system.
• Username: string
  Read Only: true

  The user's unique user name for signing in to the fusion system.

{
    "type":"object",
    "properties":{
        "BusinessName":{
            "maxLength":60,
            "type":"string",
            "description":"The person's business name.",
            "nullable":true,
            "x-queryable":true
        },
        "BusinessType":{
            "maxLength":30,
            "type":"string",
            "description":"The person's business type.",
            "nullable":true,
            "x-queryable":true
        },
        "CntrctrVerificationStatus":{
            "maxLength":2,
            "type":"string",
            "description":"The verification status of a registered public user's standing as a contractor.",
            "nullable":true,
            "x-queryable":true
        },
        "EmailAddress":{
            "type":"string",
            "description":"The user's primary email address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "HiddenPersonalProfile":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the personal profile should be hidden. When a user registers for a business, personal profile is hidden by default. Valid values are Y for yes and N for no.",
            "nullable":false,
            "default":"N",
            "x-queryable":true
        },
        "IsContractor":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether a profile has a contractor status. Valid values are Y for yes and N for no.",
            "nullable":false,
            "default":"N",
            "x-queryable":true
        },
        "IvrAccessCode":{
            "title":"IVR Access Code",
            "maxLength":512,
            "type":"string",
            "description":"The user's four digit code to access permit records and maintain inspection schedules using an interactive voice response system.",
            "nullable":true,
            "x-queryable":true
        },
        "JobTitle":{
            "maxLength":60,
            "type":"string",
            "description":"The person's job title.",
            "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
        },
        "PersonFirstName":{
            "title":"First Name",
            "type":"string",
            "description":"The person's first name.",
            "nullable":true,
            "x-queryable":false
        },
        "PersonInitials":{
            "title":"Initials",
            "type":"string",
            "description":"The person's initials.",
            "nullable":true,
            "x-queryable":false
        },
        "PersonLastName":{
            "title":"Last Name",
            "type":"string",
            "description":"The person's last name.",
            "nullable":true,
            "x-queryable":false
        },
        "PersonMiddleName":{
            "title":"Middle Name",
            "type":"string",
            "description":"The person's middle name.",
            "nullable":true,
            "x-queryable":false
        },
        "PersonName":{
            "title":"Display Name",
            "type":"string",
            "description":"The person's full name including first name, middle name, and last name.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PersonNameSuffix":{
            "title":"Suffix",
            "type":"string",
            "description":"The person's name suffix.",
            "nullable":true,
            "x-queryable":false
        },
        "PersonPreNameAdjunct":{
            "title":"Salutation",
            "type":"string",
            "description":"The salutation such as Mr. or Mrs. that is used before the person's name.",
            "nullable":true,
            "x-queryable":false
        },
        "PersonTitle":{
            "title":"Title",
            "type":"string",
            "description":"The person's title.",
            "nullable":true,
            "x-queryable":false
        },
        "PreferredContactMethod":{
            "maxLength":30,
            "type":"string",
            "description":"Applicant's preferred contact method. Valid values are EMAIL for email, and PHONE for phone.",
            "nullable":true,
            "x-queryable":true
        },
        "ProfileContactPointEmail":{
            "title":"Profile Emails",
            "type":"array",
            "description":"The profile emails resource is used to view, create, or modify email contact points for a registered public user account profile.",
            "items":{
                "$ref":"#/components/schemas/publicSectorPersonalProfiles-ProfileContactPointEmail-item-response"
            }
        },
        "ProfileContactPointPhone":{
            "title":"Profile Phones",
            "type":"array",
            "description":"The profile phones resource is used to view, create, or modify phone contact points for a registered public user account profile.",
            "items":{
                "$ref":"#/components/schemas/publicSectorPersonalProfiles-ProfileContactPointPhone-item-response"
            }
        },
        "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
        },
        "ProfileLocation":{
            "title":"Profile Locations",
            "type":"array",
            "description":"The profile locations resource is used to view, create, or modify contact addresses for a registered public user account profile.",
            "items":{
                "$ref":"#/components/schemas/publicSectorPersonalProfiles-ProfileLocation-item-response"
            }
        },
        "ProfileName":{
            "maxLength":60,
            "type":"string",
            "description":"The registered public user account profile name.",
            "nullable":false,
            "x-queryable":true
        },
        "ProfileStatus":{
            "maxLength":1,
            "type":"string",
            "description":"The profile status. Valid values are  A (active) and I (inactive).",
            "nullable":false,
            "default":"A",
            "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
        },
        "SensitiveFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the 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
        },
        "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
        },
        "UserId":{
            "type":"integer",
            "description":"The unique identifier for a user in the fusion system.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "Username":{
            "type":"string",
            "description":"The user's unique user name for signing in to the fusion system.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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 : Profile Emails

Type: array

Title: Profile Emails

The profile emails resource is used to view, create, or modify email contact points for a registered public user account profile.

Show Source

• Array of: object publicSectorPersonalProfiles-ProfileContactPointEmail-item-response

{
    "title":"Profile Emails",
    "type":"array",
    "description":"The profile emails resource is used to view, create, or modify email contact points for a registered public user account profile.",
    "items":{
        "$ref":"#/components/schemas/publicSectorPersonalProfiles-ProfileContactPointEmail-item-response"
    }
}

Nested Schema : Profile Phones

Type: array

Title: Profile Phones

The profile phones resource is used to view, create, or modify phone contact points for a registered public user account profile.

Show Source

• Array of: object publicSectorPersonalProfiles-ProfileContactPointPhone-item-response

{
    "title":"Profile Phones",
    "type":"array",
    "description":"The profile phones resource is used to view, create, or modify phone contact points for a registered public user account profile.",
    "items":{
        "$ref":"#/components/schemas/publicSectorPersonalProfiles-ProfileContactPointPhone-item-response"
    }
}

Nested Schema : Profile Locations

Type: array

Title: Profile Locations

The profile locations resource is used to view, create, or modify contact addresses for a registered public user account profile.

Show Source

• Array of: object publicSectorPersonalProfiles-ProfileLocation-item-response

{
    "title":"Profile Locations",
    "type":"array",
    "description":"The profile locations resource is used to view, create, or modify contact addresses for a registered public user account profile.",
    "items":{
        "$ref":"#/components/schemas/publicSectorPersonalProfiles-ProfileLocation-item-response"
    }
}

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."
        }
    }
}

Nested Schema : publicSectorPersonalProfiles-ProfileContactPointEmail-item-response

Type: object

Show Source

• ContactPointPurpose: string
  Title: Type

  The email type. Valid values are BUSINESS for work and PERSONAL for home.
• ContactPtId: integer (int64)
  The unique identifier for the email contact point.
• EmailAddress: string
  Title: Email

  The email address for the email contact point.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PrimaryFlag: string
  Title: Primary

  Maximum Length: 1

  Indicates whether an email is the primary email for the profile. Valid values are Y for yes and N for no.
• ProfileId: integer (int64)
  The unique identifier for the profile that is associated with the email contact point.
• Status: string
  The status of the email contact point. Valid values are A for active and I for inactive.

{
    "type":"object",
    "properties":{
        "ContactPointPurpose":{
            "title":"Type",
            "type":"string",
            "description":"The email type. Valid values are BUSINESS for work and PERSONAL for home.",
            "nullable":true,
            "x-queryable":false
        },
        "ContactPtId":{
            "type":"integer",
            "description":"The unique identifier for the email contact point.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "EmailAddress":{
            "title":"Email",
            "type":"string",
            "description":"The email address for the email contact point.",
            "nullable":true,
            "x-queryable":false
        },
        "PrimaryFlag":{
            "title":"Primary",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether an email is the primary email for the profile. Valid values are Y for yes and N for no.",
            "nullable":false,
            "x-queryable":true
        },
        "ProfileId":{
            "type":"integer",
            "description":"The unique identifier for the profile that is associated with the email contact point.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Status":{
            "type":"string",
            "description":"The status of the email contact point. Valid values are A for active and I for inactive.",
            "nullable":false,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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 : publicSectorPersonalProfiles-ProfileContactPointPhone-item-response

Type: object

Show Source

• ContactPointPurpose: string
  Title: Type

  The phone type. Valid values are BUSINESS for work and PERSONAL for home.
• ContactPtId: integer (int64)
  The unique identifier for the phone contact point.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PhoneAreaCode: string
  The phone area code.
• PhoneCountryCode: string
  The phone country code.
• PhoneExtension: string
  The phone extension.
• PhoneFull: string
  Read Only: true

  The formatted phone number.
• PhoneNumber: string
  The phone number.
• PhoneType: string
  Title: Type

  The phone type. Valid values are WORK, HOME, and MOBILE.
• PrimaryFlag: string
  Title: Primary

  Maximum Length: 1

  Indicates whether a phone is the primary phone for the profile. Valid values are Y for yes and N for no.
• ProfileId: integer (int64)
  The unique identifier for the profile that is associated with the phone contact point.
• Status: string
  The status of the phone contact point. Valid values are A for active and I for inactive.

{
    "type":"object",
    "properties":{
        "ContactPointPurpose":{
            "title":"Type",
            "type":"string",
            "description":"The phone type. Valid values are BUSINESS for work and PERSONAL for home.",
            "nullable":true,
            "x-queryable":true
        },
        "ContactPtId":{
            "type":"integer",
            "description":"The unique identifier for the phone contact point.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "PhoneAreaCode":{
            "type":"string",
            "description":"The phone area code.",
            "nullable":true,
            "x-queryable":true
        },
        "PhoneCountryCode":{
            "type":"string",
            "description":"The phone country code.",
            "nullable":true,
            "x-queryable":true
        },
        "PhoneExtension":{
            "type":"string",
            "description":"The phone extension.",
            "nullable":true,
            "x-queryable":true
        },
        "PhoneFull":{
            "type":"string",
            "description":"The formatted phone number.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PhoneNumber":{
            "type":"string",
            "description":"The phone number.",
            "nullable":true,
            "x-queryable":true
        },
        "PhoneType":{
            "title":"Type",
            "type":"string",
            "description":"The phone type. Valid values are WORK, HOME, and MOBILE.",
            "nullable":true,
            "x-queryable":false
        },
        "PrimaryFlag":{
            "title":"Primary",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether a phone is the primary phone for the profile. Valid values are Y for yes and N for no.",
            "nullable":false,
            "x-queryable":true
        },
        "ProfileId":{
            "type":"integer",
            "description":"The unique identifier for the profile that is associated with the phone contact point.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Status":{
            "type":"string",
            "description":"The status of the phone contact point. Valid values are A for active and I for inactive.",
            "nullable":false,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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 : publicSectorPersonalProfiles-ProfileLocation-item-response

Type: object

Show Source

• Address1: string
  Address line 1.
• Address2: string
  Address line 2.
• Address3: string
  Address line 3.
• Address4: string
  Address line 4.
• AddressFull: string
  Read Only: true

  The full address for a profile address.
• City: string
  Address city.
• Country: string
  Address country.
• County: string
  Address county.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LocationSiteId: integer (int64)
  The unique identifier for a contact address.
• OnlineFlag: string
  Maximum Length: 1

  Indicates whether this location has a website. Valid values are Y for yes and N for no.
• PostalCode: string
  Address postal code.
• PrimaryFlag: string
  Title: Primary

  Maximum Length: 1

  Indicates whether an address is the primary address for the profile. Valid values are Y for yes and N for no.
• ProfileId: integer (int64)
  The unique identifier for the profile that is associated with the address.
• Province: string
  The province of the address.
• SiteUseType: string
  Title: Type

  The address type. Valid values are BUSINESS for business and HOME for home.
• State: string
  Address state.
• Status: string
  The status of the address contact point. Valid values are A for active and I for inactive.

{
    "type":"object",
    "properties":{
        "Address1":{
            "type":"string",
            "description":"Address line 1.",
            "nullable":true,
            "x-queryable":false
        },
        "Address2":{
            "type":"string",
            "description":"Address line 2.",
            "nullable":true,
            "x-queryable":false
        },
        "Address3":{
            "type":"string",
            "description":"Address line 3.",
            "nullable":true,
            "x-queryable":false
        },
        "Address4":{
            "type":"string",
            "description":"Address line 4.",
            "nullable":true,
            "x-queryable":false
        },
        "AddressFull":{
            "type":"string",
            "description":"The full address for a profile address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "City":{
            "type":"string",
            "description":"Address city.",
            "nullable":true,
            "x-queryable":false
        },
        "Country":{
            "type":"string",
            "description":"Address country.",
            "nullable":false,
            "x-queryable":false
        },
        "County":{
            "type":"string",
            "description":"Address county.",
            "nullable":true,
            "x-queryable":false
        },
        "LocationSiteId":{
            "type":"integer",
            "description":"The unique identifier for a contact address.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "OnlineFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether this location has a website. Valid values are Y for yes and N for no.",
            "nullable":false,
            "x-queryable":true
        },
        "PostalCode":{
            "type":"string",
            "description":"Address postal code.",
            "nullable":true,
            "x-queryable":false
        },
        "PrimaryFlag":{
            "title":"Primary",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether an address is the primary address for the profile. Valid values are Y for yes and N for no.",
            "nullable":false,
            "x-queryable":true
        },
        "ProfileId":{
            "type":"integer",
            "description":"The unique identifier for the profile that is associated with the address.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Province":{
            "type":"string",
            "description":"The province of the address.",
            "nullable":true,
            "x-queryable":false
        },
        "SiteUseType":{
            "title":"Type",
            "type":"string",
            "description":"The address type. Valid values are BUSINESS for business and HOME for home.",
            "nullable":false,
            "x-queryable":false
        },
        "State":{
            "type":"string",
            "description":"Address state.",
            "nullable":true,
            "x-queryable":false
        },
        "Status":{
            "type":"string",
            "description":"The status of the address contact point. Valid values are A for active and I for inactive.",
            "nullable":false,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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"
    }
}

Links

ProfileContactPointEmail

Operation: /fscmRestApi/resources/11.13.18.05/publicSectorPersonalProfiles/{publicSectorPersonalProfilesUniqID}/child/ProfileContactPointEmail

Parameters:

• publicSectorPersonalProfilesUniqID: $request.path.publicSectorPersonalProfilesUniqID

The profile emails resource is used to view, create, or modify email contact points for a registered public user account profile.

ProfileContactPointPhone

Operation: /fscmRestApi/resources/11.13.18.05/publicSectorPersonalProfiles/{publicSectorPersonalProfilesUniqID}/child/ProfileContactPointPhone

Parameters:

• publicSectorPersonalProfilesUniqID: $request.path.publicSectorPersonalProfilesUniqID

The profile phones resource is used to view, create, or modify phone contact points for a registered public user account profile.

ProfileLocation

Operation: /fscmRestApi/resources/11.13.18.05/publicSectorPersonalProfiles/{publicSectorPersonalProfilesUniqID}/child/ProfileLocation

Parameters:

• publicSectorPersonalProfilesUniqID: $request.path.publicSectorPersonalProfilesUniqID

The profile locations resource is used to view, create, or modify contact addresses for a registered public user account profile.

Back to Top