| All Verbs | /api/relateditems/{ObjectId} |
|---|
namespace Eros.Subtle.Canvara.WebAPIModel.ServiceModel
open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
[<AllowNullLiteral>]
type RelatedItemsModel() =
///<summary>
///Object linked to the related item.
///</summary>
[<ApiMember(DataType="Guid", Description="Object linked to the related item.", IsRequired=true, Name="ObjectId")>]
member val ObjectId:Guid = new Guid() with get,set
///<summary>
///Related item name.
///</summary>
[<ApiMember(DataType="string", Description="Related item name.", Name="RelatedItemName")>]
member val RelatedItemName:String = null with get,set
///<summary>
///Related item type.
///</summary>
[<ApiMember(DataType="string", Description="Related item type.", Name="RelatedItemType")>]
member val RelatedItemType:String = null with 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")>]
member val CreatedAt:DateTime = new DateTime() with get,set
///<summary>
///Contact who created the related item
///</summary>
[<ApiMember(DataType="string", Description="Contact who created the related item", Name="CreatedByName")>]
member val CreatedByName:String = null with get,set
///<summary>
///Contact who created the related item
///</summary>
[<ApiMember(DataType="Guid", Description="Contact who created the related item", Name="CreatedById")>]
member val CreatedById:Guid = new Guid() with 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")>]
member val CreatedByThumbnailUrl:String = null with 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")>]
member val Relationship:String = null with get,set
///<summary>
///Is the related item significant?
///</summary>
[<ApiMember(DataType="bool", Description="Is the related item significant?", IsRequired=true, Name="IsSignificant")>]
member val IsSignificant:Boolean = new Boolean() with get,set
[<ApiResponse(Description="Items related to the object.")>]
[<AllowNullLiteral>]
type GetRelatedItemsResponse() =
member val RelatedItems:ResizeArray<RelatedItemsModel> = null with get,set
member val TotalRelatedItems:Int32 = new Int32() with get,set
member val ResponseStatus:ResponseStatus = null with get,set
type SortOrder =
| Ascending = 0
| Descending = 1
[<AllowNullLiteral>]
type PagedModel() =
///<summary>
///Page Number to retrieve
///</summary>
[<ApiMember(DataType="int", Description="Page Number to retrieve", Name="PageNumber")>]
member val PageNumber:Int32 = new Int32() with get,set
///<summary>
///Number of records to retrieve
///</summary>
[<ApiMember(DataType="int", Description="Number of records to retrieve", Name="PageSize")>]
member val PageSize:Int32 = new Int32() with get,set
///<summary>
///Index of field to sort results by
///</summary>
[<ApiMember(DataType="int", Description="Index of field to sort results by", Name="SortIndex")>]
member val SortIndex:Int32 = new Int32() with get,set
///<summary>
///Sort Order - Ascending or Descending
///</summary>
[<ApiMember(DataType="int", Description="Sort Order - Ascending or Descending", Name="SortOrder")>]
member val SortOrder:SortOrder = new SortOrder() with get,set
///<summary>
///Get related items related to the specified object.
///</summary>
[<Api(Description="Get related items related to the specified object.")>]
[<AllowNullLiteral>]
type GetRelatedItems() =
inherit PagedModel()
///<summary>
///Object to get related items for.
///</summary>
[<ApiMember(Description="Object to get related items for.", IsRequired=true, Name="ObjectId")>]
member val ObjectId:Guid = new Guid() with get,set
///<summary>
///Significant Only or All
///</summary>
[<ApiMember(Description="Significant Only or All", IsRequired=true, Name="RelatedItemsLevel")>]
member val RelatedItemsLevel:Guid = new Guid() with get,set
///<summary>
///Return all connections or paged results?
///</summary>
[<ApiMember(Description="Return all connections or paged results?", Name="IsPagedMode")>]
member val IsPagedMode:Boolean = new Boolean() with get,set
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>