Platform API

<back to all web services

UpdateObjectSubscription

Updates an existing object subscription record

Requires Authentication
The following routes are available for this service:
All Verbs/api/updateobjectsubscription
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Eros.Subtle.Canvara.WebAPIModel.ServiceModel;
using Eros.Causal.Common.Entity;

namespace Eros.Causal.Common.Entity
{
    public partial class ObjectSubscription
    {
        public virtual Guid? ObjectSubscriptionId { get; set; }
        public virtual Guid ObjectId { get; set; }
        public virtual Guid SuiteDataSourceInstanceId { get; set; }
        public virtual Guid RmsTableContextId { get; set; }
        public virtual string AlternateKey { get; set; }
        public virtual string SuiteDataSourceName { get; set; }
        public virtual DateTime CreatedAt { get; set; }
        public virtual DateTime? LastModified { get; set; }
        public virtual string RecordStatus { get; set; }
        public virtual Guid SuiteInstanceId { get; set; }
        public virtual string SuiteInstanceName { get; set; }
        public virtual Guid ContactIdLicensee { get; set; }
        public virtual Guid? SubscriptionUpdateResultId { get; set; }
        public virtual string SubscriptionUpdateResult { get; set; }
        public virtual bool? IsExport { get; set; }
        public virtual DateTime? ProcessedAt { get; set; }
        public virtual DateTime? AcknowledgedAt { get; set; }
        public virtual int Failures { get; set; }
        public virtual string Result { get; set; }
        public virtual string ObjectHash { get; set; }
    }

}

namespace Eros.Subtle.Canvara.WebAPIModel.ServiceModel
{
    public partial class ObjectSubscriptionResponse
    {
        public virtual bool Success { get; set; }
        public virtual string Message { get; set; }
        public virtual ResponseStatus ResponseStatus { get; set; }
    }

    ///<summary>
    ///Updates an existing object subscription record
    ///</summary>
    [Api(Description="Updates an existing object subscription record")]
    public partial class UpdateObjectSubscription
    {
        public virtual ObjectSubscription ObjectSubscription { get; set; }
    }

}

C# UpdateObjectSubscription DTOs

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

HTTP + JSV

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

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

{
	ObjectSubscription: 
	{
		ObjectSubscriptionId: 00000000000000000000000000000000,
		AlternateKey: String,
		SuiteDataSourceName: String,
		CreatedAt: 0001-01-01,
		LastModified: 0001-01-01,
		RecordStatus: String,
		SuiteInstanceName: String,
		SubscriptionUpdateResultId: 00000000000000000000000000000000,
		SubscriptionUpdateResult: String,
		IsExport: False,
		ProcessedAt: 0001-01-01,
		AcknowledgedAt: 0001-01-01,
		Failures: 0,
		Result: String,
		ObjectHash: String
	}
}
HTTP/1.1 200 OK
Content-Type: text/jsv
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
		}
	}
}