GET api/{context}/event/ID/{text}

Retrieve an event by its ID

Request Information

ParameterDescriptionAdditional information
text
The EventID of the event

Define this parameter in the request URI.

Special Field Notes

Field NameNotes
EventID
Primary key for all Aegis CRM events.

Response Information

Response body formats

application/json, text/json

Sample:
{
  "EventID": "sample string 1",
  "EventName": "sample string 2",
  "StartDate": "2020-08-04T10:35:43.753764-06:00",
  "EndDate": "2020-08-04T10:35:43.753764-06:00",
  "Venue": {
    "VenueName": "sample string 1",
    "Address": "sample string 2",
    "City": "sample string 3",
    "StateProv": "sample string 4",
    "PostalCode": "sample string 5",
    "Phone": "sample string 6",
    "Email": "sample string 7",
    "Website": "sample string 8",
    "ContactName": "sample string 9",
    "Notes": "sample string 10"
  },
  "Sponsorships": [
    {
      "EventID": "sample string 1",
      "PartnerID": "sample string 2",
      "SponsorshipLevel": "sample string 3"
    },
    {
      "EventID": "sample string 1",
      "PartnerID": "sample string 2",
      "SponsorshipLevel": "sample string 3"
    },
    {
      "EventID": "sample string 1",
      "PartnerID": "sample string 2",
      "SponsorshipLevel": "sample string 3"
    }
  ],
  "SponsorshipLevels": [
    {
      "Name": "sample string 1",
      "Description": "sample string 2",
      "SponsorshipLevelBenefits": [
        {
          "Name": "sample string 1",
          "Description": "sample string 2"
        },
        {
          "Name": "sample string 1",
          "Description": "sample string 2"
        },
        {
          "Name": "sample string 1",
          "Description": "sample string 2"
        }
      ]
    },
    {
      "Name": "sample string 1",
      "Description": "sample string 2",
      "SponsorshipLevelBenefits": [
        {
          "Name": "sample string 1",
          "Description": "sample string 2"
        },
        {
          "Name": "sample string 1",
          "Description": "sample string 2"
        },
        {
          "Name": "sample string 1",
          "Description": "sample string 2"
        }
      ]
    },
    {
      "Name": "sample string 1",
      "Description": "sample string 2",
      "SponsorshipLevelBenefits": [
        {
          "Name": "sample string 1",
          "Description": "sample string 2"
        },
        {
          "Name": "sample string 1",
          "Description": "sample string 2"
        },
        {
          "Name": "sample string 1",
          "Description": "sample string 2"
        }
      ]
    }
  ],
  "InventoryList": [
    {
      "ProductCategory": "sample string 2",
      "BinLocation": "sample string 3",
      "WarehouseID": "sample string 4",
      "SKU": "sample string 5",
      "Name": "sample string 6",
      "Summary": "sample string 7",
      "FullDescription": "sample string 8",
      "Author": "sample string 9",
      "ForSale": true,
      "Taxable": true,
      "Weight": 1.0,
      "FMV": 1.0,
      "Price": 1.0,
      "MaxStock": 1,
      "ReorderLevel": 1,
      "LeadTime": 1,
      "Notes": "sample string 10",
      "Active": true,
      "OnDemand": true,
      "AllowBackorder": true,
      "ServiceOnly": true,
      "DefaultFund": "sample string 11",
      "IsTicket": true,
      "UPC": "sample string 12",
      "ForSaleOnWeb": true,
      "WebAvailableStart": "2020-08-04T10:35:43.753764-06:00",
      "WebAvailableEnd": "2020-08-04T10:35:43.753764-06:00",
      "WebPrice": 1.0,
      "WebMaxQuantity": 1,
      "WebFreeWithDonation": true,
      "WebMinimumDonation": 1.0,
      "WebDonationFund": "sample string 14",
      "Enclosure": true,
      "Featured": true,
      "MaxQuantity": 1,
      "AllowDiscount": true,
      "Version": 1,
      "IgnoreVersion": true,
      "AvailableQty": "sample string 16",
      "Attributes": [
        {
          "Name": "sample string 1",
          "DisplayOrder": 2,
          "DataType": "sample string 3",
          "Required": true
        },
        {
          "Name": "sample string 1",
          "DisplayOrder": 2,
          "DataType": "sample string 3",
          "Required": true
        },
        {
          "Name": "sample string 1",
          "DisplayOrder": 2,
          "DataType": "sample string 3",
          "Required": true
        }
      ]
    },
    {
      "ProductCategory": "sample string 2",
      "BinLocation": "sample string 3",
      "WarehouseID": "sample string 4",
      "SKU": "sample string 5",
      "Name": "sample string 6",
      "Summary": "sample string 7",
      "FullDescription": "sample string 8",
      "Author": "sample string 9",
      "ForSale": true,
      "Taxable": true,
      "Weight": 1.0,
      "FMV": 1.0,
      "Price": 1.0,
      "MaxStock": 1,
      "ReorderLevel": 1,
      "LeadTime": 1,
      "Notes": "sample string 10",
      "Active": true,
      "OnDemand": true,
      "AllowBackorder": true,
      "ServiceOnly": true,
      "DefaultFund": "sample string 11",
      "IsTicket": true,
      "UPC": "sample string 12",
      "ForSaleOnWeb": true,
      "WebAvailableStart": "2020-08-04T10:35:43.753764-06:00",
      "WebAvailableEnd": "2020-08-04T10:35:43.753764-06:00",
      "WebPrice": 1.0,
      "WebMaxQuantity": 1,
      "WebFreeWithDonation": true,
      "WebMinimumDonation": 1.0,
      "WebDonationFund": "sample string 14",
      "Enclosure": true,
      "Featured": true,
      "MaxQuantity": 1,
      "AllowDiscount": true,
      "Version": 1,
      "IgnoreVersion": true,
      "AvailableQty": "sample string 16",
      "Attributes": [
        {
          "Name": "sample string 1",
          "DisplayOrder": 2,
          "DataType": "sample string 3",
          "Required": true
        },
        {
          "Name": "sample string 1",
          "DisplayOrder": 2,
          "DataType": "sample string 3",
          "Required": true
        },
        {
          "Name": "sample string 1",
          "DisplayOrder": 2,
          "DataType": "sample string 3",
          "Required": true
        }
      ]
    },
    {
      "ProductCategory": "sample string 2",
      "BinLocation": "sample string 3",
      "WarehouseID": "sample string 4",
      "SKU": "sample string 5",
      "Name": "sample string 6",
      "Summary": "sample string 7",
      "FullDescription": "sample string 8",
      "Author": "sample string 9",
      "ForSale": true,
      "Taxable": true,
      "Weight": 1.0,
      "FMV": 1.0,
      "Price": 1.0,
      "MaxStock": 1,
      "ReorderLevel": 1,
      "LeadTime": 1,
      "Notes": "sample string 10",
      "Active": true,
      "OnDemand": true,
      "AllowBackorder": true,
      "ServiceOnly": true,
      "DefaultFund": "sample string 11",
      "IsTicket": true,
      "UPC": "sample string 12",
      "ForSaleOnWeb": true,
      "WebAvailableStart": "2020-08-04T10:35:43.753764-06:00",
      "WebAvailableEnd": "2020-08-04T10:35:43.753764-06:00",
      "WebPrice": 1.0,
      "WebMaxQuantity": 1,
      "WebFreeWithDonation": true,
      "WebMinimumDonation": 1.0,
      "WebDonationFund": "sample string 14",
      "Enclosure": true,
      "Featured": true,
      "MaxQuantity": 1,
      "AllowDiscount": true,
      "Version": 1,
      "IgnoreVersion": true,
      "AvailableQty": "sample string 16",
      "Attributes": [
        {
          "Name": "sample string 1",
          "DisplayOrder": 2,
          "DataType": "sample string 3",
          "Required": true
        },
        {
          "Name": "sample string 1",
          "DisplayOrder": 2,
          "DataType": "sample string 3",
          "Required": true
        },
        {
          "Name": "sample string 1",
          "DisplayOrder": 2,
          "DataType": "sample string 3",
          "Required": true
        }
      ]
    }
  ],
  "Shifts": [
    {
      "ShiftID": "f53f7a77-b5be-42d4-a64e-473bb873b727",
      "RoleName": "sample string 2",
      "ShiftDate": "2020-08-04T10:35:43.753764-06:00",
      "StartTime": "00:00:00.1234567",
      "EndTime": "00:00:00.1234567",
      "StaffCapacity": 1,
      "Availability": 3
    },
    {
      "ShiftID": "f53f7a77-b5be-42d4-a64e-473bb873b727",
      "RoleName": "sample string 2",
      "ShiftDate": "2020-08-04T10:35:43.753764-06:00",
      "StartTime": "00:00:00.1234567",
      "EndTime": "00:00:00.1234567",
      "StaffCapacity": 1,
      "Availability": 3
    },
    {
      "ShiftID": "f53f7a77-b5be-42d4-a64e-473bb873b727",
      "RoleName": "sample string 2",
      "ShiftDate": "2020-08-04T10:35:43.753764-06:00",
      "StartTime": "00:00:00.1234567",
      "EndTime": "00:00:00.1234567",
      "StaffCapacity": 1,
      "Availability": 3
    }
  ]
}

