Create an emergency contact
post
/fscmRestApi/resources/11.13.18.05/personProfiles/{PartyId}/child/emergencyContacts
Request
Path Parameters
-
PartyId(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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object-
AdditionalEmail: string
Title:
Additional EmailMaximum Length:1000The additional email for an emergency contact. -
AdditionalEmailTypeCode: string
Title:
Additional Email Type CodeMaximum Length:30The additional email type code. A list of accepted values is defined in the lookup type CONTACT_POINT_PURPOSE. -
AdditionalPhoneAreaCode: string
Title:
Additional Phone Area CodeMaximum Length:10The area code for additional phone of an emergency contact. -
AdditionalPhoneCountryCode: string
Title:
Additional Phone Country CodeMaximum Length:10The country code for additional phone of an emergency contact. -
AdditionalPhoneExtension: string
Title:
Additional Phone ExtensionMaximum Length:10The extension for additional phone of an emergency contact. -
AdditionalPhoneNumber: string
Title:
Additional Phone NumberMaximum Length:40The additional phone number for an emergency contact. -
AdditionalPhoneTypeCode: string
Title:
Additional Phone Type CodeMaximum Length:30The additional phone type code. A list of accepted values is defined in the lookup type CONTACT_POINT_PURPOSE. -
ContactTypeCode: string
Title:
Contact Type CodeMaximum Length:30The emergency contact type of the person. A list of accepted values is defined in the lookup type ORA_HEY_EMERGENCY_CONTACT_TYPE. -
Email: string
Title:
EmailMaximum Length:1000The email address of the emergency contact. -
EmailTypeCode: string
Title:
Email Type CodeMaximum Length:30The email type code. A list of accepted values is defined in the lookup type CONTACT_POINT_PURPOSE. -
FirstName: string
Title:
First NameMaximum Length:150The first name by which emergency contact is known. -
LastName: string
Title:
Last NameMaximum Length:150The last name by which emergency contact is known. -
MiddleName: string
Title:
Middle NameMaximum Length:60The middle name of the person. -
NameSuffix: string
Title:
Name SuffixMaximum Length:30The suffix can be junior or senior. -
PhoneAreaCode: string
Title:
Area CodeMaximum Length:10The country area code for the emergency contact phone number. -
PhoneCountryCode: string
Title:
Select CountryMaximum Length:10The international country code for the emergency contact phone number. -
PhoneExtension: string
Title:
ExtensionMaximum Length:10The extension number for the emergency contact phone number. -
PhoneNumber: string
Title:
PhoneMaximum Length:40The emergency contact phone number. -
PhoneTypeCode: string
Title:
Phone Type CodeMaximum Length:30The phone type code. A list of accepted values is defined in the lookup type CONTACT_POINT_PURPOSE. -
PreferredFlag: boolean
Title:
PreferredMaximum Length:1Default Value:falseIndicates the preferred emergency contact. -
SingleNameFlag: boolean
Title:
Only One NameMaximum Length:1Default Value:falseIndicates if the person has single name. -
Title: string
Title:
TitleMaximum Length:60The title of the person, such as Mr or Mrs.
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.
Root Schema : personProfiles-emergencyContacts-item-response
Type:
Show Source
object-
AdditionalEmail: string
Title:
Additional EmailMaximum Length:1000The additional email for an emergency contact. -
AdditionalEmailTypeCode: string
Title:
Additional Email Type CodeMaximum Length:30The additional email type code. A list of accepted values is defined in the lookup type CONTACT_POINT_PURPOSE. -
AdditionalEmailTypeMeaning: string
Title:
Additional Email Type NameRead Only:trueMaximum Length:80The meaning of the additional email type code. A list of accepted values is defined in the lookup type CONTACT_POINT_PURPOSE. -
AdditionalPhoneAreaCode: string
Title:
Additional Phone Area CodeMaximum Length:10The area code for additional phone of an emergency contact. -
AdditionalPhoneCountryCode: string
Title:
Additional Phone Country CodeMaximum Length:10The country code for additional phone of an emergency contact. -
AdditionalPhoneExtension: string
Title:
Additional Phone ExtensionMaximum Length:10The extension for additional phone of an emergency contact. -
AdditionalPhoneNumber: string
Title:
Additional Phone NumberMaximum Length:40The additional phone number for an emergency contact. -
AdditionalPhoneTypeCode: string
Title:
Additional Phone Type CodeMaximum Length:30The additional phone type code. A list of accepted values is defined in the lookup type CONTACT_POINT_PURPOSE. -
AdditionalPhoneTypeMeaning: string
Title:
Additional Phone Type NameRead Only:trueMaximum Length:80The meaning of the additional phone type code. A list of accepted values is defined in the lookup type CONTACT_POINT_PURPOSE. -
ContactTypeCode: string
Title:
Contact Type CodeMaximum Length:30The emergency contact type of the person. A list of accepted values is defined in the lookup type ORA_HEY_EMERGENCY_CONTACT_TYPE. -
ContactTypeMeaning: string
Title:
Relationship TypeRead Only:trueMaximum Length:80The meaning of emergency contact type. A list of accepted values is defined in the lookup type ORA_HEY_EMERGENCY_CONTACT_TYPE. -
Email: string
Title:
EmailMaximum Length:1000The email address of the emergency contact. -
EmailTypeCode: string
Title:
Email Type CodeMaximum Length:30The email type code. A list of accepted values is defined in the lookup type CONTACT_POINT_PURPOSE. -
EmailTypeMeaning: string
Title:
Email Type NameRead Only:trueMaximum Length:80The meaning of the email type code. A list of accepted values is defined in the lookup type CONTACT_POINT_PURPOSE. -
EmergencyContactId: integer
(int64)
Title:
Emergency Contact IDRead Only:trueThe unique identifier for emergency contact. -
FirstName: string
Title:
First NameMaximum Length:150The first name by which emergency contact is known. -
LastName: string
Title:
Last NameMaximum Length:150The last name by which emergency contact is known. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MiddleName: string
Title:
Middle NameMaximum Length:60The middle name of the person. -
NameSuffix: string
Title:
Name SuffixMaximum Length:30The suffix can be junior or senior. -
PhoneAreaCode: string
Title:
Area CodeMaximum Length:10The country area code for the emergency contact phone number. -
PhoneCountryCode: string
Title:
Select CountryMaximum Length:10The international country code for the emergency contact phone number. -
PhoneExtension: string
Title:
ExtensionMaximum Length:10The extension number for the emergency contact phone number. -
PhoneNumber: string
Title:
PhoneMaximum Length:40The emergency contact phone number. -
PhoneTypeCode: string
Title:
Phone Type CodeMaximum Length:30The phone type code. A list of accepted values is defined in the lookup type CONTACT_POINT_PURPOSE. -
PhoneTypeMeaning: string
Title:
Phone Type NameRead Only:trueMaximum Length:80The meaning of the phone type code. A list of accepted values is defined in the lookup type CONTACT_POINT_PURPOSE. -
PreferredFlag: boolean
Title:
PreferredMaximum Length:1Default Value:falseIndicates the preferred emergency contact. -
SingleNameFlag: boolean
Title:
Only One NameMaximum Length:1Default Value:falseIndicates if the person has single name. -
Title: string
Title:
TitleMaximum Length:60The title of the person, such as Mr or Mrs.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed 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
- AdditionalEmailTypeCodeLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupCode%3D{AdditionalEmailTypeCode}%2CLookupType%3DCONTACT_POINT_PURPOSE
The following properties are defined on the LOV link relation:- Source Attribute: AdditionalEmailTypeCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- AdditionalPhoneCountryCodeLOV
-
The following properties are defined on the LOV link relation:
- Source Attribute: AdditionalPhoneCountryCode; Target Attribute: PhoneCountryCode
- Display Attribute: PhoneCountryCode, TerritoryShortName
- AdditionalPhoneTypeCodeLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupCode%3D{AdditionalPhoneTypeCode}%2CLookupType%3DCONTACT_POINT_PURPOSE
The following properties are defined on the LOV link relation:- Source Attribute: AdditionalPhoneTypeCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- ContactTypeLOV
-
Parameters:
- finder:
ByLookupTypeFinder%3BLookupType%3DORA_HEY_EMERGENCY_CONTACT_TYPE%2CLookupCode%3D{ContactTypeCode}
The following properties are defined on the LOV link relation:- Source Attribute: ContactTypeCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- EmailTypeCodeLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupCode%3D{EmailTypeCode}%2CLookupType%3DCONTACT_POINT_PURPOSE
The following properties are defined on the LOV link relation:- Source Attribute: EmailTypeCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- PhoneCountryCodeLOV
-
The following properties are defined on the LOV link relation:
- Source Attribute: PhoneCountryCode; Target Attribute: PhoneCountryCode
- Display Attribute: PhoneCountryCode, TerritoryShortName
- PhoneTypeCodeLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupCode%3D{PhoneTypeCode}%2CLookupType%3DCONTACT_POINT_PURPOSE
The following properties are defined on the LOV link relation:- Source Attribute: PhoneTypeCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder: