GET Events/{id}

Gets an Event by ID

Request Information

URI Parameters

Name	Description	Type	Additional information
id	The ID of the Event to get	integer	Required

Body Parameters

None.

Response Information

Resource Description

Event

Name	Type	Additional information
ID	integer	None.
Name	string	None.
ProductName	string	None.
PartnerName	string	None.
ShipmentCount	integer	None.
PrimaryAddress	string	None.
Latitude	decimal number	None.
Longitude	decimal number	None.
RepExtension	string	None.
SiteContactPhoneNumber	string	None.
ExaminerInstructions	string	None.
CoachInstructions	string	None.
TeamLeadInstructions	string	None.
ReceptionistInstructions	string	None.
StatusList	Collection of EventStatus	None.
SessionList	Collection of EventSession	None.

Response Formats

application/json, text/json

Sample:

{
  "ID": 1,
  "Name": "sample string 2",
  "ProductName": "sample string 3",
  "PartnerName": "sample string 4",
  "ShipmentCount": 5,
  "PrimaryAddress": "sample string 6",
  "Latitude": 1.1,
  "Longitude": 1.1,
  "RepExtension": "sample string 7",
  "SiteContactPhoneNumber": "sample string 8",
  "ExaminerInstructions": "sample string 9",
  "CoachInstructions": "sample string 10",
  "TeamLeadInstructions": "sample string 11",
  "ReceptionistInstructions": "sample string 12",
  "StatusList": [
    {
      "Date": "sample string 1",
      "Notes": "sample string 2",
      "StatusType": "sample string 3",
      "SystemComment": "sample string 4"
    },
    {
      "Date": "sample string 1",
      "Notes": "sample string 2",
      "StatusType": "sample string 3",
      "SystemComment": "sample string 4"
    }
  ],
  "SessionList": [
    {
      "PK": "sample string 1",
      "Name": "sample string 2",
      "Description": "sample string 3",
      "Date": "sample string 4",
      "ArrivalTime": "sample string 5",
      "StartTime": "sample string 6",
      "EndTime": "sample string 7",
      "DepartureTime": "sample string 8",
      "ParticipantsEstimate": 9,
      "ParticipantsRegistered": 10,
      "ExaminerRoleCount": 11,
      "TeamLeadRoleCount": 12,
      "CoachRoleCount": 13,
      "ReceptionistRoleCount": 14,
      "Instructions": "sample string 15",
      "LoggedInUserIsAssigned": true,
      "IsNextNearestSession": true
    },
    {
      "PK": "sample string 1",
      "Name": "sample string 2",
      "Description": "sample string 3",
      "Date": "sample string 4",
      "ArrivalTime": "sample string 5",
      "StartTime": "sample string 6",
      "EndTime": "sample string 7",
      "DepartureTime": "sample string 8",
      "ParticipantsEstimate": 9,
      "ParticipantsRegistered": 10,
      "ExaminerRoleCount": 11,
      "TeamLeadRoleCount": 12,
      "CoachRoleCount": 13,
      "ReceptionistRoleCount": 14,
      "Instructions": "sample string 15",
      "LoggedInUserIsAssigned": true,
      "IsNextNearestSession": true
    }
  ]
}

application/xml, text/xml

Sample:

<Event xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <ID>1</ID>
  <Name>sample string 2</Name>
  <ProductName>sample string 3</ProductName>
  <PartnerName>sample string 4</PartnerName>
  <ShipmentCount>5</ShipmentCount>
  <PrimaryAddress>sample string 6</PrimaryAddress>
  <Latitude>1.1</Latitude>
  <Longitude>1.1</Longitude>
  <RepExtension>sample string 7</RepExtension>
  <SiteContactPhoneNumber>sample string 8</SiteContactPhoneNumber>
  <ExaminerInstructions>sample string 9</ExaminerInstructions>
  <CoachInstructions>sample string 10</CoachInstructions>
  <TeamLeadInstructions>sample string 11</TeamLeadInstructions>
  <ReceptionistInstructions>sample string 12</ReceptionistInstructions>
  <StatusList>
    <EventStatus>
      <Date>sample string 1</Date>
      <Notes>sample string 2</Notes>
      <StatusType>sample string 3</StatusType>
      <SystemComment>sample string 4</SystemComment>
    </EventStatus>
    <EventStatus>
      <Date>sample string 1</Date>
      <Notes>sample string 2</Notes>
      <StatusType>sample string 3</StatusType>
      <SystemComment>sample string 4</SystemComment>
    </EventStatus>
  </StatusList>
  <SessionList>
    <EventSession>
      <PK>sample string 1</PK>
      <Name>sample string 2</Name>
      <Description>sample string 3</Description>
      <Date>sample string 4</Date>
      <ArrivalTime>sample string 5</ArrivalTime>
      <StartTime>sample string 6</StartTime>
      <EndTime>sample string 7</EndTime>
      <DepartureTime>sample string 8</DepartureTime>
      <ParticipantsEstimate>9</ParticipantsEstimate>
      <ParticipantsRegistered>10</ParticipantsRegistered>
      <ExaminerRoleCount>11</ExaminerRoleCount>
      <TeamLeadRoleCount>12</TeamLeadRoleCount>
      <CoachRoleCount>13</CoachRoleCount>
      <ReceptionistRoleCount>14</ReceptionistRoleCount>
      <Instructions>sample string 15</Instructions>
      <LoggedInUserIsAssigned>true</LoggedInUserIsAssigned>
      <IsNextNearestSession>true</IsNextNearestSession>
    </EventSession>
    <EventSession>
      <PK>sample string 1</PK>
      <Name>sample string 2</Name>
      <Description>sample string 3</Description>
      <Date>sample string 4</Date>
      <ArrivalTime>sample string 5</ArrivalTime>
      <StartTime>sample string 6</StartTime>
      <EndTime>sample string 7</EndTime>
      <DepartureTime>sample string 8</DepartureTime>
      <ParticipantsEstimate>9</ParticipantsEstimate>
      <ParticipantsRegistered>10</ParticipantsRegistered>
      <ExaminerRoleCount>11</ExaminerRoleCount>
      <TeamLeadRoleCount>12</TeamLeadRoleCount>
      <CoachRoleCount>13</CoachRoleCount>
      <ReceptionistRoleCount>14</ReceptionistRoleCount>
      <Instructions>sample string 15</Instructions>
      <LoggedInUserIsAssigned>true</LoggedInUserIsAssigned>
      <IsNextNearestSession>true</IsNextNearestSession>
    </EventSession>
  </SessionList>
</Event>