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.*;

public class dtos
{

    /**
    * Updates an existing object subscription record
    */
    @Api(Description="Updates an existing object subscription record")
    public static class UpdateObjectSubscription
    {
        public ObjectSubscription ObjectSubscription = null;
        
        public ObjectSubscription getObjectSubscription() { return ObjectSubscription; }
        public UpdateObjectSubscription setObjectSubscription(ObjectSubscription value) { this.ObjectSubscription = value; return this; }
    }

    public static class ObjectSubscription
    {
        public UUID ObjectSubscriptionId = null;
        public UUID ObjectId = null;
        public UUID SuiteDataSourceInstanceId = null;
        public UUID RmsTableContextId = null;
        public String AlternateKey = null;
        public String SuiteDataSourceName = null;
        public Date CreatedAt = null;
        public Date LastModified = null;
        public String RecordStatus = null;
        public UUID SuiteInstanceId = null;
        public String SuiteInstanceName = null;
        public UUID ContactIdLicensee = null;
        public UUID SubscriptionUpdateResultId = null;
        public String SubscriptionUpdateResult = null;
        public Boolean IsExport = null;
        public Date ProcessedAt = null;
        public Date AcknowledgedAt = null;
        public Integer Failures = null;
        public String Result = null;
        public String ObjectHash = null;
        
        public UUID getObjectSubscriptionId() { return ObjectSubscriptionId; }
        public ObjectSubscription setObjectSubscriptionId(UUID value) { this.ObjectSubscriptionId = value; return this; }
        public UUID getObjectId() { return ObjectId; }
        public ObjectSubscription setObjectId(UUID value) { this.ObjectId = value; return this; }
        public UUID getSuiteDataSourceInstanceId() { return SuiteDataSourceInstanceId; }
        public ObjectSubscription setSuiteDataSourceInstanceId(UUID value) { this.SuiteDataSourceInstanceId = value; return this; }
        public UUID getRmsTableContextId() { return RmsTableContextId; }
        public ObjectSubscription setRmsTableContextId(UUID value) { this.RmsTableContextId = value; return this; }
        public String getAlternateKey() { return AlternateKey; }
        public ObjectSubscription setAlternateKey(String value) { this.AlternateKey = value; return this; }
        public String getSuiteDataSourceName() { return SuiteDataSourceName; }
        public ObjectSubscription setSuiteDataSourceName(String value) { this.SuiteDataSourceName = value; return this; }
        public Date getCreatedAt() { return CreatedAt; }
        public ObjectSubscription setCreatedAt(Date value) { this.CreatedAt = value; return this; }
        public Date getLastModified() { return LastModified; }
        public ObjectSubscription setLastModified(Date value) { this.LastModified = value; return this; }
        public String getRecordStatus() { return RecordStatus; }
        public ObjectSubscription setRecordStatus(String value) { this.RecordStatus = value; return this; }
        public UUID getSuiteInstanceId() { return SuiteInstanceId; }
        public ObjectSubscription setSuiteInstanceId(UUID value) { this.SuiteInstanceId = value; return this; }
        public String getSuiteInstanceName() { return SuiteInstanceName; }
        public ObjectSubscription setSuiteInstanceName(String value) { this.SuiteInstanceName = value; return this; }
        public UUID getContactIdLicensee() { return ContactIdLicensee; }
        public ObjectSubscription setContactIdLicensee(UUID value) { this.ContactIdLicensee = value; return this; }
        public UUID getSubscriptionUpdateResultId() { return SubscriptionUpdateResultId; }
        public ObjectSubscription setSubscriptionUpdateResultId(UUID value) { this.SubscriptionUpdateResultId = value; return this; }
        public String getSubscriptionUpdateResult() { return SubscriptionUpdateResult; }
        public ObjectSubscription setSubscriptionUpdateResult(String value) { this.SubscriptionUpdateResult = value; return this; }
        public Boolean getIsExport() { return IsExport; }
        public ObjectSubscription setIsExport(Boolean value) { this.IsExport = value; return this; }
        public Date getProcessedAt() { return ProcessedAt; }
        public ObjectSubscription setProcessedAt(Date value) { this.ProcessedAt = value; return this; }
        public Date getAcknowledgedAt() { return AcknowledgedAt; }
        public ObjectSubscription setAcknowledgedAt(Date value) { this.AcknowledgedAt = value; return this; }
        public Integer getFailures() { return Failures; }
        public ObjectSubscription setFailures(Integer value) { this.Failures = value; return this; }
        public String getResult() { return Result; }
        public ObjectSubscription setResult(String value) { this.Result = value; return this; }
        public String getObjectHash() { return ObjectHash; }
        public ObjectSubscription setObjectHash(String value) { this.ObjectHash = value; return this; }
    }

    public static class ObjectSubscriptionResponse
    {
        public Boolean Success = null;
        public String Message = null;
        public ResponseStatus ResponseStatus = null;
        
        public Boolean isSuccess() { return Success; }
        public ObjectSubscriptionResponse setSuccess(Boolean value) { this.Success = value; return this; }
        public String getMessage() { return Message; }
        public ObjectSubscriptionResponse setMessage(String value) { this.Message = value; return this; }
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public ObjectSubscriptionResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
    }

}

Java 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>