Platform API

GetLists

Get specified lists and list items

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

import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


/**
* Get specified lists and list items
*/
@Api(Description="Get specified lists and list items")
open class GetLists
{
    /**
    * Get list and list items for the specified list ids
    */
    @ApiMember(Description="Get list and list items for the specified list ids", Name="ListIds")
    open var ListIds:ArrayList<UUID>? = null
}

@ApiResponse(Description="List and list items")
open class GetListResponse
{
    open var List:ListModel? = null
    open var ResponseStatus:ResponseStatus? = null
}

open class ListModel
{
    open var ListId:UUID? = null
    open var Name:String? = null
    open var Description:String? = null
    open var ShortName:String? = null
    open var OwnerContactId:UUID? = null
    open var IsStandard:Boolean? = null
    open var RecordStatus:String? = null
    open var DefaultListItemId:UUID? = null
    open var DefaultListItemName:String? = null
    open var HasImageForListItem:Boolean? = null
    open var HasTrafficLightForListItem:Boolean? = null
    open var ListItems:ArrayList<ListItemModel>? = null
    open var PermissionEdit:Boolean? = null
    open var PermissionAdd:Boolean? = null
    open var PermissionDelete:Boolean? = null
}

open class ListItemModel
{
    open var ListItemId:UUID? = null
    open var Name:String? = null
    open var Description:String? = null
    open var ShortName:String? = null
    open var IsDefault:Boolean? = null
    open var Order:Int? = null
    open var ListItemTrafficLightId:UUID? = null
    open var PrimaryListItemImageId:UUID? = null
    open var PrimaryListItemImageUrl:String? = null
    open var PrimaryImageThumbnailUrl:String? = null
    open var OwnerContactId:UUID? = null
    open var RecordStatus:String? = null
}

Kotlin GetLists DTOs

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

HTTP + CSV

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: text/csv
Content-Type: text/csv
Content-Length: length

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

HTTP/1.1 200 OK
Content-Type: text/csv
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"}}}