Platform API

<back to all web services

InsertObjectSubscription

Inseets a new object subscription record

Requires Authentication
The following routes are available for this service:
All Verbs/api/insertobjectsubscription
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 ObjectSubscription() = 
        member val ObjectSubscriptionId:Nullable<Guid> = new Nullable<Guid>() with get,set
        member val ObjectId:Guid = new Guid() with get,set
        member val SuiteDataSourceInstanceId:Guid = new Guid() with get,set
        member val RmsTableContextId:Guid = new Guid() with get,set
        member val AlternateKey:String = null with get,set
        member val SuiteDataSourceName:String = null with get,set
        member val CreatedAt:DateTime = new DateTime() with get,set
        member val LastModified:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val RecordStatus:String = null with get,set
        member val SuiteInstanceId:Guid = new Guid() with get,set
        member val SuiteInstanceName:String = null with get,set
        member val ContactIdLicensee:Guid = new Guid() with get,set
        member val SubscriptionUpdateResultId:Nullable<Guid> = new Nullable<Guid>() with get,set
        member val SubscriptionUpdateResult:String = null with get,set
        member val IsExport:Nullable<Boolean> = new Nullable<Boolean>() with get,set
        member val ProcessedAt:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val AcknowledgedAt:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val Failures:Int32 = new Int32() with get,set
        member val Result:String = null with get,set
        member val ObjectHash:String = null with get,set

    ///<summary>
    ///Inseets a new object subscription record
    ///</summary>
    [<Api(Description="Inseets a new object subscription record")>]
    [<AllowNullLiteral>]
    type InsertObjectSubscription() = 
        member val ObjectSubscription:ObjectSubscription = null with get,set

    [<AllowNullLiteral>]
    type ObjectSubscriptionResponse() = 
        member val Success:Boolean = new Boolean() with get,set
        member val Message:String = null with get,set
        member val ResponseStatus:ResponseStatus = null with get,set

F# InsertObjectSubscription DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /api/insertobjectsubscription HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"ObjectSubscription":{"ObjectSubscriptionId":"00000000000000000000000000000000","ObjectId":"00000000-0000-0000-0000-000000000000","SuiteDataSourceInstanceId":"00000000-0000-0000-0000-000000000000","RmsTableContextId":"00000000-0000-0000-0000-000000000000","AlternateKey":"String","SuiteDataSourceName":"String","CreatedAt":"0001-01-01T00:00:00.0000000","LastModified":"0001-01-01T00:00:00.0000000","RecordStatus":"String","SuiteInstanceId":"00000000-0000-0000-0000-000000000000","SuiteInstanceName":"String","ContactIdLicensee":"00000000-0000-0000-0000-000000000000","SubscriptionUpdateResultId":"00000000000000000000000000000000","SubscriptionUpdateResult":"String","IsExport":false,"ProcessedAt":"0001-01-01T00:00:00.0000000","AcknowledgedAt":"0001-01-01T00:00:00.0000000","Failures":0,"Result":"String","ObjectHash":"String"}}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Success":false,"Message":"String","ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}