GrowthZone REST API API Reference

undefined

API Endpoint
https://app.memberzone.org
Request Content-Types: application/json
Response Content-Types: application/json
Schemes: https
Version: v1.0

Paths

DELETE /api/content/{contentitemid}/preimage/{imageid}

contentitemid: integer
in path

(no description)

imageid: integer
in path

(no description)

200 OK

OK

POST /api/content/{contentitemid}/preimage/{imageid}/{fileid}

contentitemid: integer
in path

(no description)

imageid: integer
in path

(no description)

fileid: integer
in path

(no description)

Request Example
{
  "ImageId": "integer",
  "FileId": "integer",
  "Url": "string",
  "Title": "string",
  "Caption": "string",
  "CropX": "integer",
  "CropY": "integer",
  "CropHeight": "integer",
  "CropWidth": "integer",
  "ShortDescription": "string"
}

OK

Response Example (200 OK)
{
  "ImageId": "integer",
  "Url": "string",
  "Title": "string",
  "Caption": "string",
  "ShortDescription": "string"
}

POST /api/content/{contentitemid}/preimage/order

Int32
contentitemid: integer
in path

(no description)

Request Example
[
  "object"
]
200 OK

OK

GET /api/content/{contentlistid}/info

contentlistid: integer
in path

(no description)

Response Example (200 OK)
{
  "ContentListId": "integer",
  "ContentListPluralName": "string",
  "ListViewItems": "string"
}

POST /api/content/{contentlistid}/items

contentlistid: integer
in path

(no description)

Request Example
{
  "Top": "string",
  "Take": "string",
  "Skip": "string",
  "Filter": "string",
  "OrderBy": "string",
  "CalendarStartDate": "string",
  "CalendarEndDate": "string",
  "TenantId": "integer",
  "ContentListId": "integer",
  "Contact": "string",
  "Title": "string",
  "Tags": "string",
  "Statuses": "string",
  "Categories": "string",
  "ActiveDateBetween": "string",
  "IncludeExpiredItems": "boolean",
  "ContactId": "string",
  "Criteria": "string"
}
Response Example (200 OK)
{
  "Criteria": "string",
  "CriteriaItems": "string",
  "TotalRecordAvailable": "string",
  "ModelItems": "string",
  "Results": "string"
}

GET /api/content/{contentlistid}/items/{contentitemid}

contentlistid: integer
in path

(no description)

contentitemid: integer
in path

(no description)

Response Example (200 OK)
{
  "ContentItemId": "integer",
  "AuditId": "integer",
  "ContentListId": "integer",
  "ContactId": "integer",
  "Contact": "string",
  "PublishedByContactId": "string",
  "PublishedByContact": "string",
  "ContentStatusId": "string",
  "Title": "string",
  "Subtitle": "string",
  "ShortDescription": "string",
  "Tags": "string",
  "Description": "string",
  "ItemDate": "string",
  "PublishStart": "string",
  "PublishEnd": "string",
  "EditKey": "string",
  "RequireApprovalAfterEdit": "boolean",
  "CategoryItems": "string",
  "Featured": "boolean",
  "FeaturedEndDate": "string",
  "Fields": "string",
  "SearchItemImage": "string",
  "Images": "string",
  "SourceId": "string"
}

GET /api/content/activeads/{contactid}/{systemcontacttypeid}

contactid: integer
in path

(no description)

systemcontacttypeid: string
in path

(no description)

Response Example (200 OK)
{
  "ContactId": "integer",
  "SystemContactTypeId": "string",
  "Items": "string"
}

GET /api/content/adareas/lookup

Response Example (200 OK)
[
  {
    "Id": "integer",
    "Name": "string",
    "IsSelected": "boolean",
    "AdAreaId": "integer",
    "SiteModuleTypeId": "string",
    "SitePageId": "string",
    "isDeleted": "boolean"
  }
]

GET /api/content/adareatypes/lookup

Response Example (200 OK)
[
  {
    "AdStyleId": "integer",
    "Name": "string",
    "PreferredWidth": "integer",
    "PreferredHeight": "integer"
  }
]

GET /api/content/advertisementtypes

options: string
in query

(no description)

Response Example (200 OK)
[
  {
    "AdAreaId": "integer",
    "Name": "string",
    "AdStyleId": "string",
    "AdStyle": "string",
    "PreferredWidth": "string",
    "PreferredHeight": "string",
    "IsActive": "boolean"
  }
]

GET /api/content/advertisementtypes/{adareaid}

adareaid: integer
in path

(no description)

OK

Response Example (200 OK)
{
  "AdAreaId": "integer",
  "IsReadOnly": "boolean",
  "AdStyleId": "string",
  "Name": "string",
  "SiteModuleTypeId": "string",
  "SitePageId": "string",
  "PreferredWidth": "integer",
  "PreferredHeight": "integer",
  "IsActive": "boolean"
}

POST /api/content/advertisementtypes/{adareaid}

undefined

adareaid: integer
in path

(no description)

Request Example
{
  "AdAreaId": "integer",
  "IsReadOnly": "boolean",
  "AdStyleId": "string",
  "Name": "string",
  "SiteModuleTypeId": "string",
  "SitePageId": "string",
  "PreferredWidth": "integer",
  "PreferredHeight": "integer",
  "IsActive": "boolean"
}
Response Example (200 OK)
{
  "AdAreaId": "integer",
  "Name": "string",
  "AdStyleId": "string",
  "AdStyle": "string",
  "PreferredWidth": "string",
  "PreferredHeight": "string",
  "IsActive": "boolean"
}

