Platform API

UpdateObjectSubscrptionStatus

Updates an object subscription status

The following routes are available for this service:
All Verbs	/api/updateobjectsubscriptionstatus

import Foundation
import ServiceStack

/**
* Updates an object subscription status
*/
// @Api(Description="Updates an object subscription status")
public class UpdateObjectSubscrptionStatus : Codable
{
    public var objectSubscriptionId:String
    public var recordStatus:String
    public var subscriptionKey:String

    required public init(){}
}

public class GetDataSourcesResponse : Codable
{
    public var dataSources:[ListDataItem]
    public var responseStatus:ResponseStatus

    required public init(){}
}

public class ListDataItem : Codable
{
    public var id:String
    public var name:String
    public var Description:String
    public var shortName:String
    public var defaultName:String
    public var isDefault:Bool
    public var order:Int
    public var listItemTrafficLightId:String
    public var primaryListItemImageId:String
    public var primaryListItemImageUrl:String
    public var primaryImageThumbnailUrl:String
    public var ownerContactId:String
    public var recordStatus:String
    public var tags:String
    public var listId:String
    public var markAsChecked:Bool
    public var relatedObjectId:String
    public var canEdit:Bool
    public var isOwner:Bool
    public var extraValues:[String]
    public var listItemFilters:[ListItemFilter]

    required public init(){}
}

public class ListItemFilter : Codable
{
    public var listItemFilterId:String
    public var filterName:String
    public var listId:String
    public var listItemId:String
    public var listItemIsInFilter:Bool

    required public init(){}
}

Swift UpdateObjectSubscrptionStatus DTOs

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

HTTP + XML

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/xml
Content-Type: application/xml
Content-Length: length

<UpdateObjectSubscrptionStatus xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
  <ObjectSubscriptionId>00000000-0000-0000-0000-000000000000</ObjectSubscriptionId>
  <RecordStatus>0</RecordStatus>
  <SubscriptionKey>String</SubscriptionKey>
</UpdateObjectSubscrptionStatus>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetDataSourcesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
  <DataSources xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eros.Causal.Common.Entity">
    <d2p1:ListDataItem>
      <d2p1:_x003C_CanEdit_x003E_k__BackingField>false</d2p1:_x003C_CanEdit_x003E_k__BackingField>
      <d2p1:_x003C_DefaultName_x003E_k__BackingField>String</d2p1:_x003C_DefaultName_x003E_k__BackingField>
      <d2p1:_x003C_Description_x003E_k__BackingField>String</d2p1:_x003C_Description_x003E_k__BackingField>
      <d2p1:_x003C_ExtraValues_x003E_k__BackingField xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:anyType />
      </d2p1:_x003C_ExtraValues_x003E_k__BackingField>
      <d2p1:_x003C_Id_x003E_k__BackingField>00000000-0000-0000-0000-000000000000</d2p1:_x003C_Id_x003E_k__BackingField>
      <d2p1:_x003C_IsDefault_x003E_k__BackingField>false</d2p1:_x003C_IsDefault_x003E_k__BackingField>
      <d2p1:_x003C_IsOwner_x003E_k__BackingField>false</d2p1:_x003C_IsOwner_x003E_k__BackingField>
      <d2p1:_x003C_ListId_x003E_k__BackingField>00000000-0000-0000-0000-000000000000</d2p1:_x003C_ListId_x003E_k__BackingField>
      <d2p1:_x003C_ListItemFilters_x003E_k__BackingField>
        <d2p1:ListItemFilter>
          <d2p1:_x003C_FilterName_x003E_k__BackingField>String</d2p1:_x003C_FilterName_x003E_k__BackingField>
          <d2p1:_x003C_ListId_x003E_k__BackingField>00000000-0000-0000-0000-000000000000</d2p1:_x003C_ListId_x003E_k__BackingField>
          <d2p1:_x003C_ListItemFilterId_x003E_k__BackingField>00000000-0000-0000-0000-000000000000</d2p1:_x003C_ListItemFilterId_x003E_k__BackingField>
          <d2p1:_x003C_ListItemId_x003E_k__BackingField>00000000-0000-0000-0000-000000000000</d2p1:_x003C_ListItemId_x003E_k__BackingField>
          <d2p1:_x003C_ListItemIsInFilter_x003E_k__BackingField>false</d2p1:_x003C_ListItemIsInFilter_x003E_k__BackingField>
        </d2p1:ListItemFilter>
      </d2p1:_x003C_ListItemFilters_x003E_k__BackingField>
      <d2p1:_x003C_ListItemTrafficLightId_x003E_k__BackingField>00000000-0000-0000-0000-000000000000</d2p1:_x003C_ListItemTrafficLightId_x003E_k__BackingField>
      <d2p1:_x003C_MarkAsChecked_x003E_k__BackingField>false</d2p1:_x003C_MarkAsChecked_x003E_k__BackingField>
      <d2p1:_x003C_Name_x003E_k__BackingField>String</d2p1:_x003C_Name_x003E_k__BackingField>
      <d2p1:_x003C_Order_x003E_k__BackingField>0</d2p1:_x003C_Order_x003E_k__BackingField>
      <d2p1:_x003C_OwnerContactId_x003E_k__BackingField>00000000-0000-0000-0000-000000000000</d2p1:_x003C_OwnerContactId_x003E_k__BackingField>
      <d2p1:_x003C_PrimaryImageThumbnailUrl_x003E_k__BackingField>String</d2p1:_x003C_PrimaryImageThumbnailUrl_x003E_k__BackingField>
      <d2p1:_x003C_PrimaryListItemImageId_x003E_k__BackingField>00000000-0000-0000-0000-000000000000</d2p1:_x003C_PrimaryListItemImageId_x003E_k__BackingField>
      <d2p1:_x003C_PrimaryListItemImageUrl_x003E_k__BackingField>String</d2p1:_x003C_PrimaryListItemImageUrl_x003E_k__BackingField>
      <d2p1:_x003C_RecordStatus_x003E_k__BackingField>String</d2p1:_x003C_RecordStatus_x003E_k__BackingField>
      <d2p1:_x003C_RelatedObjectId_x003E_k__BackingField>00000000-0000-0000-0000-000000000000</d2p1:_x003C_RelatedObjectId_x003E_k__BackingField>
      <d2p1:_x003C_ShortName_x003E_k__BackingField>String</d2p1:_x003C_ShortName_x003E_k__BackingField>
      <d2p1:_x003C_Tags_x003E_k__BackingField>String</d2p1:_x003C_Tags_x003E_k__BackingField>
    </d2p1:ListDataItem>
  </DataSources>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</GetDataSourcesResponse>