Platform API

GetRelatedItems

Get related items related to the specified object.

The following routes are available for this service:
All Verbs	/api/relateditems/{ObjectId}

**GetRelatedItems** Parameters:
Name	Parameter	Data Type	Required	Description
ObjectId	path	Guid	Yes	Object to get related items for.
RelatedItemsLevel	query	Guid	Yes	Significant Only or All
IsPagedMode	query	bool	No	Return all connections or paged results?

**PagedModel** Parameters:
Name	Parameter	Data Type	Required	Description
PageNumber	form	int	No	Page Number to retrieve
PageSize	form	int	No	Number of records to retrieve
SortIndex	form	int	No	Index of field to sort results by
SortOrder	form	int	No	Sort Order - Ascending or Descending

**SortOrder** Enum:
Ascending
Descending

**GetRelatedItemsResponse** Parameters:
Name	Parameter	Data Type	Required
RelatedItems	form	List<RelatedItemsModel>	No
TotalRelatedItems	form	int	No
ResponseStatus	form	ResponseStatus	No

**RelatedItemsModel** Parameters:
Name	Parameter	Data Type	Required	Description
ObjectId	form	Guid	Yes	Object linked to the related item.
RelatedItemName	form	string	No	Related item name.
RelatedItemType	form	string	No	Related item type.
CreatedAt	form	DateTime	Yes	Date of creation of the related item.
CreatedByName	form	string	No	Contact who created the related item
CreatedById	form	Guid	No	Contact who created the related item
CreatedByThumbnailUrl	form	string	No	Profile photo of the contact who created the related item
Relationship	form	string	No	Relationship between objects linked to the related item
IsSignificant	form	bool	Yes	Is the related item significant?

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + 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>