DELETE /api/content/advertisementtypes/{adareaid}

adareaid: integer
in path

(no description)

200 OK

OK

GET /api/content/advertisementtypes/lookup

Response Example (200 OK)
[
  {
    "Id": "integer",
    "Name": "string",
    "ExtraData": "string",
    "CssColor": "string",
    "IsSelected": "boolean",
    "IsDeleted": "boolean",
    "Order": "integer",
    "Width": "integer",
    "Height": "integer"
  }
]

GET /api/content/contact/{contactid}/items

contactid: integer
in path

(no description)

Response Example (200 OK)
[
  {
    "DirectoryContactId": "integer",
    "Type": "string",
    "Name": "string",
    "Localize": "string",
    "IsActive": "boolean",
    "IsPublic": "boolean",
    "IsVisibleToMembers": "boolean",
    "Availability": "string",
    "Actions": "string"
  }
]

GET /api/content/contact/organization/{contactid}/items

contactid: integer
in path

(no description)

Response Example (200 OK)
[
  {
    "DirectoryContactId": "integer",
    "Type": "string",
    "Name": "string",
    "Localize": "string",
    "IsActive": "boolean",
    "IsPublic": "boolean",
    "IsVisibleToMembers": "boolean",
    "Availability": "string",
    "Actions": "string"
  }
]

GET /api/content/content/base/page

200 OK

OK

GET /api/content/contentstatus/lookup

Response Example (200 OK)
[
  {
    "IsSelected": "boolean",
    "PreviouslySelected": "boolean",
    "Id": "integer",
    "Name": "string",
    "Order": "integer"
  }
]

POST /api/content/emaildesigner/webcontent

Request Example
{
  "ContentListId": "integer",
  "Take": "integer",
  "IncludeDate": "boolean",
  "IncludeContactName": "boolean"
}
Response Example (200 OK)
[
  {
    "Title": "string",
    "SubTitle": "string",
    "ShortDescription": "string",
    "ContentUrl": "string",
    "ContentImageUrl": "string",
    "ContactName": "string",
    "ViewablePublishDate": "string",
    "IncludeContactName": "boolean",
    "IncludeDate": "boolean"
  }
]

GET /api/content/emaildesigner/webcontent

contentlistid: integer
in query

(no description)

includedate: boolean
in query

(no description)

includecontact: boolean
in query

(no description)

maxitems: integer
in query

(no description)

Response Example (200 OK)
[
  {
    "Title": "string",
    "SubTitle": "string",
    "ShortDescription": "string",
    "ContentUrl": "string",
    "ContentImageUrl": "string",
    "ContactName": "string",
    "ViewablePublishDate": "string",
    "IncludeContactName": "boolean",
    "IncludeDate": "boolean"
  }
]

GET /api/content/hotdeals/{contactid}/{systemcontacttypeid}

contactid: integer
in path

(no description)

systemcontacttypeid: string
in path

(no description)

Response Example (200 OK)
{
  "ContactId": "integer",
  "SystemContactTypeId": "string",
  "Items": "string"
}

GET /api/content/item/listing/{contactid}/{directorycontactid}

contactid: integer
in path

(no description)

directorycontactid: integer
in path

(no description)

Response Example (200 OK)
{
  "AuditId": "integer",
  "DirectoryContactId": "integer",
  "ContactId": "integer",
  "ContactInfoAuditId": "integer",
  "SystemContactTypeId": "string",
  "StartDate": "string",
  "EndDate": "string",
  "ShowGallery": "boolean",
  "ShowVideo": "boolean",
  "ShowHighlights": "boolean",
  "ShowCustomFields": "string",
  "DirectoryId": "string",
  "DirectoryListingTypeId": "string",
  "Title": "string",
  "DisplaySortValue": "string",
  "ContactShortDescription": "string",
  "ContactDescription": "string",
  "Keywords": "string",
  "Highlights": "string",
  "Categories": "string",
  "Images": "string",
  "Videos": "string",
  "Visibility": "string",
  "Fields": "string",
  "Settings": "string",
  "Bio": "string",
  "MembershipId": "string"
}

POST /api/content/item/listing/{directorycontactid}

directorycontactid: integer
in path

(no description)

Request Example
{
  "AuditId": "integer",
  "DirectoryContactId": "integer",
  "ContactId": "integer",
  "ContactInfoAuditId": "integer",
  "SystemContactTypeId": "string",
  "StartDate": "string",
  "EndDate": "string",
  "ShowGallery": "boolean",
  "ShowVideo": "boolean",
  "ShowHighlights": "boolean",
  "ShowCustomFields": "string",
  "DirectoryId": "string",
  "DirectoryListingTypeId": "string",
  "Title": "string",
  "DisplaySortValue": "string",
  "ContactShortDescription": "string",
  "ContactDescription": "string",
  "Keywords": "string",
  "Highlights": "string",
  "Categories": "string",
  "Images": "string",
  "Videos": "string",
  "Visibility": "string",
  "Fields": "string",
  "Settings": "string",
  "Bio": "string",
  "MembershipId": "string"
}
Response Example (200 OK)
{
  "DirectoryContactId": "integer",
  "Type": "string",
  "Name": "string",
  "Localize": "string",
  "IsActive": "boolean",
  "IsPublic": "boolean",
  "IsVisibleToMembers": "boolean",
  "Availability": "string",
  "Actions": "string"
}

DELETE /api/content/item/listing/{directorycontactid}/{auditid}

directorycontactid: integer
in path

(no description)

auditid: integer
in path

(no description)

Response Example (200 OK)
{
  "DirectoryContactId": "integer",
  "Type": "string",
  "Name": "string",
  "Localize": "string",
  "IsActive": "boolean",
  "IsPublic": "boolean",
  "IsVisibleToMembers": "boolean",
  "Availability": "string",
  "Actions": "string"
}

POST /api/content/item/listing/suggest

Request Example
{
  "AuditId": "integer",
  "DirectoryContactId": "integer",
  "ContactId": "integer",
  "ContactInfoAuditId": "integer",
  "SystemContactTypeId": "string",
  "StartDate": "string",
  "EndDate": "string",
  "ShowGallery": "boolean",
  "ShowVideo": "boolean",
  "ShowHighlights": "boolean",
  "ShowCustomFields": "string",
  "DirectoryId": "string",
  "DirectoryListingTypeId": "string",
  "Title": "string",
  "DisplaySortValue": "string",
  "ContactShortDescription": "string",
  "ContactDescription": "string",
  "Keywords": "string",
  "Highlights": "string",
  "Categories": "string",
  "Images": "string",
  "Videos": "string",
  "Visibility": "string",
  "Fields": "string",
  "Settings": "string",
  "Bio": "string",
  "MembershipId": "string"
}
Response Example (200 OK)
{
  "AuditId": "integer",
  "DirectoryContactId": "integer",
  "ContactId": "integer",
  "ContactInfoAuditId": "integer",
  "SystemContactTypeId": "string",
  "StartDate": "string",
  "EndDate": "string",
  "ShowGallery": "boolean",
  "ShowVideo": "boolean",
  "ShowHighlights": "boolean",
  "ShowCustomFields": "string",
  "DirectoryId": "string",
  "DirectoryListingTypeId": "string",
  "Title": "string",
  "DisplaySortValue": "string",
  "ContactShortDescription": "string",
  "ContactDescription": "string",
  "Keywords": "string",
  "Highlights": "string",
  "Categories": "string",
  "Images": "string",
  "Videos": "string",
  "Visibility": "string",
  "Fields": "string",
  "Settings": "string",
  "Bio": "string",
  "MembershipId": "string"
}

GET /api/content/item/load/{contactid}/{contentlistid}/{contentitemid}

contactid: integer
in path

(no description)

contentlistid: integer
in path

(no description)

contentitemid: integer
in path

(no description)

Response Example (200 OK)
{
  "ContentItemId": "integer",
  "ContentListId": "integer",
  "ContactId": "integer",
  "ContentStatusId": "string",
  "PublishStartDate": "string",
  "PublishEndDate": "string",
  "Categories": "string",
  "Title": "string",
  "ShortDescription": "string",
  "Description": "string",
  "MainImage": "string",
  "Images": "string",
  "Fields": "string"
}

POST /api/content/item/new

Request Example
{
  "ContentItemId": "integer",
  "ContentListId": "integer",
  "ContactId": "integer",
  "ContentStatusId": "string",
  "PublishStartDate": "string",
  "PublishEndDate": "string",
  "Categories": "string",
  "Title": "string",
  "ShortDescription": "string",
  "Description": "string",
  "MainImage": "string",
  "Images": "string",
  "Fields": "string"
}

OK

Response Example (200 OK)
{
  "Type": "string",
  "ContentListId": "integer",
  "Id": "integer",
  "ContentType": "string",
  "Name": "string",
  "Status": "string",
  "PublishStartDate": "string",
  "PublishEndDate": "string"
}

POST /api/content/items/{contentitemid}

contentitemid: integer
in path

(no description)

Request Example
{
  "ContentItemId": "integer",
  "AuditId": "integer",
  "ContentListId": "integer",
  "ContactId": "integer",
  "Contact": "string",
  "PublishedByContactId": "string",
  "PublishedByContact": "string",
  "ContentStatusId": "string",
  "Title": "string",
  "Subtitle": "string",
  "ShortDescription": "string",
  "Tags": "string",
  "Description": "string",
  "ItemDate": "string",
  "PublishStart": "string",
  "PublishEnd": "string",
  "EditKey": "string",
  "RequireApprovalAfterEdit": "boolean",
  "CategoryItems": "string",
  "Featured": "boolean",
  "FeaturedEndDate": "string",
  "Fields": "string",
  "SearchItemImage": "string",
  "Images": "string",
  "SourceId": "string"
}
Response Example (200 OK)
{
  "ContentItemId": "integer",
  "AuditId": "integer",
  "ContentListId": "integer",
  "ContentStatusId": "string",
  "ContentStatus": "string",
  "Title": "string",
  "Contacts": "string",
  "Description": "string",
  "PublishStart": "string",
  "PublishEnd": "string"
}

DELETE /api/content/items/{contentitemid}/{auditid}

contentitemid: integer
in path

(no description)

auditid: integer
in path

(no description)

200 OK

OK

GET /api/content/jobs/{contactid}/{systemcontacttypeid}

contactid: integer
in path

(no description)

systemcontacttypeid: string
in path

(no description)

OK

Response Example (200 OK)
{
  "ContactId": "integer",
  "SystemContactTypeId": "string",
  "Items": "string"
}

GET /api/content/list/{contentlistid}

contentlistid: integer
in path

(no description)

Response Example (200 OK)
{
  "ContentListId": "integer",
  "AuditId": "integer",
  "ContentTypeId": "string",
  "Name": "string",
  "PluralName": "string",
  "Description": "string",
  "HubIconCssClass": "string",
  "SubscriptionFrequencyId": "string",
  "SubscriberGroupId": "string",
  "CategoryListId": "string",
  "DefaultSortOrder": "string",
  "IsMemberViewable": "boolean",
  "IsMemberCreatable": "boolean",
  "AllowPublicSubscribers": "boolean",
  "IsPublicViewable": "boolean",
  "IsPublicCreatable": "boolean",
  "SubmissionOptions": "string",
  "ProfileImage": "string",
  "ObjectTypeId": "string",
  "SearchObjectTypeId": "string",
  "CustomFields": "string"
}

POST /api/content/list/{contentlistid}

contentlistid: integer
in path

(no description)

Request Example
{
  "ContentListId": "integer",
  "AuditId": "integer",
  "ContentTypeId": "string",
  "Name": "string",
  "PluralName": "string",
  "Description": "string",
  "HubIconCssClass": "string",
  "SubscriptionFrequencyId": "string",
  "SubscriberGroupId": "string",
  "CategoryListId": "string",
  "DefaultSortOrder": "string",
  "IsMemberViewable": "boolean",
  "IsMemberCreatable": "boolean",
  "AllowPublicSubscribers": "boolean",
  "IsPublicViewable": "boolean",
  "IsPublicCreatable": "boolean",
  "SubmissionOptions": "string",
  "ProfileImage": "string",
  "ObjectTypeId": "string",
  "SearchObjectTypeId": "string",
  "CustomFields": "string"
}
Response Example (200 OK)
{
  "ContentListId": "integer",
  "AuditId": "integer",
  "ContentTypeId": "string",
  "ContentType": "string",
  "Name": "string",
  "Description": "string",
  "PendingFilter": "string",
  "PendingCount": "integer",
  "Actions": "string"
}

DELETE /api/content/list/{contentlistid}/{auditid}

contentlistid: integer
in path

(no description)

auditid: integer
in path

(no description)

200 OK

OK

GET /api/content/list/{contentlistid}/pricing/{contentlistpricingid}

contentlistid: integer
in path

(no description)

contentlistpricingid: string
in path

(no description)

Response Example (200 OK)
{
  "ContentListPricingId": "integer",
  "ContentListId": "integer",
  "Name": "string",
  "DisplayDuration": "integer",
  "Description": "string",
  "SaleableItemId": "integer",
  "AccountingClassId": "string",
  "Price": "number",
  "TaxSetId": "string",
  "ProductTaxCategoryId": "string"
}

POST /api/content/list/{contentlistid}/pricing/{contentlistpricingid}

contentlistid: integer
in path

(no description)

contentlistpricingid: integer
in path

(no description)

Request Example
{
  "ContentListPricingId": "integer",
  "ContentListId": "integer",
  "Name": "string",
  "DisplayDuration": "integer",
  "Description": "string",
  "SaleableItemId": "integer",
  "AccountingClassId": "string",
  "Price": "number",
  "TaxSetId": "string",
  "ProductTaxCategoryId": "string"
}
Response Example (200 OK)
{
  "ContentListId": "integer",
  "ContentListPricingId": "integer",
  "DisplayDuration": "integer",
  "DisplayName": "string",
  "Name": "string",
  "Price": "number",
  "Actions": "string"
}

DELETE /api/content/list/{contentlistid}/pricing/{contentlistpricingid}

contentlistid: string
in path

(no description)

contentlistpricingid: integer
in path

(no description)

200 OK

OK

GET /api/content/list/common

Response Example (200 OK)
{
  "CommonContentItems": "string"
}

POST /api/content/list/common

Request Example
{
  "CommonContentItems": "string"
}
Response Example (200 OK)
[
  {
    "ContentListId": "integer",
    "AuditId": "integer",
    "ContentTypeId": "string",
    "ContentType": "string",
    "Name": "string",
    "Description": "string",
    "PendingFilter": "string",
    "PendingCount": "integer",
    "Actions": "string"
  }
]

GET /api/content/list/lookup

Response Example (200 OK)
[
  {
    "Id": "integer",
    "Name": "string",
    "ExtraData": "string",
    "CssColor": "string",
    "IsSelected": "boolean",
    "IsDeleted": "boolean",
    "Order": "integer"
  }
]

GET /api/content/lists

options: string
in query

(no description)

Response Example (200 OK)
[
  {
    "ContentListId": "integer",
    "AuditId": "integer",
    "ContentTypeId": "string",
    "ContentType": "string",
    "Name": "string",
    "Description": "string",
    "PendingFilter": "string",
    "PendingCount": "integer",
    "Actions": "string"
  }
]

GET /api/content/lookup/categories/{contentlistid}

contentlistid: integer
in path

(no description)

Response Example (200 OK)
[
  {
    "Id": "integer",
    "Name": "string",
    "ExtraData": "string",
    "CssColor": "string",
    "IsSelected": "boolean",
    "IsDeleted": "boolean",
    "Order": "integer"
  }
]

