Platform API

<back to all web services

GetDataSources

Gets a list of integration data sources

Requires Authentication
The following routes are available for this service:
All Verbs/api/datasources
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.ServiceModel
Imports Eros.Causal.Common.Entity

Namespace Global

    Namespace Eros.Causal.Common.Entity

        Public Partial Class ListDataItem
            Public Overridable Property Id As Guid
            Public Overridable Property Name As String
            Public Overridable Property Description As String
            Public Overridable Property ShortName As String
            Public Overridable Property DefaultName As String
            Public Overridable Property IsDefault As Boolean
            Public Overridable Property Order As Integer
            Public Overridable Property ListItemTrafficLightId As Guid
            Public Overridable Property PrimaryListItemImageId As Guid
            Public Overridable Property PrimaryListItemImageUrl As String
            Public Overridable Property PrimaryImageThumbnailUrl As String
            Public Overridable Property OwnerContactId As Guid
            Public Overridable Property RecordStatus As String
            Public Overridable Property Tags As String
            Public Overridable Property ListId As Guid
            Public Overridable Property MarkAsChecked As Boolean
            Public Overridable Property RelatedObjectId As Guid
            Public Overridable Property CanEdit As Boolean
            Public Overridable Property IsOwner As Boolean
            Public Overridable Property ExtraValues As List(Of Object)
            Public Overridable Property ListItemFilters As List(Of ListItemFilter)
        End Class

        Public Partial Class ListItemFilter
            Public Overridable Property ListItemFilterId As Guid
            Public Overridable Property FilterName As String
            Public Overridable Property ListId As Guid
            Public Overridable Property ListItemId As Guid
            Public Overridable Property ListItemIsInFilter As Boolean
        End Class
    End Namespace

    Namespace Eros.Subtle.Canvara.WebAPIModel.ServiceModel

        '''<Summary>
        '''Gets a list of integration data sources
        '''</Summary>
        <Api(Description:="Gets a list of integration data sources")>
        Public Partial Class GetDataSources
        End Class

        Public Partial Class GetDataSourcesResponse
            Public Overridable Property DataSources As List(Of ListDataItem)
            Public Overridable Property ResponseStatus As ResponseStatus
        End Class
    End Namespace
End Namespace

VB.NET GetDataSources 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/datasources HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<GetDataSources xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel" />

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>