Platform API

GetListItem

Get details of the specified list item

The following routes are available for this service:
All Verbs	/api/listitems/{ListItemId}

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

public class dtos
{

    /**
    * Get details of the specified list item
    */
    @Api(Description="Get details of the specified list item")
    public static class GetListItem
    {
        /**
        * List item id to retrieve details for
        */
        @ApiMember(DataType="Guid", Description="List item id to retrieve details for", IsRequired=true, Name="ListItemId", ParameterType="query")
        public UUID ListItemId = null;
        
        public UUID getListItemId() { return ListItemId; }
        public GetListItem setListItemId(UUID value) { this.ListItemId = value; return this; }
    }

    @ApiResponse(Description="List item details")
    public static class GetListItemResponse
    {
        public ListItemModel ListItem = null;
        public ResponseStatus ResponseStatus = null;
        
        public ListItemModel getListItem() { return ListItem; }
        public GetListItemResponse setListItem(ListItemModel value) { this.ListItem = value; return this; }
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public GetListItemResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
    }

    public static class ListItemModel
    {
        public UUID ListItemId = null;
        public String Name = null;
        public String Description = null;
        public String ShortName = null;
        public Boolean IsDefault = null;
        public Integer Order = null;
        public UUID ListItemTrafficLightId = null;
        public UUID PrimaryListItemImageId = null;
        public String PrimaryListItemImageUrl = null;
        public String PrimaryImageThumbnailUrl = null;
        public UUID OwnerContactId = null;
        public String RecordStatus = null;
        
        public UUID getListItemId() { return ListItemId; }
        public ListItemModel setListItemId(UUID value) { this.ListItemId = value; return this; }
        public String getName() { return Name; }
        public ListItemModel setName(String value) { this.Name = value; return this; }
        public String getDescription() { return Description; }
        public ListItemModel setDescription(String value) { this.Description = value; return this; }
        public String getShortName() { return ShortName; }
        public ListItemModel setShortName(String value) { this.ShortName = value; return this; }
        public Boolean getIsDefault() { return IsDefault; }
        public ListItemModel setIsDefault(Boolean value) { this.IsDefault = value; return this; }
        public Integer getOrder() { return Order; }
        public ListItemModel setOrder(Integer value) { this.Order = value; return this; }
        public UUID getListItemTrafficLightId() { return ListItemTrafficLightId; }
        public ListItemModel setListItemTrafficLightId(UUID value) { this.ListItemTrafficLightId = value; return this; }
        public UUID getPrimaryListItemImageId() { return PrimaryListItemImageId; }
        public ListItemModel setPrimaryListItemImageId(UUID value) { this.PrimaryListItemImageId = value; return this; }
        public String getPrimaryListItemImageUrl() { return PrimaryListItemImageUrl; }
        public ListItemModel setPrimaryListItemImageUrl(String value) { this.PrimaryListItemImageUrl = value; return this; }
        public String getPrimaryImageThumbnailUrl() { return PrimaryImageThumbnailUrl; }
        public ListItemModel setPrimaryImageThumbnailUrl(String value) { this.PrimaryImageThumbnailUrl = value; return this; }
        public UUID getOwnerContactId() { return OwnerContactId; }
        public ListItemModel setOwnerContactId(UUID value) { this.OwnerContactId = value; return this; }
        public String getRecordStatus() { return RecordStatus; }
        public ListItemModel setRecordStatus(String value) { this.RecordStatus = value; return this; }
    }

}

Java GetListItem 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/listitems/{ListItemId} HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	
}

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

{
	ListItem: 
	{
		Name: String,
		Description: String,
		ShortName: String,
		IsDefault: False,
		Order: 0,
		PrimaryListItemImageUrl: String,
		PrimaryImageThumbnailUrl: String,
		RecordStatus: String
	},
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}