Platform API

GetDataLists

Get custom data lists for a licensee, as well as standard data lists

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

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


/**
* Get custom data lists for a licensee, as well as standard data lists
*/
@Api(Description="Get custom data lists for a licensee, as well as standard data lists")
open class GetDataLists
{
    /**
    * Licensee requested Custom data lists belong to.
    */
    @ApiMember(DataType="Guid?", Description="Licensee requested Custom data lists belong to.", Name="LicenseeId", ParameterType="query")
    open var LicenseeId:UUID? = null

    /**
    * Specific text to search for.
    */
    @ApiMember(DataType="string", Description="Specific text to search for.", Name="SearchText", ParameterType="query")
    open var SearchText:String? = null
}

@ApiResponse(Description="Custom data lists for a licensee, as well as standard data lists")
open class GetDataListsResponse
{
    open var Lists:ArrayList<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 GetDataLists 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/datalists/ HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	LicenseeId: 00000000000000000000000000000000,
	SearchText: String
}

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

{
	Lists: 
	[
		{
			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
		}
	}
}