application/xml, text/xml

Sample:
<EventModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BDS.Web.WebApi.Models">
  <EndDate>2020-08-04T10:35:43.753764-06:00</EndDate>
  <EventID>sample string 1</EventID>
  <EventName>sample string 2</EventName>
  <InventoryList>
    <InventoryModel>
      <Active>true</Active>
      <AllowBackorder>true</AllowBackorder>
      <AllowDiscount>true</AllowDiscount>
      <Attributes>
        <InventoryModel.ProductAttribute>
          <DataType>sample string 3</DataType>
          <DisplayOrder>2</DisplayOrder>
          <Name>sample string 1</Name>
          <PickListID>12a5a435-f558-4acf-ab59-d31123e65714</PickListID>
          <Required>true</Required>
        </InventoryModel.ProductAttribute>
        <InventoryModel.ProductAttribute>
          <DataType>sample string 3</DataType>
          <DisplayOrder>2</DisplayOrder>
          <Name>sample string 1</Name>
          <PickListID>12a5a435-f558-4acf-ab59-d31123e65714</PickListID>
          <Required>true</Required>
        </InventoryModel.ProductAttribute>
        <InventoryModel.ProductAttribute>
          <DataType>sample string 3</DataType>
          <DisplayOrder>2</DisplayOrder>
          <Name>sample string 1</Name>
          <PickListID>12a5a435-f558-4acf-ab59-d31123e65714</PickListID>
          <Required>true</Required>
        </InventoryModel.ProductAttribute>
      </Attributes>
      <Author>sample string 9</Author>
      <AvailableQty>sample string 16</AvailableQty>
      <BinLocation>sample string 3</BinLocation>
      <DefaultFund>sample string 11</DefaultFund>
      <DefaultFundID>fd8bfa17-a082-4142-a3d8-778f0ada5a2c</DefaultFundID>
      <Enclosure>true</Enclosure>
      <FMV>1</FMV>
      <Featured>true</Featured>
      <ForSale>true</ForSale>
      <ForSaleOnWeb>true</ForSaleOnWeb>
      <FullDescription>sample string 8</FullDescription>
      <ID>041fb6b7-677c-4222-9163-40f454195b34</ID>
      <IgnoreVersion>true</IgnoreVersion>
      <IsTicket>true</IsTicket>
      <LeadTime>1</LeadTime>
      <MaxQuantity>1</MaxQuantity>
      <MaxStock>1</MaxStock>
      <Name>sample string 6</Name>
      <Notes>sample string 10</Notes>
      <OnDemand>true</OnDemand>
      <Price>1</Price>
      <ProductCategory>sample string 2</ProductCategory>
      <ProductCategoryID>01b648f9-8854-4511-a80d-7451f98d65c7</ProductCategoryID>
      <ReorderLevel>1</ReorderLevel>
      <SKU>sample string 5</SKU>
      <ServiceOnly>true</ServiceOnly>
      <Summary>sample string 7</Summary>
      <Taxable>true</Taxable>
      <UPC>sample string 12</UPC>
      <Version>1</Version>
      <WarehouseID>sample string 4</WarehouseID>
      <WebAvailableEnd>2020-08-04T10:35:43.753764-06:00</WebAvailableEnd>
      <WebAvailableStart>2020-08-04T10:35:43.753764-06:00</WebAvailableStart>
      <WebDonationFund>sample string 14</WebDonationFund>
      <WebDonationFundID>173affa3-9781-41f0-9b5b-4b318bf1086a</WebDonationFundID>
      <WebFreeWithDonation>true</WebFreeWithDonation>
      <WebMaxQuantity>1</WebMaxQuantity>
      <WebMinimumDonation>1</WebMinimumDonation>
      <WebPrice>1</WebPrice>
      <Weight>1</Weight>
    </InventoryModel>
    <InventoryModel>
      <Active>true</Active>
      <AllowBackorder>true</AllowBackorder>
      <AllowDiscount>true</AllowDiscount>
      <Attributes>
        <InventoryModel.ProductAttribute>
          <DataType>sample string 3</DataType>
          <DisplayOrder>2</DisplayOrder>
          <Name>sample string 1</Name>
          <PickListID>12a5a435-f558-4acf-ab59-d31123e65714</PickListID>
          <Required>true</Required>
        </InventoryModel.ProductAttribute>
        <InventoryModel.ProductAttribute>
          <DataType>sample string 3</DataType>
          <DisplayOrder>2</DisplayOrder>
          <Name>sample string 1</Name>
          <PickListID>12a5a435-f558-4acf-ab59-d31123e65714</PickListID>
          <Required>true</Required>
        </InventoryModel.ProductAttribute>
        <InventoryModel.ProductAttribute>
          <DataType>sample string 3</DataType>
          <DisplayOrder>2</DisplayOrder>
          <Name>sample string 1</Name>
          <PickListID>12a5a435-f558-4acf-ab59-d31123e65714</PickListID>
          <Required>true</Required>
        </InventoryModel.ProductAttribute>
      </Attributes>
      <Author>sample string 9</Author>
      <AvailableQty>sample string 16</AvailableQty>
      <BinLocation>sample string 3</BinLocation>
      <DefaultFund>sample string 11</DefaultFund>
      <DefaultFundID>fd8bfa17-a082-4142-a3d8-778f0ada5a2c</DefaultFundID>
      <Enclosure>true</Enclosure>
      <FMV>1</FMV>
      <Featured>true</Featured>
      <ForSale>true</ForSale>
      <ForSaleOnWeb>true</ForSaleOnWeb>
      <FullDescription>sample string 8</FullDescription>
      <ID>041fb6b7-677c-4222-9163-40f454195b34</ID>
      <IgnoreVersion>true</IgnoreVersion>
      <IsTicket>true</IsTicket>
      <LeadTime>1</LeadTime>
      <MaxQuantity>1</MaxQuantity>
      <MaxStock>1</MaxStock>
      <Name>sample string 6</Name>
      <Notes>sample string 10</Notes>
      <OnDemand>true</OnDemand>
      <Price>1</Price>
      <ProductCategory>sample string 2</ProductCategory>
      <ProductCategoryID>01b648f9-8854-4511-a80d-7451f98d65c7</ProductCategoryID>
      <ReorderLevel>1</ReorderLevel>
      <SKU>sample string 5</SKU>
      <ServiceOnly>true</ServiceOnly>
      <Summary>sample string 7</Summary>
      <Taxable>true</Taxable>
      <UPC>sample string 12</UPC>
      <Version>1</Version>
      <WarehouseID>sample string 4</WarehouseID>
      <WebAvailableEnd>2020-08-04T10:35:43.753764-06:00</WebAvailableEnd>
      <WebAvailableStart>2020-08-04T10:35:43.753764-06:00</WebAvailableStart>
      <WebDonationFund>sample string 14</WebDonationFund>
      <WebDonationFundID>173affa3-9781-41f0-9b5b-4b318bf1086a</WebDonationFundID>
      <WebFreeWithDonation>true</WebFreeWithDonation>
      <WebMaxQuantity>1</WebMaxQuantity>
      <WebMinimumDonation>1</WebMinimumDonation>
      <WebPrice>1</WebPrice>
      <Weight>1</Weight>
    </InventoryModel>
    <InventoryModel>
      <Active>true</Active>
      <AllowBackorder>true</AllowBackorder>
      <AllowDiscount>true</AllowDiscount>
      <Attributes>
        <InventoryModel.ProductAttribute>
          <DataType>sample string 3</DataType>
          <DisplayOrder>2</DisplayOrder>
          <Name>sample string 1</Name>
          <PickListID>12a5a435-f558-4acf-ab59-d31123e65714</PickListID>
          <Required>true</Required>
        </InventoryModel.ProductAttribute>
        <InventoryModel.ProductAttribute>
          <DataType>sample string 3</DataType>
          <DisplayOrder>2</DisplayOrder>
          <Name>sample string 1</Name>
          <PickListID>12a5a435-f558-4acf-ab59-d31123e65714</PickListID>
          <Required>true</Required>
        </InventoryModel.ProductAttribute>
        <InventoryModel.ProductAttribute>
          <DataType>sample string 3</DataType>
          <DisplayOrder>2</DisplayOrder>
          <Name>sample string 1</Name>
          <PickListID>12a5a435-f558-4acf-ab59-d31123e65714</PickListID>
          <Required>true</Required>
        </InventoryModel.ProductAttribute>
      </Attributes>
      <Author>sample string 9</Author>
      <AvailableQty>sample string 16</AvailableQty>
      <BinLocation>sample string 3</BinLocation>
      <DefaultFund>sample string 11</DefaultFund>
      <DefaultFundID>fd8bfa17-a082-4142-a3d8-778f0ada5a2c</DefaultFundID>
      <Enclosure>true</Enclosure>
      <FMV>1</FMV>
      <Featured>true</Featured>
      <ForSale>true</ForSale>
      <ForSaleOnWeb>true</ForSaleOnWeb>
      <FullDescription>sample string 8</FullDescription>
      <ID>041fb6b7-677c-4222-9163-40f454195b34</ID>
      <IgnoreVersion>true</IgnoreVersion>
      <IsTicket>true</IsTicket>
      <LeadTime>1</LeadTime>
      <MaxQuantity>1</MaxQuantity>
      <MaxStock>1</MaxStock>
      <Name>sample string 6</Name>
      <Notes>sample string 10</Notes>
      <OnDemand>true</OnDemand>
      <Price>1</Price>
      <ProductCategory>sample string 2</ProductCategory>
      <ProductCategoryID>01b648f9-8854-4511-a80d-7451f98d65c7</ProductCategoryID>
      <ReorderLevel>1</ReorderLevel>
      <SKU>sample string 5</SKU>
      <ServiceOnly>true</ServiceOnly>
      <Summary>sample string 7</Summary>
      <Taxable>true</Taxable>
      <UPC>sample string 12</UPC>
      <Version>1</Version>
      <WarehouseID>sample string 4</WarehouseID>
      <WebAvailableEnd>2020-08-04T10:35:43.753764-06:00</WebAvailableEnd>
      <WebAvailableStart>2020-08-04T10:35:43.753764-06:00</WebAvailableStart>
      <WebDonationFund>sample string 14</WebDonationFund>
      <WebDonationFundID>173affa3-9781-41f0-9b5b-4b318bf1086a</WebDonationFundID>
      <WebFreeWithDonation>true</WebFreeWithDonation>
      <WebMaxQuantity>1</WebMaxQuantity>
      <WebMinimumDonation>1</WebMinimumDonation>
      <WebPrice>1</WebPrice>
      <Weight>1</Weight>
    </InventoryModel>
  </InventoryList>
  <StartDate>2020-08-04T10:35:43.753764-06:00</StartDate>
  <Venue>
    <Address>sample string 2</Address>
    <City>sample string 3</City>
    <ContactName>sample string 9</ContactName>
    <Email>sample string 7</Email>
    <Notes>sample string 10</Notes>
    <Phone>sample string 6</Phone>
    <PostalCode>sample string 5</PostalCode>
    <StateProv>sample string 4</StateProv>
    <VenueName>sample string 1</VenueName>
    <Website>sample string 8</Website>
  </Venue>
</EventModel>