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

export class ListItemFilter
{
    public ListItemFilterId: string;
    public FilterName: string;
    public ListId: string;
    public ListItemId: string;
    public ListItemIsInFilter: boolean;

    public constructor(init?: Partial<ListItemFilter>) { (Object as any).assign(this, init); }
}

export class ListDataItem
{
    public Id: string;
    public Name: string;
    public Description: string;
    public ShortName: string;
    public DefaultName: string;
    public IsDefault: boolean;
    public Order: number;
    public ListItemTrafficLightId: string;
    public PrimaryListItemImageId: string;
    public PrimaryListItemImageUrl: string;
    public PrimaryImageThumbnailUrl: string;
    public OwnerContactId: string;
    public RecordStatus: string;
    public Tags: string;
    public ListId: string;
    public MarkAsChecked: boolean;
    public RelatedObjectId: string;
    public CanEdit: boolean;
    public IsOwner: boolean;
    public ExtraValues: Object[];
    public ListItemFilters: ListItemFilter[];

    public constructor(init?: Partial<ListDataItem>) { (Object as any).assign(this, init); }
}

export class GetDataSourcesResponse
{
    public DataSources: ListDataItem[];
    public ResponseStatus: ResponseStatus;

    public constructor(init?: Partial<GetDataSourcesResponse>) { (Object as any).assign(this, init); }
}

/** @description Updates an object subscription status */
// @Api(Description="Updates an object subscription status")
export class UpdateObjectSubscrptionStatus
{
    public ObjectSubscriptionId: string;
    public RecordStatus: string;
    public SubscriptionKey: string;

    public constructor(init?: Partial<UpdateObjectSubscrptionStatus>) { (Object as any).assign(this, init); }
}

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

{"ObjectSubscriptionId":"00000000-0000-0000-0000-000000000000","RecordStatus":"\u0000","SubscriptionKey":"String"}

HTTP/1.1 200 OK
Content-Type: text/csv
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"}}}