Create a missing person contact
post
/fscmRestApi/resources/11.13.18.05/hedPersonProfiles/{PartyId}/child/missingPersonContacts
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: string
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: string
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: string
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 Email
Maximum Length:1000
The additional email for a missing person 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. -
AdditionalPhoneAreaCode: string
Title:
Additional Phone Area Code
Maximum Length:10
The area code for additional phone of a missing person contact. -
AdditionalPhoneCountryCode: string
Title:
Additional Phone Country Code
Maximum Length:10
The country code for additional phone of a missing person contact. -
AdditionalPhoneExtension: string
Title:
Additional Phone Extension
Maximum Length:10
The extension for additional phone of a missing person contact. -
AdditionalPhoneNumber: string
Title:
Additional Phone Number
Maximum Length:40
The additional phone number for a missing person 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. -
ContactTypeCode: string
Title:
Relationship Type
Maximum Length:30
The missing person contact type of the person, such as Spouse, Parent, and Grandparent. 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 for a missing person 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. -
FirstName: string
Title:
First Name
Maximum Length:150
The first name of a person. -
LastName: string
Title:
Last Name
Maximum Length:150
The last name of a person. -
MiddleName: string
Title:
Middle Name
Maximum Length:60
The middle name of the person. -
NameSuffix: string
Title:
Name Suffix
Maximum Length:30
The suffix can be junior or senior. -
PhoneAreaCode: string
Title:
Area Code
Maximum Length:10
The area code within a country code. -
PhoneCountryCode: string
Title:
Phone Country Code
Maximum Length:10
The country code for phone of a missing person contact. -
PhoneExtension: string
Title:
Phone Extension
Maximum Length:10
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. -
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. -
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
Title:
Title
Maximum Length:60
The 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 : hedPersonProfiles-missingPersonContacts-item-response
Type:
Show Source
object
-
AdditionalEmail: string
Title:
Additional Email
Maximum Length:1000
The additional email for a missing person 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
Title:
Additional Phone Area Code
Maximum Length:10
The area code for additional phone of a missing person contact. -
AdditionalPhoneCountryCode: string
Title:
Additional Phone Country Code
Maximum Length:10
The country code for additional phone of a missing person contact. -
AdditionalPhoneExtension: string
Title:
Additional Phone Extension
Maximum Length:10
The extension for additional phone of a missing person contact. -
AdditionalPhoneNumber: string
Title:
Additional Phone Number
Maximum Length:40
The additional phone number for a missing person 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:
Relationship Type
Maximum Length:30
The missing person contact type of the person, such as Spouse, Parent, and Grandparent. 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 missing person 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 for a missing person 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. -
FirstName: string
Title:
First Name
Maximum Length:150
The first name of a person. -
LastName: string
Title:
Last Name
Maximum Length:150
The last name of a person. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MiddleName: string
Title:
Middle Name
Maximum Length:60
The middle name of the person. -
MissingPersonContactId: integer
(int64)
Title:
Missing Person Contact ID
Read Only:true
The unique identifier of a missing person contact. -
NameSuffix: string
Title:
Name Suffix
Maximum Length:30
The suffix can be junior or senior. -
PhoneAreaCode: string
Title:
Area Code
Maximum Length:10
The area code within a country code. -
PhoneCountryCode: string
Title:
Phone Country Code
Maximum Length:10
The country code for phone of a missing person contact. -
PhoneExtension: string
Title:
Phone Extension
Maximum Length:10
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. -
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
Title:
Title
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: