REST API for Oracle Loyalty Cloud

Get a contact rollup

get

/crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/ContactRollup/{PersonProfileId}

Request

Path Parameters

PartyNumber(required): string

The alternate key identifier for the contact party. The profile option HZ_GENERATE_PARTY_NUMBER controls whether the attribute value can be system generated or user-provided during create. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Profile Options task. Inactive records can't be updated.
PersonProfileId(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
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.

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 : contacts-ContactRollup-item-response

Type: object

Show Source

CallsMade: number

Title: Calls Made

Read Only: true

The total number of calls made to a contact.
CorpCurrencyCode: string

Title: Corporate Currency

Read Only: true

Maximum Length: 15

The corporate currency code associated with the contact rollup such as USD or INR.
CreatedBy: string

Title: Created By

Read Only: true

Maximum Length: 64

The user who created the contact rollup.
CreationDate: string (date-time)

Title: Creation Date

Read Only: true

The date when the contact rollup was created.
EmailsSent: number

Title: Emails Sent

Read Only: true

The total number of emails sent to a contact.
LastCallMadeDate: string (date-time)

Title: Last Call Made

Read Only: true

The date when last call was made to a contact.
LastCompletedActivity: string (date-time)

Title: Last Completed Activity

Read Only: true

The date when the activity was last completed with a contact. Activity includes task, appointment, and call report.
LastEmailSentDate: string (date-time)

Title: Last Email Sent

Read Only: true

The date when last email was sent to a contact.
LastResponse: string (date-time)

Title: Last Response Date

Read Only: true

The date when a last email or call was received from a contact.
LastTouchDate: string (date-time)

Title: Last Touch

Read Only: true

The date when the last email was sent or call was made to a contact.
LastUpdateDate: string (date-time)

Title: Last Updated Date

Read Only: true

The date when the contact rollup was last updated.
LastUpdatedBy: string

Title: Last Updated By

Read Only: true

Maximum Length: 64

The user who last updated the contact rollup.
LastUpdateLogin: string

Title: Last Update Login

Read Only: true

Maximum Length: 32

The login of the user who last updated the contact rollup.
links: array Links

Title: Links

The link relations associated with the resource instance.
NextTaskDue: string (date)

Title: Next Task Due

Read Only: true

The due date of the task with a contact.
NumberOfOpenActivities: number

Title: Number of Open Activities

Read Only: true

The total number of activities that are open for a contact.
NumberOfOpenCriticalServiceRequests: number

Title: Critical Open Service Requests

Read Only: true

The number of open service requests with severity equal to one that are associated with a contact.
NumberOfOpenHotLeads: number

Title: Hot Leads

Read Only: true

The number of leads that are open and are ranked hot.
NumberOfOpenLeads: number

Title: Open Leads

Read Only: true

The total number of leads that are open for the contact.
NumberOfOpenOpportunities: number

Title: Open Opportunities

Read Only: true

The number of open opportunities associated with a contact.
NumberOfOpenServiceRequests: number

Title: Open Service Requests

Read Only: true

The number of open service requests associated with a contact.
NumberOfResponses: number

Title: Responses

Read Only: true

The total number of calls or emails received from a contact.
NumberOfTouches: number

Title: Touches

Read Only: true

The total number of emails sent or calls made to a contact.
PersonProfileId: integer (int64)

Title: Person Profile Identifier

Read Only: true

The unique identifier of the person profile.
SumOfOpenOpportunitiesRevenue: number

Title: Open Opportunities Revenue

Read Only: true

The cumulative total of revenues from open opportunities associated with a contact.
TotalNotes: number

Title: Total Notes

Read Only: true

The total number of notes for a contact.

{
    "type":"object",
    "properties":{
        "NumberOfOpenLeads":{
            "title":"Open Leads",
            "type":"number",
            "description":"The total number of leads that are open for the contact.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "description":"Count of leads that are open for the contact."
            },
            "x-queryable":true
        },
        "NumberOfOpenHotLeads":{
            "title":"Hot Leads",
            "type":"number",
            "description":"The number of leads that are open and are ranked hot.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "description":"Count of leads that are open and are ranked hot."
            },
            "x-queryable":true
        },
        "NextTaskDue":{
            "title":"Next Task Due",
            "type":"string",
            "description":"The due date of the task with a contact.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "description":"The date when a task is due with a contact."
            },
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the contact rollup was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "ATTR_INTERNAL_USE":"Y",
                "description":"Who column: indicates the date of the creation of the row."
            },
            "x-queryable":true
        },
        "LastCompletedActivity":{
            "title":"Last Completed Activity",
            "type":"string",
            "description":"The date when the activity was last completed with a contact. Activity includes task, appointment, and call report.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "description":"The date of last completed activity with a contact. Activity includes task, appointment, and call report."
            },
            "x-queryable":true
        },
        "CallsMade":{
            "title":"Calls Made",
            "type":"number",
            "description":"The total number of calls made to a contact.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "description":"The total number of calls made to a contact."
            },
            "x-queryable":true
        },
        "LastCallMadeDate":{
            "title":"Last Call Made",
            "type":"string",
            "description":"The date when last call was made to a contact.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "description":"The date when last call was made to a contact."
            },
            "x-queryable":true
        },
        "NumberOfResponses":{
            "title":"Responses",
            "type":"number",
            "description":"The total number of calls or emails received from a contact.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "description":"Number of responses received from a contact."
            },
            "x-queryable":true
        },
        "EmailsSent":{
            "title":"Emails Sent",
            "type":"number",
            "description":"The total number of emails sent to a contact.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "description":"The total number of emails sent to a contact."
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PersonProfileId":{
            "title":"Person Profile Identifier",
            "type":"integer",
            "description":"The unique identifier of the person profile.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "description":"The unique identifier of the person profile."
            },
            "x-queryable":true
        },
        "CorpCurrencyCode":{
            "title":"Corporate Currency",
            "maxLength":"15",
            "type":"string",
            "description":"The corporate currency code associated with the contact rollup such as USD or INR.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "description":"The corporate currency code associated with the account rollup such as USD or INR."
            }
        },
        "NumberOfOpenActivities":{
            "title":"Number of Open Activities",
            "type":"number",
            "description":"The total number of activities that are open for a contact.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "description":"Count of activities that are open for a contact."
            },
            "x-queryable":true
        },
        "LastEmailSentDate":{
            "title":"Last Email Sent",
            "type":"string",
            "description":"The date when last email was sent to a contact.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "description":"The date when last email was sent to a contact."
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the contact rollup.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "ATTR_INTERNAL_USE":"Y",
                "ExtnEventActionProperty":"User",
                "description":"Who column: indicates the user who last updated the row."
            },
            "x-queryable":true
        },
        "LastResponse":{
            "title":"Last Response Date",
            "type":"string",
            "description":"The date when a last email or call was received from a contact.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "description":"The date when last response was received from a contact."
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the contact rollup.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "ATTR_INTERNAL_USE":"Y",
                "ExtnEventActionProperty":"User",
                "description":"Who column: indicates the user who created the row."
            },
            "x-queryable":true
        },
        "LastTouchDate":{
            "title":"Last Touch",
            "type":"string",
            "description":"The date when the last email was sent or call was made to a contact.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "description":"The date when the last touch was made with a contact."
            },
            "x-queryable":true
        },
        "TotalNotes":{
            "title":"Total Notes",
            "type":"number",
            "description":"The total number of notes for a contact.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "description":"The total number of public notes associated with a contact."
            },
            "x-queryable":true
        },
        "SumOfOpenOpportunitiesRevenue":{
            "title":"Open Opportunities Revenue",
            "type":"number",
            "description":"The cumulative total of revenues from open opportunities associated with a contact.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "description":"The cumulative total of revenues from open opportunities associated with a contact.",
                "objCurrencyCode":"CorpCurrencyCode"
            },
            "x-queryable":true
        },
        "NumberOfTouches":{
            "title":"Touches",
            "type":"number",
            "description":"The total number of emails sent or calls made to a contact.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "description":"The total number of touches with a contact. Touches refer to outbound communications such as email, phone, and so on."
            },
            "x-queryable":true
        },
        "NumberOfOpenOpportunities":{
            "title":"Open Opportunities",
            "type":"number",
            "description":"The number of open opportunities associated with a contact.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "description":"Count on open opportunities with a contact."
            },
            "x-queryable":true
        },
        "NumberOfOpenCriticalServiceRequests":{
            "title":"Critical Open Service Requests",
            "type":"number",
            "description":"The number of open service requests with severity equal to one that are associated with a contact.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "description":"The number of open service requests for the contact that have severity equal to one."
            },
            "x-queryable":true
        },
        "NumberOfOpenServiceRequests":{
            "title":"Open Service Requests",
            "type":"number",
            "description":"The number of open service requests associated with a contact.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "description":"The number of open service requests for a contact."
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the contact rollup was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "ATTR_INTERNAL_USE":"Y",
                "description":"Who column: indicates the date of the last update of the row."
            },
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":"32",
            "type":"string",
            "description":"The login of the user who last updated the contact rollup.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "ATTR_INTERNAL_USE":"Y",
                "description":"Who column: indicates the session login associated to the user who last updated the row."
            },
            "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."
        }
    }
}