Create a business profile of a registered public user
post
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessProfiles
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 business name for a registered public user account business profile. -
BusinessType: string
Maximum Length:
30
The business type for a registered public user account business profile. -
CntrctrVerificationStatus: string
Maximum Length:
2
The verification status of a registered public user's standing as a contractor. -
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. -
JobTitle: string
Maximum Length:
60
The person's job title. -
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 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 for active and I for inactive. -
PscUserId(required): integer
(int64)
The unique identifier for a registered public user reference row.
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 addresses for a registered public user account profile.
Show Source
Nested Schema : publicSectorBusinessProfiles-ProfileContactPointEmail-item-post-request
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 : publicSectorBusinessProfiles-ProfileContactPointPhone-item-post-request
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 : publicSectorBusinessProfiles-ProfileLocation-item-post-request
Type:
Show Source
object
-
Address1: string
The first line of the address.
-
Address2: string
The second line of the address.
-
Address3: string
The third line of the address.
-
Address4: string
The fourth line of the address.
-
City: string
The city of the address.
-
Country: string
The country of the address.
-
County: string
The county of the address.
-
LocationSiteId: integer
(int64)
The unique identifier for a profile 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
The postal code of the address.
-
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
The state for the address.
-
Status: string
The status of the address. 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 : publicSectorBusinessProfiles-item-response
Type:
Show Source
object
-
BusinessName: string
Maximum Length:
60
The business name for a registered public user account business profile. -
BusinessType: string
Maximum Length:
30
The business type for a registered public user account business profile. -
CntrctrVerificationStatus: string
Maximum Length:
2
The verification status of a registered public user's standing as a contractor. -
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. -
JobTitle: string
Maximum Length:
60
The person's job title. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
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 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 for active and I for inactive. -
PscUserId: integer
(int64)
The unique identifier for a registered public user reference row.
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 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 : publicSectorBusinessProfiles-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 : publicSectorBusinessProfiles-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 full 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 : publicSectorBusinessProfiles-ProfileLocation-item-response
Type:
Show Source
object
-
Address1: string
The first line of the address.
-
Address2: string
The second line of the address.
-
Address3: string
The third line of the address.
-
Address4: string
The fourth line of the address.
-
AddressFull: string
Read Only:
true
The full address for a profile address. -
City: string
The city of the address.
-
Country: string
The country of the address.
-
County: string
The county of the address.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LocationSiteId: integer
(int64)
The unique identifier for a profile 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
The postal code of the address.
-
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
The state for the address.
-
Status: string
The status of the address. 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:
- ProfileId:
$request.path.ProfileId
The profile emails resource is used to view, create, or modify email contact points for a registered public user account profile. - ProfileId:
- ProfileContactPointPhone
-
Parameters:
- ProfileId:
$request.path.ProfileId
The profile phones resource is used to view, create, or modify phone contact points for a registered public user account profile. - ProfileId:
- ProfileLocation
-
Operation: /fscmRestApi/resources/11.13.18.05/publicSectorBusinessProfiles/{ProfileId}/child/ProfileLocationParameters:
- ProfileId:
$request.path.ProfileId
The profile locations resource is used to view, create, or modify addresses for a registered public user account profile. - ProfileId: