ASP.NET Web API Help Page

Introduction

Provide a general description of your APIs here.

CatalogImages

API	Description
GET api/catalog/catalogs/{catalogId}/images?Status={Status}&IncludeDeleted={IncludeDeleted}&CatalogPath={CatalogPath}&Page={Page}&PageSize={PageSize}&CoverOnly={CoverOnly}	No documentation available.
GET api/catalog/catalogs/{catalogId}/images/{imageId}	No documentation available.
POST api/catalog/catalogs/{catalogId}/images	No documentation available.
POST api/catalog/catalogs/{catalogId}/images/batch	No documentation available.
PUT api/catalog/catalogs/{catalogId}/images/{imageId}	No documentation available.
DELETE api/catalog/catalogs/{catalogId}/images/{imageId}	No documentation available.
POST api/catalog/catalogs/{catalogId}/images/{imageId}/restore	No documentation available.
PATCH api/catalog/catalogs/{catalogId}/images/{imageId}/rename	No documentation available.
PATCH api/catalog/catalogs/{catalogId}/images/{imageId}/notes	No documentation available.
POST api/catalog/catalogs/{catalogId}/images/{imageId}/undo	No documentation available.
POST api/catalog/catalogs/{catalogId}/images/batch-delete	No documentation available.
POST api/catalog/catalogs/{catalogId}/images/upload	No documentation available.
PATCH api/catalog/catalogs/{catalogId}/images/{imageId}/reorder	No documentation available.

Images

API	Description
GET api/catalog/images?Hash={Hash}&Path={Path}&IncludeDeleted={IncludeDeleted}&Page={Page}&PageSize={PageSize}	No documentation available.
GET api/catalog/images/{id}	No documentation available.
GET api/catalog/images/by-hash/{hash}	No documentation available.
POST api/catalog/images	No documentation available.
PUT api/catalog/images/{id}	No documentation available.
DELETE api/catalog/images/{id}	No documentation available.
POST api/catalog/images/cleanup	No documentation available.
GET api/catalog/images/zone/{zone}	No documentation available.
PUT api/catalog/images/bulk-update-dates	No documentation available.
GET api/catalog/images/verification-stats	No documentation available.

Devices

API	Description
POST api/messaging/devices/register	No documentation available.
PUT api/messaging/devices/preferences	No documentation available.
GET api/messaging/devices/preferences/{token}?appName={appName}	No documentation available.
GET api/messaging/devices/stats/{token}?appName={appName}	No documentation available.
GET api/messaging/devices/status/{token}?appName={appName}	No documentation available.
DELETE api/messaging/devices/sns-endpoint/{token}?appName={appName}	No documentation available.
POST api/messaging/devices/cleanup-invalid?appName={appName}	No documentation available.
POST api/messaging/devices/cleanup-obsolete?appName={appName}&specificUser={specificUser}&dryRun={dryRun}	No documentation available.
GET api/messaging/devices/app-users?appName={appName}	No documentation available.
GET api/messaging/devices/users-devices?appName={appName}	No documentation available.

Categories

API	Description
GET api/catalog/categories	No documentation available.
GET api/catalog/catalogs/{catalogId}/categories	No documentation available.
POST api/catalog/categories	No documentation available.
PUT api/catalog/categories/{id}	No documentation available.
DELETE api/catalog/categories/{id}	No documentation available.
POST api/catalog/catalogs/{catalogId}/categories	No documentation available.
DELETE api/catalog/catalogs/{catalogId}/categories/{categoryId}	No documentation available.

Thumbnails

API	Description
POST api/catalog/thumbnails/generate	No documentation available.
POST api/catalog/thumbnails/catalogs/{catalogId}	No documentation available.
POST api/catalog/thumbnails/cleanup	No documentation available.
GET api/catalog/thumbnails/errors	No documentation available.
PUT api/catalog/thumbnails/{hash}	No documentation available.
PATCH api/catalog/thumbnails/{hash}/size	No documentation available.

Audit

API	Description
GET api/appversion/audit-log?appId={appId}&platform={platform}&action={action}&dateFrom={dateFrom}&dateTo={dateTo}&pageSize={pageSize}&pageNumber={pageNumber}	No documentation available.
GET api/appversion/audit-log/{auditId}	No documentation available.
GET api/appversion/audit-log/ping	No documentation available.
POST api/appversion/audit-log/test-insert	No documentation available.

Auth

API	Description
POST api/auth/authtoken	No documentation available.
POST api/auth/refresh	No documentation available.
GET api/auth/modules/{username}	No documentation available.
GET api/auth/status/{userId}	No documentation available.

VssInventory

API	Description
GET api/vss/inventory/ping	No documentation available.
GET api/vss/inventory/search?searchTerms={searchTerms}&xfrloc={xfrloc}	No documentation available.
GET api/vss/inventory/custom-clothing/{sku}?xfrloc={xfrloc}	No documentation available.
GET api/vss/inventory/custom-shirts/{sku}?xfrloc={xfrloc}	No documentation available.
GET api/vss/inventory/ready-made/{skurmd}	No documentation available.
GET api/vss/inventory/pricing/{sku}?xfrloc={xfrloc}	No documentation available.

ActivityLog

API	Description
GET api/catalog/activity-log?ActionType={ActionType}&TargetType={TargetType}&UserId={UserId}&StartDate={StartDate}&EndDate={EndDate}&Page={Page}&PageSize={PageSize}	No documentation available.
GET api/catalog/activity-log/catalogs/{catalogId}?ActionType={ActionType}&TargetType={TargetType}&UserId={UserId}&StartDate={StartDate}&EndDate={EndDate}&Page={Page}&PageSize={PageSize}	No documentation available.
GET api/catalog/activity-log/summary?startDate={startDate}&endDate={endDate}	No documentation available.

Maintenance

API	Description
POST api/catalog/maintenance/purge	No documentation available.
GET api/catalog/maintenance/purge/counts?retentionDays={retentionDays}	No documentation available.
GET api/catalog/maintenance/status	No documentation available.

FavoriteCatalog

API	Description
POST api/vss/favorites/add	No documentation available.
POST api/vss/favorites/remove	No documentation available.
GET api/vss/favorites/list?pumusr={pumusr}&devapp={devapp}	No documentation available.
GET api/vss/favorites/details?pumusr={pumusr}&devapp={devapp}&region={region}&catalogId={catalogId}	No documentation available.
GET api/vss/favorites/statistics?devapp={devapp}	No documentation available.
GET api/vss/favorites/ping	No documentation available.

Videos

API	Description
GET api/catalog/videos/tutorials	No documentation available.
GET api/catalog/videos/tutorials/{id}	No documentation available.

AppVersion

API	Description
GET api/appversion/versions?status={status}&platform={platform}	No documentation available.
GET api/appversion/versions/{appId}/{platform}	No documentation available.
POST api/appversion/versions	No documentation available.
PUT api/appversion/versions/{appId}/{platform}	No documentation available.
POST api/appversion/versions/{appId}/{platform}/promote	No documentation available.
DELETE api/appversion/versions/{appId}/{platform}	No documentation available.
POST api/appversion/check-compatibility	No documentation available.
GET api/appversion/minimum-version/{appId}/{platform}	No documentation available.
POST api/appversion/batch-check	No documentation available.
GET api/appversion/history/{appId}/{platform}?limit={limit}	No documentation available.
GET api/appversion/ping	No documentation available.

NonInventariablePages

API	Description
POST api/vss/inventory-settings/mark-non-inventariable	No documentation available.
DELETE api/vss/inventory-settings/mark-inventariable/{catalogId}/{pageNum}	No documentation available.
GET api/vss/inventory-settings/non-inventariable-pages/{catalogId}	No documentation available.
GET api/vss/inventory-settings/non-inventariable-pages	No documentation available.
GET api/vss/inventory-settings/check-page/{catalogId}/{pageNum}	No documentation available.
GET api/vss/inventory-settings/ping	No documentation available.

SyncAlerts

API	Description
POST api/vss/system/sync-alerts?alertThreshold={alertThreshold}&dryRun={dryRun}	No documentation available.
GET api/vss/system/sync-alerts/preview?alertThreshold={alertThreshold}	No documentation available.
GET api/vss/system/sync-alerts/statistics	No documentation available.
POST api/vss/system/sync-alerts/reset-flags	No documentation available.
GET api/vss/system/sync-alerts/health	No documentation available.

ReleaseFiles

API	Description
POST api/appversion/releases/upload	No documentation available.
GET api/appversion/releases/{appId}/{platform}/{version}/download	No documentation available.
GET api/appversion/releases/{appId}/{platform}/{version}/checksums	No documentation available.
POST api/appversion/releases/{appId}/{platform}/{version}/verify	No documentation available.
GET api/appversion/releases?appId={appId}&platform={platform}&status={status}	No documentation available.
GET api/appversion/releases/{appId}/{platform}/{version}	No documentation available.
GET api/appversion/releases/production?appId={appId}&platform={platform}	No documentation available.
DELETE api/appversion/releases/{appId}/{platform}/{version}	No documentation available.
GET api/appversion/releases/ping	No documentation available.

