Framework API

<back to all web services

GetWorkflowData

Retrieves Updated workflow data to be saved to Framework

Requires Authentication 
namespace FrameworkApi.Models

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<ApiResponse(Description="Eros workflow data for synching to Framework")>]
    [<AllowNullLiteral>]
    type GetWorkflowDataResponse() = 
        ///<summary>
        ///Bin Row Version of the last update
        ///</summary>
        [<ApiMember(Description="Bin Row Version of the last update")>]
        member val BinRowVersion:Byte[] = null with get,set

        ///<summary>
        ///XML string containing the workflow Data
        ///</summary>
        [<ApiMember(Description="XML string containing the workflow Data")>]
        member val WorkflowData:String = null with get,set

        member val ResponseStatus:ResponseStatus = null with get,set

    ///<summary>
    ///Retrieves Updated workflow data to be saved to Framework
    ///</summary>
    [<Api(Description="Retrieves Updated workflow data to be saved to Framework")>]
    [<AllowNullLiteral>]
    type GetWorkflowData() = 
        ///<summary>
        ///Bin Row Version of the last update
        ///</summary>
        [<ApiMember(DataType="byte[]", Description="Bin Row Version of the last update", Name="BinRowVersion")>]
        member val BinRowVersion:Byte[] = null with get,set

        ///<summary>
        ///Suite Data Source Instance Id to determine which licensees data to retrieve.
        ///</summary>
        [<ApiMember(DataType="Guid", Description="Suite Data Source Instance Id to determine which licensees data to retrieve.", Name="SuiteDataSourceInstanceId")>]
        member val SuiteDataSourceInstanceId:Guid = new Guid() with get,set

        member val IgnoreValidation:Boolean = new Boolean() with get,set

F# GetWorkflowData 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/GetWorkflowData HTTP/1.1 
Host: gatewayframeworkapi.pstpf.com.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<GetWorkflowData xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FrameworkApi.Models">
  <BinRowVersion>AA==</BinRowVersion>
  <SuiteDataSourceInstanceId>00000000-0000-0000-0000-000000000000</SuiteDataSourceInstanceId>
</GetWorkflowData>

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

<GetWorkflowDataResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FrameworkApi.Models">
  <BinRowVersion>AA==</BinRowVersion>
  <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>
  <WorkflowData>String</WorkflowData>
</GetWorkflowDataResponse>