POST api/Event/GetEventSummaryUsingDisplayId

Returns the EventSummary object for the specified case or investigation. Investigations are retrieved using the displayed investigation Id, not the record key. The Ids required must be provided in the SessionInfo Parameters dictionary. If the case or investigation cannot be located, or the user does not have access to the record, an empty EventSummary is returned with the CategoryId set to the associated error code.

Request Information

URI Parameters

None.

Body Parameters

SessionInfo for current user

SessionInfo

Name	Type	Additional information
BaseCatgId	integer	None.
BaseCatgCode	integer	None.
DesigneeId	integer	None.
DesigneeName	string	None.
Desktop	string	None.
EventCatgId	integer	None.
EventCatgCode	integer	None.
EventCatgStatusCode	integer	None.
ErrorCode	string	None.
ErrorDescription	string	None.
NetworkId	string	None.
OrgEntityId	integer	None.
OrgRoleCode	integer	None.
OrgRoleType	string	None.
WorkerName	string	None.
WorkerId	integer	None.
Parameters	Dictionary of string [key] and string [value]	None.

Request Formats

application/json, text/json

Sample:

{
  "BaseCatgId": 1,
  "BaseCatgCode": 2,
  "DesigneeId": 3,
  "DesigneeName": "sample string 4",
  "Desktop": "sample string 5",
  "EventCatgId": 6,
  "EventCatgCode": 7,
  "EventCatgStatusCode": 8,
  "ErrorCode": "sample string 9",
  "ErrorDescription": "sample string 10",
  "NetworkId": "sample string 11",
  "OrgEntityId": 12,
  "OrgRoleCode": 13,
  "OrgRoleType": "sample string 14",
  "WorkerName": "sample string 15",
  "WorkerId": 16,
  "Parameters": {
    "sample string 1": "sample string 2",
    "sample string 3": "sample string 4"
  }
}

application/xml, text/xml

Sample:

<SessionInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SACWISAPI">
  <BaseCatgCode>2</BaseCatgCode>
  <BaseCatgId>1</BaseCatgId>
  <DesigneeId>3</DesigneeId>
  <DesigneeName>sample string 4</DesigneeName>
  <Desktop>sample string 5</Desktop>
  <ErrorCode>sample string 9</ErrorCode>
  <ErrorDescription>sample string 10</ErrorDescription>
  <EventCatgCode>7</EventCatgCode>
  <EventCatgId>6</EventCatgId>
  <EventCatgStatusCode>8</EventCatgStatusCode>
  <NetworkId>sample string 11</NetworkId>
  <OrgEntityId>12</OrgEntityId>
  <OrgRoleCode>13</OrgRoleCode>
  <OrgRoleType>sample string 14</OrgRoleType>
  <Parameters xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>sample string 1</d2p1:Key>
      <d2p1:Value>sample string 2</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>sample string 3</d2p1:Key>
      <d2p1:Value>sample string 4</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Parameters>
  <WorkerId>16</WorkerId>
  <WorkerName>sample string 15</WorkerName>
</SessionInfo>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

EventSummary object

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.