TheYeshiva

Object

BaseUrl

string

DateCreated

string

Description

string

Summary of the item

IsCommentsDisabled

boolean

ItemTypeId

integer

1 = Video, 2 = Audio, 3 = Article, 7 = LandingPage, 8 = Group

LanguageId

integer

SponsorText

string

Dedication text

SubTitle

string

The secondary title

Subject

string

Title

string

The Main title

DateLastUpdated

string

DatePublished

string

IsActive

boolean

Do not display if this is false

PublishStatus

integer

0 = NotPublished, 193 = Published, 194 = Drafted

DateGoLive

string

Before this time, display coming soon countdown

HebDate

string

SEOUrl

string

Image

PurchaseInfo

CustomItemTypeFields

string

integer

Object

FileType

string

FileName

string

Original file url

Caption

string

If this field is not null, display the text beneath the image

CloudUrl_xxxxxx

string

The image saved at different sizes

Don’t worry about this, at the moment there are no items for sale on the app

Object

GroupId

string

UserAccessRightId

string

PurchaseDate

string

PurchaseType

string

PurchaseAmount

string

PurchaseId

string

Don’t worry about this - no items for sale on the app at this time

Object

DollarPrice

string

CreditPrice

string

IsSecureItem

string

IsPurchasedByUser

string

IsIndividualPurchasingDisabled

string

PurchaseReceiptInfo

This object will differ depending on the ItemTypeId field (If the item type is video, audio or article).

Object

FieldId

integer

ItemTypeId

integer

FieldName

string

FieldType

string

SortOrder

integer

FieldValueId

integer

ItemId

integer

FieldValue

string

Get Featured Items

GET /Home/GetGroups?s=app&v=5.5.0&GroupIds=2

Get Category Items

GET /Search/Browse?s=app&v=5.5.0

GET /Home/GetGroups?s=app&v=5.5.0&GroupIds=2

Request parameters

GroupCount

integer optional

How many featured items you wish to retrieve (Max 15)

Responses

200 OK

Body

Object

data

Array

Array of Item

message

string

status

integer

authenticated

boolean

error

string

GET /Search/Browse?s=app&v=5.5.0

Request parameters

categoryId

string optional

Id of the category you are fetching items from

ItemsPerPage

string optional

How many items you want to retrieve per page

page

string optional

Which page you want to retrieve