Guides
  1. API Guide

Models Reference

Index of all request and response model types used across the Nomad Media API, organized by domain area.

Models Reference

Overview

This document provides a reference for the key request and response models used across the API. Models are organized by domain area.

📘

SDK-validated subset

For the exact shapes the SDKs return — verified against the live platform — see Return Shapes and the Schema Reference. This page is the broader API model index; those pages are the canonical source for the SDK surface.

Common Models

IdModel

Standard response containing a single identifier.

  • Id (Guid) — The unique identifier.

BatchResultModel

Result of a batch operation.

  • TotalCount (int) — Total items processed.
  • SuccessCount (int) — Items that succeeded.
  • ErrorCount (int) — Items that failed.
  • Errors (List) — Error details for failed items.

ListModel<T>

Generic wrapper for list-based requests.

  • Items (List<T>) — The list of items.

ListResultModel<T>

Paginated list result.

  • Items (List<T>) — The result items.
  • TotalCount (int) — Total available records.
  • HasItems (bool) — Whether the result contains items.
  • RelatedItems (List) — Optional related items.

LookupModel

Standard reference/lookup value.

  • Id (Guid) — The lookup identifier.
  • Description (string) — The display name.

SearchResultModel

Generic search result record.

  • Id (Guid) — The record identifier.
  • Title (string) — The display title.
  • Identifiers (Dictionary) — Dynamic key-value properties.

Asset Models

AssetModel

Complete asset representation.

  • Id (Guid) — Asset identifier.
  • Name (string) — Asset name.
  • AssetType (AssetTypes) — Type (Folder/File).
  • Status (AssetStatuses) — Processing status.
  • MediaType (string) — MIME type.
  • CreatedDate (DateTime) — Creation timestamp.
  • LastModifiedDate (DateTime) — Last modification timestamp.

Schedule Models

ScheduleModel

Complete schedule representation.

  • Id (Guid) — Schedule identifier.
  • Name (string) — Schedule name.
  • ScheduleStatus (ScheduleStatuses) — Current status.
  • ExpirationDate (DateTime?) — Optional expiration date.
  • StatusMessage (string) — Current status message.

ScheduleItemModel

Individual item within a schedule.

  • Id (Guid) — Item identifier.
  • ScheduleId (Guid) — Parent schedule ID.
  • Name (string) — Item name.
  • SortOrder (int) — Position in the schedule.

ScheduleItemChangeModel

Result of a schedule item modification including cascading changes.

AddScheduleModel

Request to create a new schedule.

  • Id (Guid?) — Optional pre-assigned ID.
  • Name (string) — Schedule name (required).

AddScheduleItemModel

Request to create or update a schedule item.

  • Id (Guid?) — Optional pre-assigned ID.
  • ScheduleId (Guid) — Parent schedule ID.

ScheduleItemMoveModel

Request to reposition a schedule item.

PublishScheduleRequestModel

Request to publish an intelligent schedule.

  • ScheduleId (Guid) — Schedule to publish.
  • NumberOfLockedDays (int) — Days to lock the schedule.

ImportScheduleItemModel

Request to bulk import schedule items.

ScheduleGuideModel

Preview representation of a schedule's playback guide.

Collection Models

CollectionModel

  • Id (Guid?) — Collection identifier.
  • Name (string) — Collection name.

CollectionContentModel

Associates content items with collections.

  • ContentId (Guid) — The content item.
  • CollectionId (Guid) — The collection.

Tag Models

TagModel

  • Id (Guid?) — Tag identifier.
  • Name (string) — Tag name.

TagContentModel

Associates content items with tags.

  • ContentId (Guid) — The content item.
  • TagId (Guid) — The tag.

Related Content Models

RelatedContentModel

Defines a relationship between content items.

  • ContentId (Guid) — The source content item.
  • RelatedContentId (Guid) — The related content item.

Media Models

MediaGroupModel

Group of media items for display.

  • Id (Guid) — Group identifier.
  • Title (string) — Display title.
  • Items (List) — Media items in the group.
  • Menu (List) — Navigation menu items.

MediaItemModel

Individual media item with full details.

  • Id (Guid) — Item identifier.
  • Title (string) — Display title.
  • Description (string) — Item description.
  • MediaType (string) — Content type.
  • StreamUrl (string) — Playback URL.

DynamicContentModel

Custom dynamic content record.

  • Id (Guid) — Content identifier.
  • Title (string) — Display title.
  • Fields (Dictionary) — Dynamic field values.

SiteConfigModel

Site-wide configuration settings.

MediaSearchModel

Search criteria for media queries.

  • Query (string) — Search text.
  • Filters (List) — Filter criteria.
  • PageSize (int) — Results per page.
  • PageOffset (int) — Page offset.

FeaturedItemModel

Featured/search result media item.

MyContentModel

User's personalized content lists (favorites, continue watching).

FormDataModel

Custom form submission data.

Media Builder Models

MediaBuilderModel

Complete media builder representation.

  • Id (Guid) — Builder identifier.
  • Name (string) — Builder name.
  • Status (string) — Current status.

MediaBuilderAddModel

Request to create a media builder.

MediaBuilderUpdateModel

Request to update a media builder.

MediaBuilderDuplicateModel

Request to duplicate a media builder.

MediaBuilderItemModel

Individual item in a media builder timeline.

  • Id (Guid) — Item identifier.
  • MediaBuilderId (Guid) — Parent builder ID.
  • SortOrder (int) — Position in timeline.

MediaBuilderItemAddModel

Request to create a media builder item.

MediaBuilderItemChangeModel

Result of a media builder item modification.

MediaBuilderItemMoveModel

Request to reposition a media builder item.

Payment Models

StartTransactionRequestModel

Request to initiate a payment.

StartTransactionResponseModel

Response containing payment processor details for the client.

Statistics Models

StatisticsListModel

Summary statistics record.

StatisticsConfigResultModel

Configuration for available statistics measurements.

StatisticsRequestModel

Request for aggregated statistics data.

  • Period (string) — Time period.
  • Measurements (List) — Requested measurement types.

StatisiticsDataGraph

Aggregated statistics data point for graphing.

Stage Models

StageLoginResponseModel

Response from a stage session authentication.

StagePingResponseModel

Response from a stage session heartbeat.

AuthTokenRequestModel

Request containing a token and identifier for session authentication.

Embedded Models

EmbeddedMediaModel

Media details for embedded player display.

ResponseHtmlWrapper

Wrapper for HTML content responses.

Feed Models

DirectPublisherFeedModel (Roku)

Roku Direct Publisher feed in the required JSON format.

MrssDirectPublisherFeedModel (MRSS)

MRSS feed in XML format for media syndication.

System Models

InvalidateDistributionModel

Request to invalidate CDN cache paths.

EmailDispatcherModel

Request to dispatch an email.

LicenseGrant

License information for the application.

AlignCatalogModel

Configuration for catalog alignment operations.

CoJudicial Models

StreamsModel

Available counties and live streams for the judicial streaming system.