Foundry API

UpdateMachineRequest

The following routes are available for this service:
PUT,PATCH	/machines/{Id}

namespace Application.Interfaces.Resources

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type Machine() = 
        member val Name:String = null with get,set
        member val Type:String = null with get,set
        member val ManufacturedOn:DateOnly = new DateOnly() with get,set
        member val Location:String = null with get,set
        member val Configuration:String = null with get,set
        member val Id:String = null with get,set

    [<AllowNullLiteral>]
    type UpdateMachineResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val Machine:Machine = null with get,set

    [<AllowNullLiteral>]
    type UpdateMachineRequest() = 
        inherit PutPatchOperationTenanted<UpdateMachineResponse>()
        member val Id:String = null with get,set
        member val Name:String = null with get,set
        member val Type:String = null with get,set
        member val ManufacturedOn:Nullable<DateOnly> = new Nullable<DateOnly>() with get,set
        member val Location:String = null with get,set
        member val Configuration:String = null with get,set

    [<AllowNullLiteral>]
    type PutPatchOperationTenanted<'TResponse>() = 
        inherit PutPatchOperationUnTenanted<TResponse>()
        member val OrganisationId:String = null with get,set

    [<AllowNullLiteral>]
    type PutPatchOperationUnTenanted<'TResponse>() = 
        interface IPatch
        interface IPut

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