GET api/WebProducts?eventWebProductId={eventWebProductId}&contactId={contactId}

Retrieves a paged set of active Web Products determined Portal ID and Web Category ID.
Possible Service Responses:
200/OK - match found and list of web product records are in the body of the response.
404/Web Products Not Found - no match found
500/Internal Server - unexpected server error, details in the body of the response.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
eventWebProductId

The web category related to the web products.

System.String

Required

contactId

The portal ID of the contact to authenticate against. Prevents unauthenticated users from seeing certain web products.

System.String

Required

Body Parameters

None.

Response Information

Resource Description

List of Web Products

Altai.Web.Services.Models.WebProduct
NameDescriptionTypeAdditional information
WebFormName

System.String

None.

Id

System.String

None.

Name

System.String

None.

ShortDescription

System.String

None.

LongDescription

System.String

None.

DisplayFrom

System.DateTime

None.

DisplayTo

System.DateTime

None.

DisplayInWebCategoryOnly

System.Boolean

None.

IncludeSpecialInstructions

System.Boolean

None.

SpecialInstructionsRequired

System.Boolean

None.

NextCategoryId

System.String

None.

PreReqSessionWebProductId

System.String

None.

SpecialInstructionsLabel

System.String

None.

SpecialInstructionsMaxLength

System.Int32

None.

BasicOptions

System.Collections.Generic.List`1[System.String]

None.

DisplayOrder

System.Decimal

None.

ImageUrl

System.String

None.

ThumbnailImageUrl

System.String

None.

WebFormId

System.String

None.

EnableRegisterOthers

System.Boolean

None.

AuthenticationRequired

System.Boolean

None.

SessionBlockCode

System.String

None.

ProgramId

System.String

None.

EventId

System.String

None.

SessionId

System.String

None.

DonationFundId

System.String

None.

ProductId

System.String

None.

Program

Altai.Web.Services.Models.Program

None.

Event

Altai.Web.Services.Models.Event

None.

Session

Altai.Web.Services.Models.Session

None.

SessionOptions

System.Collections.Generic.IEnumerable`1[Altai.Web.Services.Models.SessionOption]

None.

IsAvailable

System.Boolean

None.

QuantityOnHand

System.Decimal

None.

Price

System.Decimal

None.

Date

System.String

None.

Response Formats

application/json, text/json

Sample:
{
  "WebFormName": "sample string 1",
  "Id": "sample string 2",
  "Name": "sample string 3",
  "ShortDescription": "sample string 4",
  "LongDescription": "sample string 5",
  "DisplayFrom": "2018-08-22T01:01:19.0058179-04:00",
  "DisplayTo": "2018-08-22T01:01:19.0058179-04:00",
  "DisplayInWebCategoryOnly": true,
  "IncludeSpecialInstructions": true,
  "SpecialInstructionsRequired": true,
  "NextCategoryId": "sample string 11",
  "PreReqSessionWebProductId": "sample string 12",
  "SpecialInstructionsLabel": "sample string 13",
  "SpecialInstructionsMaxLength": 14,
  "BasicOptions": [
    "sample string 1",
    "sample string 2"
  ],
  "DisplayOrder": 15.0,
  "ImageUrl": "sample string 16",
  "ThumbnailImageUrl": "sample string 17",
  "WebFormId": "sample string 18",
  "EnableRegisterOthers": true,
  "AuthenticationRequired": true,
  "SessionBlockCode": "sample string 21",
  "ProgramId": "sample string 22",
  "EventId": "sample string 23",
  "SessionId": "sample string 24",
  "DonationFundId": "sample string 25",
  "ProductId": "sample string 26",
  "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
  },
  "Event": {
    "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": "1448e6d9-62ef-41b8-b87b-1cdacdf8b484",
          "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": "1448e6d9-62ef-41b8-b87b-1cdacdf8b484",
          "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": "521dc410-abfb-46cd-8aff-15182decd6ee",
        "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": "2018-08-22T01:01:19.0058179-04:00",
          "aPHRi": "2018-08-22T01:01:19.0058179-04:00",
          "GPHR": "2018-08-22T01:01:19.0058179-04:00",
          "PHR": "2018-08-22T01:01:19.0058179-04:00",
          "PHRca": "2018-08-22T01:01:19.0058179-04:00",
          "PHRi": "2018-08-22T01:01:19.0058179-04:00",
          "SPHR": "2018-08-22T01:01:19.0058179-04:00",
          "SPHRi": "2018-08-22T01:01:19.0058179-04:00"
        },
        "Embargo": true,
        "EmbargoOverride": true,
        "Preferences": {
          "Phone": true,
          "Mail": true,
          "MarketingEmails": true,
          "SmsMessaging": true,
          "HrciNews": true,
          "IndDirectoryOptIn": true,
          "HrciAlert": true
        }
      },
      "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
  },
  "Session": {
    "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
  },
  "SessionOptions": [
    {
      "Id": "sample string 1",
      "Name": "sample string 2",
      "SessionId": "sample string 3"
    },
    {
      "Id": "sample string 1",
      "Name": "sample string 2",
      "SessionId": "sample string 3"
    }
  ],
  "IsAvailable": true,
  "QuantityOnHand": 28.0,
  "Price": 29.0,
  "Date": "sample string 30"
}

application/xml

Sample:

Sample not available.

text/xml

Sample:

Sample not available.