| All Verbs | /api/datalist/{DataListId} |
|---|
import Foundation
import ServiceStack
/**
* Get details of the specified data list
*/
// @Api(Description="Get details of the specified data list")
public class GetDataListDetails : 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.", IsRequired=true, Name="DataListId", ParameterType="query")
public var dataListId:String
/**
* Owner Contact Id - Licensee for Custom lists, Perspective Platform for Standard ones
*/
// @ApiMember(DataType="Guid", Description="Owner Contact Id - Licensee for Custom lists, Perspective Platform for Standard ones", IsRequired=true, Name="OwnerContactId", ParameterType="query")
public var ownerContactId:String
required public init(){}
}
// @ApiResponse(Description="Details of the specified data list")
public class GetDataListDetailsResponse : Codable
{
public var dataList: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 .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /api/datalist/{DataListId} HTTP/1.1
Host: pfapi.pstpf.com.au
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<GetDataListDetails xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
<DataListId>00000000-0000-0000-0000-000000000000</DataListId>
<OwnerContactId>00000000-0000-0000-0000-000000000000</OwnerContactId>
</GetDataListDetails>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<GetDataListDetailsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
<DataList xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eros.Saguna.Common.WebAPIModel.Models">
<d2p1:DefaultListItemId>00000000-0000-0000-0000-000000000000</d2p1:DefaultListItemId>
<d2p1:DefaultListItemName>String</d2p1:DefaultListItemName>
<d2p1:Description>String</d2p1:Description>
<d2p1:HasImageForListItem>false</d2p1:HasImageForListItem>
<d2p1:HasTrafficLightForListItem>false</d2p1:HasTrafficLightForListItem>
<d2p1:IsStandard>false</d2p1:IsStandard>
<d2p1:ListId>00000000-0000-0000-0000-000000000000</d2p1:ListId>
<d2p1:ListItems>
<d2p1:ListItemModel>
<d2p1:Description>String</d2p1:Description>
<d2p1:IsDefault>false</d2p1:IsDefault>
<d2p1:ListItemId>00000000-0000-0000-0000-000000000000</d2p1:ListItemId>
<d2p1:ListItemTrafficLightId>00000000-0000-0000-0000-000000000000</d2p1:ListItemTrafficLightId>
<d2p1:Name>String</d2p1:Name>
<d2p1:Order>0</d2p1:Order>
<d2p1:OwnerContactId>00000000-0000-0000-0000-000000000000</d2p1:OwnerContactId>
<d2p1:PrimaryImageThumbnailUrl>String</d2p1:PrimaryImageThumbnailUrl>
<d2p1:PrimaryListItemImageId>00000000-0000-0000-0000-000000000000</d2p1:PrimaryListItemImageId>
<d2p1:PrimaryListItemImageUrl>String</d2p1:PrimaryListItemImageUrl>
<d2p1:RecordStatus>String</d2p1:RecordStatus>
<d2p1:ShortName>String</d2p1:ShortName>
</d2p1:ListItemModel>
</d2p1:ListItems>
<d2p1:Name>String</d2p1:Name>
<d2p1:OwnerContactId>00000000-0000-0000-0000-000000000000</d2p1:OwnerContactId>
<d2p1:PermissionAdd>false</d2p1:PermissionAdd>
<d2p1:PermissionDelete>false</d2p1:PermissionDelete>
<d2p1:PermissionEdit>false</d2p1:PermissionEdit>
<d2p1:RecordStatus>String</d2p1:RecordStatus>
<d2p1:ShortName>String</d2p1:ShortName>
</DataList>
<ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:Message>String</d2p1:Message>
<d2p1:StackTrace>String</d2p1:StackTrace>
<d2p1:Errors>
<d2p1:ResponseError>
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:FieldName>String</d2p1:FieldName>
<d2p1:Message>String</d2p1:Message>
<d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:KeyValueOfstringstring>
<d5p1:Key>String</d5p1:Key>
<d5p1:Value>String</d5p1:Value>
</d5p1:KeyValueOfstringstring>
</d2p1:Meta>
</d2p1:ResponseError>
</d2p1:Errors>
<d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:KeyValueOfstringstring>
<d3p1:Key>String</d3p1:Key>
<d3p1:Value>String</d3p1:Value>
</d3p1:KeyValueOfstringstring>
</d2p1:Meta>
</ResponseStatus>
</GetDataListDetailsResponse>