Platform API

GetList

Get specified list and list items

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

import Foundation
import ServiceStack

/**
* Get specified list and list items
*/
// @Api(Description="Get specified list and list items")
public class GetList : Codable
{
    /**
    * Get list and list items for the specified list id
    */
    // @ApiMember(Description="Get list and list items for the specified list id", Name="ListId")
    public var listId:String

    required public init(){}
}

// @ApiResponse(Description="List and list items")
public class GetListResponse : Codable
{
    public var list:ListModel
    public var responseStatus:ResponseStatus

    required public init(){}
}

public class ListModel : Codable
{
    public var listId:String
    public var name:String
    public var Description:String
    public var shortName:String
    public var ownerContactId:String
    public var isStandard:Bool
    public var recordStatus:String
    public var defaultListItemId:String
    public var defaultListItemName:String
    public var hasImageForListItem:Bool
    public var hasTrafficLightForListItem:Bool
    public var listItems:[ListItemModel]
    public var permissionEdit:Bool
    public var permissionAdd:Bool
    public var permissionDelete:Bool

    required public init(){}
}

public class ListItemModel : Codable
{
    public var listItemId:String
    public var name:String
    public var Description:String
    public var shortName:String
    public var isDefault:Bool
    public var order:Int
    public var listItemTrafficLightId:String
    public var primaryListItemImageId:String
    public var primaryListItemImageUrl:String
    public var primaryImageThumbnailUrl:String
    public var ownerContactId:String
    public var recordStatus:String

    required public init(){}
}

Swift 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
		}
	}
}