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 Foundation
import ServiceStack

/**
* 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 class GetCustomContentViews : Codable
{
    /**
    * 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 var rmsTableCtxId:String

    required public init(){}
}

// @ApiResponse(Description="Returns the Views matching the specified type.")
public class GetCustomContentViewsResponse : Codable
{
    public var views:[CustomContentViewModel]
    public var responseStatus:ResponseStatus

    required public init(){}
}

public class CustomContentViewModel : Codable
{
    /**
    * Id of the Custom Content View.
    */
    // @ApiMember(DataType="Guid", Description="Id of the Custom Content View.", Name="ContentViewId", ParameterType="query")
    public var contentViewId:String

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

    required public init(){}
}


Swift 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"}}}