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 'package:servicestack/servicestack.dart';

class ObjectSubscription implements IConvertible
{
    String? ObjectSubscriptionId;
    String? ObjectId;
    String? SuiteDataSourceInstanceId;
    String? RmsTableContextId;
    String? AlternateKey;
    String? SuiteDataSourceName;
    DateTime? CreatedAt;
    DateTime? LastModified;
    String? RecordStatus;
    String? SuiteInstanceId;
    String? SuiteInstanceName;
    String? ContactIdLicensee;
    String? SubscriptionUpdateResultId;
    String? SubscriptionUpdateResult;
    bool? IsExport;
    DateTime? ProcessedAt;
    DateTime? AcknowledgedAt;
    int? Failures;
    String? Result;
    String? ObjectHash;

    ObjectSubscription({this.ObjectSubscriptionId,this.ObjectId,this.SuiteDataSourceInstanceId,this.RmsTableContextId,this.AlternateKey,this.SuiteDataSourceName,this.CreatedAt,this.LastModified,this.RecordStatus,this.SuiteInstanceId,this.SuiteInstanceName,this.ContactIdLicensee,this.SubscriptionUpdateResultId,this.SubscriptionUpdateResult,this.IsExport,this.ProcessedAt,this.AcknowledgedAt,this.Failures,this.Result,this.ObjectHash});
    ObjectSubscription.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        ObjectSubscriptionId = json['ObjectSubscriptionId'];
        ObjectId = json['ObjectId'];
        SuiteDataSourceInstanceId = json['SuiteDataSourceInstanceId'];
        RmsTableContextId = json['RmsTableContextId'];
        AlternateKey = json['AlternateKey'];
        SuiteDataSourceName = json['SuiteDataSourceName'];
        CreatedAt = JsonConverters.fromJson(json['CreatedAt'],'DateTime',context!);
        LastModified = JsonConverters.fromJson(json['LastModified'],'DateTime',context!);
        RecordStatus = json['RecordStatus'];
        SuiteInstanceId = json['SuiteInstanceId'];
        SuiteInstanceName = json['SuiteInstanceName'];
        ContactIdLicensee = json['ContactIdLicensee'];
        SubscriptionUpdateResultId = json['SubscriptionUpdateResultId'];
        SubscriptionUpdateResult = json['SubscriptionUpdateResult'];
        IsExport = json['IsExport'];
        ProcessedAt = JsonConverters.fromJson(json['ProcessedAt'],'DateTime',context!);
        AcknowledgedAt = JsonConverters.fromJson(json['AcknowledgedAt'],'DateTime',context!);
        Failures = json['Failures'];
        Result = json['Result'];
        ObjectHash = json['ObjectHash'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'ObjectSubscriptionId': ObjectSubscriptionId,
        'ObjectId': ObjectId,
        'SuiteDataSourceInstanceId': SuiteDataSourceInstanceId,
        'RmsTableContextId': RmsTableContextId,
        'AlternateKey': AlternateKey,
        'SuiteDataSourceName': SuiteDataSourceName,
        'CreatedAt': JsonConverters.toJson(CreatedAt,'DateTime',context!),
        'LastModified': JsonConverters.toJson(LastModified,'DateTime',context!),
        'RecordStatus': RecordStatus,
        'SuiteInstanceId': SuiteInstanceId,
        'SuiteInstanceName': SuiteInstanceName,
        'ContactIdLicensee': ContactIdLicensee,
        'SubscriptionUpdateResultId': SubscriptionUpdateResultId,
        'SubscriptionUpdateResult': SubscriptionUpdateResult,
        'IsExport': IsExport,
        'ProcessedAt': JsonConverters.toJson(ProcessedAt,'DateTime',context!),
        'AcknowledgedAt': JsonConverters.toJson(AcknowledgedAt,'DateTime',context!),
        'Failures': Failures,
        'Result': Result,
        'ObjectHash': ObjectHash
    };

    getTypeName() => "ObjectSubscription";
    TypeContext? context = _ctx;
}

/**
* Updates an existing object subscription record
*/
// @Api(Description="Updates an existing object subscription record")
class UpdateObjectSubscription implements IConvertible
{
    ObjectSubscription? ObjectSubscription;

    UpdateObjectSubscription({this.ObjectSubscription});
    UpdateObjectSubscription.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        ObjectSubscription = JsonConverters.fromJson(json['ObjectSubscription'],'ObjectSubscription',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'ObjectSubscription': JsonConverters.toJson(ObjectSubscription,'ObjectSubscription',context!)
    };

    getTypeName() => "UpdateObjectSubscription";
    TypeContext? context = _ctx;
}

class ObjectSubscriptionResponse implements IConvertible
{
    bool? Success;
    String? Message;
    ResponseStatus? ResponseStatus;

    ObjectSubscriptionResponse({this.Success,this.Message,this.ResponseStatus});
    ObjectSubscriptionResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Success = json['Success'];
        Message = json['Message'];
        ResponseStatus = JsonConverters.fromJson(json['ResponseStatus'],'ResponseStatus',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Success': Success,
        'Message': Message,
        'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!)
    };

    getTypeName() => "ObjectSubscriptionResponse";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'pfapi.pstpf.com.au', types: <String, TypeInfo> {
    'ObjectSubscription': TypeInfo(TypeOf.Class, create:() => ObjectSubscription()),
    'UpdateObjectSubscription': TypeInfo(TypeOf.Class, create:() => UpdateObjectSubscription()),
    'ObjectSubscriptionResponse': TypeInfo(TypeOf.Class, create:() => ObjectSubscriptionResponse()),
});

Dart UpdateObjectSubscription 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/updateobjectsubscription HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<UpdateObjectSubscription xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
  <ObjectSubscription xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eros.Causal.Common.Entity">
    <d2p1:AcknowledgedAt>0001-01-01T00:00:00</d2p1:AcknowledgedAt>
    <d2p1:AlternateKey>String</d2p1:AlternateKey>
    <d2p1:ContactIdLicensee>00000000-0000-0000-0000-000000000000</d2p1:ContactIdLicensee>
    <d2p1:CreatedAt>0001-01-01T00:00:00</d2p1:CreatedAt>
    <d2p1:Failures>0</d2p1:Failures>
    <d2p1:IsExport>false</d2p1:IsExport>
    <d2p1:LastModified>0001-01-01T00:00:00</d2p1:LastModified>
    <d2p1:ObjectHash>String</d2p1:ObjectHash>
    <d2p1:ObjectId>00000000-0000-0000-0000-000000000000</d2p1:ObjectId>
    <d2p1:ObjectSubscriptionId>00000000-0000-0000-0000-000000000000</d2p1:ObjectSubscriptionId>
    <d2p1:ProcessedAt>0001-01-01T00:00:00</d2p1:ProcessedAt>
    <d2p1:RecordStatus>String</d2p1:RecordStatus>
    <d2p1:Result>String</d2p1:Result>
    <d2p1:RmsTableContextId>00000000-0000-0000-0000-000000000000</d2p1:RmsTableContextId>
    <d2p1:SubscriptionUpdateResult>String</d2p1:SubscriptionUpdateResult>
    <d2p1:SubscriptionUpdateResultId>00000000-0000-0000-0000-000000000000</d2p1:SubscriptionUpdateResultId>
    <d2p1:SuiteDataSourceInstanceId>00000000-0000-0000-0000-000000000000</d2p1:SuiteDataSourceInstanceId>
    <d2p1:SuiteDataSourceName>String</d2p1:SuiteDataSourceName>
    <d2p1:SuiteInstanceId>00000000-0000-0000-0000-000000000000</d2p1:SuiteInstanceId>
    <d2p1:SuiteInstanceName>String</d2p1:SuiteInstanceName>
  </ObjectSubscription>
</UpdateObjectSubscription>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ObjectSubscriptionResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
  <Message>String</Message>
  <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>
  <Success>false</Success>
</ObjectSubscriptionResponse>