POST /api/content/partners

Request Example
{
  "Top": "string",
  "Take": "string",
  "Skip": "string",
  "Filter": "string",
  "OrderBy": "string",
  "CalendarStartDate": "string",
  "CalendarEndDate": "string",
  "TenantId": "integer",
  "ContentListId": "integer",
  "Contact": "string",
  "Title": "string",
  "Tags": "string",
  "Statuses": "string",
  "Categories": "string",
  "ActiveDateBetween": "string",
  "IncludeExpiredItems": "boolean",
  "ContactId": "string",
  "Criteria": "string"
}
Response Example (200 OK)
[
  {
    "AdId": "integer",
    "Title": "string",
    "ContactName": "string",
    "StartDate": "string",
    "EndDate": "string",
    "IsActive": "boolean"
  }
]

DELETE /api/content/partners/{adid}/{auditid}

adid: integer
in path

(no description)

auditid: integer
in path

(no description)

200 OK

OK

GET /api/content/partners/{adid}/{sponsorid}

adid: integer
in path

(no description)

sponsorid: string
in path

(no description)

OK

Response Example (200 OK)
{
  "AdId": "integer",
  "AuditId": "integer",
  "ContactId": "string",
  "ContactName": "string",
  "Title": "string",
  "StartDate": "string",
  "EndDate": "string",
  "DestinationUrl": "string",
  "OpenInNewWindow": "boolean",
  "ExternalImageUrl": "string",
  "CustomHtml": "string",
  "SponsorId": "string",
  "Advertisements": "string",
  "_StartDate": "string",
  "_EndDate": "string",
  "FileImageInfoId": "string",
  "Width": "integer",
  "Height": "integer"
}

POST /api/content/partners/{adid}/{sponsorid}

undefined

adid: string
in path

(no description)

sponsorid: string
in path

(no description)

Request Example
{
  "AdId": "integer",
  "AuditId": "integer",
  "ContactId": "string",
  "ContactName": "string",
  "Title": "string",
  "StartDate": "string",
  "EndDate": "string",
  "DestinationUrl": "string",
  "OpenInNewWindow": "boolean",
  "ExternalImageUrl": "string",
  "CustomHtml": "string",
  "SponsorId": "string",
  "Advertisements": "string",
  "_StartDate": "string",
  "_EndDate": "string",
  "FileImageInfoId": "string",
  "Width": "integer",
  "Height": "integer"
}

OK

Response Example (200 OK)
{
  "AdId": "integer",
  "Title": "string",
  "ContactName": "string",
  "StartDate": "string",
  "EndDate": "string",
  "IsActive": "boolean"
}

GET /api/content/partners/{adid}/areas

adid: integer
in path

(no description)

OK

Response Example (200 OK)
{
  "AdId": "integer",
  "AdActivationId": "integer",
  "BannerName": "string",
  "Areas": "string"
}

POST /api/content/partners/{adid}/areas

undefined

adid: integer
in path

(no description)

Request Example
{
  "AdId": "integer",
  "AdActivationId": "integer",
  "BannerName": "string",
  "Areas": "string"
}
200 OK

OK

GET /api/content/partners/{adid}/images

adid: integer
in path

(no description)

OK

Response Example (200 OK)
{
  "AdId": "integer",
  "TenantId": "integer",
  "BannerName": "string",
  "Images": "string"
}

POST /api/content/partners/{adid}/images

undefined

adid: integer
in path

(no description)

Request Example
{
  "AdId": "integer",
  "TenantId": "integer",
  "BannerName": "string",
  "Images": "string"
}
200 OK

OK

POST /api/content/partners/suggest

undefined

Request Example
{
  "AdId": "integer",
  "AuditId": "integer",
  "ContactId": "string",
  "ContactName": "string",
  "Title": "string",
  "StartDate": "string",
  "EndDate": "string",
  "DestinationUrl": "string",
  "OpenInNewWindow": "boolean",
  "ExternalImageUrl": "string",
  "CustomHtml": "string",
  "SponsorId": "string",
  "Advertisements": "string",
  "_StartDate": "string",
  "_EndDate": "string",
  "FileImageInfoId": "string",
  "Width": "integer",
  "Height": "integer"
}

OK

Response Example (200 OK)
{
  "AdId": "integer",
  "AuditId": "integer",
  "ContactId": "string",
  "ContactName": "string",
  "Title": "string",
  "StartDate": "string",
  "EndDate": "string",
  "DestinationUrl": "string",
  "OpenInNewWindow": "boolean",
  "ExternalImageUrl": "string",
  "CustomHtml": "string",
  "SponsorId": "string",
  "Advertisements": "string",
  "_StartDate": "string",
  "_EndDate": "string",
  "FileImageInfoId": "string",
  "Width": "integer",
  "Height": "integer"
}

Schema Definitions

ContentListCollectionModel: object

ContentListId: integer
AuditId: integer
ContentTypeId: string
ContentType: string
Name: string
Description: string
PendingFilter: string
PendingCount: integer
Actions: string
Example
{
  "ContentListId": "integer",
  "AuditId": "integer",
  "ContentTypeId": "string",
  "ContentType": "string",
  "Name": "string",
  "Description": "string",
  "PendingFilter": "string",
  "PendingCount": "integer",
  "Actions": "string"
}

ContentListPublishingPackageAddEditModel: object

