GET api/WebCategories?portalId={portalId}

Retrieves all active Web Categories determined by user authentication status
Possible Service Responses:
200/OK - match found and list of web category records are in the body of the response.
404/Web Categories Not Found - no match found
500/Internal Server - unexpected server error, details in the body of the response.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
portalId

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

System.String

Required

Body Parameters

None.

Response Information

Resource Description

List of Web Categories

System.Collections.Generic.IEnumerable`1[Altai.Web.Services.Models.WebCategory]
NameDescriptionTypeAdditional information
Id

System.String

None.

Name

System.String

None.

WebHeaderText

System.String

None.

ImageUrl

System.String

None.

IsRestricted

System.Boolean

None.

IsTopLevel

System.Boolean

None.

IsDefault

System.Boolean

None.

IsSelectionRequired

System.Boolean

None.

IsAuthenticationRequired

System.Boolean

None.

AllowMultipleSelections

System.Boolean

None.

DisplayOrder

System.Int32

None.

SubCategories

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

None.

Filter

System.String

None.

NextWebFormId

System.String

None.

NextWebFormName

System.String

None.

PreviousWebFormId

System.String

None.

PreviousWebFormName

System.String

None.

NextCategoryId

System.String

None.

PreviousCategoryId

System.String

None.

NextNavigation

System.Int32

None.

ItemTemplate

System.Int32

None.

StandAlone

System.Boolean

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "Id": "sample string 1",
    "Name": "sample string 2",
    "WebHeaderText": "sample string 3",
    "ImageUrl": "sample string 4",
    "IsRestricted": true,
    "IsTopLevel": true,
    "IsDefault": true,
    "IsSelectionRequired": true,
    "IsAuthenticationRequired": true,
    "AllowMultipleSelections": true,
    "DisplayOrder": 11,
    "SubCategories": [],
    "Filter": "sample string 12",
    "NextWebFormId": "sample string 13",
    "NextWebFormName": "sample string 14",
    "PreviousWebFormId": "sample string 15",
    "PreviousWebFormName": "sample string 16",
    "NextCategoryId": "sample string 17",
    "PreviousCategoryId": "sample string 18",
    "NextNavigation": 19,
    "ItemTemplate": 20,
    "StandAlone": true
  },
  {
    "Id": "sample string 1",
    "Name": "sample string 2",
    "WebHeaderText": "sample string 3",
    "ImageUrl": "sample string 4",
    "IsRestricted": true,
    "IsTopLevel": true,
    "IsDefault": true,
    "IsSelectionRequired": true,
    "IsAuthenticationRequired": true,
    "AllowMultipleSelections": true,
    "DisplayOrder": 11,
    "SubCategories": [],
    "Filter": "sample string 12",
    "NextWebFormId": "sample string 13",
    "NextWebFormName": "sample string 14",
    "PreviousWebFormId": "sample string 15",
    "PreviousWebFormName": "sample string 16",
    "NextCategoryId": "sample string 17",
    "PreviousCategoryId": "sample string 18",
    "NextNavigation": 19,
    "ItemTemplate": 20,
    "StandAlone": true
  }
]

application/xml

Sample:

Sample not available.

text/xml

Sample:

Sample not available.