Create a personal profile of a registered user
post
/fscmRestApi/resources/11.13.18.05/publicSectorPersonalProfiles
Request
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
The following table describes the body parameters in the request for this task.
Root Schema : publicSectorPersonalProfiles-item
Type:
Show Source
object-
CntrctrVerificationStatus(optional):
string
Maximum Length:
2The verification status of a registered public user's standing as a contractor. -
EmailAddress(optional):
string
The user's primary email address.
-
HiddenPersonalProfile(optional):
string
Maximum Length:
1Indicates 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(optional):
string
Maximum Length:
1Indicates whether a profile has a contractor status. Valid values are Y for yes and N for no. -
IvrAccessCode(optional):
string
Title:
IVR Access CodeMaximum Length:512The user's four digit code to access permit records and maintain inspection schedules using an interactive voice response system. -
links(optional):
array Items
Title:
ItemsLink Relations -
PartyId(optional):
integer(int64)
The person party ID for the registered public user.
-
PersonFirstName(optional):
string
Title:
First NameThe person's first name. -
PersonInitials(optional):
string
Title:
InitialsThe person's initials. -
PersonLastName(optional):
string
Title:
Last NameThe person's last name. -
PersonMiddleName(optional):
string
Title:
Middle NameThe person's middle name. -
PersonName(optional):
string
Title:
Display NameThe person's full name including first name, middle name, and last name. -
PersonNameSuffix(optional):
string
Title:
SuffixThe person's name suffix. -
PersonPreNameAdjunct(optional):
string
Title:
SalutationThe salutation such as Mr. or Mrs. that is used before the person's name. -
PersonTitle(optional):
string
Title:
TitleThe person's title. -
PreferredContactMethod(optional):
string
Maximum Length:
30Applicant's preferred contact method. Valid values are EMAIL for email, and PHONE for phone. -
ProfileContactPointEmail(optional):
array Profile Emails
Title:
Profile EmailsThe profile emails resource is used to view, create, or modify email contact points for a registered public user account profile. -
ProfileContactPointPhone(optional):
array Profile Phones
Title:
Profile PhonesThe profile phones resource is used to view, create, or modify phone contact points for a registered public user account profile. -
ProfileId(optional):
integer(int64)
The unique identifier for a registered public user account profile.
-
ProfileLocation(optional):
array Profile Locations
Title:
Profile LocationsThe profile locations resource is used to view, create, or modify contact addresses for a registered public user account profile. -
ProfileName(optional):
string
Maximum Length:
60The registered public user account profile name. -
ProfileStatus(optional):
string
Maximum Length:
1The profile status. Valid values are A (active) and I (inactive). -
PscUserId(optional):
integer(int64)
The unique identifier for a registered public user reference row.
-
SensitiveFlag(optional):
string
Maximum Length:
1Indicates 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(optional):
string
Maximum Length:
2The verification status of a registered public user's standing as a member of law enforcement or a judicial agency. -
UserId(optional):
integer(int64)
The unique identifier for a user in the fusion system.
-
Username(optional):
string
The user's unique user name for signing in to the fusion system.
Nested Schema : Profile Emails
Type:
arrayTitle:
Profile EmailsThe profile emails resource is used to view, create, or modify email contact points for a registered public user account profile.
Show Source
Nested Schema : Profile Phones
Type:
arrayTitle:
Profile PhonesThe profile phones resource is used to view, create, or modify phone contact points for a registered public user account profile.
Show Source
Nested Schema : Profile Locations
Type:
arrayTitle:
Profile LocationsThe profile locations resource is used to view, create, or modify contact addresses for a registered public user account profile.
Show Source
Nested Schema : link
Type:
Show Source
object-
href(optional):
string
Title:
hyperlink referenceThe URI to the related resource. -
rel(optional):
string
Title:
relationThe name of the relation to the resource instance. Example: self.
Nested Schema : publicSectorPersonalProfiles-ProfileContactPointEmail-item
Type:
Show Source
object-
ContactPointPurpose(optional):
string
Title:
TypeThe email type. Valid values are BUSINESS for work and PERSONAL for home. -
ContactPtId(optional):
integer(int64)
The unique identifier for the email contact point.
-
EmailAddress(optional):
string
Title:
EmailThe email address for the email contact point. -
links(optional):
array Items
Title:
ItemsLink Relations -
PrimaryFlag(optional):
string
Title:
PrimaryMaximum Length:1Indicates whether an email is the primary email for the profile. Valid values are Y for yes and N for no. -
ProfileId(optional):
integer(int64)
The unique identifier for the profile that is associated with the email contact point.
-
Status(optional):
string
The status of the email contact point. Valid values are A for active and I for inactive.
Nested Schema : publicSectorPersonalProfiles-ProfileContactPointPhone-item
Type:
Show Source
object-
ContactPointPurpose(optional):
string
Title:
TypeThe phone type. Valid values are BUSINESS for work and PERSONAL for home. -
ContactPtId(optional):
integer(int64)
The unique identifier for the phone contact point.
-
links(optional):
array Items
Title:
ItemsLink Relations -
PhoneAreaCode(optional):
string
The phone area code.
-
PhoneCountryCode(optional):
string
The phone country code.
-
PhoneExtension(optional):
string
The phone extension.
-
PhoneFull(optional):
string
The formatted phone number.
-
PhoneNumber(optional):
string
The phone number.
-
PhoneType(optional):
string
Title:
TypeThe phone type. Valid values are WORK, HOME, and MOBILE. -
PrimaryFlag(optional):
string
Title:
PrimaryMaximum Length:1Indicates whether a phone is the primary phone for the profile. Valid values are Y for yes and N for no. -
ProfileId(optional):
integer(int64)
The unique identifier for the profile that is associated with the phone contact point.
-
Status(optional):
string
The status of the phone contact point. Valid values are A for active and I for inactive.
Nested Schema : publicSectorPersonalProfiles-ProfileLocation-item
Type:
Show Source
object-
Address1(optional):
string
Address line 1.
-
Address2(optional):
string
Address line 2.
-
Address3(optional):
string
Address line 3.
-
Address4(optional):
string
Address line 4.
-
AddressFull(optional):
string
The full address for a profile address.
-
City(optional):
string
Address city.
-
Country(optional):
string
Address country.
-
County(optional):
string
Address county.
-
links(optional):
array Items
Title:
ItemsLink Relations -
LocationSiteId(optional):
integer(int64)
The unique identifier for a contact address.
-
OnlineFlag(optional):
string
Maximum Length:
1Indicates whether this location has a website. Valid values are Y for yes and N for no. -
PostalCode(optional):
string
Address postal code.
-
PrimaryFlag(optional):
string
Title:
PrimaryMaximum Length:1Indicates whether an address is the primary address for the profile. Valid values are Y for yes and N for no. -
ProfileId(optional):
integer(int64)
The unique identifier for the profile that is associated with the address.
-
SiteUseType(optional):
string
Title:
TypeThe address type. Valid values are BUSINESS for business and HOME for home. -
State(optional):
string
Address state.
-
Status(optional):
string
The status of the address contact point. Valid values are A for active and I for inactive.
Response
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
Default Response
The following table describes the default response for this task.
Root Schema : publicSectorPersonalProfiles-item
Type:
Show Source
object-
CntrctrVerificationStatus(optional):
string
Maximum Length:
2The verification status of a registered public user's standing as a contractor. -
EmailAddress(optional):
string
The user's primary email address.
-
HiddenPersonalProfile(optional):
string
Maximum Length:
1Indicates 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(optional):
string
Maximum Length:
1Indicates whether a profile has a contractor status. Valid values are Y for yes and N for no. -
IvrAccessCode(optional):
string
Title:
IVR Access CodeMaximum Length:512The user's four digit code to access permit records and maintain inspection schedules using an interactive voice response system. -
links(optional):
array Items
Title:
ItemsLink Relations -
PartyId(optional):
integer(int64)
The person party ID for the registered public user.
-
PersonFirstName(optional):
string
Title:
First NameThe person's first name. -
PersonInitials(optional):
string
Title:
InitialsThe person's initials. -
PersonLastName(optional):
string
Title:
Last NameThe person's last name. -
PersonMiddleName(optional):
string
Title:
Middle NameThe person's middle name. -
PersonName(optional):
string
Title:
Display NameThe person's full name including first name, middle name, and last name. -
PersonNameSuffix(optional):
string
Title:
SuffixThe person's name suffix. -
PersonPreNameAdjunct(optional):
string
Title:
SalutationThe salutation such as Mr. or Mrs. that is used before the person's name. -
PersonTitle(optional):
string
Title:
TitleThe person's title. -
PreferredContactMethod(optional):
string
Maximum Length:
30Applicant's preferred contact method. Valid values are EMAIL for email, and PHONE for phone. -
ProfileContactPointEmail(optional):
array Profile Emails
Title:
Profile EmailsThe profile emails resource is used to view, create, or modify email contact points for a registered public user account profile. -
ProfileContactPointPhone(optional):
array Profile Phones
Title:
Profile PhonesThe profile phones resource is used to view, create, or modify phone contact points for a registered public user account profile. -
ProfileId(optional):
integer(int64)
The unique identifier for a registered public user account profile.
-
ProfileLocation(optional):
array Profile Locations
Title:
Profile LocationsThe profile locations resource is used to view, create, or modify contact addresses for a registered public user account profile. -
ProfileName(optional):
string
Maximum Length:
60The registered public user account profile name. -
ProfileStatus(optional):
string
Maximum Length:
1The profile status. Valid values are A (active) and I (inactive). -
PscUserId(optional):
integer(int64)
The unique identifier for a registered public user reference row.
-
SensitiveFlag(optional):
string
Maximum Length:
1Indicates 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(optional):
string
Maximum Length:
2The verification status of a registered public user's standing as a member of law enforcement or a judicial agency. -
UserId(optional):
integer(int64)
The unique identifier for a user in the fusion system.
-
Username(optional):
string
The user's unique user name for signing in to the fusion system.
Nested Schema : Profile Emails
Type:
arrayTitle:
Profile EmailsThe profile emails resource is used to view, create, or modify email contact points for a registered public user account profile.
Show Source
Nested Schema : Profile Phones
Type:
arrayTitle:
Profile PhonesThe profile phones resource is used to view, create, or modify phone contact points for a registered public user account profile.
Show Source
Nested Schema : Profile Locations
Type:
arrayTitle:
Profile LocationsThe profile locations resource is used to view, create, or modify contact addresses for a registered public user account profile.
Show Source
Nested Schema : link
Type:
Show Source
object-
href(optional):
string
Title:
hyperlink referenceThe URI to the related resource. -
rel(optional):
string
Title:
relationThe name of the relation to the resource instance. Example: self.
Nested Schema : publicSectorPersonalProfiles-ProfileContactPointEmail-item
Type:
Show Source
object-
ContactPointPurpose(optional):
string
Title:
TypeThe email type. Valid values are BUSINESS for work and PERSONAL for home. -
ContactPtId(optional):
integer(int64)
The unique identifier for the email contact point.
-
EmailAddress(optional):
string
Title:
EmailThe email address for the email contact point. -
links(optional):
array Items
Title:
ItemsLink Relations -
PrimaryFlag(optional):
string
Title:
PrimaryMaximum Length:1Indicates whether an email is the primary email for the profile. Valid values are Y for yes and N for no. -
ProfileId(optional):
integer(int64)
The unique identifier for the profile that is associated with the email contact point.
-
Status(optional):
string
The status of the email contact point. Valid values are A for active and I for inactive.
Nested Schema : publicSectorPersonalProfiles-ProfileContactPointPhone-item
Type:
Show Source
object-
ContactPointPurpose(optional):
string
Title:
TypeThe phone type. Valid values are BUSINESS for work and PERSONAL for home. -
ContactPtId(optional):
integer(int64)
The unique identifier for the phone contact point.
-
links(optional):
array Items
Title:
ItemsLink Relations -
PhoneAreaCode(optional):
string
The phone area code.
-
PhoneCountryCode(optional):
string
The phone country code.
-
PhoneExtension(optional):
string
The phone extension.
-
PhoneFull(optional):
string
The formatted phone number.
-
PhoneNumber(optional):
string
The phone number.
-
PhoneType(optional):
string
Title:
TypeThe phone type. Valid values are WORK, HOME, and MOBILE. -
PrimaryFlag(optional):
string
Title:
PrimaryMaximum Length:1Indicates whether a phone is the primary phone for the profile. Valid values are Y for yes and N for no. -
ProfileId(optional):
integer(int64)
The unique identifier for the profile that is associated with the phone contact point.
-
Status(optional):
string
The status of the phone contact point. Valid values are A for active and I for inactive.
Nested Schema : publicSectorPersonalProfiles-ProfileLocation-item
Type:
Show Source
object-
Address1(optional):
string
Address line 1.
-
Address2(optional):
string
Address line 2.
-
Address3(optional):
string
Address line 3.
-
Address4(optional):
string
Address line 4.
-
AddressFull(optional):
string
The full address for a profile address.
-
City(optional):
string
Address city.
-
Country(optional):
string
Address country.
-
County(optional):
string
Address county.
-
links(optional):
array Items
Title:
ItemsLink Relations -
LocationSiteId(optional):
integer(int64)
The unique identifier for a contact address.
-
OnlineFlag(optional):
string
Maximum Length:
1Indicates whether this location has a website. Valid values are Y for yes and N for no. -
PostalCode(optional):
string
Address postal code.
-
PrimaryFlag(optional):
string
Title:
PrimaryMaximum Length:1Indicates whether an address is the primary address for the profile. Valid values are Y for yes and N for no. -
ProfileId(optional):
integer(int64)
The unique identifier for the profile that is associated with the address.
-
SiteUseType(optional):
string
Title:
TypeThe address type. Valid values are BUSINESS for business and HOME for home. -
State(optional):
string
Address state.
-
Status(optional):
string
The status of the address contact point. Valid values are A for active and I for inactive.