| All Verbs | /api/customcontentviews |
|---|
export class CustomContentViewModel
{
/** @description Id of the Custom Content View. */
// @ApiMember(DataType="Guid", Description="Id of the Custom Content View.", Name="ContentViewId", ParameterType="query")
public ContentViewId: string;
/** @description Name of the Custom Content View. */
// @ApiMember(DataType="string", Description="Name of the Custom Content View.", Name="Name", ParameterType="query")
public Name: string;
public constructor(init?: Partial<CustomContentViewModel>) { (Object as any).assign(this, init); }
}
// @ApiResponse(Description="Returns the Views matching the specified type.")
export class GetCustomContentViewsResponse
{
public Views: CustomContentViewModel[];
public ResponseStatus: ResponseStatus;
public constructor(init?: Partial<GetCustomContentViewsResponse>) { (Object as any).assign(this, init); }
}
/** @description 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.")
export class GetCustomContentViews
{
/** @description 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 RmsTableCtxId: string;
public constructor(init?: Partial<GetCustomContentViews>) { (Object as any).assign(this, init); }
}
TypeScript GetCustomContentViews DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
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/jsv
Content-Type: text/jsv
Content-Length: length
{
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
Views:
[
{
Name: String
}
],
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
}
}