| All Verbs | /api/datalists/ |
|---|
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;
public class dtos
{
/**
* 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 static class GetDataLists
{
/**
* Licensee requested Custom data lists belong to.
*/
@ApiMember(DataType="Guid?", Description="Licensee requested Custom data lists belong to.", Name="LicenseeId", ParameterType="query")
public UUID LicenseeId = null;
/**
* Specific text to search for.
*/
@ApiMember(DataType="string", Description="Specific text to search for.", Name="SearchText", ParameterType="query")
public String SearchText = null;
public UUID getLicenseeId() { return LicenseeId; }
public GetDataLists setLicenseeId(UUID value) { this.LicenseeId = value; return this; }
public String getSearchText() { return SearchText; }
public GetDataLists setSearchText(String value) { this.SearchText = value; return this; }
}
@ApiResponse(Description="Custom data lists for a licensee, as well as standard data lists")
public static class GetDataListsResponse
{
public ArrayList<ListModel> Lists = null;
public ResponseStatus ResponseStatus = null;
public ArrayList<ListModel> getLists() { return Lists; }
public GetDataListsResponse setLists(ArrayList<ListModel> value) { this.Lists = value; return this; }
public ResponseStatus getResponseStatus() { return ResponseStatus; }
public GetDataListsResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
}
public static class ListModel
{
public UUID ListId = null;
public String Name = null;
public String Description = null;
public String ShortName = null;
public UUID OwnerContactId = null;
public Boolean IsStandard = null;
public String RecordStatus = null;
public UUID DefaultListItemId = null;
public String DefaultListItemName = null;
public Boolean HasImageForListItem = null;
public Boolean HasTrafficLightForListItem = null;
public ArrayList<ListItemModel> ListItems = null;
public Boolean PermissionEdit = null;
public Boolean PermissionAdd = null;
public Boolean PermissionDelete = null;
public UUID getListId() { return ListId; }
public ListModel setListId(UUID value) { this.ListId = value; return this; }
public String getName() { return Name; }
public ListModel setName(String value) { this.Name = value; return this; }
public String getDescription() { return Description; }
public ListModel setDescription(String value) { this.Description = value; return this; }
public String getShortName() { return ShortName; }
public ListModel setShortName(String value) { this.ShortName = value; return this; }
public UUID getOwnerContactId() { return OwnerContactId; }
public ListModel setOwnerContactId(UUID value) { this.OwnerContactId = value; return this; }
public Boolean getIsStandard() { return IsStandard; }
public ListModel setIsStandard(Boolean value) { this.IsStandard = value; return this; }
public String getRecordStatus() { return RecordStatus; }
public ListModel setRecordStatus(String value) { this.RecordStatus = value; return this; }
public UUID getDefaultListItemId() { return DefaultListItemId; }
public ListModel setDefaultListItemId(UUID value) { this.DefaultListItemId = value; return this; }
public String getDefaultListItemName() { return DefaultListItemName; }
public ListModel setDefaultListItemName(String value) { this.DefaultListItemName = value; return this; }
public Boolean isHasImageForListItem() { return HasImageForListItem; }
public ListModel setHasImageForListItem(Boolean value) { this.HasImageForListItem = value; return this; }
public Boolean isHasTrafficLightForListItem() { return HasTrafficLightForListItem; }
public ListModel setHasTrafficLightForListItem(Boolean value) { this.HasTrafficLightForListItem = value; return this; }
public ArrayList<ListItemModel> getListItems() { return ListItems; }
public ListModel setListItems(ArrayList<ListItemModel> value) { this.ListItems = value; return this; }
public Boolean isPermissionEdit() { return PermissionEdit; }
public ListModel setPermissionEdit(Boolean value) { this.PermissionEdit = value; return this; }
public Boolean isPermissionAdd() { return PermissionAdd; }
public ListModel setPermissionAdd(Boolean value) { this.PermissionAdd = value; return this; }
public Boolean isPermissionDelete() { return PermissionDelete; }
public ListModel setPermissionDelete(Boolean value) { this.PermissionDelete = 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; }
}
}
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/datalists/ HTTP/1.1
Host: pfapi.pstpf.com.au
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"LicenseeId":"00000000000000000000000000000000","SearchText":"String"}
HTTP/1.1 200 OK
Content-Type: text/csv
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"}}}