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

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 .xml suffix or ?format=xml

HTTP + XML

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

<GetCustomContentViews xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
  <RmsTableCtxId>00000000-0000-0000-0000-000000000000</RmsTableCtxId>
</GetCustomContentViews>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetCustomContentViewsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <Views>
    <CustomContentViewModel>
      <ContentViewId>00000000-0000-0000-0000-000000000000</ContentViewId>
      <Name>String</Name>
    </CustomContentViewModel>
  </Views>
</GetCustomContentViewsResponse>