Platform API

<back to all web services

GetCustomContentViews

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

import 'package:servicestack/servicestack.dart';

class CustomContentViewModel implements IConvertible
{
    /**
    * Id of the Custom Content View.
    */
    // @ApiMember(DataType="Guid", Description="Id of the Custom Content View.", Name="ContentViewId", ParameterType="query")
    String? ContentViewId;

    /**
    * Name of the Custom Content View.
    */
    // @ApiMember(DataType="string", Description="Name of the Custom Content View.", Name="Name", ParameterType="query")
    String? Name;

    CustomContentViewModel({this.ContentViewId,this.Name});
    CustomContentViewModel.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        ContentViewId = json['ContentViewId'];
        Name = json['Name'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'ContentViewId': ContentViewId,
        'Name': Name
    };

    getTypeName() => "CustomContentViewModel";
    TypeContext? context = _ctx;
}

// @ApiResponse(Description="Returns the Views matching the specified type.")
class GetCustomContentViewsResponse implements IConvertible
{
    List<CustomContentViewModel>? Views;
    ResponseStatus? ResponseStatus;

    GetCustomContentViewsResponse({this.Views,this.ResponseStatus});
    GetCustomContentViewsResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Views = JsonConverters.fromJson(json['Views'],'List<CustomContentViewModel>',context!);
        ResponseStatus = JsonConverters.fromJson(json['ResponseStatus'],'ResponseStatus',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Views': JsonConverters.toJson(Views,'List<CustomContentViewModel>',context!),
        'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!)
    };

    getTypeName() => "GetCustomContentViewsResponse";
    TypeContext? context = _ctx;
}

/**
* 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.")
class GetCustomContentViews implements IConvertible
{
    /**
    * 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")
    String? RmsTableCtxId;

    GetCustomContentViews({this.RmsTableCtxId});
    GetCustomContentViews.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        RmsTableCtxId = json['RmsTableCtxId'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'RmsTableCtxId': RmsTableCtxId
    };

    getTypeName() => "GetCustomContentViews";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'pfapi.pstpf.com.au', types: <String, TypeInfo> {
    'CustomContentViewModel': TypeInfo(TypeOf.Class, create:() => CustomContentViewModel()),
    'GetCustomContentViewsResponse': TypeInfo(TypeOf.Class, create:() => GetCustomContentViewsResponse()),
    'List<CustomContentViewModel>': TypeInfo(TypeOf.Class, create:() => <CustomContentViewModel>[]),
    'GetCustomContentViews': TypeInfo(TypeOf.Class, create:() => GetCustomContentViews()),
});

Dart GetCustomContentViews DTOs

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>