ContentListPricingId: integer
ContentListId: integer
Name: string
DisplayDuration: integer
Description: string
SaleableItemId: integer
AccountingClassId: string
Price: number
TaxSetId: string
ProductTaxCategoryId: string
Example
{
  "ContentListPricingId": "integer",
  "ContentListId": "integer",
  "Name": "string",
  "DisplayDuration": "integer",
  "Description": "string",
  "SaleableItemId": "integer",
  "AccountingClassId": "string",
  "Price": "number",
  "TaxSetId": "string",
  "ProductTaxCategoryId": "string"
}

ContentListSubmissionOptionListItem: object

ContentListId: integer
ContentListPricingId: integer
DisplayDuration: integer
DisplayName: string
Name: string
Price: number
Actions: string
Example
{
  "ContentListId": "integer",
  "ContentListPricingId": "integer",
  "DisplayDuration": "integer",
  "DisplayName": "string",
  "Name": "string",
  "Price": "number",
  "Actions": "string"
}

Object: object

Example
"object"

ContentListAddEditModel: object

ContentListId: integer
AuditId: integer
ContentTypeId: string
Name: string
PluralName: string
Description: string
HubIconCssClass: string
SubscriptionFrequencyId: string
SubscriberGroupId: string
CategoryListId: string
DefaultSortOrder: string
IsMemberViewable: boolean
IsMemberCreatable: boolean
AllowPublicSubscribers: boolean
IsPublicViewable: boolean
IsPublicCreatable: boolean
SubmissionOptions: string
ProfileImage: string
ObjectTypeId: string
SearchObjectTypeId: string
CustomFields: string
Example
{
  "ContentListId": "integer",
  "AuditId": "integer",
  "ContentTypeId": "string",
  "Name": "string",
  "PluralName": "string",
  "Description": "string",
  "HubIconCssClass": "string",
  "SubscriptionFrequencyId": "string",
  "SubscriberGroupId": "string",
  "CategoryListId": "string",
  "DefaultSortOrder": "string",
  "IsMemberViewable": "boolean",
  "IsMemberCreatable": "boolean",
  "AllowPublicSubscribers": "boolean",
  "IsPublicViewable": "boolean",
  "IsPublicCreatable": "boolean",
  "SubmissionOptions": "string",
  "ProfileImage": "string",
  "ObjectTypeId": "string",
  "SearchObjectTypeId": "string",
  "CustomFields": "string"
}

ContentListSetupCommonContentViewModel: object

CommonContentItems: string
Example
{
  "CommonContentItems": "string"
}

GenericLookUpChoice<Int32>: object

Id: integer
Name: string
ExtraData: string
CssColor: string
IsSelected: boolean
IsDeleted: boolean
Order: integer
Example
{
  "Id": "integer",
  "Name": "string",
  "ExtraData": "string",
  "CssColor": "string",
  "IsSelected": "boolean",
  "IsDeleted": "boolean",
  "Order": "integer"
}

ContactContentCollectionModel: object

DirectoryContactId: integer
Type: string
Name: string
Localize: string
IsActive: boolean
IsPublic: boolean
IsVisibleToMembers: boolean
Availability: string
Actions: string
Example
{
  "DirectoryContactId": "integer",
  "Type": "string",
  "Name": "string",
  "Localize": "string",
  "IsActive": "boolean",
  "IsPublic": "boolean",
  "IsVisibleToMembers": "boolean",
  "Availability": "string",
  "Actions": "string"
}

ContentItemManagementModel: object

ContentListId: integer
ContentListPluralName: string
ListViewItems: string
Example
{
  "ContentListId": "integer",
  "ContentListPluralName": "string",
  "ListViewItems": "string"
}

ListViewReturnModel<ContentItemCollectionModel>: object

Criteria: string
CriteriaItems: string
TotalRecordAvailable: string

We typically only return a subset of what is available on the server, but lets show the user what was available

ModelItems: string
Results: string
Example
{
  "Criteria": "string",
  "CriteriaItems": "string",
  "TotalRecordAvailable": "string",
  "ModelItems": "string",
  "Results": "string"
}

ContentItemAdvancedFilter: object

Top: string
Take: string
Skip: string
Filter: string
OrderBy: string
CalendarStartDate: string
CalendarEndDate: string
TenantId: integer
ContentListId: integer
Contact: string
Title: string
Tags: string
Statuses: string
Categories: string
ActiveDateBetween: string
IncludeExpiredItems: boolean
ContactId: string
Criteria: string
Example
{
  "Top": "string",
  "Take": "string",
  "Skip": "string",
  "Filter": "string",
  "OrderBy": "string",
  "CalendarStartDate": "string",
  "CalendarEndDate": "string",
  "TenantId": "integer",
  "ContentListId": "integer",
  "Contact": "string",
  "Title": "string",
  "Tags": "string",
  "Statuses": "string",
  "Categories": "string",
  "ActiveDateBetween": "string",
  "IncludeExpiredItems": "boolean",
  "ContactId": "string",
  "Criteria": "string"
}

ContentItemAddEditModel: object

