Platform API

<back to all web services

GetRelatedItems

Get related items related to the specified object.

using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Eros.Subtle.Canvara.WebAPIModel.ServiceModel;
using Eros.Saguna.Common.WebAPIModel.Models;

namespace Eros.Saguna.Common.WebAPIModel.Models
{
    public partial class PagedModel
    {
        ///<summary>
        ///Page Number to retrieve
        ///</summary>
        [ApiMember(DataType="int", Description="Page Number to retrieve", Name="PageNumber")]
        public virtual int PageNumber { get; set; }

        ///<summary>
        ///Number of records to retrieve
        ///</summary>
        [ApiMember(DataType="int", Description="Number of records to retrieve", Name="PageSize")]
        public virtual int PageSize { get; set; }

        ///<summary>
        ///Index of field to sort results by
        ///</summary>
        [ApiMember(DataType="int", Description="Index of field to sort results by", Name="SortIndex")]
        public virtual int SortIndex { get; set; }

        ///<summary>
        ///Sort Order - Ascending or Descending
        ///</summary>
        [ApiMember(DataType="int", Description="Sort Order - Ascending or Descending", Name="SortOrder")]
        public virtual SortOrder SortOrder { get; set; }
    }

    public partial class RelatedItemsModel
    {
        ///<summary>
        ///Object linked to the related item.
        ///</summary>
        [ApiMember(DataType="Guid", Description="Object linked to the related item.", IsRequired=true, Name="ObjectId")]
        public virtual Guid ObjectId { get; set; }

        ///<summary>
        ///Related item name.
        ///</summary>
        [ApiMember(DataType="string", Description="Related item name.", Name="RelatedItemName")]
        public virtual string RelatedItemName { get; set; }

        ///<summary>
        ///Related item type.
        ///</summary>
        [ApiMember(DataType="string", Description="Related item type.", Name="RelatedItemType")]
        public virtual string RelatedItemType { get; set; }

        ///<summary>
        ///Date of creation of the related item.
        ///</summary>
        [ApiMember(DataType="DateTime", Description="Date of creation of the related item.", IsRequired=true, Name="CreatedAt")]
        public virtual DateTime CreatedAt { get; set; }

        ///<summary>
        ///Contact who created the related item
        ///</summary>
        [ApiMember(DataType="string", Description="Contact who created the related item", Name="CreatedByName")]
        public virtual string CreatedByName { get; set; }

        ///<summary>
        ///Contact who created the related item
        ///</summary>
        [ApiMember(DataType="Guid", Description="Contact who created the related item", Name="CreatedById")]
        public virtual Guid CreatedById { get; set; }

        ///<summary>
        ///Profile photo of the contact who created the related item
        ///</summary>
        [ApiMember(DataType="string", Description="Profile photo of the contact who created the related item", Name="CreatedByThumbnailUrl")]
        public virtual string CreatedByThumbnailUrl { get; set; }

        ///<summary>
        ///Relationship between objects linked to the related item
        ///</summary>
        [ApiMember(DataType="string", Description="Relationship between objects linked to the related item", Name="Relationship")]
        public virtual string Relationship { get; set; }

        ///<summary>
        ///Is the related item significant?
        ///</summary>
        [ApiMember(DataType="bool", Description="Is the related item significant?", IsRequired=true, Name="IsSignificant")]
        public virtual bool IsSignificant { get; set; }
    }

    public enum SortOrder
    {
        Ascending,
        Descending,
    }

}

namespace Eros.Subtle.Canvara.WebAPIModel.ServiceModel
{
    ///<summary>
    ///Get related items related to the specified object.
    ///</summary>
    [Api(Description="Get related items related to the specified object.")]
    public partial class GetRelatedItems
        : PagedModel
    {
        ///<summary>
        ///Object to get related items for.
        ///</summary>
        [ApiMember(Description="Object to get related items for.", IsRequired=true, Name="ObjectId")]
        public virtual Guid ObjectId { get; set; }

        ///<summary>
        ///Significant Only or All
        ///</summary>
        [ApiMember(Description="Significant Only or All", IsRequired=true, Name="RelatedItemsLevel")]
        public virtual Guid RelatedItemsLevel { get; set; }

        ///<summary>
        ///Return all connections or paged results?
        ///</summary>
        [ApiMember(Description="Return all connections or paged results?", Name="IsPagedMode")]
        public virtual bool IsPagedMode { get; set; }
    }

    [ApiResponse(Description="Items related to the object.")]
    public partial class GetRelatedItemsResponse
    {
        public virtual List<RelatedItemsModel> RelatedItems { get; set; }
        public virtual int TotalRelatedItems { get; set; }
        public virtual ResponseStatus ResponseStatus { get; set; }
    }

}

C# GetRelatedItems DTOs

POST /api/relateditems/{ObjectId} HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	IsPagedMode: False,
	PageNumber: 0,
	PageSize: 0,
	SortIndex: 0,
	SortOrder: Ascending
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	RelatedItems: 
	[
		{
			RelatedItemName: String,
			RelatedItemType: String,
			CreatedAt: 0001-01-01,
			CreatedByName: String,
			CreatedByThumbnailUrl: String,
			Relationship: String,
			IsSignificant: False
		}
	],
	TotalRelatedItems: 0,
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}