Platform API

GetAutomationTypesByObjectType

Get automation types available for the specified object type (rmsTableCtxId)

The following routes are available for this service:
GET	/api/automation/availabletypes/{RmsTableCtxId}

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.Saguna.Common.WebAPIModel.Models

Namespace Global

    Namespace Eros.Saguna.Common.WebAPIModel.Models

        Public Partial Class ListItemModel
            Public Overridable Property ListItemId As Guid
            Public Overridable Property Name As String
            Public Overridable Property Description As String
            Public Overridable Property ShortName 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
        End Class
    End Namespace

    Namespace Eros.Subtle.Canvara.WebAPIModel.ServiceModel

        '''<Summary>
        '''Get automation types available for the specified object type (rmsTableCtxId)
        '''</Summary>
        <Api(Description:="Get automation types available for the specified object type (rmsTableCtxId)")>
        Public Partial Class GetAutomationTypesByObjectType
            '''<Summary>
            '''RmsTableCtx Id to filter available automation types by
            '''</Summary>
            <ApiMember(Description:="RmsTableCtx Id to filter available automation types by", ParameterType:="path")>
            Public Overridable Property RmsTableCtxId As Guid
        End Class

        <ApiResponse(Description:="A list of automation types assignable to a particular object type")>
        Public Partial Class GetAutomationTypesByObjectTypeResponse
            '''<Summary>
            '''List of applicable automation types.
            '''</Summary>
            <ApiMember(Description:="List of applicable automation types.")>
            Public Overridable Property AutomationTypes As List(Of ListItemModel)

            Public Overridable Property ResponseStatus As ResponseStatus
        End Class
    End Namespace
End Namespace

VB.NET GetAutomationTypesByObjectType 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.

GET /api/automation/availabletypes/{RmsTableCtxId} HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: application/xml

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

<GetAutomationTypesByObjectTypeResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
  <AutomationTypes xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eros.Saguna.Common.WebAPIModel.Models">
    <d2p1:ListItemModel>
      <d2p1:Description>String</d2p1:Description>
      <d2p1:IsDefault>false</d2p1:IsDefault>
      <d2p1:ListItemId>00000000-0000-0000-0000-000000000000</d2p1:ListItemId>
      <d2p1:ListItemTrafficLightId>00000000-0000-0000-0000-000000000000</d2p1:ListItemTrafficLightId>
      <d2p1:Name>String</d2p1:Name>
      <d2p1:Order>0</d2p1:Order>
      <d2p1:OwnerContactId>00000000-0000-0000-0000-000000000000</d2p1:OwnerContactId>
      <d2p1:PrimaryImageThumbnailUrl>String</d2p1:PrimaryImageThumbnailUrl>
      <d2p1:PrimaryListItemImageId>00000000-0000-0000-0000-000000000000</d2p1:PrimaryListItemImageId>
      <d2p1:PrimaryListItemImageUrl>String</d2p1:PrimaryListItemImageUrl>
      <d2p1:RecordStatus>String</d2p1:RecordStatus>
      <d2p1:ShortName>String</d2p1:ShortName>
    </d2p1:ListItemModel>
  </AutomationTypes>
  <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>
</GetAutomationTypesByObjectTypeResponse>