Jump to

• Request
• Response
• Examples

Create a Lightbox presentation session

post

/crmRestApi/resources/11.13.18.05/presentationSessions

Request

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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• AccountId: integer (int64)
  Title: Account ID

  The unique identifier of the account for which the presentation session was conducted. The default value is obtained from Activity unless specified during create.
• AccountName: string
  Title: Account

  Maximum Length: 360

  The name of the account for which the presentation session was conducted.
• ActivityId: integer (int64)
  Title: Activity ID

  The unique identifier of the activity for the presentation session.
• PresentationSessionId: integer (int64)
  Title: Session ID

  The unique identifier of the Lightbox presentation session.
• sessionAttendanceEvents: array Presentation Session Attendance Events
  Title: Presentation Session Attendance Events

  The presentation session attendance events resource is used to view and create the event attendance. Presentation session events attendance is used to keep track of the audience who attended a session when a Lightbox document was displayed.
• SessionDate: string (date-time)
  Title: Session Date

  The date and time when the Lightbox presentation session was conducted. The default value is obtained from Activity unless specified during create.
• sessionDisplayEvents: array Presentation Session Display Events
  Title: Presentation Session Display Events

  The presentation session display events resource is used to view and create the display events. Display events log the start and stop times during which a Lightbox document page was displayed during a presentation session.
• SessionOwnerId: integer (int64)
  Title: Session Owner ID

  The unique identifier of the owner of the presentation session. This person is the primary presenter of Lightbox documents. The default value is obtained from the user's PartyId unless specified during create.

{
    "type":"object",
    "properties":{
        "PresentationSessionId":{
            "title":"Session ID",
            "type":"integer",
            "description":"The unique identifier of the Lightbox presentation session.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "SessionOwnerId":{
            "title":"Session Owner ID",
            "type":"integer",
            "description":"The unique identifier of the owner of the presentation session. This person is the primary presenter of Lightbox documents. The default value is obtained from the user's PartyId unless specified during create.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "AccountId":{
            "title":"Account ID",
            "type":"integer",
            "description":"The unique identifier of the account for which the presentation session was conducted. The default value is obtained from Activity unless specified during create.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "ActivityId":{
            "title":"Activity ID",
            "type":"integer",
            "description":"The unique identifier of the activity for the presentation session.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "sessionDisplayEvents":{
            "title":"Presentation Session Display Events",
            "type":"array",
            "description":"The presentation session display events resource is used to view and create the display events. Display events log the start and stop times during which a Lightbox document page was displayed during a presentation session.",
            "items":{
                "$ref":"#/components/schemas/presentationSessions-sessionDisplayEvents-item-post-request"
            }
        },
        "SessionDate":{
            "title":"Session Date",
            "type":"string",
            "description":"The date and time when the Lightbox presentation session was conducted. The default value is obtained from Activity unless specified during create.",
            "format":"date-time",
            "nullable":false
        },
        "AccountName":{
            "title":"Account",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the account for which the presentation session was conducted.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "sessionAttendanceEvents":{
            "title":"Presentation Session Attendance Events",
            "type":"array",
            "description":"The presentation session attendance events resource is used to view and create the event attendance. Presentation session events attendance is used to keep track of the audience who attended a session when a Lightbox document was displayed.",
            "items":{
                "$ref":"#/components/schemas/presentationSessions-sessionAttendanceEvents-item-post-request"
            }
        }
    }
}

Nested Schema : Presentation Session Attendance Events

Type: array

Title: Presentation Session Attendance Events

The presentation session attendance events resource is used to view and create the event attendance. Presentation session events attendance is used to keep track of the audience who attended a session when a Lightbox document was displayed.

Show Source

• Array of: object presentationSessions-sessionAttendanceEvents-item-post-request

{
    "title":"Presentation Session Attendance Events",
    "type":"array",
    "description":"The presentation session attendance events resource is used to view and create the event attendance. Presentation session events attendance is used to keep track of the audience who attended a session when a Lightbox document was displayed.",
    "items":{
        "$ref":"#/components/schemas/presentationSessions-sessionAttendanceEvents-item-post-request"
    }
}

Nested Schema : Presentation Session Display Events

Type: array

Title: Presentation Session Display Events

The presentation session display events resource is used to view and create the display events. Display events log the start and stop times during which a Lightbox document page was displayed during a presentation session.

Show Source

• Array of: object schema

{
    "title":"Presentation Session Display Events",
    "type":"array",
    "description":"The presentation session display events resource is used to view and create the display events. Display events log the start and stop times during which a Lightbox document page was displayed during a presentation session.",
    "items":{
        "$ref":"#/components/schemas/presentationSessions-sessionDisplayEvents-item-post-request"
    }
}

Nested Schema : presentationSessions-sessionAttendanceEvents-item-post-request

Type: object

Show Source

• AttendanceEventId: integer (int64)
  Title: Attendance Event ID

  The unique identifier of the attendance event.
• AttendanceEventStartTime: string (date-time)
  Title: Attendance Event Start Time

  The start time for the attendance event.
• AttendanceEventStopTime: string (date-time)
  Title: Attendance Event Stop Time

  The stop time for the attendance event.
• AttendeeId: integer (int64)
  Title: Attendee ID

  The unique identifier of the attendee.
• ContactId: integer
  Title: Contact ID

  The unique identifier of the contact.
• LightboxDocumentId: string
  Title: Document ID

  Maximum Length: 64

  The unique identifier of the Lightbox document.
• LightboxDocumentPageId: string
  Title: Document Page ID

  The unique identifier of the Lightbox document page. The value is obtained from LightboxDocumentId, DocumentVersion and PageSequenceNumber unless specified during create.
• LightboxDocumentVersion: string
  Title: Version

  Maximum Length: 64

  The version of the Lightbox document.
• PageSequenceNumber: integer (int32)
  Title: Page Sequence Number

  The page sequence number of the Lightbox document page.
• PresentationSessionId: string
  Title: Session ID

  Maximum Length: 1000

  The unique identifier of the presentation session.

{
    "type":"object",
    "properties":{
        "PresentationSessionId":{
            "title":"Session ID",
            "maxLength":"1000",
            "type":"string",
            "description":"The unique identifier of the presentation session.",
            "nullable":true
        },
        "AttendanceEventStartTime":{
            "title":"Attendance Event Start Time",
            "type":"string",
            "description":"The start time for the attendance event.",
            "format":"date-time",
            "nullable":true
        },
        "AttendanceEventId":{
            "title":"Attendance Event ID",
            "type":"integer",
            "description":"The unique identifier of the attendance event.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "LightboxDocumentId":{
            "title":"Document ID",
            "maxLength":"64",
            "type":"string",
            "description":"The unique identifier of the Lightbox document.",
            "nullable":false
        },
        "ContactId":{
            "title":"Contact ID",
            "type":"integer",
            "description":"The unique identifier of the contact.",
            "nullable":true
        },
        "AttendeeId":{
            "title":"Attendee ID",
            "type":"integer",
            "description":"The unique identifier of the attendee.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "PageSequenceNumber":{
            "title":"Page Sequence Number",
            "type":"integer",
            "description":"The page sequence number of the Lightbox document page.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"9"
            }
        },
        "LightboxDocumentPageId":{
            "title":"Document Page ID",
            "type":"string",
            "description":"The unique identifier of the Lightbox document page. The value is obtained from LightboxDocumentId, DocumentVersion and PageSequenceNumber unless specified during create.",
            "nullable":true
        },
        "LightboxDocumentVersion":{
            "title":"Version",
            "maxLength":"64",
            "type":"string",
            "description":"The version of the Lightbox document.",
            "nullable":true
        },
        "AttendanceEventStopTime":{
            "title":"Attendance Event Stop Time",
            "type":"string",
            "description":"The stop time for the attendance event.",
            "format":"date-time",
            "nullable":true
        }
    }
}

Nested Schema : schema

Type: object

Show Source

• DisplayEventId: integer (int64)
  Title: Display Event ID

  The unique identifier of the presentation session display event.
• DisplayEventStartTime: string (date-time)
  Title: Display Event Start Time

  The start time for the display event.
• DisplayEventStopTime: string (date-time)
  Title: Display Event Stop Time

  The stop time for the display event.
• LightboxDocumentId: string
  Title: Document ID

  Maximum Length: 64

  The unique identifier of the Lightbox document.
• LightboxDocumentPageId: string
  Title: Document Page ID

  The unique identifier of the Lightbox document page. The value is obtained from LightboxDocumentId, DocumentVersion and PageSequenceNumber unless specified during create.
• LightboxDocumentVersion: string
  Title: Version

  Maximum Length: 64

  The version of the Lightbox document.
• PageSequenceNumber: integer (int32)
  Title: Page Sequence Number

  The page sequence number of the Lightbox document page.
• PresentationSessionId: string
  Title: Session ID

  Maximum Length: 1000

  The unique identifier of the presentation session.

{
    "type":"object",
    "properties":{
        "PresentationSessionId":{
            "title":"Session ID",
            "maxLength":"1000",
            "type":"string",
            "description":"The unique identifier of the presentation session.",
            "nullable":true
        },
        "DisplayEventId":{
            "title":"Display Event ID",
            "type":"integer",
            "description":"The unique identifier of the presentation session display event.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "LightboxDocumentId":{
            "title":"Document ID",
            "maxLength":"64",
            "type":"string",
            "description":"The unique identifier of the Lightbox document.",
            "nullable":false
        },
        "PageSequenceNumber":{
            "title":"Page Sequence Number",
            "type":"integer",
            "description":"The page sequence number of the Lightbox document page.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"9"
            }
        },
        "DisplayEventStartTime":{
            "title":"Display Event Start Time",
            "type":"string",
            "description":"The start time for the display event.",
            "format":"date-time",
            "nullable":true
        },
        "LightboxDocumentPageId":{
            "title":"Document Page ID",
            "type":"string",
            "description":"The unique identifier of the Lightbox document page. The value is obtained from LightboxDocumentId, DocumentVersion and PageSequenceNumber unless specified during create.",
            "nullable":true
        },
        "LightboxDocumentVersion":{
            "title":"Version",
            "maxLength":"64",
            "type":"string",
            "description":"The version of the Lightbox document.",
            "nullable":true
        },
        "DisplayEventStopTime":{
            "title":"Display Event Stop Time",
            "type":"string",
            "description":"The stop time for the display event.",
            "format":"date-time",
            "nullable":true
        }
    }
}

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 : presentationSessions-item-response

Type: object

Show Source

• AccountId: integer (int64)
  Title: Account ID

  The unique identifier of the account for which the presentation session was conducted. The default value is obtained from Activity unless specified during create.
• AccountName: string
  Title: Account

  Maximum Length: 360

  The name of the account for which the presentation session was conducted.
• AccountPartyNumber: string
  Title: Registry ID

  Read Only: true

  Maximum Length: 30

  The registry identifier for the account for which the presentation session was conducted.
• ActivityAccountId: integer (int64)
  Title: Activity Account ID

  Read Only: true

  The unique identifier of the activity account. This attribute is not available for ad-hoc presentation sessions.
• ActivityAccountName: string
  Title: Activity Account

  Read Only: true

  Maximum Length: 900

  The name of the activity account for the presentation session. This attribute is not available for ad-hoc presentation sessions.
• ActivityAccountPartyNumber: string
  Title: Activity Registry ID

  Read Only: true

  Maximum Length: 30

  The registry identifier for the activity account for the presentation session. This attribute is not available for ad-hoc presentation sessions.
• ActivityId: integer (int64)
  Title: Activity ID

  The unique identifier of the activity for the presentation session.
• ActivityNumber: string
  Title: Activity Number

  Read Only: true

  Maximum Length: 64

  The activity number for the presentation session.
• ActivitySubject: string
  Title: Subject

  Read Only: true

  Maximum Length: 500

  The subject of the activity for the presentation session.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the record.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the record was created.
• DeleteFlag: boolean
  Read Only: true

  Indicates whether the record can be deleted. The default value is true.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date when the record was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the record.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PresentationSessionId: integer (int64)
  Title: Session ID

  The unique identifier of the Lightbox presentation session.
• sessionAttendanceEvents: array Presentation Session Attendance Events
  Title: Presentation Session Attendance Events

  The presentation session attendance events resource is used to view and create the event attendance. Presentation session events attendance is used to keep track of the audience who attended a session when a Lightbox document was displayed.
• SessionDate: string (date-time)
  Title: Session Date

  The date and time when the Lightbox presentation session was conducted. The default value is obtained from Activity unless specified during create.
• sessionDisplayEvents: array Presentation Session Display Events
  Title: Presentation Session Display Events

  The presentation session display events resource is used to view and create the display events. Display events log the start and stop times during which a Lightbox document page was displayed during a presentation session.
• SessionOwnerEmailAddress: string
  Title: Owner Primary Email

  Read Only: true

  Maximum Length: 320

  The e-mail address of the owner of the presentation session.
• SessionOwnerId: integer (int64)
  Title: Session Owner ID

  The unique identifier of the owner of the presentation session. This person is the primary presenter of Lightbox documents. The default value is obtained from the user's PartyId unless specified during create.
• SessionOwnerName: string
  Title: Owner Name

  Read Only: true

  Maximum Length: 360

  The name of the owner of the presentation session.
• SessionOwnerTitle: string
  Title: Owner Title

  Read Only: true

  Maximum Length: 60

  The title of the owner of the presentation session.
• TotalSessionDisplayDuration: number
  Title: Total Session Display Duration

  Read Only: true

  Default Value: 1

  The summed duration of all presentation session display events of all Lightbox document pages presented during the presentation session. The value is in seconds.
• UpdateFlag: boolean
  Read Only: true

  Indicates whether the record can be updated. The default value is true.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ActivityAccountPartyNumber":{
            "title":"Activity Registry ID",
            "maxLength":"30",
            "type":"string",
            "description":"The registry identifier for the activity account for the presentation session. This attribute is not available for ad-hoc presentation sessions.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AccountId":{
            "title":"Account ID",
            "type":"integer",
            "description":"The unique identifier of the account for which the presentation session was conducted. The default value is obtained from Activity unless specified during create.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ActivityId":{
            "title":"Activity ID",
            "type":"integer",
            "description":"The unique identifier of the activity for the presentation session.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AccountPartyNumber":{
            "title":"Registry ID",
            "maxLength":"30",
            "type":"string",
            "description":"The registry identifier for the account for which the presentation session was conducted.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SessionDate":{
            "title":"Session Date",
            "type":"string",
            "description":"The date and time when the Lightbox presentation session was conducted. The default value is obtained from Activity unless specified during create.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "PresentationSessionId":{
            "title":"Session ID",
            "type":"integer",
            "description":"The unique identifier of the Lightbox presentation session.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "UpdateFlag":{
            "type":"boolean",
            "description":"Indicates whether the record can be updated. The default value is true.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "SessionOwnerId"
                ]
            }
        },
        "ActivityNumber":{
            "title":"Activity Number",
            "maxLength":"64",
            "type":"string",
            "description":"The activity number for the presentation session.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SessionOwnerId":{
            "title":"Session Owner ID",
            "type":"integer",
            "description":"The unique identifier of the owner of the presentation session. This person is the primary presenter of Lightbox documents. The default value is obtained from the user's PartyId unless specified during create.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ActivityAccountName":{
            "title":"Activity Account",
            "maxLength":"900",
            "type":"string",
            "description":"The name of the activity account for the presentation session. This attribute is not available for ad-hoc presentation sessions.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SessionOwnerName":{
            "title":"Owner Name",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the owner of the presentation session.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SessionOwnerEmailAddress":{
            "title":"Owner Primary Email",
            "maxLength":"320",
            "type":"string",
            "description":"The e-mail address of the owner of the presentation session.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"EmailEO.EmailAddress",
                "protectionObjectTitle":"Email",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Email"
            },
            "x-queryable":true
        },
        "ActivityAccountId":{
            "title":"Activity Account ID",
            "type":"integer",
            "description":"The unique identifier of the activity account. This attribute is not available for ad-hoc presentation sessions.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ActivitySubject":{
            "title":"Subject",
            "maxLength":"500",
            "type":"string",
            "description":"The subject of the activity for the presentation session.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"combo_lov",
                "protectionKey":"ActivityEO.Subject",
                "protectionState":"TOKENIZED"
            },
            "x-queryable":true
        },
        "DeleteFlag":{
            "type":"boolean",
            "description":"Indicates whether the record can be deleted. The default value is true.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "SessionOwnerId"
                ]
            }
        },
        "sessionAttendanceEvents":{
            "title":"Presentation Session Attendance Events",
            "type":"array",
            "description":"The presentation session attendance events resource is used to view and create the event attendance. Presentation session events attendance is used to keep track of the audience who attended a session when a Lightbox document was displayed.",
            "items":{
                "$ref":"#/components/schemas/presentationSessions-sessionAttendanceEvents-item-response"
            }
        },
        "TotalSessionDisplayDuration":{
            "title":"Total Session Display Duration",
            "type":"number",
            "description":"The summed duration of all presentation session display events of all Lightbox document pages presented during the presentation session. The value is in seconds.",
            "nullable":false,
            "readOnly":true,
            "default":"1",
            "x-queryable":true
        },
        "sessionDisplayEvents":{
            "title":"Presentation Session Display Events",
            "type":"array",
            "description":"The presentation session display events resource is used to view and create the display events. Display events log the start and stop times during which a Lightbox document page was displayed during a presentation session.",
            "items":{
                "$ref":"#/components/schemas/presentationSessions-sessionDisplayEvents-item-response"
            }
        },
        "SessionOwnerTitle":{
            "title":"Owner Title",
            "maxLength":"60",
            "type":"string",
            "description":"The title of the owner of the presentation session.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":"32",
            "type":"string",
            "description":"The login of the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AccountName":{
            "title":"Account",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the account for which the presentation session was conducted.",
            "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 : Presentation Session Attendance Events

Type: array

Title: Presentation Session Attendance Events

The presentation session attendance events resource is used to view and create the event attendance. Presentation session events attendance is used to keep track of the audience who attended a session when a Lightbox document was displayed.

Show Source

• Array of: object presentationSessions-sessionAttendanceEvents-item-response

{
    "title":"Presentation Session Attendance Events",
    "type":"array",
    "description":"The presentation session attendance events resource is used to view and create the event attendance. Presentation session events attendance is used to keep track of the audience who attended a session when a Lightbox document was displayed.",
    "items":{
        "$ref":"#/components/schemas/presentationSessions-sessionAttendanceEvents-item-response"
    }
}

Nested Schema : Presentation Session Display Events

Type: array

Title: Presentation Session Display Events

The presentation session display events resource is used to view and create the display events. Display events log the start and stop times during which a Lightbox document page was displayed during a presentation session.

Show Source

• Array of: object presentationSessions-sessionDisplayEvents-item-response

{
    "title":"Presentation Session Display Events",
    "type":"array",
    "description":"The presentation session display events resource is used to view and create the display events. Display events log the start and stop times during which a Lightbox document page was displayed during a presentation session.",
    "items":{
        "$ref":"#/components/schemas/presentationSessions-sessionDisplayEvents-item-response"
    }
}

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."
        }
    }
}

Nested Schema : presentationSessions-sessionAttendanceEvents-item-response

Type: object

Show Source

• AttendanceEventId: integer (int64)
  Title: Attendance Event ID

  The unique identifier of the attendance event.
• AttendanceEventStartTime: string (date-time)
  Title: Attendance Event Start Time

  The start time for the attendance event.
• AttendanceEventStopTime: string (date-time)
  Title: Attendance Event Stop Time

  The stop time for the attendance event.
• AttendeeId: integer (int64)
  Title: Attendee ID

  The unique identifier of the attendee.
• ContactId: integer
  Title: Contact ID

  The unique identifier of the contact.
• ContactName: string
  Title: Contact

  Read Only: true

  Maximum Length: 450

  The name of the contact for the attendance event.
• ContactPartyNumber: string
  Title: Party Number

  Read Only: true

  Maximum Length: 30

  The party number of the contact.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the record.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the record was created.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date when the record was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the record.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the record.
• LightboxDocumentId: string
  Title: Document ID

  Maximum Length: 64

  The unique identifier of the Lightbox document.
• LightboxDocumentPageId: string
  Title: Document Page ID

  The unique identifier of the Lightbox document page. The value is obtained from LightboxDocumentId, DocumentVersion and PageSequenceNumber unless specified during create.
• LightboxDocumentVersion: string
  Title: Version

  Maximum Length: 64

  The version of the Lightbox document.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PageSequenceNumber: integer (int32)
  Title: Page Sequence Number

  The page sequence number of the Lightbox document page.
