Get an emergency contact
get
/fscmRestApi/resources/11.13.18.05/personProfiles/{PartyId}/child/emergencyContacts/{EmergencyContactId}
Request
Path Parameters
-
EmergencyContactId(required): integer(int64)
The unique identifier for emergency contact.
-
PartyId(required): integer(int64)
The unique identifier for the party. Party can be a person. For example, a student can be a party.
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
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.
There's no request body for this operation.
Back to TopResponse
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 : personProfiles-emergencyContacts-item-response
Type:
Show Source
object
-
AdditionalEmail: string
Maximum Length:
1000
The additional email for an emergency contact. -
AdditionalEmailTypeCode: string
Title:
Additional Email Type Code
Maximum Length:30
The additional email type code. A list of accepted values is defined in the lookup type CONTACT_POINT_PURPOSE. -
AdditionalEmailTypeMeaning: string
Title:
Additional Email Type Name
Read Only:true
Maximum Length:80
The meaning of the additional email type code. A list of accepted values is defined in the lookup type CONTACT_POINT_PURPOSE. -
AdditionalPhoneAreaCode: string
Maximum Length:
10
The area code for additional phone of an emergency contact. -
AdditionalPhoneCountryCode: string
Maximum Length:
10
The country code for additional phone of an emergency contact. -
AdditionalPhoneExtension: string
Maximum Length:
10
The extension for additional phone of an emergency contact. -
AdditionalPhoneNumber: string
Maximum Length:
40
The additional phone number for an emergency contact. -
AdditionalPhoneTypeCode: string
Title:
Additional Phone Type Code
Maximum Length:30
The additional phone type code. A list of accepted values is defined in the lookup type CONTACT_POINT_PURPOSE. -
AdditionalPhoneTypeMeaning: string
Title:
Additional Phone Type Name
Read Only:true
Maximum Length:80
The 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 Code
Maximum Length:30
The 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 Type
Read Only:true
Maximum Length:80
The meaning of emergency contact type. A list of accepted values is defined in the lookup type ORA_HEY_EMERGENCY_CONTACT_TYPE. -
Email: string
Title:
Email
Maximum Length:1000
The email address of the emergency contact. -
EmailTypeCode: string
Title:
Email Type Code
Maximum Length:30
The email type code. A list of accepted values is defined in the lookup type CONTACT_POINT_PURPOSE. -
EmailTypeMeaning: string
Title:
Email Type Name
Read Only:true
Maximum Length:80
The 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 ID
Read Only:true
The unique identifier for emergency contact. -
FirstName: string
Title:
First Name
Maximum Length:150
The first name by which emergency contact is known. -
LastName: string
Title:
Last Name
Maximum Length:150
The last name by which emergency contact is known. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MiddleName: string
Maximum Length:
60
The middle name of the person. -
NameSuffix: string
Maximum Length:
30
The suffix can be junior or senior. -
PhoneAreaCode: string
Title:
Area Code
Maximum Length:10
The country area code for the emergency contact phone number. -
PhoneCountryCode: string
Title:
Select Country
Maximum Length:10
The international country code for the emergency contact phone number. -
PhoneExtension: string
Title:
Extension
Maximum Length:10
The extension number for the emergency contact phone number. -
PhoneNumber: string
Title:
Phone
Maximum Length:40
The emergency contact phone number. -
PhoneTypeCode: string
Title:
Phone Type Code
Maximum Length:30
The phone type code. A list of accepted values is defined in the lookup type CONTACT_POINT_PURPOSE. -
PhoneTypeMeaning: string
Title:
Phone Type Name
Read Only:true
Maximum Length:80
The meaning of the phone type code. A list of accepted values is defined in the lookup type CONTACT_POINT_PURPOSE. -
PreferredFlag: boolean
Title:
Preferred
Maximum Length:1
Default Value:false
Indicates the preferred emergency contact. -
SingleNameFlag: boolean
Title:
Only One Name
Maximum Length:1
Default Value:false
Indicates if the person has single name. -
Title: string
Maximum Length:
60
The title of the person, such as Mr or Mrs.
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
- 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: