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
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Eros.Subtle.Canvara.WebAPIModel.ServiceModel;

namespace Eros.Subtle.Canvara.WebAPIModel.ServiceModel
{
    public partial class CustomContentViewModel
    {
        ///<summary>
        ///Id of the Custom Content View.
        ///</summary>
        [ApiMember(DataType="Guid", Description="Id of the Custom Content View.", Name="ContentViewId", ParameterType="query")]
        public virtual Guid ContentViewId { get; set; }

        ///<summary>
        ///Name of the Custom Content View.
        ///</summary>
        [ApiMember(DataType="string", Description="Name of the Custom Content View.", Name="Name", ParameterType="query")]
        public virtual string Name { get; set; }
    }

    ///<summary>
    ///Request a list of Custom Content Views for the current licensee of the specified type.
    ///</summary>
    [Api(Description="Request a list of Custom Content Views for the current licensee of the specified type.")]
    public partial class GetCustomContentViews
    {
        ///<summary>
        ///The RmsTableCtxId representing the type of views we are retrieving.
        ///</summary>
        [ApiMember(DataType="Guid", Description="The RmsTableCtxId representing the type of views we are retrieving.", IsRequired=true, Name="RmsTableCtxId", ParameterType="query")]
        public virtual Guid RmsTableCtxId { get; set; }
    }

    [ApiResponse(Description="Returns the Views matching the specified type.")]
    public partial class GetCustomContentViewsResponse
    {
        public virtual List<CustomContentViewModel> Views { get; set; }
        public virtual ResponseStatus ResponseStatus { get; set; }
    }

}

C# GetCustomContentViews DTOs

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

HTTP + OTHER

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/jsonl
Content-Type: text/jsonl
Content-Length: length

{"RmsTableCtxId":"00000000-0000-0000-0000-000000000000"}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"Views":[{"ContentViewId":"00000000-0000-0000-0000-000000000000","Name":"String"}],"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}