| All Verbs | /api/datalist/{DataListId} |
|---|
"use strict";
export class ListItemModel {
/** @param {{ListItemId?:string,Name?:string,Description?:string,ShortName?:string,IsDefault?:boolean,Order?:number,ListItemTrafficLightId?:string,PrimaryListItemImageId?:string,PrimaryListItemImageUrl?:string,PrimaryImageThumbnailUrl?:string,OwnerContactId?:string,RecordStatus?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
ListItemId;
/** @type {string} */
Name;
/** @type {string} */
Description;
/** @type {string} */
ShortName;
/** @type {boolean} */
IsDefault;
/** @type {number} */
Order;
/** @type {string} */
ListItemTrafficLightId;
/** @type {string} */
PrimaryListItemImageId;
/** @type {string} */
PrimaryListItemImageUrl;
/** @type {string} */
PrimaryImageThumbnailUrl;
/** @type {string} */
OwnerContactId;
/** @type {string} */
RecordStatus;
}
export class ListModel {
/** @param {{ListId?:string,Name?:string,Description?:string,ShortName?:string,OwnerContactId?:string,IsStandard?:boolean,RecordStatus?:string,DefaultListItemId?:string,DefaultListItemName?:string,HasImageForListItem?:boolean,HasTrafficLightForListItem?:boolean,ListItems?:ListItemModel[],PermissionEdit?:boolean,PermissionAdd?:boolean,PermissionDelete?:boolean}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
ListId;
/** @type {string} */
Name;
/** @type {string} */
Description;
/** @type {string} */
ShortName;
/** @type {string} */
OwnerContactId;
/** @type {boolean} */
IsStandard;
/** @type {string} */
RecordStatus;
/** @type {string} */
DefaultListItemId;
/** @type {string} */
DefaultListItemName;
/** @type {boolean} */
HasImageForListItem;
/** @type {boolean} */
HasTrafficLightForListItem;
/** @type {ListItemModel[]} */
ListItems;
/** @type {boolean} */
PermissionEdit;
/** @type {boolean} */
PermissionAdd;
/** @type {boolean} */
PermissionDelete;
}
export class GetDataListDetailsResponse {
/** @param {{DataList?:ListModel,ResponseStatus?:ResponseStatus}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {ListModel} */
DataList;
/** @type {ResponseStatus} */
ResponseStatus;
}
export class GetDataListDetails {
/** @param {{DataListId?:string,OwnerContactId?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {string}
* @description The Data List Guid. Records retrieved will belong to this data list. */
DataListId;
/**
* @type {string}
* @description Owner Contact Id - Licensee for Custom lists, Perspective Platform for Standard ones */
OwnerContactId;
}
JavaScript GetDataListDetails DTOs
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>