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 Foundation
import ServiceStack

/**
* Inseets a new object subscription record
*/
// @Api(Description="Inseets a new object subscription record")
public class InsertObjectSubscription : Codable
{
    public var objectSubscription:ObjectSubscription

    required public init(){}
}

public class ObjectSubscription : Codable
{
    public var objectSubscriptionId:String?
    public var objectId:String
    public var suiteDataSourceInstanceId:String
    public var rmsTableContextId:String
    public var alternateKey:String
    public var suiteDataSourceName:String
    public var createdAt:Date
    public var lastModified:Date?
    public var recordStatus:String
    public var suiteInstanceId:String
    public var suiteInstanceName:String
    public var contactIdLicensee:String
    public var subscriptionUpdateResultId:String?
    public var subscriptionUpdateResult:String
    public var isExport:Bool?
    public var processedAt:Date?
    public var acknowledgedAt:Date?
    public var failures:Int
    public var result:String
    public var objectHash:String

    required public init(){}
}

public class ObjectSubscriptionResponse : Codable
{
    public var success:Bool
    public var message:String
    public var responseStatus:ResponseStatus

    required public init(){}
}

Swift InsertObjectSubscription DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: application/json
Content-Type: application/json
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: application/json
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"}}}