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