Framework API

<back to all web services

GetWorkflowData

Retrieves Updated workflow data to be saved to Framework

Requires Authentication 
import Foundation
import ServiceStack

/**
* Retrieves Updated workflow data to be saved to Framework
*/
// @Api(Description="Retrieves Updated workflow data to be saved to Framework")
public class GetWorkflowData : ISubscription, Codable
{
    /**
    * Bin Row Version of the last update
    */
    // @ApiMember(DataType="byte[]", Description="Bin Row Version of the last update", Name="BinRowVersion")
    public var binRowVersion:[UInt8]

    /**
    * Suite Data Source Instance Id to determine which licensees data to retrieve.
    */
    // @ApiMember(DataType="Guid", Description="Suite Data Source Instance Id to determine which licensees data to retrieve.", Name="SuiteDataSourceInstanceId")
    public var suiteDataSourceInstanceId:String

    public var ignoreValidation:Bool

    required public init(){}
}

// @ApiResponse(Description="Eros workflow data for synching to Framework")
public class GetWorkflowDataResponse : Codable
{
    /**
    * Bin Row Version of the last update
    */
    // @ApiMember(Description="Bin Row Version of the last update")
    public var binRowVersion:[UInt8]

    /**
    * XML string containing the workflow Data
    */
    // @ApiMember(Description="XML string containing the workflow Data")
    public var workflowData:String

    public var responseStatus:ResponseStatus

    required public init(){}
}

Swift GetWorkflowData DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /json/reply/GetWorkflowData HTTP/1.1 
Host: gatewayframeworkapi.pstpf.com.au 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"BinRowVersion":"AA==","IgnoreValidation":true}

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

{"BinRowVersion":"AA==","WorkflowData":"String","ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}