Catalogs

API	Description
GET api/catalog/catalogs?Name={Name}&Status={Status}&ParentCatalogId={ParentCatalogId}&IncludeDeleted={IncludeDeleted}&Page={Page}&PageSize={PageSize}	No documentation available.
GET api/catalog/catalogs/tree	No documentation available.
GET api/catalog/catalogs/{id}	No documentation available.
GET api/catalog/catalogs/by-name?name={name}	No documentation available.
POST api/catalog/catalogs	No documentation available.
PUT api/catalog/catalogs/{id}	No documentation available.
PATCH api/catalog/catalogs/{id}/rename	No documentation available.
DELETE api/catalog/catalogs/{id}	No documentation available.
POST api/catalog/catalogs/{id}/restore	No documentation available.
POST api/catalog/catalogs/batch-delete	No documentation available.
GET api/catalog/catalogs/covers?ids={ids}	No documentation available.
POST api/catalog/catalogs/images/batch	No documentation available.
GET api/catalog/catalogs/{id}/statistics	No documentation available.

Rollback

API	Description
GET api/appversion/rollback/{appId}/{platform}/candidates	No documentation available.
POST api/appversion/rollback/{appId}/{platform}/execute	No documentation available.
GET api/appversion/rollback/ping	No documentation available.

System

API	Description
GET api/messaging/system/ping	No documentation available.
GET api/messaging/system/status	No documentation available.
GET api/messaging/system/info	No documentation available.
GET api/messaging/system/host	No documentation available.
POST api/messaging/system/validate-notification	No documentation available.

Notifications

API	Description
POST api/messaging/notifications/send-to-device	No documentation available.
POST api/messaging/notifications/send-to-user	No documentation available.
GET api/messaging/notifications/enabled-users?appName={appName}	No documentation available.

Catalog

API	Description
GET api/vss/catalog-categories	No documentation available.
GET api/vss/catalog-categories/{vssfld}	No documentation available.
POST api/vss/catalog-categories	No documentation available.
PUT api/vss/catalog-categories/{vssfld}	No documentation available.
DELETE api/vss/catalog-categories/{vssfld}	No documentation available.

Storage

API	Description
GET api/catalog/storage/status	No documentation available.
GET api/catalog/storage/test	No documentation available.

Publish

API	Description
POST api/catalog/publish/catalogs	No documentation available.
POST api/catalog/publish/thumbnails	No documentation available.
GET api/catalog/publish/pending	No documentation available.
GET api/catalog/publish/status/{jobId}	No documentation available.
GET api/catalog/publish/history?environment={environment}&page={page}&pageSize={pageSize}	No documentation available.

ModulePermissions

API	Description
GET api/permissions/user/{username}	No documentation available.
GET api/permissions/modules	No documentation available.
GET api/permissions/module/{moduleCode}/users	No documentation available.
POST api/permissions/grant	No documentation available.
POST api/permissions/revoke	No documentation available.

Messages

API	Description
POST api/messaging/messages/queue	No documentation available.
GET api/messaging/messages/user/{pumusr}?limit={limit}&appName={appName}&includeErrored={includeErrored}	No documentation available.
PUT api/messaging/messages/{dtaid}/read?appName={appName}	No documentation available.
POST api/messaging/messages/mark-read-batch	No documentation available.
GET api/messaging/messages/user/{pumusr}/unread-count?appName={appName}	No documentation available.
POST api/messaging/messages/test-emoji-processing	No documentation available.
POST api/messaging/messages/process-queue	No documentation available.
POST api/messaging/messages/debug-process-queue	No documentation available.

UserSync

API	Description
PUT api/vss/users/{pumusr}/sync-status	No documentation available.
GET api/vss/users/{pumusr}/sync-status?includeAnalytics={includeAnalytics}	No documentation available.
GET api/vss/users/needing-attention?alertThreshold={alertThreshold}	No documentation available.
POST api/vss/users/{pumusr}/mark-notification-sent	No documentation available.
POST api/vss/users/reset-notification-flags	No documentation available.
GET api/vss/users/sync-statistics	No documentation available.
GET api/vss/users/sync-health	No documentation available.

CatalogImagesSync

API	Description
POST api/catalog/catalog-images/sync-deletions	No documentation available.

VssSystem

API	Description
GET api/vss/system/ping	No documentation available.
GET api/vss/system/config-status	No documentation available.
GET api/vss/system/stats/summary	No documentation available.
GET api/vss/system/users/notifications-enabled	No documentation available.
POST api/vss/system/devices/cleanup	No documentation available.