Foundry API

<back to all web services

UpdateMachineRequest

Requires Authentication
The following routes are available for this service:
PUT,PATCH/machines/{Id}
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Infrastructure.Api.Interfaces.ServiceOperations.Machines;
using Infrastructure.Api.Interfaces.ServiceOperations;
using Application.Interfaces.Resources;

namespace Application.Interfaces.Resources
{
    public partial class Machine
        : IIdentifiableResource
    {
        public virtual string Name { get; set; }
        public virtual string Type { get; set; }
        public virtual DateOnly ManufacturedOn { get; set; }
        public virtual string Location { get; set; }
        public virtual string Configuration { get; set; }
        public virtual string Id { get; set; }
    }

}

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

    public partial class PutPatchOperationUnTenanted<TResponse>
        : IPatch, IPut
    {
    }

}

namespace Infrastructure.Api.Interfaces.ServiceOperations.Machines
{
    public partial class UpdateMachineRequest
        : PutPatchOperationTenanted<UpdateMachineResponse>
    {
        public virtual string Id { get; set; }
        public virtual string Name { get; set; }
        public virtual string Type { get; set; }
        public virtual DateOnly? ManufacturedOn { get; set; }
        public virtual string Location { get; set; }
        public virtual string Configuration { get; set; }
    }

    public partial class UpdateMachineResponse
    {
        public virtual ResponseStatus ResponseStatus { get; set; }
        public virtual Machine Machine { get; set; }
    }

}

C# UpdateMachineRequest 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.

PUT /machines/{Id} HTTP/1.1 
Host: foundrystage-api-app.azurewebsites.net 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	id: String,
	name: String,
	type: String,
	manufacturedOn: 0001-01-01,
	location: String,
	configuration: String,
	organisationId: String
}
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
		}
	},
	machine: 
	{
		name: String,
		type: String,
		manufacturedOn: 0001-01-01,
		location: String,
		configuration: String,
		id: String
	}
}