| All Verbs | /api/relateditems/{ObjectId} |
|---|
import Foundation
import ServiceStack
/**
* Get related items related to the specified object.
*/
// @Api(Description="Get related items related to the specified object.")
public class GetRelatedItems : PagedModel
{
/**
* Object to get related items for.
*/
// @ApiMember(Description="Object to get related items for.", IsRequired=true, Name="ObjectId")
public var objectId:String
/**
* Significant Only or All
*/
// @ApiMember(Description="Significant Only or All", IsRequired=true, Name="RelatedItemsLevel")
public var relatedItemsLevel:String
/**
* Return all connections or paged results?
*/
// @ApiMember(Description="Return all connections or paged results?", Name="IsPagedMode")
public var isPagedMode:Bool
required public init(){ super.init() }
private enum CodingKeys : String, CodingKey {
case objectId
case relatedItemsLevel
case isPagedMode
}
required public init(from decoder: Decoder) throws {
try super.init(from: decoder)
let container = try decoder.container(keyedBy: CodingKeys.self)
objectId = try container.decodeIfPresent(String.self, forKey: .objectId)
relatedItemsLevel = try container.decodeIfPresent(String.self, forKey: .relatedItemsLevel)
isPagedMode = try container.decodeIfPresent(Bool.self, forKey: .isPagedMode)
}
public override func encode(to encoder: Encoder) throws {
try super.encode(to: encoder)
var container = encoder.container(keyedBy: CodingKeys.self)
if objectId != nil { try container.encode(objectId, forKey: .objectId) }
if relatedItemsLevel != nil { try container.encode(relatedItemsLevel, forKey: .relatedItemsLevel) }
if isPagedMode != nil { try container.encode(isPagedMode, forKey: .isPagedMode) }
}
}
public class PagedModel : Codable
{
/**
* Page Number to retrieve
*/
// @ApiMember(DataType="int", Description="Page Number to retrieve", Name="PageNumber")
public var pageNumber:Int
/**
* Number of records to retrieve
*/
// @ApiMember(DataType="int", Description="Number of records to retrieve", Name="PageSize")
public var pageSize:Int
/**
* Index of field to sort results by
*/
// @ApiMember(DataType="int", Description="Index of field to sort results by", Name="SortIndex")
public var sortIndex:Int
/**
* Sort Order - Ascending or Descending
*/
// @ApiMember(DataType="int", Description="Sort Order - Ascending or Descending", Name="SortOrder")
public var sortOrder:SortOrder
required public init(){}
}
public enum SortOrder : String, Codable
{
case Ascending
case Descending
}
// @ApiResponse(Description="Items related to the object.")
public class GetRelatedItemsResponse : Codable
{
public var relatedItems:[RelatedItemsModel]
public var totalRelatedItems:Int
public var responseStatus:ResponseStatus
required public init(){}
}
public class RelatedItemsModel : Codable
{
/**
* Object linked to the related item.
*/
// @ApiMember(DataType="Guid", Description="Object linked to the related item.", IsRequired=true, Name="ObjectId")
public var objectId:String
/**
* Related item name.
*/
// @ApiMember(DataType="string", Description="Related item name.", Name="RelatedItemName")
public var relatedItemName:String
/**
* Related item type.
*/
// @ApiMember(DataType="string", Description="Related item type.", Name="RelatedItemType")
public var relatedItemType:String
/**
* Date of creation of the related item.
*/
// @ApiMember(DataType="DateTime", Description="Date of creation of the related item.", IsRequired=true, Name="CreatedAt")
public var createdAt:Date
/**
* Contact who created the related item
*/
// @ApiMember(DataType="string", Description="Contact who created the related item", Name="CreatedByName")
public var createdByName:String
/**
* Contact who created the related item
*/
// @ApiMember(DataType="Guid", Description="Contact who created the related item", Name="CreatedById")
public var createdById:String
/**
* 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 var createdByThumbnailUrl:String
/**
* Relationship between objects linked to the related item
*/
// @ApiMember(DataType="string", Description="Relationship between objects linked to the related item", Name="Relationship")
public var relationship:String
/**
* Is the related item significant?
*/
// @ApiMember(DataType="bool", Description="Is the related item significant?", IsRequired=true, Name="IsSignificant")
public var isSignificant:Bool
required public init(){}
}
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>