| 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 .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/objectsubscriptions/{ObjectId} HTTP/1.1
Host: pfapi.pstpf.com.au
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<GetObjectSubscriptions xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
<ObjectId>00000000-0000-0000-0000-000000000000</ObjectId>
</GetObjectSubscriptions>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<GetObjectSubscriptionsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
<ObjectSubscriptions xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.Models">
<d2p1:ObjectSubscriptionDetailModel>
<d2p1:AlternateKey>String</d2p1:AlternateKey>
<d2p1:CreatedAt>0001-01-01T00:00:00</d2p1:CreatedAt>
<d2p1:ObjectId>00000000-0000-0000-0000-000000000000</d2p1:ObjectId>
<d2p1:ObjectSubscriptionId>00000000-0000-0000-0000-000000000000</d2p1:ObjectSubscriptionId>
<d2p1:RecordStatus>String</d2p1:RecordStatus>
<d2p1:RmsTableContextId>00000000-0000-0000-0000-000000000000</d2p1:RmsTableContextId>
<d2p1:SuiteDataSourceInstanceId>00000000-0000-0000-0000-000000000000</d2p1:SuiteDataSourceInstanceId>
<d2p1:SuiteDataSourceName>String</d2p1:SuiteDataSourceName>
<d2p1:SuiteInstanceId>00000000-0000-0000-0000-000000000000</d2p1:SuiteInstanceId>
<d2p1:SuiteInstanceName>String</d2p1:SuiteInstanceName>
</d2p1:ObjectSubscriptionDetailModel>
</ObjectSubscriptions>
<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>
</GetObjectSubscriptionsResponse>