Platform API

GetDataListDetails

Get details of the specified data list

The following routes are available for this service:
All Verbs	/api/datalist/{DataListId}

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


/**
* Get details of the specified data list
*/
@Api(Description="Get details of the specified data list")
open class GetDataListDetails
{
    /**
    * 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.", IsRequired=true, Name="DataListId", ParameterType="query")
    open var DataListId:UUID? = null

    /**
    * Owner Contact Id - Licensee for Custom lists, Perspective Platform for Standard ones
    */
    @ApiMember(DataType="Guid", Description="Owner Contact Id - Licensee for Custom lists, Perspective Platform for Standard ones", IsRequired=true, Name="OwnerContactId", ParameterType="query")
    open var OwnerContactId:UUID? = null
}

@ApiResponse(Description="Details of the specified data list")
open class GetDataListDetailsResponse
{
    open var DataList: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 GetDataListDetails 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/{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","OwnerContactId":"00000000-0000-0000-0000-000000000000"}

HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"DataList":{"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"}}}