Framework API

GetWorkflowData

Retrieves Updated workflow data to be saved to Framework

import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


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

    /**
    * 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")
    override var SuiteDataSourceInstanceId:UUID? = null

    override var IgnoreValidation:Boolean? = null
}

@ApiResponse(Description="Eros workflow data for synching to Framework")
open class GetWorkflowDataResponse
{
    /**
    * Bin Row Version of the last update
    */
    @ApiMember(Description="Bin Row Version of the last update")
    open var BinRowVersion:ByteArray? = null

    /**
    * XML string containing the workflow Data
    */
    @ApiMember(Description="XML string containing the workflow Data")
    open var WorkflowData:String? = null

    open var ResponseStatus:ResponseStatus? = null
}

Kotlin GetWorkflowData DTOs

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

HTTP + JSV

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

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

{
	BinRowVersion: AA==,
	IgnoreValidation: True
}

HTTP/1.1 200 OK
Content-Type: text/jsv
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
		}
	}
}