Platform API

GetCustomContentViews

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

The following routes are available for this service:
All Verbs	/api/customcontentviews

Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports Eros.Subtle.Canvara.WebAPIModel.ServiceModel

Namespace Global

    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 Overridable Property ContentViewId As Guid

            '''<Summary>
            '''Name of the Custom Content View.
            '''</Summary>
            <ApiMember(DataType:="string", Description:="Name of the Custom Content View.", Name:="Name", ParameterType:="query")>
            Public Overridable Property Name As String
        End Class

        '''<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 Overridable Property RmsTableCtxId As Guid
        End Class

        <ApiResponse(Description:="Returns the Views matching the specified type.")>
        Public Partial Class GetCustomContentViewsResponse
            Public Overridable Property Views As List(Of CustomContentViewModel)
            Public Overridable Property ResponseStatus As ResponseStatus
        End Class
    End Namespace
End Namespace

VB.NET 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"}}}