Foundry API

GetWarningRequest

The following routes are available for this service:
GET	/warnings/{Id}

Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports Infrastructure.Api.Interfaces.ServiceOperations.Warnings
Imports Infrastructure.Api.Interfaces.ServiceOperations
Imports Application.Interfaces.Resources

Namespace Global

    Namespace Application.Interfaces.Resources

        Public Partial Class Warning
            Implements IIdentifiableResource
            Public Overridable Property Id As String
            Public Overridable Property MachineId As String
            Public Overridable Property Type As String
            Public Overridable Property StartedAt As Date
            Public Overridable Property ResolvedAt As Date
            Public Overridable Property Description As String
        End Class
    End Namespace

    Namespace Infrastructure.Api.Interfaces.ServiceOperations

        Public Partial Class GetOperationTenanted(Of TResponse)
            Inherits GetOperationUnTenanted(Of TResponse)
            Implements ITenantedRequest
            Public Overridable Property OrganisationId As String
        End Class

        Public Partial Class GetOperationUnTenanted(Of TResponse)
            Implements IHasGetOptions
            Implements IGet
            Public Overridable Property Embed As String
        End Class
    End Namespace

    Namespace Infrastructure.Api.Interfaces.ServiceOperations.Warnings

        Public Partial Class GetWarningRequest
            Inherits GetOperationTenanted(Of GetWarningResponse)
            Public Overridable Property Id As String
        End Class

        Public Partial Class GetWarningResponse
            Public Overridable Property ResponseStatus As ResponseStatus
            Public Overridable Property Warning As Warning
        End Class
    End Namespace
End Namespace

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

GET /warnings/{Id} HTTP/1.1 
Host: foundrystage-api-app.azurewebsites.net 
Accept: text/jsv

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	},
	warning: 
	{
		id: String,
		machineId: String,
		type: String,
		description: String
	}
}