Jump to

• Request
• Response

Get all missing person contacts

get

/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=

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
• finder: string
  Used as a predefined finder to search the collection.
  
  Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables
  
  

  • PrimaryKey Finds the missing person contact that matches the primary key criteria specified.
    Finder Variables
    • MissingPersonContactId; integer; Unique identifier for missing person contact.
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• 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
  
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • AdditionalEmail; string; The additional email for a missing person contact.
  • AdditionalEmailTypeCode; string; The additional email type code. A list of accepted values is defined in the lookup type CONTACT_POINT_PURPOSE.
  • AdditionalEmailTypeMeaning; string; The meaning of the additional email type code. A list of accepted values is defined in the lookup type CONTACT_POINT_PURPOSE.
  • AdditionalPhoneAreaCode; string; The area code for additional phone of a missing person contact.
  • AdditionalPhoneCountryCode; string; The country code for additional phone of a missing person contact.
  • AdditionalPhoneExtension; string; The extension for additional phone of a missing person contact.
  • AdditionalPhoneNumber; string; The additional phone number for a missing person contact.
  • AdditionalPhoneTypeCode; string; The additional phone type code. A list of accepted values is defined in the lookup type CONTACT_POINT_PURPOSE.
  • AdditionalPhoneTypeMeaning; string; The meaning of the additional phone type code. A list of accepted values is defined in the lookup type CONTACT_POINT_PURPOSE.
  • ContactTypeCode; string; 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; 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; The email for a missing person contact.
  • EmailTypeCode; string; The email type code. A list of accepted values is defined in the lookup type CONTACT_POINT_PURPOSE.
  • EmailTypeMeaning; string; The meaning of the email type code. A list of accepted values is defined in the lookup type CONTACT_POINT_PURPOSE.
  • FirstName; string; The first name of a person.
  • LastName; string; The last name of a person.
  • MiddleName; string; The middle name of the person.
  • MissingPersonContactId; integer; The unique identifier of a missing person contact.
  • NameSuffix; string; The suffix can be junior or senior.
  • PhoneAreaCode; string; The area code within a country code.
  • PhoneCountryCode; string; The country code for phone of a missing person contact.
  • PhoneExtension; string; The extension number for a phone number.
  • PhoneNumber; string; The phone number formatted in the local format. The number should not include area code, country code, or extension.
  • PhoneTypeCode; string; The phone type code. A list of accepted values is defined in the lookup type CONTACT_POINT_PURPOSE.
  • PhoneTypeMeaning; string; The meaning of the phone type code. A list of accepted values is defined in the lookup type CONTACT_POINT_PURPOSE.
  • PreferredFlag; boolean; Indicates the preferred emergency contact.
  • SingleNameFlag; boolean; Indicates if the person has single name.
  • Title; string; The title of the person, such as Mr or Mrs.
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

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.