ContentItemId: integer
AuditId: integer
ContentListId: integer
ContactId: integer
Contact: string
PublishedByContactId: string
PublishedByContact: string
ContentStatusId: string
Title: string
Subtitle: string
ShortDescription: string
Tags: string
Description: string
ItemDate: string
PublishStart: string
PublishEnd: string
EditKey: string
RequireApprovalAfterEdit: boolean
CategoryItems: string
Featured: boolean
FeaturedEndDate: string
Fields: string
SearchItemImage: string
Images: string
SourceId: string
Example
{
  "ContentItemId": "integer",
  "AuditId": "integer",
  "ContentListId": "integer",
  "ContactId": "integer",
  "Contact": "string",
  "PublishedByContactId": "string",
  "PublishedByContact": "string",
  "ContentStatusId": "string",
  "Title": "string",
  "Subtitle": "string",
  "ShortDescription": "string",
  "Tags": "string",
  "Description": "string",
  "ItemDate": "string",
  "PublishStart": "string",
  "PublishEnd": "string",
  "EditKey": "string",
  "RequireApprovalAfterEdit": "boolean",
  "CategoryItems": "string",
  "Featured": "boolean",
  "FeaturedEndDate": "string",
  "Fields": "string",
  "SearchItemImage": "string",
  "Images": "string",
  "SourceId": "string"
}

ContentItemCollectionModel: object

ContentItemId: integer
AuditId: integer
ContentListId: integer
ContentStatusId: string
ContentStatus: string
Title: string
Contacts: string
Description: string
PublishStart: string
PublishEnd: string
Example
{
  "ContentItemId": "integer",
  "AuditId": "integer",
  "ContentListId": "integer",
  "ContentStatusId": "string",
  "ContentStatus": "string",
  "Title": "string",
  "Contacts": "string",
  "Description": "string",
  "PublishStart": "string",
  "PublishEnd": "string"
}

BenefitItemModel: object

Type: string
ContentListId: integer
Id: integer
ContentType: string
Name: string
Status: string
PublishStartDate: string
PublishEndDate: string
Example
{
  "Type": "string",
  "ContentListId": "integer",
  "Id": "integer",
  "ContentType": "string",
  "Name": "string",
  "Status": "string",
  "PublishStartDate": "string",
  "PublishEndDate": "string"
}

PersonContentItemAddEditModel: object

ContentItemId: integer
ContentListId: integer
ContactId: integer
ContentStatusId: string
PublishStartDate: string
PublishEndDate: string
Categories: string
Title: string
ShortDescription: string
Description: string
MainImage: string
Images: string
Fields: string
Example
{
  "ContentItemId": "integer",
  "ContentListId": "integer",
  "ContactId": "integer",
  "ContentStatusId": "string",
  "PublishStartDate": "string",
  "PublishEndDate": "string",
  "Categories": "string",
  "Title": "string",
  "ShortDescription": "string",
  "Description": "string",
  "MainImage": "string",
  "Images": "string",
  "Fields": "string"
}

AddEditDirectoryListingViewModel: object

AuditId: integer
DirectoryContactId: integer
ContactId: integer
ContactInfoAuditId: integer
SystemContactTypeId: string
StartDate: string
EndDate: string
ShowGallery: boolean
ShowVideo: boolean
ShowHighlights: boolean
ShowCustomFields: string
DirectoryId: string
DirectoryListingTypeId: string
Title: string
DisplaySortValue: string
ContactShortDescription: string
ContactDescription: string
Keywords: string
Highlights: string
Categories: string
Images: string
Videos: string
Visibility: string
Fields: string
Settings: string
Bio: string
MembershipId: string
Example
{
  "AuditId": "integer",
  "DirectoryContactId": "integer",
  "ContactId": "integer",
  "ContactInfoAuditId": "integer",
  "SystemContactTypeId": "string",
  "StartDate": "string",
  "EndDate": "string",
  "ShowGallery": "boolean",
  "ShowVideo": "boolean",
  "ShowHighlights": "boolean",
  "ShowCustomFields": "string",
  "DirectoryId": "string",
  "DirectoryListingTypeId": "string",
  "Title": "string",
  "DisplaySortValue": "string",
  "ContactShortDescription": "string",
  "ContactDescription": "string",
  "Keywords": "string",
  "Highlights": "string",
  "Categories": "string",
  "Images": "string",
  "Videos": "string",
  "Visibility": "string",
  "Fields": "string",
  "Settings": "string",
  "Bio": "string",
  "MembershipId": "string"
}

AdCollectionModel: object

AdId: integer
Title: string
ContactName: string
StartDate: string
EndDate: string
IsActive: boolean
Example
{
  "AdId": "integer",
  "Title": "string",
  "ContactName": "string",
  "StartDate": "string",
  "EndDate": "string",
  "IsActive": "boolean"
}

AdItemAddEditModel: object

AdId: integer
AuditId: integer
ContactId: string
ContactName: string
Title: string
StartDate: string
EndDate: string
DestinationUrl: string
OpenInNewWindow: boolean
ExternalImageUrl: string
CustomHtml: string
SponsorId: string
Advertisements: string
_StartDate: string
_EndDate: string
FileImageInfoId: string
Width: integer
Height: integer
Example
{
  "AdId": "integer",
  "AuditId": "integer",
  "ContactId": "string",
  "ContactName": "string",
  "Title": "string",
  "StartDate": "string",
  "EndDate": "string",
  "DestinationUrl": "string",
  "OpenInNewWindow": "boolean",
  "ExternalImageUrl": "string",
  "CustomHtml": "string",
  "SponsorId": "string",
  "Advertisements": "string",
  "_StartDate": "string",
  "_EndDate": "string",
  "FileImageInfoId": "string",
  "Width": "integer",
  "Height": "integer"
}

