| All Verbs | /api/datalist/items/{DataListId} |
|---|
import Foundation
import ServiceStack
/**
* Get list items of the specified data list
*/
// @Api(Description="Get list items of the specified data list")
public class GetListItemsForList : Codable
{
/**
* 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.", Name="DataListId")
public var dataListId:String
required public init(){}
}
// @ApiResponse(Description="List items for a list")
public class GetListItemsResponse : Codable
{
public var listItems:[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 GetListItemsForList DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /api/datalist/items/{DataListId} HTTP/1.1
Host: pfapi.pstpf.com.au
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"DataListId":"00000000-0000-0000-0000-000000000000"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"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"}],"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}