Update a phone contact point for the user profile
patch
/fscmRestApi/resources/11.13.18.05/publicSectorPersonalProfiles/{publicSectorPersonalProfilesUniqID}/child/ProfileContactPointPhone/{ContactPtId}
Request
Path Parameters
-
ContactPtId(required): integer(int64)
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
-
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:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
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.
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-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 : 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.