Update a Student Management organization email address
patch
/fscmRestApi/resources/11.13.18.05/hedOrganizationContacts/{ContactPartyId}/child/emails/{EmailId}
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=
-
EmailId(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
Root Schema : schema
Type:
Show Source
object
-
EmailAddress: string
Title:
Email
Maximum Length:320
The email address of the contact. -
PreferredFlag: boolean
Title:
Preferred
Maximum Length:1
Default Value:false
Indicates the preferred email address to use for the contact. The default value is: false.
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 : hedOrganizationContacts-emails-item-response
Type:
Show Source
object
-
EmailAddress: string
Title:
Email
Maximum Length:320
The email address of the contact. -
EmailId: integer
(int64)
Title:
Email ID
Read Only:true
The unique identifier for an email address. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PreferredFlag: boolean
Title:
Preferred
Maximum Length:1
Default Value:false
Indicates the preferred email address to use for the contact. The default value is: false. -
PurposeCode: string
Title:
Purpose Code
Maximum Length:30
The type of purpose for the email contact point, 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_WEB.
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.
Links
- EmailPurposeLOV
-
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
- finder: