Platform API

<back to all web services

GetListItem

Get details of the specified list item

Requires Authentication
The following routes are available for this service:
All Verbs/api/listitems/{ListItemId}
import Foundation
import ServiceStack

/**
* Get details of the specified list item
*/
// @Api(Description="Get details of the specified list item")
public class GetListItem : Codable
{
    /**
    * 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 var listItemId:String

    required public init(){}
}

// @ApiResponse(Description="List item details")
public class GetListItemResponse : Codable
{
    public var listItem:ListItemModel
    public var responseStatus:ResponseStatus

    required public init(){}
}

public class ListItemModel : Codable
{
    public var listItemId:String
    public var name:String
    public var Description:String
    public var shortName:String
    public var isDefault:Bool
    public var order:Int
    public var listItemTrafficLightId:String
    public var primaryListItemImageId:String
    public var primaryListItemImageUrl:String
    public var primaryImageThumbnailUrl:String
    public var ownerContactId:String
    public var recordStatus:String

    required public init(){}
}

Swift GetListItem DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: application/json
Content-Type: application/json
Content-Length: length

{"ListItemId":"00000000-0000-0000-0000-000000000000"}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

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