Platform API

<back to all web services

GetListItemsForList

Get list items of the specified data list

Requires Authentication
The following routes are available for this service:
All Verbs/api/datalist/items/{DataListId}
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


/**
* Get list items of the specified data list
*/
@Api(Description="Get list items of the specified data list")
open class GetListItemsForList
{
    /**
    * The Data List Guid. Records retrieved will belong to this data list.
    */
    @ApiMember(DataType="Guid", Description="The Data List Guid. Records retrieved will belong to this data list.", Name="DataListId")
    open var DataListId:UUID? = null
}

@ApiResponse(Description="List items for a list")
open class GetListItemsResponse
{
    open var ListItems:ArrayList<ListItemModel>? = null
    open var ResponseStatus:ResponseStatus? = 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 GetListItemsForList DTOs

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

HTTP + OTHER

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

POST /api/datalist/items/{DataListId} HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"DataListId":"00000000-0000-0000-0000-000000000000"}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"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"}],"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}