Jump to

• Request
• Response

Update a Student Management organization phone number

patch

/fscmRestApi/resources/11.13.18.05/hedOrganizationContacts/{ContactPartyId}/child/phones/{PhoneId}

Request

Path Parameters

• ContactPartyId(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=
• PhoneId(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=

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 ()

Root Schema : schema

Type: object

Show Source

• PhoneAreaCode: string
  Title: Area Code

  Maximum Length: 20

  The area code within a country.
• PhoneCountryCode: string
  Title: Country Code

  Maximum Length: 10

  The international country code for a phone number. For example, 33 for France.
• PhoneExtension: string
  Title: Phone Extension

  Maximum Length: 20

  The extension number for a phone number.
• PhoneNumber: string
  Title: Phone Number

  Maximum Length: 40

  The phone number formatted in the local format. The number should not include area code, country code, or extension.
• PreferredFlag: boolean
  Title: Preferred

  Maximum Length: 1

  Default Value: false

  Indicates the preferred phone number to use for the contact. The default value is: false.
• PurposeCode: string
  Title: Purpose Code

  Maximum Length: 30

  The type of purpose for phone contact, such as work, emergency, and home. A list of accepted values is defined in the lookup type CONTACT_POINT_PURPOSE.

{
    "type":"object",
    "properties":{
        "PhoneCountryCode":{
            "title":"Country Code",
            "maxLength":"10",
            "type":"string",
            "description":"The international country code for a phone number. For example, 33 for France.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "HR_ATTRIBUTE":"Y"
            }
        },
        "PhoneAreaCode":{
            "title":"Area Code",
            "maxLength":"20",
            "type":"string",
            "description":"The area code within a country.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PhoneEO.PhoneAreaCode",
                "protectionObjectTitle":"Phone",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Area Code",
                "HR_ATTRIBUTE":"Y"
            }
        },
        "PhoneNumber":{
            "title":"Phone Number",
            "maxLength":"40",
            "type":"string",
            "description":"The phone number formatted in the local format. The number should not include area code, country code, or extension.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PhoneEO.PhoneNumber",
                "protectionObjectTitle":"Phone",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Phone",
                "HR_ATTRIBUTE":"Y"
            }
        },
        "PurposeCode":{
            "title":"Purpose Code",
            "maxLength":"30",
            "type":"string",
            "description":"The type of purpose for phone contact, such as work, emergency, and home. A list of accepted values is defined in the lookup type CONTACT_POINT_PURPOSE.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "HR_ATTRIBUTE":"Y"
            }
        },
        "PreferredFlag":{
            "title":"Preferred",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates the preferred phone number to use for the contact. The default value is: false.",
            "nullable":true,
            "default":false
        },
        "PhoneExtension":{
            "title":"Phone Extension",
            "maxLength":"20",
            "type":"string",
            "description":"The extension number for a phone number.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PhoneEO.PhoneExtension",
                "protectionObjectTitle":"Phone",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Extension",
                "HR_ATTRIBUTE":"Y"
            }
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• 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.

Body ()

Root Schema : hedOrganizationContacts-phones-item-response

Type: object

Show Source

• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PhoneAreaCode: string
  Title: Area Code

  Maximum Length: 20

  The area code within a country.
• PhoneCountryCode: string
  Title: Country Code

  Maximum Length: 10

  The international country code for a phone number. For example, 33 for France.
• PhoneExtension: string
  Title: Phone Extension

  Maximum Length: 20

  The extension number for a phone number.
• PhoneId: integer (int64)
  Title: Phone ID

  Read Only: true

  The unique identifier for a phone number.
• PhoneNumber: string
  Title: Phone Number

  Maximum Length: 40

  The phone number formatted in the local format. The number should not include area code, country code, or extension.
• PreferredFlag: boolean
  Title: Preferred

  Maximum Length: 1

  Default Value: false

  Indicates the preferred phone number to use for the contact. The default value is: false.
• PurposeCode: string
  Title: Purpose Code

  Maximum Length: 30

  The type of purpose for phone contact, such as work, emergency, and home. A list of accepted values is defined in the lookup type CONTACT_POINT_PURPOSE.
• PurposeMeaning: string
  Title: Purpose

  Read Only: true

  Maximum Length: 80

  The meaning of the purpose code. A list of accepted values is defined in the lookup type CONTACT_POINT_PURPOSE.

{
    "type":"object",
    "properties":{
        "PhoneCountryCode":{
            "title":"Country Code",
            "maxLength":"10",
            "type":"string",
            "description":"The international country code for a phone number. For example, 33 for France.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "PhoneAreaCode":{
            "title":"Area Code",
            "maxLength":"20",
            "type":"string",
            "description":"The area code within a country.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PhoneEO.PhoneAreaCode",
                "protectionObjectTitle":"Phone",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Area Code",
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "PhoneId":{
            "title":"Phone ID",
            "type":"integer",
            "description":"The unique identifier for a phone number.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "PurposeMeaning":{
            "title":"Purpose",
            "maxLength":"80",
            "type":"string",
            "description":"The meaning of the purpose code. A list of accepted values is defined in the lookup type CONTACT_POINT_PURPOSE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PhoneNumber":{
            "title":"Phone Number",
            "maxLength":"40",
            "type":"string",
            "description":"The phone number formatted in the local format. The number should not include area code, country code, or extension.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PhoneEO.PhoneNumber",
                "protectionObjectTitle":"Phone",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Phone",
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PurposeCode":{
            "title":"Purpose Code",
            "maxLength":"30",
            "type":"string",
            "description":"The type of purpose for phone contact, such as work, emergency, and home. A list of accepted values is defined in the lookup type CONTACT_POINT_PURPOSE.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "PreferredFlag":{
            "title":"Preferred",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates the preferred phone number to use for the contact. The default value is: false.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "PhoneExtension":{
            "title":"Phone Extension",
            "maxLength":"20",
            "type":"string",
            "description":"The extension number for a phone number.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PhoneEO.PhoneExtension",
                "protectionObjectTitle":"Phone",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Extension",
                "HR_ATTRIBUTE":"Y"
            },
            "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."
        }
    }
}

Links

PhoneCountryCodeLOV

Operation: /fscmRestApi/resources/11.13.18.05/hedPhoneCountryCodes

The following properties are defined on the LOV link relation:

• Source Attribute: PhoneCountryCode; Target Attribute: PhoneCountryCode
• Display Attribute: PhoneCountryCode, TerritoryShortName

PhonePurposeLOV

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupCode%3D{PurposeCode}%2CLookupType%3DCONTACT_POINT_PURPOSE

The following properties are defined on the LOV link relation:

• Source Attribute: PurposeCode; Target Attribute: LookupCode
• Display Attribute: Meaning

Back to Top