Platform Subscription API

<back to all web services

SaveObjectSubscription

Inserts an object subscription for an integrated object.

Requires Authentication 
namespace Eros.Subtle.Canvara.WebAPIModel.ServiceModelSubscription

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    ///<summary>
    ///Inserts an object subscription for an integrated object.
    ///</summary>
    [<Api(Description="Inserts an object subscription for an integrated object.")>]
    [<AllowNullLiteral>]
    type SaveObjectSubscription() = 
        ///<summary>
        ///Guid representing the external systems datasource information.
        ///</summary>
        [<ApiMember(DataType="Guid", Description="Guid representing the external systems datasource information.", IsRequired=true, Name="SuiteDataSourceInstanceId", ParameterType="body")>]
        member val SuiteDataSourceInstanceId:Guid = new Guid() with get,set

        ///<summary>
        ///The unique key that represents the object on the external system.
        ///</summary>
        [<ApiMember(DataType="string", Description="The unique key that represents the object on the external system.", IsRequired=true, Name="AlternateKey", ParameterType="body")>]
        member val AlternateKey:String = null with get,set

        ///<summary>
        ///Guid of the object within PSTPF.
        ///</summary>
        [<ApiMember(DataType="Guid", Description="Guid of the object within PSTPF.", Name="ObjectId", ParameterType="body")>]
        member val ObjectId:Guid = new Guid() with get,set

        ///<summary>
        ///Guid of the RmsTableCtx within PSTPF.  This is used if the alternate key is provided to identify the object to update.
        ///</summary>
        [<ApiMember(DataType="Guid", Description="Guid of the RmsTableCtx within PSTPF.  This is used if the alternate key is provided to identify the object to update.", IsRequired=true, Name="RmsTableCtxId", ParameterType="body")>]
        member val RmsTableCtxId:Guid = new Guid() with get,set

F# SaveObjectSubscription DTOs

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

HTTP + OTHER

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

POST /jsonl/reply/SaveObjectSubscription HTTP/1.1 
Host: production-eros-platform-apisubscription.azurewebsites.net 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"AlternateKey":"String"}

HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

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