Platform API

<back to all web services

UpdateObjectSubscrptionStatus

Updates an object subscription status

Requires Authentication
The following routes are available for this service:
All Verbs/api/updateobjectsubscriptionstatus
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


/**
* Updates an object subscription status
*/
@Api(Description="Updates an object subscription status")
open class UpdateObjectSubscrptionStatus
{
    open var ObjectSubscriptionId:UUID? = null
    open var RecordStatus:String? = null
    open var SubscriptionKey:String? = null
}

open class GetDataSourcesResponse
{
    open var DataSources:ArrayList<ListDataItem>? = null
    open var ResponseStatus:ResponseStatus? = null
}

open class ListDataItem
{
    open var Id:UUID? = null
    open var Name:String? = null
    open var Description:String? = null
    open var ShortName:String? = null
    open var DefaultName:String? = null
    open var IsDefault:Boolean? = null
    open var Order:Int? = null
    open var ListItemTrafficLightId:UUID? = null
    open var PrimaryListItemImageId:UUID? = null
    open var PrimaryListItemImageUrl:String? = null
    open var PrimaryImageThumbnailUrl:String? = null
    open var OwnerContactId:UUID? = null
    open var RecordStatus:String? = null
    open var Tags:String? = null
    open var ListId:UUID? = null
    open var MarkAsChecked:Boolean? = null
    open var RelatedObjectId:UUID? = null
    open var CanEdit:Boolean? = null
    open var IsOwner:Boolean? = null
    open var ExtraValues:ArrayList<Object>? = null
    open var ListItemFilters:ArrayList<ListItemFilter>? = null
}

open class ListItemFilter
{
    open var ListItemFilterId:UUID? = null
    open var FilterName:String? = null
    open var ListId:UUID? = null
    open var ListItemId:UUID? = null
    open var ListItemIsInFilter:Boolean? = null
}

Kotlin UpdateObjectSubscrptionStatus 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/updateobjectsubscriptionstatus HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"ObjectSubscriptionId":"00000000-0000-0000-0000-000000000000","RecordStatus":"\u0000","SubscriptionKey":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"DataSources":[{"Id":"00000000-0000-0000-0000-000000000000","Name":"String","Description":"String","ShortName":"String","DefaultName":"String","IsDefault":false,"Order":0,"ListItemTrafficLightId":"00000000-0000-0000-0000-000000000000","PrimaryListItemImageId":"00000000-0000-0000-0000-000000000000","PrimaryListItemImageUrl":"String","PrimaryImageThumbnailUrl":"String","OwnerContactId":"00000000-0000-0000-0000-000000000000","RecordStatus":"String","Tags":"String","ListId":"00000000-0000-0000-0000-000000000000","MarkAsChecked":false,"RelatedObjectId":"00000000-0000-0000-0000-000000000000","CanEdit":false,"IsOwner":false,"ExtraValues":[{}],"ListItemFilters":[{"ListItemFilterId":"00000000-0000-0000-0000-000000000000","FilterName":"String","ListId":"00000000-0000-0000-0000-000000000000","ListItemId":"00000000-0000-0000-0000-000000000000","ListItemIsInFilter":false}]}],"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}