GET api/Events/{id}

Retrieve Event Information By Event Id.
Possible Service Responses:
200/OK - a match found and the event is returned in the body of the response.
404/Event Not Found - no event found matching the specified id.
500/Internal Server - unexpected server error, details in the body of the response.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

Event Id

System.String

Required

Body Parameters

None.

Response Information

Resource Description

Event

Altai.Web.Services.Models.Event
NameDescriptionTypeAdditional information
Id

System.String

None.

Name

System.String

None.

Code

System.String

None.

BeginDate

System.String

None.

EndDate

System.String

None.

Description

System.String

None.

SessionRegistrationRequired

System.Boolean

None.

ShowOnCalendar

System.Boolean

None.

AllowGuests

System.Boolean

None.

MaxNumberOfGuest

System.Int32

None.

RateForGuest

System.Decimal

None.

Sessions

System.Collections.Generic.List`1[Altai.Web.Services.Models.Session]

None.

Type

System.String

None.

EarlyRegistrationDate

System.String

None.

RegistrationEndDate

System.String

None.

Status

System.String

None.

Venue

Altai.Web.Services.Models.Account

None.

TwoOption1

System.Boolean

None.

Response Formats

application/json, text/json

Sample:
{
  "Id": "sample string 1",
  "Name": "sample string 2",
  "Code": "sample string 3",
  "BeginDate": "sample string 4",
  "EndDate": "sample string 5",
  "Description": "sample string 6",
  "SessionRegistrationRequired": true,
  "ShowOnCalendar": true,
  "AllowGuests": true,
  "MaxNumberOfGuest": 10,
  "RateForGuest": 11.0,
  "Sessions": [
    {
      "Id": "sample string 1",
      "Name": "sample string 2",
      "SessionGroup": {
        "Id": "sample string 1",
        "Name": "sample string 2",
        "DisplayOrder": 3.0
      },
      "PreRequisiteSessions": [],
      "TwoOption1": true,
      "IsGuestSession": true
    },
    {
      "Id": "sample string 1",
      "Name": "sample string 2",
      "SessionGroup": {
        "Id": "sample string 1",
        "Name": "sample string 2",
        "DisplayOrder": 3.0
      },
      "PreRequisiteSessions": [],
      "TwoOption1": true,
      "IsGuestSession": true
    }
  ],
  "Type": "sample string 12",
  "EarlyRegistrationDate": "sample string 13",
  "RegistrationEndDate": "sample string 14",
  "Status": "sample string 15",
  "Venue": {
    "MemberId": "sample string 1",
    "Id": "sample string 2",
    "NumberOfEmployees": 3,
    "Name": "sample string 4",
    "PrimaryContact": {
      "WebCompanyName": "sample string 1",
      "AddressLine2": "sample string 2",
      "AddressLine1": "sample string 3",
      "City": "sample string 4",
      "Country": "sample string 5",
      "CountryInfo": {
        "Id": "sample string 1",
        "Code": "sample string 2",
        "Name": "sample string 3"
      },
      "DietaryRestriction": "sample string 6",
      "Email": "sample string 7",
      "EmergencyContactName": "sample string 8",
      "EmergencyContactPhone": "sample string 9",
      "EmploymentStatus": "sample string 10",
      "District": {
        "Id": "07411545-117c-4724-9ae8-4730e89988be",
        "LogicalName": "sample string 2",
        "Name": "sample string 3",
        "KeyAttributes": [],
        "RowVersion": "sample string 4"
      },
      "FirstName": "sample string 11",
      "FullName": "sample string 12",
      "Gender": "sample string 13",
      "GraduateSchool": "sample string 14",
      "GraduationYear": "sample string 15",
      "Industry": "sample string 16",
      "Id": "sample string 17",
      "JobTitle": "sample string 18",
      "Telephone1": "sample string 19",
      "LastName": "sample string 20",
      "MemberId": "sample string 21",
      "OwnerAssociate": "sample string 22",
      "Password": "sample string 23",
      "PortalId": "sample string 24",
      "CanRegisterOthers": true,
      "ExcludeFromHL": true,
      "ExcludeFromHLDirectory": true,
      "PracticeType1": "sample string 28",
      "School": "sample string 29",
      "SpecialtyBoardsDiplomatsText": "sample string 30",
      "State": "sample string 31",
      "PostalCode": "sample string 32",
      "UniversityAlumni": "sample string 33",
      "LicenseNumber": "sample string 34",
      "Username": "sample string 35",
      "Base64Image": "sample string 36",
      "SelectedPosition": {
        "Id": "07411545-117c-4724-9ae8-4730e89988be",
        "LogicalName": "sample string 2",
        "Name": "sample string 3",
        "KeyAttributes": [],
        "RowVersion": "sample string 4"
      },
      "Participations": [
        {
          "Id": "sample string 1",
          "CycleStartDate": "sample string 2",
          "CycleEndDate": "sample string 3",
          "StartDate": "sample string 4",
          "EndDate": "sample string 5",
          "PaidThruDate": "sample string 6",
          "BillThruDate": "sample string 7",
          "Status": "sample string 8",
          "Program": {
            "Id": "sample string 1",
            "Name": "sample string 2",
            "ShortName": "sample string 3",
            "Type": "sample string 4",
            "ProgramGroup": "sample string 5",
            "BillingTermLength": 6,
            "ActivePriceListId": "sample string 7",
            "BachelorsDegreeMonthsRequired": 8,
            "DoctorateDegreeMonthsRequired": 9,
            "HighSchoolMonthsRequired": 10,
            "MastersDegreeMonthsRequired": 11
          },
          "CurrentInvoice": {
            "ShoppingCartId": "sample string 1",
            "BalanceDue": 2.0,
            "TotalAmount": 3.0,
            "Number": "sample string 4",
            "Id": "sample string 5",
            "Date": "sample string 6",
            "StatusReason": 7,
            "BillToAddress": {
              "Name": "sample string 1",
              "FirstName": "sample string 2",
              "LastName": "sample string 3",
              "EmailAddress": "sample string 4",
              "Telephone": "sample string 5",
              "Address": {
                "Id": "sample string 1",
                "Street1": "sample string 2",
                "Street2": "sample string 3",
                "City": "sample string 4",
                "StateOrProvince": "sample string 5",
                "PostalCode": "sample string 6",
                "Country": "sample string 7",
                "AddressType": "sample string 8"
              }
            },
            "ShipToAddress": {
              "Name": "sample string 1",
              "FirstName": "sample string 2",
              "LastName": "sample string 3",
              "EmailAddress": "sample string 4",
              "Telephone": "sample string 5",
              "Address": {
                "Id": "sample string 1",
                "Street1": "sample string 2",
                "Street2": "sample string 3",
                "City": "sample string 4",
                "StateOrProvince": "sample string 5",
                "PostalCode": "sample string 6",
                "Country": "sample string 7",
                "AddressType": "sample string 8"
              }
            }
          },
          "ParticipationType": "sample string 9",
          "WebProductNextCategoryId": "sample string 10",
          "WebCategoryFilterId": "sample string 11",
          "AvailableForRenewal": true,
          "International": true
        },
        {
          "Id": "sample string 1",
          "CycleStartDate": "sample string 2",
          "CycleEndDate": "sample string 3",
          "StartDate": "sample string 4",
          "EndDate": "sample string 5",
          "PaidThruDate": "sample string 6",
          "BillThruDate": "sample string 7",
          "Status": "sample string 8",
          "Program": {
            "Id": "sample string 1",
            "Name": "sample string 2",
            "ShortName": "sample string 3",
            "Type": "sample string 4",
            "ProgramGroup": "sample string 5",
            "BillingTermLength": 6,
            "ActivePriceListId": "sample string 7",
            "BachelorsDegreeMonthsRequired": 8,
            "DoctorateDegreeMonthsRequired": 9,
            "HighSchoolMonthsRequired": 10,
            "MastersDegreeMonthsRequired": 11
          },
          "CurrentInvoice": {
            "ShoppingCartId": "sample string 1",
            "BalanceDue": 2.0,
            "TotalAmount": 3.0,
            "Number": "sample string 4",
            "Id": "sample string 5",
            "Date": "sample string 6",
            "StatusReason": 7,
            "BillToAddress": {
              "Name": "sample string 1",
              "FirstName": "sample string 2",
              "LastName": "sample string 3",
              "EmailAddress": "sample string 4",
              "Telephone": "sample string 5",
              "Address": {
                "Id": "sample string 1",
                "Street1": "sample string 2",
                "Street2": "sample string 3",
                "City": "sample string 4",
                "StateOrProvince": "sample string 5",
                "PostalCode": "sample string 6",
                "Country": "sample string 7",
                "AddressType": "sample string 8"
              }
            },
            "ShipToAddress": {
              "Name": "sample string 1",
              "FirstName": "sample string 2",
              "LastName": "sample string 3",
              "EmailAddress": "sample string 4",
              "Telephone": "sample string 5",
              "Address": {
                "Id": "sample string 1",
                "Street1": "sample string 2",
                "Street2": "sample string 3",
                "City": "sample string 4",
                "StateOrProvince": "sample string 5",
                "PostalCode": "sample string 6",
                "Country": "sample string 7",
                "AddressType": "sample string 8"
              }
            }
          },
          "ParticipationType": "sample string 9",
          "WebProductNextCategoryId": "sample string 10",
          "WebCategoryFilterId": "sample string 11",
          "AvailableForRenewal": true,
          "International": true
        }
      ],
      "ContactRoles": [
        {
          "IsWebAdmin": true,
          "CanRegisterOthers": true,
          "AdHocRoleName": "sample string 3"
        },
        {
          "IsWebAdmin": true,
          "CanRegisterOthers": true,
          "AdHocRoleName": "sample string 3"
        }
      ],
      "Positions": [
        {
          "Name": "sample string 1",
          "Id": "sample string 2",
          "ContactId": "sample string 3",
          "AccountId": "sample string 4",
          "PositionTitleId": "sample string 5",
          "PositionTitle": "sample string 6",
          "Program": {
            "Id": "sample string 1",
            "Name": "sample string 2",
            "ShortName": "sample string 3",
            "Type": "sample string 4",
            "ProgramGroup": "sample string 5",
            "BillingTermLength": 6,
            "ActivePriceListId": "sample string 7",
            "BachelorsDegreeMonthsRequired": 8,
            "DoctorateDegreeMonthsRequired": 9,
            "HighSchoolMonthsRequired": 10,
            "MastersDegreeMonthsRequired": 11
          },
          "PortalAdminType": "sample string 7",
          "StartDate": "sample string 8",
          "EndDate": "sample string 9"
        },
        {
          "Name": "sample string 1",
          "Id": "sample string 2",
          "ContactId": "sample string 3",
          "AccountId": "sample string 4",
          "PositionTitleId": "sample string 5",
          "PositionTitle": "sample string 6",
          "Program": {
            "Id": "sample string 1",
            "Name": "sample string 2",
            "ShortName": "sample string 3",
            "Type": "sample string 4",
            "ProgramGroup": "sample string 5",
            "BillingTermLength": 6,
            "ActivePriceListId": "sample string 7",
            "BachelorsDegreeMonthsRequired": 8,
            "DoctorateDegreeMonthsRequired": 9,
            "HighSchoolMonthsRequired": 10,
            "MastersDegreeMonthsRequired": 11
          },
          "PortalAdminType": "sample string 7",
          "StartDate": "sample string 8",
          "EndDate": "sample string 9"
        }
      ],
      "PriceLevelId": "3b20cddb-fe43-4581-8ee2-494ee26365f6",
      "PriceListName": "sample string 37",
      "IsSiteAdmin": true,
      "ShipToAddressLine2": "sample string 39",
      "ShipToEmail": "sample string 40",
      "ShipToTelephone1": "sample string 41",
      "ShipToState": "sample string 42",
      "ShipToCity": "sample string 43",
      "ShipToAddressLine1": "sample string 44",
      "ShipToPostalCode": "sample string 45",
      "ShipToLastName": "sample string 46",
      "ShipToCountry": "sample string 47",
      "ShipToFirstName": "sample string 48",
      "EligibleToApply": {
        "aPHR": "2024-03-24T16:52:30.2742084+00:00",
        "aPHRi": "2024-03-24T16:52:30.2742084+00:00",
        "GPHR": "2024-03-24T16:52:30.2742084+00:00",
        "PHR": "2024-03-24T16:52:30.2742084+00:00",
        "PHRca": "2024-03-24T16:52:30.2742084+00:00",
        "PHRi": "2024-03-24T16:52:30.2742084+00:00",
        "SPHR": "2024-03-24T16:52:30.2742084+00:00",
        "SPHRi": "2024-03-24T16:52:30.2742084+00:00"
      },
      "Embargo": true,
      "EmbargoOverride": true,
      "Preferences": {
        "Phone": true,
        "Mail": true,
        "MarketingEmails": true,
        "SmsMessaging": true,
        "HrciNews": true,
        "HrciAlert": true
      },
      "IndDesignation": "sample string 51",
      "HLcustomText01": "sample string 52"
    },
    "Participations": [
      {
        "Id": "sample string 1",
        "CycleStartDate": "sample string 2",
        "CycleEndDate": "sample string 3",
        "StartDate": "sample string 4",
        "EndDate": "sample string 5",
        "PaidThruDate": "sample string 6",
        "BillThruDate": "sample string 7",
        "Status": "sample string 8",
        "Program": {
          "Id": "sample string 1",
          "Name": "sample string 2",
          "ShortName": "sample string 3",
          "Type": "sample string 4",
          "ProgramGroup": "sample string 5",
          "BillingTermLength": 6,
          "ActivePriceListId": "sample string 7",
          "BachelorsDegreeMonthsRequired": 8,
          "DoctorateDegreeMonthsRequired": 9,
          "HighSchoolMonthsRequired": 10,
          "MastersDegreeMonthsRequired": 11
        },
        "CurrentInvoice": {
          "ShoppingCartId": "sample string 1",
          "BalanceDue": 2.0,
          "TotalAmount": 3.0,
          "Number": "sample string 4",
          "Id": "sample string 5",
          "Date": "sample string 6",
          "StatusReason": 7,
          "BillToAddress": {
            "Name": "sample string 1",
            "FirstName": "sample string 2",
            "LastName": "sample string 3",
            "EmailAddress": "sample string 4",
            "Telephone": "sample string 5",
            "Address": {
              "Id": "sample string 1",
              "Street1": "sample string 2",
              "Street2": "sample string 3",
              "City": "sample string 4",
              "StateOrProvince": "sample string 5",
              "PostalCode": "sample string 6",
              "Country": "sample string 7",
              "AddressType": "sample string 8"
            }
          },
          "ShipToAddress": {
            "Name": "sample string 1",
            "FirstName": "sample string 2",
            "LastName": "sample string 3",
            "EmailAddress": "sample string 4",
            "Telephone": "sample string 5",
            "Address": {
              "Id": "sample string 1",
              "Street1": "sample string 2",
              "Street2": "sample string 3",
              "City": "sample string 4",
              "StateOrProvince": "sample string 5",
              "PostalCode": "sample string 6",
              "Country": "sample string 7",
              "AddressType": "sample string 8"
            }
          }
        },
        "ParticipationType": "sample string 9",
        "WebProductNextCategoryId": "sample string 10",
        "WebCategoryFilterId": "sample string 11",
        "AvailableForRenewal": true,
        "International": true
      },
      {
        "Id": "sample string 1",
        "CycleStartDate": "sample string 2",
        "CycleEndDate": "sample string 3",
        "StartDate": "sample string 4",
        "EndDate": "sample string 5",
        "PaidThruDate": "sample string 6",
        "BillThruDate": "sample string 7",
        "Status": "sample string 8",
        "Program": {
          "Id": "sample string 1",
          "Name": "sample string 2",
          "ShortName": "sample string 3",
          "Type": "sample string 4",
          "ProgramGroup": "sample string 5",
          "BillingTermLength": 6,
          "ActivePriceListId": "sample string 7",
          "BachelorsDegreeMonthsRequired": 8,
          "DoctorateDegreeMonthsRequired": 9,
          "HighSchoolMonthsRequired": 10,
          "MastersDegreeMonthsRequired": 11
        },
        "CurrentInvoice": {
          "ShoppingCartId": "sample string 1",
          "BalanceDue": 2.0,
          "TotalAmount": 3.0,
          "Number": "sample string 4",
          "Id": "sample string 5",
          "Date": "sample string 6",
          "StatusReason": 7,
          "BillToAddress": {
            "Name": "sample string 1",
            "FirstName": "sample string 2",
            "LastName": "sample string 3",
            "EmailAddress": "sample string 4",
            "Telephone": "sample string 5",
            "Address": {
              "Id": "sample string 1",
              "Street1": "sample string 2",
              "Street2": "sample string 3",
              "City": "sample string 4",
              "StateOrProvince": "sample string 5",
              "PostalCode": "sample string 6",
              "Country": "sample string 7",
              "AddressType": "sample string 8"
            }
          },
          "ShipToAddress": {
            "Name": "sample string 1",
            "FirstName": "sample string 2",
            "LastName": "sample string 3",
            "EmailAddress": "sample string 4",
            "Telephone": "sample string 5",
            "Address": {
              "Id": "sample string 1",
              "Street1": "sample string 2",
              "Street2": "sample string 3",
              "City": "sample string 4",
              "StateOrProvince": "sample string 5",
              "PostalCode": "sample string 6",
              "Country": "sample string 7",
              "AddressType": "sample string 8"
            }
          }
        },
        "ParticipationType": "sample string 9",
        "WebProductNextCategoryId": "sample string 10",
        "WebCategoryFilterId": "sample string 11",
        "AvailableForRenewal": true,
        "International": true
      }
    ],
    "MembershipEndDate": "sample string 5",
    "AddressLine1": "sample string 6",
    "AddressLine2": "sample string 7",
    "BusinessCounty": "sample string 8",
    "Municipality": "sample string 9",
    "City": "sample string 10",
    "CityLookup": {
      "Id": "sample string 1",
      "Name": "sample string 2"
    },
    "State": "sample string 11",
    "Zip": "sample string 12",
    "Telephone1": "sample string 13",
    "StatusCode": "sample string 14",
    "QAProgramNumber": "sample string 15",
    "ExcludeFromHL": true,
    "ExcludeFromHLDirectory": true,
    "Base64Image": "sample string 18"
  },
  "TwoOption1": true
}

application/xml

Sample:

Sample not available.

text/xml

Sample:

Sample not available.