Jump to

• Request
• Response

Update a phone contact point for the user profile

patch

/fscmRestApi/resources/11.13.18.05/publicSectorBusinessProfiles/{ProfileId}/child/ProfileContactPointPhone/{ContactPtId}

Request

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• application/json

Path Parameters

• ContactPtId: integer
  The unique identifier for the phone contact point.
• ProfileId: integer
  The unique identifier for a registered public user account profile.

Body ()

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

Root Schema : publicSectorBusinessProfiles-ProfileContactPointPhone-item

Type: object

Show Source

• ContactPointPurpose(optional): string
  Title: Type

  The 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: Items

  Link 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 full formatted phone number.
• PhoneNumber(optional): string
  The phone number.
• PhoneType(optional): string
  Title: Type

  The phone type. Valid values are WORK, HOME, and MOBILE.
• PrimaryFlag(optional): 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(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.

{
    "properties":{
        "ContactPointPurpose":{
            "type":"string",
            "description":"The phone type. Valid values are BUSINESS for work and PERSONAL for home.",
            "title":"Type"
        },
        "ContactPtId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for the phone contact point."
        },
        "PhoneAreaCode":{
            "type":"string",
            "description":"The phone area code."
        },
        "PhoneCountryCode":{
            "type":"string",
            "description":"The phone country code."
        },
        "PhoneExtension":{
            "type":"string",
            "description":"The phone extension."
        },
        "PhoneFull":{
            "type":"string",
            "description":"The full formatted phone number."
        },
        "PhoneNumber":{
            "type":"string",
            "description":"The phone number."
        },
        "PhoneType":{
            "type":"string",
            "description":"The phone type. Valid values are WORK, HOME, and MOBILE.",
            "title":"Type"
        },
        "PrimaryFlag":{
            "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.",
            "title":"Primary"
        },
        "ProfileId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for the profile that is associated with the phone contact point."
        },
        "Status":{
            "type":"string",
            "description":"The status of the phone contact point. Valid values are A for active and I for inactive."
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : link

Type: object

Show Source

• href(optional): string
  Title: hyperlink reference

  The URI to the related resource.
• rel(optional): string
  Title: relation

  The name of the relation to the resource instance. Example: self.

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Back to Top

Response

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• application/json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : publicSectorBusinessProfiles-ProfileContactPointPhone-item

Type: object

Show Source

• ContactPointPurpose(optional): string
  Title: Type

  The 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: Items

  Link 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 full formatted phone number.
• PhoneNumber(optional): string
  The phone number.
• PhoneType(optional): string
  Title: Type

  The phone type. Valid values are WORK, HOME, and MOBILE.
• PrimaryFlag(optional): 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(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.

{
    "properties":{
        "ContactPointPurpose":{
            "type":"string",
            "description":"The phone type. Valid values are BUSINESS for work and PERSONAL for home.",
            "title":"Type"
        },
        "ContactPtId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for the phone contact point."
        },
        "PhoneAreaCode":{
            "type":"string",
            "description":"The phone area code."
        },
        "PhoneCountryCode":{
            "type":"string",
            "description":"The phone country code."
        },
        "PhoneExtension":{
            "type":"string",
            "description":"The phone extension."
        },
        "PhoneFull":{
            "type":"string",
            "description":"The full formatted phone number."
        },
        "PhoneNumber":{
            "type":"string",
            "description":"The phone number."
        },
        "PhoneType":{
            "type":"string",
            "description":"The phone type. Valid values are WORK, HOME, and MOBILE.",
            "title":"Type"
        },
        "PrimaryFlag":{
            "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.",
            "title":"Primary"
        },
        "ProfileId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for the profile that is associated with the phone contact point."
        },
        "Status":{
            "type":"string",
            "description":"The status of the phone contact point. Valid values are A for active and I for inactive."
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : link

Type: object

Show Source

• href(optional): string
  Title: hyperlink reference

  The URI to the related resource.
• rel(optional): string
  Title: relation

  The name of the relation to the resource instance. Example: self.

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Back to Top