| GET | /api/automation/availabletypes/{RmsTableCtxId} |
|---|
import Foundation
import ServiceStack
/**
* Get automation types available for the specified object type (rmsTableCtxId)
*/
// @Api(Description="Get automation types available for the specified object type (rmsTableCtxId)")
public class GetAutomationTypesByObjectType : Codable
{
/**
* RmsTableCtx Id to filter available automation types by
*/
// @ApiMember(Description="RmsTableCtx Id to filter available automation types by", ParameterType="path")
public var rmsTableCtxId:String
required public init(){}
}
// @ApiResponse(Description="A list of automation types assignable to a particular object type")
public class GetAutomationTypesByObjectTypeResponse : Codable
{
/**
* List of applicable automation types.
*/
// @ApiMember(Description="List of applicable automation types.")
public var automationTypes:[ListItemModel]
public var responseStatus:ResponseStatus
required public init(){}
}
public class ListItemModel : Codable
{
public var listItemId:String
public var name:String
public var Description:String
public var shortName:String
public var isDefault:Bool
public var order:Int
public var listItemTrafficLightId:String
public var primaryListItemImageId:String
public var primaryListItemImageUrl:String
public var primaryImageThumbnailUrl:String
public var ownerContactId:String
public var recordStatus:String
required public init(){}
}
Swift GetAutomationTypesByObjectType DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
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: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
AutomationTypes:
[
{
Name: String,
Description: String,
ShortName: String,
IsDefault: False,
Order: 0,
PrimaryListItemImageUrl: String,
PrimaryImageThumbnailUrl: String,
RecordStatus: String
}
],
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
}
}