| All Verbs | /api/datalists/ |
|---|
import Foundation
import ServiceStack
/**
* 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")
public class GetDataLists : Codable
{
/**
* Licensee requested Custom data lists belong to.
*/
// @ApiMember(DataType="Guid?", Description="Licensee requested Custom data lists belong to.", Name="LicenseeId", ParameterType="query")
public var licenseeId:String?
/**
* Specific text to search for.
*/
// @ApiMember(DataType="string", Description="Specific text to search for.", Name="SearchText", ParameterType="query")
public var searchText:String
required public init(){}
}
// @ApiResponse(Description="Custom data lists for a licensee, as well as standard data lists")
public class GetDataListsResponse : Codable
{
public var lists:[ListModel]
public var responseStatus:ResponseStatus
required public init(){}
}
public class ListModel : Codable
{
public var listId:String
public var name:String
public var Description:String
public var shortName:String
public var ownerContactId:String
public var isStandard:Bool
public var recordStatus:String
public var defaultListItemId:String
public var defaultListItemName:String
public var hasImageForListItem:Bool
public var hasTrafficLightForListItem:Bool
public var listItems:[ListItemModel]
public var permissionEdit:Bool
public var permissionAdd:Bool
public var permissionDelete:Bool
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(){}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
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/jsonl
Content-Type: text/jsonl
Content-Length: length
{"LicenseeId":"00000000000000000000000000000000","SearchText":"String"}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length
{"Lists":[{"ListId":"00000000-0000-0000-0000-000000000000","Name":"String","Description":"String","ShortName":"String","OwnerContactId":"00000000-0000-0000-0000-000000000000","IsStandard":false,"RecordStatus":"String","DefaultListItemId":"00000000-0000-0000-0000-000000000000","DefaultListItemName":"String","HasImageForListItem":false,"HasTrafficLightForListItem":false,"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"}],"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"}}}