| All Verbs | /api/objectsubscriptions/{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 ObjectSubscriptionDetailModel() =
///<summary>
///ID for the objectSubscription record.
///</summary>
[<ApiMember(Description="ID for the objectSubscription record.", Name="ObjectSubscriptionId")>]
member val ObjectSubscriptionId:Guid = new Guid() with get,set
///<summary>
///Id of the Suite DataSource Instance Id.
///</summary>
[<ApiMember(Description="Id of the Suite DataSource Instance Id.", Name="SuiteDataSourceInstanceId")>]
member val SuiteDataSourceInstanceId:Guid = new Guid() with get,set
///<summary>
///Suite DataSource Instance Name.
///</summary>
[<ApiMember(Description="Suite DataSource Instance Name.", Name="SuiteDataSourceName")>]
member val SuiteDataSourceName:String = null with get,set
///<summary>
///Id indicating the RmsTableCtx of the object.
///</summary>
[<ApiMember(Description="Id indicating the RmsTableCtx of the object.", Name="RmsTableContextId")>]
member val RmsTableContextId:Guid = new Guid() with get,set
///<summary>
///Id of the integrated object.
///</summary>
[<ApiMember(Description="Id of the integrated object.", Name="ObjectId")>]
member val ObjectId:Guid = new Guid() with get,set
///<summary>
///Unique Key of this object in the external Data Source.
///</summary>
[<ApiMember(Description="Unique Key of this object in the external Data Source.", Name="AlternateKey")>]
member val AlternateKey:String = null with get,set
///<summary>
///Date the object was integrated.
///</summary>
[<ApiMember(Description="Date the object was integrated.", Name="CreatedAt")>]
member val CreatedAt:DateTime = new DateTime() with get,set
///<summary>
///Record Status of the object subscription.
///</summary>
[<ApiMember(Description="Record Status of the object subscription.", Name="RecordStatus")>]
member val RecordStatus:String = null with get,set
///<summary>
///Id of the Suite Instance.
///</summary>
[<ApiMember(Description="Id of the Suite Instance.", Name="SuiteInstanceId")>]
member val SuiteInstanceId:Guid = new Guid() with get,set
///<summary>
///Suite Instance Name.
///</summary>
[<ApiMember(Description="Suite Instance Name.", Name="SuiteInstanceName")>]
member val SuiteInstanceName:String = null with get,set
[<ApiResponse(Description="List of object subscriptions")>]
[<AllowNullLiteral>]
type GetObjectSubscriptionsResponse() =
member val ObjectSubscriptions:ResizeArray<ObjectSubscriptionDetailModel> = null with get,set
member val ResponseStatus:ResponseStatus = null with get,set
///<summary>
///Get object subscriptions for the specified object
///</summary>
[<Api(Description="Get object subscriptions for the specified object")>]
[<AllowNullLiteral>]
type GetObjectSubscriptions() =
///<summary>
///Get active/inactive object subscriptions for the specified object
///</summary>
[<ApiMember(Description="Get active/inactive object subscriptions for the specified object", IsRequired=true, Name="ObjectId")>]
member val ObjectId:Guid = new Guid() with get,set
F# GetObjectSubscriptions DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /api/objectsubscriptions/{ObjectId} HTTP/1.1
Host: pfapi.pstpf.com.au
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
ObjectSubscriptions:
[
{
SuiteDataSourceName: String,
AlternateKey: String,
CreatedAt: 0001-01-01,
RecordStatus: String,
SuiteInstanceName: String
}
],
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
}
}