Platform Subscription API

<back to all web services

SaveObjectConnection

Inserts an object connection between 2 valid objects.

Requires Authentication 
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports Eros.Subtle.Canvara.WebAPIModel.ServiceModelSubscription
Imports Eros.Saguna.Common.WebAPI.ServiceModel

Namespace Global

    Namespace Eros.Saguna.Common.WebAPI.ServiceModel

        Public Partial Class SubscriptionObjectModel
            Implements ISubscription
            '''<Summary>
            '''Guid representing the external systems datasource information.
            '''</Summary>
            <ApiMember(DataType:="Guid", Description:="Guid representing the external systems datasource information.", IsRequired:=true, Name:="SuiteDataSourceInstanceId", ParameterType:="query")>
            Public Overridable Property SuiteDataSourceInstanceId As Guid Implements ISubscription.SuiteDataSourceInstanceId

            '''<Summary>
            '''The unique key that represents the object on the external system.
            '''</Summary>
            <ApiMember(DataType:="string", Description:="The unique key that represents the object on the external system.", IsRequired:=true, Name:="AlternateKey", ParameterType:="query")>
            Public Overridable Property AlternateKey As String Implements ISubscription.AlternateKey

            '''<Summary>
            '''Guid of the object within Eros.  If ObjectId is known, the external system may pass this instead of the alternate key.
            '''</Summary>
            <ApiMember(DataType:="Guid", Description:="Guid of the object within Eros.  If ObjectId is known, the external system may pass this instead of the alternate key.", Name:="ObjectId", ParameterType:="query")>
            Public Overridable Property ObjectId As Guid Implements ISubscription.ObjectId

            '''<Summary>
            '''Guid of the RmsTableCtx within Eros.  This is used if the alternate key is provided to identify the object to update.
            '''</Summary>
            <ApiMember(DataType:="Guid", Description:="Guid of the RmsTableCtx within Eros.  This is used if the alternate key is provided to identify the object to update.", Name:="RmsTableCtxId", ParameterType:="query")>
            Public Overridable Property RmsTableCtxId As Guid

            '''<Summary>
            '''Validation ensures that this object has a value in alternateKey or ObjectId, ignoring validation skips this requirement.
            '''</Summary>
            <ApiMember(DataType:="bool", Description:="Validation ensures that this object has a value in alternateKey or ObjectId, ignoring validation skips this requirement.", Name:="IgnoreValidation", ParameterType:="query")>
            Public Overridable Property IgnoreValidation As Boolean Implements ISubscription.IgnoreValidation
        End Class
    End Namespace

    Namespace Eros.Subtle.Canvara.WebAPIModel.ServiceModelSubscription

        '''<Summary>
        '''Inserts an object connection between 2 valid objects.
        '''</Summary>
        <Api(Description:="Inserts an object connection between 2 valid objects.")>
        Public Partial Class SaveObjectConnection
            '''<Summary>
            '''Information to allow retrieval of the object from Eros that will be the 'From' object in the connection.
            '''</Summary>
            <ApiMember(DataType:="SubscriptionObjectModel", Description:="Information to allow retrieval of the object from Eros that will be the 'From' object in the connection.", IsRequired:=true, Name:="FromObject")>
            Public Overridable Property FromObject As SubscriptionObjectModel

            '''<Summary>
            '''Information to allow retrieval of the object from Eros that will be the 'To' object in the connection.
            '''</Summary>
            <ApiMember(DataType:="SubscriptionObjectModel", Description:="Information to allow retrieval of the object from Eros that will be the 'To' object in the connection.", IsRequired:=true, Name:="ToObject")>
            Public Overridable Property ToObject As SubscriptionObjectModel

            '''<Summary>
            '''Guid representing the Connection Method to use to connect the objects with.
            '''</Summary>
            <ApiMember(DataType:="Guid", Description:="Guid representing the Connection Method to use to connect the objects with.", IsRequired:=true, Name:="RmsTableCtxIdConnectionMethod")>
            Public Overridable Property RmsTableCtxIdConnectionMethod As Guid
        End Class
    End Namespace
End Namespace

VB.NET SaveObjectConnection 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 /xml/reply/SaveObjectConnection HTTP/1.1 
Host: production-eros-platform-apisubscription.azurewebsites.net 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<SaveObjectConnection xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModelSubscription">
  <FromObject xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eros.Saguna.Common.WebAPI.ServiceModel">
    <d2p1:_x003C_AlternateKey_x003E_k__BackingField>String</d2p1:_x003C_AlternateKey_x003E_k__BackingField>
    <d2p1:_x003C_ObjectId_x003E_k__BackingField>00000000-0000-0000-0000-000000000000</d2p1:_x003C_ObjectId_x003E_k__BackingField>
    <d2p1:_x003C_RmsTableCtxId_x003E_k__BackingField>00000000-0000-0000-0000-000000000000</d2p1:_x003C_RmsTableCtxId_x003E_k__BackingField>
    <d2p1:_x003C_SuiteDataSourceInstanceId_x003E_k__BackingField>00000000-0000-0000-0000-000000000000</d2p1:_x003C_SuiteDataSourceInstanceId_x003E_k__BackingField>
  </FromObject>
  <RmsTableCtxIdConnectionMethod>00000000-0000-0000-0000-000000000000</RmsTableCtxIdConnectionMethod>
  <ToObject xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eros.Saguna.Common.WebAPI.ServiceModel">
    <d2p1:_x003C_AlternateKey_x003E_k__BackingField>String</d2p1:_x003C_AlternateKey_x003E_k__BackingField>
    <d2p1:_x003C_ObjectId_x003E_k__BackingField>00000000-0000-0000-0000-000000000000</d2p1:_x003C_ObjectId_x003E_k__BackingField>
    <d2p1:_x003C_RmsTableCtxId_x003E_k__BackingField>00000000-0000-0000-0000-000000000000</d2p1:_x003C_RmsTableCtxId_x003E_k__BackingField>
    <d2p1:_x003C_SuiteDataSourceInstanceId_x003E_k__BackingField>00000000-0000-0000-0000-000000000000</d2p1:_x003C_SuiteDataSourceInstanceId_x003E_k__BackingField>
  </ToObject>
</SaveObjectConnection>

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

<ResponseStatus xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <ErrorCode>String</ErrorCode>
  <Message>String</Message>
  <StackTrace>String</StackTrace>
  <Errors>
    <ResponseError>
      <ErrorCode>String</ErrorCode>
      <FieldName>String</FieldName>
      <Message>String</Message>
      <Meta xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>String</d4p1:Key>
          <d4p1:Value>String</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
      </Meta>
    </ResponseError>
  </Errors>
  <Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Meta>
</ResponseStatus>