Jump to

• Request
• Response

Update a phone contact point for the user profile

patch

/fscmRestApi/resources/11.13.18.05/publicSectorProfileContactPhones/{ContactPtId}

Request

Path Parameters

• ContactPtId(required): integer(int64)
  The unique identifier for the phone contact point.

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

Request Body - application/json ()

The following table describes the body parameters in the request for this task.

Root Schema : schema

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":{
        "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
        },
        "PhoneCountryCode":{
            "type":"string",
            "description":"The phone country code.",
            "nullable":true
        },
        "PhoneAreaCode":{
            "type":"string",
            "description":"The phone area code.",
            "nullable":true
        },
        "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
        },
        "PhoneType":{
            "title":"Type",
            "type":"string",
            "description":"The phone type. Valid values are WORK, HOME, and MOBILE.",
            "nullable":true,
            "x-queryable":false
        },
        "ContactPointPurpose":{
            "title":"Type",
            "type":"string",
            "description":"The phone type. Valid values are BUSINESS for work and PERSONAL for home.",
            "nullable":true
        },
        "PhoneNumber":{
            "type":"string",
            "description":"The phone number.",
            "nullable":true
        },
        "PhoneExtension":{
            "type":"string",
            "description":"The phone extension.",
            "nullable":true
        }
    }
}

Back to Top

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.

Body ()

Root Schema : publicSectorProfileContactPhones-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":{
        "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
        },
        "PhoneCountryCode":{
            "type":"string",
            "description":"The phone country code.",
            "nullable":true,
            "x-queryable":true
        },
        "PhoneAreaCode":{
            "type":"string",
            "description":"The phone area code.",
            "nullable":true,
            "x-queryable":true
        },
        "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
        },
        "PhoneType":{
            "title":"Type",
            "type":"string",
            "description":"The phone type. Valid values are WORK, HOME, and MOBILE.",
            "nullable":true,
            "x-queryable":false
        },
        "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
        },
        "ContactPointPurpose":{
            "title":"Type",
            "type":"string",
            "description":"The phone type. Valid values are BUSINESS for work and PERSONAL for home.",
            "nullable":true,
            "x-queryable":true
        },
        "PhoneNumber":{
            "type":"string",
            "description":"The phone number.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PhoneFull":{
            "type":"string",
            "description":"The formatted phone number.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PhoneExtension":{
            "type":"string",
            "description":"The phone extension.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

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

Back to Top