• PresentationSessionId: string
  Title: Session ID

  Maximum Length: 1000

  The unique identifier of the presentation session.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AttendanceEventStartTime":{
            "title":"Attendance Event Start Time",
            "type":"string",
            "description":"The start time for the attendance event.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AttendanceEventId":{
            "title":"Attendance Event ID",
            "type":"integer",
            "description":"The unique identifier of the attendance event.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LightboxDocumentId":{
            "title":"Document ID",
            "maxLength":"64",
            "type":"string",
            "description":"The unique identifier of the Lightbox document.",
            "nullable":false,
            "x-queryable":true
        },
        "ContactId":{
            "title":"Contact ID",
            "type":"integer",
            "description":"The unique identifier of the contact.",
            "nullable":true,
            "x-queryable":true
        },
        "ContactPartyNumber":{
            "title":"Party Number",
            "maxLength":"30",
            "type":"string",
            "description":"The party number of the contact.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LightboxDocumentPageId":{
            "title":"Document Page ID",
            "type":"string",
            "description":"The unique identifier of the Lightbox document page. The value is obtained from LightboxDocumentId, DocumentVersion and PageSequenceNumber unless specified during create.",
            "nullable":true,
            "x-queryable":true
        },
        "PresentationSessionId":{
            "title":"Session ID",
            "maxLength":"1000",
            "type":"string",
            "description":"The unique identifier of the presentation session.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ContactName":{
            "title":"Contact",
            "maxLength":"450",
            "type":"string",
            "description":"The name of the contact for the attendance event.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Name",
                "protectionTokenizationScheme":"WORD"
            },
            "x-queryable":true
        },
        "AttendeeId":{
            "title":"Attendee ID",
            "type":"integer",
            "description":"The unique identifier of the attendee.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PageSequenceNumber":{
            "title":"Page Sequence Number",
            "type":"integer",
            "description":"The page sequence number of the Lightbox document page.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":"32",
            "type":"string",
            "description":"The login of the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LightboxDocumentVersion":{
            "title":"Version",
            "maxLength":"64",
            "type":"string",
            "description":"The version of the Lightbox document.",
            "nullable":true,
            "x-queryable":true
        },
        "AttendanceEventStopTime":{
            "title":"Attendance Event Stop Time",
            "type":"string",
            "description":"The stop time for the attendance event.",
            "format":"date-time",
            "nullable":true,
            "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 : presentationSessions-sessionDisplayEvents-item-response

Type: object

Show Source

• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the record.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the record was created.
• DisplayEventId: integer (int64)
  Title: Display Event ID

  The unique identifier of the presentation session display event.
• DisplayEventStartTime: string (date-time)
  Title: Display Event Start Time

  The start time for the display event.
• DisplayEventStopTime: string (date-time)
  Title: Display Event Stop Time

  The stop time for the display event.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date when the record was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the record.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the record.
• LightboxDocumentId: string
  Title: Document ID

  Maximum Length: 64

  The unique identifier of the Lightbox document.
• LightboxDocumentPageId: string
  Title: Document Page ID

  The unique identifier of the Lightbox document page. The value is obtained from LightboxDocumentId, DocumentVersion and PageSequenceNumber unless specified during create.
• LightboxDocumentVersion: string
  Title: Version

  Maximum Length: 64

  The version of the Lightbox document.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PageSequenceNumber: integer (int32)
  Title: Page Sequence Number

  The page sequence number of the Lightbox document page.
• PresentationSessionId: string
  Title: Session ID

  Maximum Length: 1000

  The unique identifier of the presentation session.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LightboxDocumentId":{
            "title":"Document ID",
            "maxLength":"64",
            "type":"string",
            "description":"The unique identifier of the Lightbox document.",
            "nullable":false,
            "x-queryable":true
        },
        "DisplayEventStartTime":{
            "title":"Display Event Start Time",
            "type":"string",
            "description":"The start time for the display event.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "LightboxDocumentPageId":{
            "title":"Document Page ID",
            "type":"string",
            "description":"The unique identifier of the Lightbox document page. The value is obtained from LightboxDocumentId, DocumentVersion and PageSequenceNumber unless specified during create.",
            "nullable":true,
            "x-queryable":true
        },
        "DisplayEventStopTime":{
            "title":"Display Event Stop Time",
            "type":"string",
            "description":"The stop time for the display event.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "PresentationSessionId":{
            "title":"Session ID",
            "maxLength":"1000",
            "type":"string",
            "description":"The unique identifier of the presentation session.",
            "nullable":true,
            "x-queryable":true
        },
        "DisplayEventId":{
            "title":"Display Event ID",
            "type":"integer",
            "description":"The unique identifier of the presentation session display event.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PageSequenceNumber":{
            "title":"Page Sequence Number",
            "type":"integer",
            "description":"The page sequence number of the Lightbox document page.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":"32",
            "type":"string",
            "description":"The login of the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LightboxDocumentVersion":{
            "title":"Version",
            "maxLength":"64",
            "type":"string",
            "description":"The version of the Lightbox document.",
            "nullable":true,
            "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"
    }
}

Links

AccountListVA

Operation: /crmRestApi/resources/11.13.18.05/accounts

An account for a customer or prospect. This object is an aggregation of primary account profile, and contact information, and references a single primary address.

ActivityVA

Operation: /crmRestApi/resources/11.13.18.05/activities

Parameters:

• finder: OpenActivities

The activities resource is used to view, create, update, and delete activity data. Activities keep track of things you plan to do, like a task or an appointment, or things that you have already completed, like logging a customer call.

ResourceVA

Operation: /crmRestApi/resources/11.13.18.05/resources

A front office person. For example, sales persons or partner members can be tagged as resources.

sessionAttendanceEvents

Operation: /crmRestApi/resources/11.13.18.05/presentationSessions/{PresentationSessionId}/child/sessionAttendanceEvents

Parameters:

• PresentationSessionId: $request.path.PresentationSessionId

The presentation session attendance events resource is used to view and create the event attendance. Presentation session events attendance is used to keep track of the audience who attended a session when a Lightbox document was displayed.

sessionDisplayEvents

Operation: /crmRestApi/resources/11.13.18.05/presentationSessions/{PresentationSessionId}/child/sessionDisplayEvents

Parameters:

• PresentationSessionId: $request.path.PresentationSessionId

The presentation session display events resource is used to view and create the display events. Display events log the start and stop times during which a Lightbox document page was displayed during a presentation session.

Back to Top

Examples

The following example shows how to create a Lightbox presentation session by submitting a POST request on the REST resource using cURL.

Create a Lightbox presentation session with reference to an appointment activity

cURL Command

curl --user sales_cloud_user -X POST -d @example_request_payload.json https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/presentationSessions

Example of Request Body

The following shows an example of the request body in JSON format.

{
"ActivityId":300100089786738
}

Example of Response Body

The following example shows the contents of the response body in JSON format.

{
  "PresentationSessionId": 300100089786740,
  "SessionDate": "2017-02-16T00:30:00+00:00",
  "ActivityId": 300100089786738,
  "ActivitySubject": "Payload Examples",
  "ActivityNumber": "CDRM_56153",
  "AccountId": 1004,
  "AccountName": "Hilman and Associates",
  "AccountPartyNumber": "1004",
  "ActivityAccountId": 1004,
  "ActivityAccountName": "Hilman and Associates US)",
  "ActivityAccountPartyNumber": "1004",
  "SessionOwnerId": 100010032752947,
  "SessionOwnerName": "Ryan,Katy",
  "SessionOwnerEmailAddress": "email@your_organization.com",
  "SessionOwnerTitle": null,
  "CreatedBy": "KRyan",
  "CreationDate": "2017-02-21T06:07:55+00:00",
  "LastUpdateDate": "2017-02-21T06:07:55+00:00",
  "LastUpdateLogin": "4904EDC6284F3784E0533DD7F00A5CB2",
  "LastUpdatedBy": "KRyan",
  "TotalSessionDisplayDuration": null,
  "DeleteFlag": true,
  "UpdateFlag": true,
  "links": [
  	...
]
}

Create a Lightbox presentation session without referencing an appointment activity

cURL Command

curl --user sales_cloud_user -X POST -d @example_request_payload.json https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/presentationSessions

Example of Response Body

The following example shows the contents of the response body in JSON format.

{
  "PresentationSessionId": 300100089786735,
  "SessionDate": "2017-02-21T05:48:17+00:00",
  "ActivityId": null,
  "ActivitySubject": null,
  "ActivityNumber": null,
  "AccountId": null,
  "AccountName": null,
  "AccountPartyNumber": null,
  "ActivityAccountId": null,
  "ActivityAccountName": null,
  "ActivityAccountPartyNumber": null,
  "SessionOwnerId": 100010032752947,
  "SessionOwnerName": "Ryan,Katy",
  "SessionOwnerEmailAddress": "CEO.CRM+TM39@your_organization.com",
  "SessionOwnerTitle": null,
  "CreatedBy": "KRyan",
  "CreationDate": "2017-02-21T05:48:27+00:00",
  "LastUpdateDate": "2017-02-21T05:48:27+00:00",
  "LastUpdateLogin": "4904EDC6284F3784E0533DD7F00A5CB2",
  "LastUpdatedBy": "KRyan",
  "TotalSessionDisplayDuration": null,
  "DeleteFlag": true,
  "UpdateFlag": true,
  "links": [
	....
  		]
}

Back to Top