Platform API

GetList

Get specified list and list items

The following routes are available for this service:
All Verbs	/api/lists/{ListId}

import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ListItemModel:
    list_item_id: Optional[str] = None
    name: Optional[str] = None
    description: Optional[str] = None
    short_name: Optional[str] = None
    is_default: bool = False
    order: int = 0
    list_item_traffic_light_id: Optional[str] = None
    primary_list_item_image_id: Optional[str] = None
    primary_list_item_image_url: Optional[str] = None
    primary_image_thumbnail_url: Optional[str] = None
    owner_contact_id: Optional[str] = None
    record_status: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ListModel:
    list_id: Optional[str] = None
    name: Optional[str] = None
    description: Optional[str] = None
    short_name: Optional[str] = None
    owner_contact_id: Optional[str] = None
    is_standard: bool = False
    record_status: Optional[str] = None
    default_list_item_id: Optional[str] = None
    default_list_item_name: Optional[str] = None
    has_image_for_list_item: bool = False
    has_traffic_light_for_list_item: bool = False
    list_items: Optional[List[ListItemModel]] = None
    permission_edit: bool = False
    permission_add: bool = False
    permission_delete: bool = False


# @ApiResponse(Description="List and list items")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetListResponse:
    list: Optional[ListModel] = None
    response_status: Optional[ResponseStatus] = None


# @Api(Description="Get specified list and list items")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetList:
    """
    Get specified list and list items
    """

    # @ApiMember(Description="Get list and list items for the specified list id", Name="ListId")
    list_id: Optional[str] = None
    """
    Get list and list items for the specified list id
    """

Python GetList DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /api/lists/{ListId} 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

{
	List: 
	{
		Name: String,
		Description: String,
		ShortName: String,
		IsStandard: False,
		RecordStatus: String,
		DefaultListItemName: String,
		HasImageForListItem: False,
		HasTrafficLightForListItem: False,
		ListItems: 
		[
			{
				Name: String,
				Description: String,
				ShortName: String,
				IsDefault: False,
				Order: 0,
				PrimaryListItemImageUrl: String,
				PrimaryImageThumbnailUrl: String,
				RecordStatus: String
			}
		],
		PermissionEdit: False,
		PermissionAdd: False,
		PermissionDelete: False
	},
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}