Platform API

UpdateObjectSubscription

Updates an existing object subscription record

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


export class ObjectSubscription
{
    public ObjectSubscriptionId?: string;
    public ObjectId: string;
    public SuiteDataSourceInstanceId: string;
    public RmsTableContextId: string;
    public AlternateKey: string;
    public SuiteDataSourceName: string;
    public CreatedAt: string;
    public LastModified?: string;
    public RecordStatus: string;
    public SuiteInstanceId: string;
    public SuiteInstanceName: string;
    public ContactIdLicensee: string;
    public SubscriptionUpdateResultId?: string;
    public SubscriptionUpdateResult: string;
    public IsExport?: boolean;
    public ProcessedAt?: string;
    public AcknowledgedAt?: string;
    public Failures: number;
    public Result: string;
    public ObjectHash: string;

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

/** @description Updates an existing object subscription record */
// @Api(Description="Updates an existing object subscription record")
export class UpdateObjectSubscription
{
    public ObjectSubscription: ObjectSubscription;

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

export class ObjectSubscriptionResponse
{
    public Success: boolean;
    public Message: string;
    public ResponseStatus: ResponseStatus;

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

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