Platform API

<back to all web services

GetCustomContentViews

Request a list of Custom Content Views for the current licensee of the specified type.

Requires Authentication
The following routes are available for this service:
All Verbs/api/customcontentviews
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CustomContentViewModel:
    # @ApiMember(DataType="Guid", Description="Id of the Custom Content View.", Name="ContentViewId", ParameterType="query")
    content_view_id: Optional[str] = None
    """
    Id of the Custom Content View.
    """


    # @ApiMember(DataType="string", Description="Name of the Custom Content View.", Name="Name", ParameterType="query")
    name: Optional[str] = None
    """
    Name of the Custom Content View.
    """


# @ApiResponse(Description="Returns the Views matching the specified type.")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetCustomContentViewsResponse:
    views: Optional[List[CustomContentViewModel]] = None
    response_status: Optional[ResponseStatus] = None


# @Api(Description="Request a list of Custom Content Views for the current licensee of the specified type.")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetCustomContentViews:
    """
    Request a list of Custom Content Views for the current licensee of the specified type.
    """

    # @ApiMember(DataType="Guid", Description="The RmsTableCtxId representing the type of views we are retrieving.", IsRequired=true, Name="RmsTableCtxId", ParameterType="query")
    rms_table_ctx_id: Optional[str] = None
    """
    The RmsTableCtxId representing the type of views we are retrieving.
    """

Python GetCustomContentViews DTOs

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 /api/customcontentviews HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Views: 
	[
		{
			Name: String
		}
	],
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}