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
namespace Eros.Subtle.Canvara.WebAPIModel.ServiceModel

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type CustomContentViewModel() = 
        ///<summary>
        ///Id of the Custom Content View.
        ///</summary>
        [<ApiMember(DataType="Guid", Description="Id of the Custom Content View.", Name="ContentViewId", ParameterType="query")>]
        member val ContentViewId:Guid = new Guid() with get,set

        ///<summary>
        ///Name of the Custom Content View.
        ///</summary>
        [<ApiMember(DataType="string", Description="Name of the Custom Content View.", Name="Name", ParameterType="query")>]
        member val Name:String = null with get,set

    [<ApiResponse(Description="Returns the Views matching the specified type.")>]
    [<AllowNullLiteral>]
    type GetCustomContentViewsResponse() = 
        member val Views:ResizeArray<CustomContentViewModel> = null with get,set
        member val ResponseStatus:ResponseStatus = null with 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.")>]
    [<AllowNullLiteral>]
    type 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")>]
        member val RmsTableCtxId:Guid = new Guid() with get,set

F# GetCustomContentViews DTOs

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

HTTP + CSV

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

{"RmsTableCtxId":"00000000-0000-0000-0000-000000000000"}
HTTP/1.1 200 OK
Content-Type: text/csv
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"}}}