Platform API

GetLists

Get specified lists and list items

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

import Foundation
import ServiceStack

/**
* Get specified lists and list items
*/
// @Api(Description="Get specified lists and list items")
public class GetLists : Codable
{
    /**
    * Get list and list items for the specified list ids
    */
    // @ApiMember(Description="Get list and list items for the specified list ids", Name="ListIds")
    public var listIds:[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 GetLists DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

POST /api/lists/ HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"ListIds":["00000000-0000-0000-0000-000000000000"]}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"List":{"ListId":"00000000-0000-0000-0000-000000000000","Name":"String","Description":"String","ShortName":"String","OwnerContactId":"00000000-0000-0000-0000-000000000000","IsStandard":false,"RecordStatus":"String","DefaultListItemId":"00000000-0000-0000-0000-000000000000","DefaultListItemName":"String","HasImageForListItem":false,"HasTrafficLightForListItem":false,"ListItems":[{"ListItemId":"00000000-0000-0000-0000-000000000000","Name":"String","Description":"String","ShortName":"String","IsDefault":false,"Order":0,"ListItemTrafficLightId":"00000000-0000-0000-0000-000000000000","PrimaryListItemImageId":"00000000-0000-0000-0000-000000000000","PrimaryListItemImageUrl":"String","PrimaryImageThumbnailUrl":"String","OwnerContactId":"00000000-0000-0000-0000-000000000000","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"}}}