YM REST Services

<back to all web services

CustomPageVersions

Requires Authentication
Requires any of the roles:admin, oauthadmin, admin, oauthadmin, admin, oauthadmin
The following routes are available for this service:
GET/Ams/{ClientID}/CustomPageVersionsReturn custom page versions.
POST/Ams/{ClientID}/CustomPageVersionsPublish or Unpublish a custom page versions.
DELETE/Ams/{ClientID}/CustomPageVersionsDelete a custom page versions.
CustomPageVersions Parameters:
NameParameterData TypeRequiredDescription
PageIDbodyintNo
VersionIDbodyintNo
MemberBaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
MemberIDformintNo
BaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
ClientIDformintNo
ResponseStatusformResponseStatusNo
BypassCacheformboolNo
DateCachedformDateTimeNo
DeviceformDeviceNo
CustomPageVersionsResponse Parameters:
NameParameterData TypeRequiredDescription
CustomPageVersionsformList<CustomPageVersion>No
CustomPageVersion Parameters:
NameParameterData TypeRequiredDescription
VersionIDformintNo
PageIDformintNo
StatusformintNo
TitleformstringNo
BodyformstringNo
LabelformstringNo
NotesformstringNo
DateModifiedformDateTimeNo
EditorNameformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /Ams/{ClientID}/CustomPageVersions HTTP/1.1 
Host: ws.yourmembership.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	PageID: 0,
	VersionID: 0,
	MemberID: 0,
	ClientID: 0,
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	},
	BypassCache: False,
	DateCached: 2024-05-03T10:03:25.0601063-04:00,
	Device: Desktop
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	CustomPageVersions: 
	[
		{
			VersionID: 0,
			PageID: 0,
			Status: 0,
			Title: String,
			Body: String,
			Label: String,
			Notes: String,
			DateModified: 0001-01-01,
			EditorName: String
		}
	],
	PageID: 0,
	VersionID: 0,
	MemberID: 0,
	ClientID: 0,
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	},
	BypassCache: False,
	DateCached: 2024-05-03T10:03:25.0601063-04:00,
	Device: Desktop
}