Create a personal profile of a registered user
post
/fscmRestApi/resources/11.13.18.05/publicSectorPersonalProfiles
Request
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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
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. -
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. -
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(required): 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(required): 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.
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
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
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
Nested Schema : schema
Type:
Show Source
object
-
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. -
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.
Nested Schema : schema
Type:
Show Source
object
-
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.
-
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. -
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.
Nested Schema : schema
Type:
Show Source
object
-
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.
-
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.
-
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.
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.
Root Schema : publicSectorPersonalProfiles-item-response
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
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
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
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
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.
Nested Schema : publicSectorPersonalProfiles-ProfileContactPointEmail-item-response
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorPersonalProfiles-ProfileContactPointPhone-item-response
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorPersonalProfiles-ProfileLocation-item-response
Type:
Show Source
object
-
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.
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- 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. - publicSectorPersonalProfilesUniqID:
- 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. - publicSectorPersonalProfilesUniqID:
- 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. - publicSectorPersonalProfilesUniqID: