| GET | /api/objects/{RmsTableCtxIdConnectionMethod}/connectionsFrom/{FromObjectId} | ||
|---|---|---|---|
| GET | /api/objects/{RmsTableCtxIdConnectionMethod}/connectionsTo/{ToObjectId} |
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Eros.Saguna.Common.WebAPIModel.ServiceModels;
using Eros.Saguna.Common.WebAPIModel.Models;
namespace Eros.Saguna.Common.WebAPIModel.Models
{
public partial class ObjectConnectionModel
{
public virtual Guid ObjectConnectionId { get; set; }
public virtual Guid ObjectIdFrom { get; set; }
public virtual string ObjectFromReference { get; set; }
public virtual string ObjectToReference { get; set; }
public virtual Guid ObjectIdTo { get; set; }
public virtual Guid ConnectionMethodId { get; set; }
public virtual string ObjectFromName { get; set; }
public virtual string ObjectToName { get; set; }
public virtual string RecordStatus { get; set; }
}
}
namespace Eros.Saguna.Common.WebAPIModel.ServiceModels
{
///<summary>
///Get object connections for the specified object and connection method.
///</summary>
[Api(Description="Get object connections for the specified object and connection method.")]
public partial class GetObjectConnections
{
///<summary>
///'From' object ID in the connection.
///</summary>
[ApiMember(DataType="Guid", Description="'From' object ID in the connection.", IsRequired=true, Name="FromObjectId", ParameterType="query")]
public virtual Guid FromObjectId { get; set; }
///<summary>
///'To' object ID in the connection.
///</summary>
[ApiMember(DataType="Guid", Description="'To' object ID in the connection.", IsRequired=true, Name="ToObjectId", ParameterType="query")]
public virtual Guid ToObjectId { get; set; }
///<summary>
///Guid representing the Connection Method to use to connect the objects with.
///</summary>
[ApiMember(DataType="Guid", Description="Guid representing the Connection Method to use to connect the objects with.", IsRequired=true, Name="RmsTableCtxIdConnectionMethod", ParameterType="query")]
public virtual Guid RmsTableCtxIdConnectionMethod { get; set; }
///<summary>
///Status of object Connections to retrieve, if not specified active connections are retrieved by default.
///</summary>
[ApiMember(DataType="string", Description="Status of object Connections to retrieve, if not specified active connections are retrieved by default.", Name="RecordStatus", ParameterType="query")]
public virtual string RecordStatus { get; set; }
}
[ApiResponse(Description="Returns the connections for the specified object.")]
public partial class GetObjectConnectionsResponse
{
public virtual List<ObjectConnectionModel> ObjectConnections { get; set; }
public virtual ResponseStatus ResponseStatus { get; set; }
}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /api/objects/{RmsTableCtxIdConnectionMethod}/connectionsFrom/{FromObjectId} HTTP/1.1
Host: pfapi.pstpf.com.au
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"ObjectConnections":[{"ObjectConnectionId":"00000000-0000-0000-0000-000000000000","ObjectIdFrom":"00000000-0000-0000-0000-000000000000","ObjectFromReference":"String","ObjectToReference":"String","ObjectIdTo":"00000000-0000-0000-0000-000000000000","ConnectionMethodId":"00000000-0000-0000-0000-000000000000","ObjectFromName":"String","ObjectToName":"String","RecordStatus":"String"}],"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}