| All Verbs | /api/relateditems/{ObjectId} |
|---|
"use strict";
/** @typedef {'Ascending'|'Descending'} */
export var SortOrder;
(function (SortOrder) {
SortOrder["Ascending"] = "Ascending"
SortOrder["Descending"] = "Descending"
})(SortOrder || (SortOrder = {}));
export class PagedModel {
/** @param {{PageNumber?:number,PageSize?:number,SortIndex?:number,SortOrder?:SortOrder}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {number}
* @description Page Number to retrieve */
PageNumber;
/**
* @type {number}
* @description Number of records to retrieve */
PageSize;
/**
* @type {number}
* @description Index of field to sort results by */
SortIndex;
/**
* @type {SortOrder}
* @description Sort Order - Ascending or Descending */
SortOrder;
}
export class RelatedItemsModel {
/** @param {{ObjectId?:string,RelatedItemName?:string,RelatedItemType?:string,CreatedAt?:string,CreatedByName?:string,CreatedById?:string,CreatedByThumbnailUrl?:string,Relationship?:string,IsSignificant?:boolean}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {string}
* @description Object linked to the related item. */
ObjectId;
/**
* @type {string}
* @description Related item name. */
RelatedItemName;
/**
* @type {string}
* @description Related item type. */
RelatedItemType;
/**
* @type {string}
* @description Date of creation of the related item. */
CreatedAt;
/**
* @type {string}
* @description Contact who created the related item */
CreatedByName;
/**
* @type {string}
* @description Contact who created the related item */
CreatedById;
/**
* @type {string}
* @description Profile photo of the contact who created the related item */
CreatedByThumbnailUrl;
/**
* @type {string}
* @description Relationship between objects linked to the related item */
Relationship;
/**
* @type {boolean}
* @description Is the related item significant? */
IsSignificant;
}
export class GetRelatedItemsResponse {
/** @param {{RelatedItems?:RelatedItemsModel[],TotalRelatedItems?:number,ResponseStatus?:ResponseStatus}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {RelatedItemsModel[]} */
RelatedItems;
/** @type {number} */
TotalRelatedItems;
/** @type {ResponseStatus} */
ResponseStatus;
}
export class GetRelatedItems extends PagedModel {
/** @param {{ObjectId?:string,RelatedItemsLevel?:string,IsPagedMode?:boolean,PageNumber?:number,PageSize?:number,SortIndex?:number,SortOrder?:SortOrder}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/**
* @type {string}
* @description Object to get related items for. */
ObjectId;
/**
* @type {string}
* @description Significant Only or All */
RelatedItemsLevel;
/**
* @type {boolean}
* @description Return all connections or paged results? */
IsPagedMode;
}
JavaScript GetRelatedItems 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/relateditems/{ObjectId} HTTP/1.1
Host: pfapi.pstpf.com.au
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<GetRelatedItems xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
<PageNumber xmlns="http://schemas.datacontract.org/2004/07/Eros.Saguna.Common.WebAPIModel.Models">0</PageNumber>
<PageSize xmlns="http://schemas.datacontract.org/2004/07/Eros.Saguna.Common.WebAPIModel.Models">0</PageSize>
<SortIndex xmlns="http://schemas.datacontract.org/2004/07/Eros.Saguna.Common.WebAPIModel.Models">0</SortIndex>
<SortOrder xmlns="http://schemas.datacontract.org/2004/07/Eros.Saguna.Common.WebAPIModel.Models">Ascending</SortOrder>
<IsPagedMode>false</IsPagedMode>
<ObjectId>00000000-0000-0000-0000-000000000000</ObjectId>
<RelatedItemsLevel>00000000-0000-0000-0000-000000000000</RelatedItemsLevel>
</GetRelatedItems>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<GetRelatedItemsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
<RelatedItems xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eros.Saguna.Common.WebAPIModel.Models">
<d2p1:RelatedItemsModel>
<d2p1:CreatedAt>0001-01-01T00:00:00</d2p1:CreatedAt>
<d2p1:CreatedById>00000000-0000-0000-0000-000000000000</d2p1:CreatedById>
<d2p1:CreatedByName>String</d2p1:CreatedByName>
<d2p1:CreatedByThumbnailUrl>String</d2p1:CreatedByThumbnailUrl>
<d2p1:IsSignificant>false</d2p1:IsSignificant>
<d2p1:ObjectId>00000000-0000-0000-0000-000000000000</d2p1:ObjectId>
<d2p1:RelatedItemName>String</d2p1:RelatedItemName>
<d2p1:RelatedItemType>String</d2p1:RelatedItemType>
<d2p1:Relationship>String</d2p1:Relationship>
</d2p1:RelatedItemsModel>
</RelatedItems>
<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>
<TotalRelatedItems>0</TotalRelatedItems>
</GetRelatedItemsResponse>