POST {version}/GetTransactionEvents

Get Events

Request Information

URI Parameters

NameDescriptionTypeAdditional information
version

string

None.

Body Parameters

Query
NameDescriptionTypeAdditional information
ActiveOnly

boolean

None.

Ids

Collection of globally unique identifier

None.

Request Formats

application/json, text/json

Sample:
{
  "ActiveOnly": true,
  "Ids": [
    "01eae20c-00f9-472d-850a-a624e384f485",
    "220d751b-7f22-4103-9b5b-99339c9a0130"
  ]
}

application/xml, text/xml

Sample:
<Query xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Aristotle.CM.Model">
  <ActiveOnly>true</ActiveOnly>
  <Ids xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:guid>01eae20c-00f9-472d-850a-a624e384f485</d2p1:guid>
    <d2p1:guid>220d751b-7f22-4103-9b5b-99339c9a0130</d2p1:guid>
  </Ids>
</Query>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

List of Events

Collection of Event
NameDescriptionTypeAdditional information
GUID

globally unique identifier

None.

Text

string

None.

Description

string

None.

StartDate

date

None.

EndDate

date

None.

Isactive

boolean

None.

Inactive

boolean

None.

ShortStartDate

string

None.

ShortEndDate

string

None.

AllocationOnly

boolean

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "GUID": "74171da6-f650-439f-a54a-ffddc2620dae",
    "Text": "sample string 2",
    "Description": "sample string 3",
    "StartDate": "10/16/2024",
    "EndDate": "10/16/2024",
    "Isactive": true,
    "Inactive": true,
    "ShortStartDate": "10/16/2024",
    "ShortEndDate": "10/16/2024",
    "AllocationOnly": true
  },
  {
    "GUID": "74171da6-f650-439f-a54a-ffddc2620dae",
    "Text": "sample string 2",
    "Description": "sample string 3",
    "StartDate": "10/16/2024",
    "EndDate": "10/16/2024",
    "Isactive": true,
    "Inactive": true,
    "ShortStartDate": "10/16/2024",
    "ShortEndDate": "10/16/2024",
    "AllocationOnly": true
  }
]

application/xml, text/xml

Sample:
<ArrayOfEvent xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Aristotle.CM.Model">
  <Event>
    <AllocationOnly>true</AllocationOnly>
    <Description>sample string 3</Description>
    <EndDate>2024-10-16T12:18:22.9791906-04:00</EndDate>
    <GUID>74171da6-f650-439f-a54a-ffddc2620dae</GUID>
    <Inactive>true</Inactive>
    <Isactive>true</Isactive>
    <StartDate>2024-10-16T12:18:22.9791906-04:00</StartDate>
    <Text>sample string 2</Text>
  </Event>
  <Event>
    <AllocationOnly>true</AllocationOnly>
    <Description>sample string 3</Description>
    <EndDate>2024-10-16T12:18:22.9791906-04:00</EndDate>
    <GUID>74171da6-f650-439f-a54a-ffddc2620dae</GUID>
    <Inactive>true</Inactive>
    <Isactive>true</Isactive>
    <StartDate>2024-10-16T12:18:22.9791906-04:00</StartDate>
    <Text>sample string 2</Text>
  </Event>
</ArrayOfEvent>