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.*


/**
* 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.")
open 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")
    open var RmsTableCtxId:UUID? = null
}

@ApiResponse(Description="Returns the Views matching the specified type.")
open class GetCustomContentViewsResponse
{
    open var Views:ArrayList<CustomContentViewModel>? = null
    open var ResponseStatus:ResponseStatus? = null
}

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

    /**
    * Name of the Custom Content View.
    */
    @ApiMember(DataType="string", Description="Name of the Custom Content View.", Name="Name", ParameterType="query")
    open var Name:String? = null
}

Kotlin GetCustomContentViews DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: application/json
Content-Type: application/json
Content-Length: length

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