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
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


/**
* Inseets a new object subscription record
*/
@Api(Description="Inseets a new object subscription record")
open class InsertObjectSubscription
{
    open var ObjectSubscription:ObjectSubscription? = null
}

open class ObjectSubscription
{
    open var ObjectSubscriptionId:UUID? = null
    open var ObjectId:UUID? = null
    open var SuiteDataSourceInstanceId:UUID? = null
    open var RmsTableContextId:UUID? = null
    open var AlternateKey:String? = null
    open var SuiteDataSourceName:String? = null
    open var CreatedAt:Date? = null
    open var LastModified:Date? = null
    open var RecordStatus:String? = null
    open var SuiteInstanceId:UUID? = null
    open var SuiteInstanceName:String? = null
    open var ContactIdLicensee:UUID? = null
    open var SubscriptionUpdateResultId:UUID? = null
    open var SubscriptionUpdateResult:String? = null
    open var IsExport:Boolean? = null
    open var ProcessedAt:Date? = null
    open var AcknowledgedAt:Date? = null
    open var Failures:Int? = null
    open var Result:String? = null
    open var ObjectHash:String? = null
}

open class ObjectSubscriptionResponse
{
    open var Success:Boolean? = null
    open var Message:String? = null
    open var ResponseStatus:ResponseStatus? = null
}

Kotlin InsertObjectSubscription 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/insertobjectsubscription 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
		}
	}
}