AdAreaChoiceModel: object

Id: integer
Name: string
IsSelected: boolean
AdAreaId: integer
SiteModuleTypeId: string
SitePageId: string
isDeleted: boolean
Example
{
  "Id": "integer",
  "Name": "string",
  "IsSelected": "boolean",
  "AdAreaId": "integer",
  "SiteModuleTypeId": "string",
  "SitePageId": "string",
  "isDeleted": "boolean"
}

AdAreaStyleSelectModel: object

AdStyleId: integer
Name: string
PreferredWidth: integer
PreferredHeight: integer
Example
{
  "AdStyleId": "integer",
  "Name": "string",
  "PreferredWidth": "integer",
  "PreferredHeight": "integer"
}

AdAreasEditModel: object

AdId: integer
AdActivationId: integer
BannerName: string
Areas: string
Example
{
  "AdId": "integer",
  "AdActivationId": "integer",
  "BannerName": "string",
  "Areas": "string"
}

Boolean: object

Example
"object"

AdImagesEditModel: object

AdId: integer
TenantId: integer
BannerName: string
Images: string
Example
{
  "AdId": "integer",
  "TenantId": "integer",
  "BannerName": "string",
  "Images": "string"
}

AdTypeCollectionModel: object

AdAreaId: integer
Name: string
AdStyleId: string
AdStyle: string
PreferredWidth: string
PreferredHeight: string
IsActive: boolean
Example
{
  "AdAreaId": "integer",
  "Name": "string",
  "AdStyleId": "string",
  "AdStyle": "string",
  "PreferredWidth": "string",
  "PreferredHeight": "string",
  "IsActive": "boolean"
}

AdTypeAddEditModel: object

AdAreaId: integer
IsReadOnly: boolean
AdStyleId: string
Name: string
SiteModuleTypeId: string
SitePageId: string
PreferredWidth: integer
PreferredHeight: integer
IsActive: boolean
Example
{
  "AdAreaId": "integer",
  "IsReadOnly": "boolean",
  "AdStyleId": "string",
  "Name": "string",
  "SiteModuleTypeId": "string",
  "SitePageId": "string",
  "PreferredWidth": "integer",
  "PreferredHeight": "integer",
  "IsActive": "boolean"
}

AdTypeLookupChoiceModel: object

Id: integer
Name: string
ExtraData: string
CssColor: string
IsSelected: boolean
IsDeleted: boolean
Order: integer
Width: integer
Height: integer
Example
{
  "Id": "integer",
  "Name": "string",
  "ExtraData": "string",
  "CssColor": "string",
  "IsSelected": "boolean",
  "IsDeleted": "boolean",
  "Order": "integer",
  "Width": "integer",
  "Height": "integer"
}

ItemChoiceModel: object

IsSelected: boolean
PreviouslySelected: boolean
Id: integer
Name: string
Order: integer
Example
{
  "IsSelected": "boolean",
  "PreviouslySelected": "boolean",
  "Id": "integer",
  "Name": "string",
  "Order": "integer"
}

ImageGalleryItem: object

ImageId: integer
Url: string
Title: string
Caption: string
ShortDescription: string
Example
{
  "ImageId": "integer",
  "Url": "string",
  "Title": "string",
  "Caption": "string",
  "ShortDescription": "string"
}

AddEditImageGalleryItem: object

ImageId: integer
FileId: integer
Url: string
Title: string
Caption: string
CropX: integer
CropY: integer
CropHeight: integer
CropWidth: integer
ShortDescription: string
Example
{
  "ImageId": "integer",
  "FileId": "integer",
  "Url": "string",
  "Title": "string",
  "Caption": "string",
  "CropX": "integer",
  "CropY": "integer",
  "CropHeight": "integer",
  "CropWidth": "integer",
  "ShortDescription": "string"
}

Int32: object

Example
"object"

ActiveAdsNameListModel: object

ContactId: integer
SystemContactTypeId: string
Items: string
Example
{
  "ContactId": "integer",
  "SystemContactTypeId": "string",
  "Items": "string"
}

HotDealsNameListModel: object

ContactId: integer
SystemContactTypeId: string
Items: string
Example
{
  "ContactId": "integer",
  "SystemContactTypeId": "string",
  "Items": "string"
}

JobsNameListModel: object

ContactId: integer
SystemContactTypeId: string
Items: string
Example
{
  "ContactId": "integer",
  "SystemContactTypeId": "string",
  "Items": "string"
}

WebContentToolResponseModel: object

Title: string
SubTitle: string
ShortDescription: string
ContentUrl: string
ContentImageUrl: string
ContactName: string
ViewablePublishDate: string
IncludeContactName: boolean
IncludeDate: boolean
Example
{
  "Title": "string",
  "SubTitle": "string",
  "ShortDescription": "string",
  "ContentUrl": "string",
  "ContentImageUrl": "string",
  "ContactName": "string",
  "ViewablePublishDate": "string",
  "IncludeContactName": "boolean",
  "IncludeDate": "boolean"
}

WebContentsUnlayerToolQueryFilter: object

ContentListId: integer
Take: integer
IncludeDate: boolean
IncludeContactName: boolean
Example
{
  "ContentListId": "integer",
  "Take": "integer",
  "IncludeDate": "boolean",
  "IncludeContactName": "boolean"
}