There's no request body for this operation.

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 : hedPersonProfiles-missingPersonContacts

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/hedPersonProfiles-missingPersonContacts-item-response"
            }
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object hedPersonProfiles-missingPersonContacts-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/hedPersonProfiles-missingPersonContacts-item-response"
    }
}

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 : hedPersonProfiles-missingPersonContacts-item-response

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "AdditionalPhoneAreaCode":{
            "title":"Additional Phone Area Code",
            "maxLength":10,
            "type":"string",
            "description":"The area code for additional phone of a missing person contact.",
            "nullable":true,
            "x-queryable":true
        },
        "Email":{
            "title":"Email",
            "maxLength":1000,
            "type":"string",
            "description":"The email for a missing person contact.",
            "nullable":true,
            "x-queryable":true
        },
        "AdditionalPhoneNumber":{
            "title":"Additional Phone Number",
            "maxLength":40,
            "type":"string",
            "description":"The additional phone number for a missing person contact.",
            "nullable":true,
            "x-queryable":true
        },
        "PhoneTypeMeaning":{
            "title":"Phone Type Name",
            "maxLength":80,
            "type":"string",
            "description":"The meaning of the phone type code. A list of accepted values is defined in the lookup type CONTACT_POINT_PURPOSE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AdditionalEmailTypeMeaning":{
            "title":"Additional Email Type Name",
            "maxLength":80,
            "type":"string",
            "description":"The meaning of the additional email type code. A list of accepted values is defined in the lookup type CONTACT_POINT_PURPOSE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AdditionalEmail":{
            "title":"Additional Email",
            "maxLength":1000,
            "type":"string",
            "description":"The additional email for a missing person contact.",
            "nullable":true,
            "x-queryable":true
        },
        "ContactTypeMeaning":{
            "title":"Relationship Type",
            "maxLength":80,
            "type":"string",
            "description":"The meaning of missing person contact type. A list of accepted values is defined in the lookup type ORA_HEY_EMERGENCY_CONTACT_TYPE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PhoneCountryCode":{
            "title":"Phone Country Code",
            "maxLength":10,
            "type":"string",
            "description":"The country code for phone of a missing person contact.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PhoneAreaCode":{
            "title":"Area Code",
            "maxLength":10,
            "type":"string",
            "description":"The area code within a country code.",
            "nullable":true,
            "x-queryable":true
        },
        "AdditionalPhoneExtension":{
            "title":"Additional Phone Extension",
            "maxLength":10,
            "type":"string",
            "description":"The extension for additional phone of a missing person contact.",
            "nullable":true,
            "x-queryable":true
        },
        "ContactTypeCode":{
            "title":"Relationship Type",
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AdditionalEmailTypeCode":{
            "title":"Additional Email Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The additional email type code. A list of accepted values is defined in the lookup type CONTACT_POINT_PURPOSE.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "NameSuffix":{
            "title":"Name Suffix",
            "maxLength":30,
            "type":"string",
            "description":"The suffix can be junior or senior.",
            "nullable":true,
            "x-queryable":true
        },
        "SingleNameFlag":{
            "title":"Only One Name",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if the person has single name.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "EmailTypeMeaning":{
            "title":"Email Type Name",
            "maxLength":80,
            "type":"string",
            "description":"The meaning of the email type code. A list of accepted values is defined in the lookup type CONTACT_POINT_PURPOSE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AdditionalPhoneTypeMeaning":{
            "title":"Additional Phone Type Name",
            "maxLength":80,
            "type":"string",
            "description":"The meaning of the additional phone type code. A list of accepted values is defined in the lookup type CONTACT_POINT_PURPOSE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FirstName":{
            "title":"First Name",
            "maxLength":150,
            "type":"string",
            "description":"The first name of a person.",
            "nullable":true,
            "x-queryable":true
        },
        "Title":{
            "title":"Title",
            "maxLength":60,
            "type":"string",
            "description":"The title of the person, such as Mr or Mrs.",
            "nullable":true,
            "x-queryable":true
        },
        "MiddleName":{
            "title":"Middle Name",
            "maxLength":60,
            "type":"string",
            "description":"The middle name of the person.",
            "nullable":true,
            "x-queryable":true
        },
        "PhoneTypeCode":{
            "title":"Phone Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The phone type code. A list of accepted values is defined in the lookup type CONTACT_POINT_PURPOSE.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AdditionalPhoneTypeCode":{
            "title":"Additional Phone Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The additional phone type code. A list of accepted values is defined in the lookup type CONTACT_POINT_PURPOSE.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PhoneExtension":{
            "title":"Phone Extension",
            "maxLength":10,
            "type":"string",
            "description":"The extension number for a phone number.",
            "nullable":true,
            "x-queryable":true
        },
        "AdditionalPhoneCountryCode":{
            "title":"Additional Phone Country Code",
            "maxLength":10,
            "type":"string",
            "description":"The country code for additional phone of a missing person contact.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "MissingPersonContactId":{
            "title":"Missing Person Contact ID",
            "type":"integer",
            "description":"The unique identifier of a missing person contact.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"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-queryable":true
        },
        "LastName":{
            "title":"Last Name",
            "maxLength":150,
            "type":"string",
            "description":"The last name of a person.",
            "nullable":false,
            "x-queryable":true
        },
        "PreferredFlag":{
            "title":"Preferred",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates the preferred emergency contact.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "EmailTypeCode":{
            "title":"Email Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The email type code. A list of accepted values is defined in the lookup type CONTACT_POINT_PURPOSE.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "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."
        }
    }
}

Back to Top