Foundry API

<back to all web services

GetWarningRequest

Requires Authentication
The following routes are available for this service:
GET/warnings/{Id}
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Infrastructure.Api.Interfaces.ServiceOperations.Warnings;
using Infrastructure.Api.Interfaces.ServiceOperations;
using Application.Interfaces.Resources;

namespace Application.Interfaces.Resources
{
    public partial class Warning
        : IIdentifiableResource
    {
        public virtual string Id { get; set; }
        public virtual string MachineId { get; set; }
        public virtual string Type { get; set; }
        public virtual DateTime StartedAt { get; set; }
        public virtual DateTime ResolvedAt { get; set; }
        public virtual string Description { get; set; }
    }

}

namespace Infrastructure.Api.Interfaces.ServiceOperations
{
    public partial class GetOperationTenanted<TResponse>
        : GetOperationUnTenanted<TResponse>, ITenantedRequest
    {
        public virtual string OrganisationId { get; set; }
    }

    public partial class GetOperationUnTenanted<TResponse>
        : IHasGetOptions, IGet
    {
        public virtual string Embed { get; set; }
    }

}

namespace Infrastructure.Api.Interfaces.ServiceOperations.Warnings
{
    public partial class GetWarningRequest
        : GetOperationTenanted<GetWarningResponse>
    {
        public virtual string Id { get; set; }
    }

    public partial class GetWarningResponse
    {
        public virtual ResponseStatus ResponseStatus { get; set; }
        public virtual Warning Warning { get; set; }
    }

}

C# 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
	}
}