Platform API

<back to all web services

GetRelatedItems

Get related items related to the specified object.

export enum SortOrder
{
    Ascending = 'Ascending',
    Descending = 'Descending',
}

export class PagedModel
{
    /** @description Page Number to retrieve */
    // @ApiMember(DataType="int", Description="Page Number to retrieve", Name="PageNumber")
    public PageNumber: number;

    /** @description Number of records to retrieve */
    // @ApiMember(DataType="int", Description="Number of records to retrieve", Name="PageSize")
    public PageSize: number;

    /** @description Index of field to sort results by */
    // @ApiMember(DataType="int", Description="Index of field to sort results by", Name="SortIndex")
    public SortIndex: number;

    /** @description Sort Order - Ascending or Descending */
    // @ApiMember(DataType="int", Description="Sort Order - Ascending or Descending", Name="SortOrder")
    public SortOrder: SortOrder;

    public constructor(init?: Partial<PagedModel>) { (Object as any).assign(this, init); }
}

export class RelatedItemsModel
{
    /** @description Object linked to the related item. */
    // @ApiMember(DataType="Guid", Description="Object linked to the related item.", IsRequired=true, Name="ObjectId")
    public ObjectId: string;

    /** @description Related item name. */
    // @ApiMember(DataType="string", Description="Related item name.", Name="RelatedItemName")
    public RelatedItemName: string;

    /** @description Related item type. */
    // @ApiMember(DataType="string", Description="Related item type.", Name="RelatedItemType")
    public RelatedItemType: string;

    /** @description Date of creation of the related item. */
    // @ApiMember(DataType="DateTime", Description="Date of creation of the related item.", IsRequired=true, Name="CreatedAt")
    public CreatedAt: string;

    /** @description Contact who created the related item */
    // @ApiMember(DataType="string", Description="Contact who created the related item", Name="CreatedByName")
    public CreatedByName: string;

    /** @description Contact who created the related item */
    // @ApiMember(DataType="Guid", Description="Contact who created the related item", Name="CreatedById")
    public CreatedById: string;

    /** @description Profile photo of the contact who created the related item */
    // @ApiMember(DataType="string", Description="Profile photo of the contact who created the related item", Name="CreatedByThumbnailUrl")
    public CreatedByThumbnailUrl: string;

    /** @description Relationship between objects linked to the related item */
    // @ApiMember(DataType="string", Description="Relationship between objects linked to the related item", Name="Relationship")
    public Relationship: string;

    /** @description Is the related item significant? */
    // @ApiMember(DataType="bool", Description="Is the related item significant?", IsRequired=true, Name="IsSignificant")
    public IsSignificant: boolean;

    public constructor(init?: Partial<RelatedItemsModel>) { (Object as any).assign(this, init); }
}

// @ApiResponse(Description="Items related to the object.")
export class GetRelatedItemsResponse
{
    public RelatedItems: RelatedItemsModel[];
    public TotalRelatedItems: number;
    public ResponseStatus: ResponseStatus;

    public constructor(init?: Partial<GetRelatedItemsResponse>) { (Object as any).assign(this, init); }
}

/** @description Get related items related to the specified object. */
// @Api(Description="Get related items related to the specified object.")
export class GetRelatedItems extends PagedModel
{
    /** @description Object to get related items for. */
    // @ApiMember(Description="Object to get related items for.", IsRequired=true, Name="ObjectId")
    public ObjectId: string;

    /** @description Significant Only or All */
    // @ApiMember(Description="Significant Only or All", IsRequired=true, Name="RelatedItemsLevel")
    public RelatedItemsLevel: string;

    /** @description Return all connections or paged results? */
    // @ApiMember(Description="Return all connections or paged results?", Name="IsPagedMode")
    public IsPagedMode: boolean;

    public constructor(init?: Partial<GetRelatedItems>) { super(init); (Object as any).assign(this, init); }
}

TypeScript GetRelatedItems DTOs

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>