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


/**
* Updates an existing object subscription record
*/
@Api(Description="Updates an existing object subscription record")
open class UpdateObjectSubscription
{
    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 UpdateObjectSubscription 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/updateobjectsubscription 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"}}}