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 java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class dtos
{

    /**
    * Request a list of Custom Content Views for the current licensee of the specified type.
    */
    @Api(Description="Request a list of Custom Content Views for the current licensee of the specified type.")
    public static class GetCustomContentViews
    {
        /**
        * The RmsTableCtxId representing the type of views we are retrieving.
        */
        @ApiMember(DataType="Guid", Description="The RmsTableCtxId representing the type of views we are retrieving.", IsRequired=true, Name="RmsTableCtxId", ParameterType="query")
        public UUID RmsTableCtxId = null;
        
        public UUID getRmsTableCtxId() { return RmsTableCtxId; }
        public GetCustomContentViews setRmsTableCtxId(UUID value) { this.RmsTableCtxId = value; return this; }
    }

    @ApiResponse(Description="Returns the Views matching the specified type.")
    public static class GetCustomContentViewsResponse
    {
        public ArrayList<CustomContentViewModel> Views = null;
        public ResponseStatus ResponseStatus = null;
        
        public ArrayList<CustomContentViewModel> getViews() { return Views; }
        public GetCustomContentViewsResponse setViews(ArrayList<CustomContentViewModel> value) { this.Views = value; return this; }
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public GetCustomContentViewsResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
    }

    public static class CustomContentViewModel
    {
        /**
        * Id of the Custom Content View.
        */
        @ApiMember(DataType="Guid", Description="Id of the Custom Content View.", Name="ContentViewId", ParameterType="query")
        public UUID ContentViewId = null;

        /**
        * Name of the Custom Content View.
        */
        @ApiMember(DataType="string", Description="Name of the Custom Content View.", Name="Name", ParameterType="query")
        public String Name = null;
        
        public UUID getContentViewId() { return ContentViewId; }
        public CustomContentViewModel setContentViewId(UUID value) { this.ContentViewId = value; return this; }
        public String getName() { return Name; }
        public CustomContentViewModel setName(String value) { this.Name = value; return this; }
    }

}

Java 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
		}
	}
}