| All Verbs | /api/listitems/{ListItemId} |
|---|
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*
/**
* Get details of the specified list item
*/
@Api(Description="Get details of the specified list item")
open 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")
open var ListItemId:UUID? = null
}
@ApiResponse(Description="List item details")
open class GetListItemResponse
{
open var ListItem: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
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=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
}
}
}