Foundry API

CreateMachineRequest

The following routes are available for this service:
POST	/machines

import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


TResponse = TypeVar('TResponse')


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PostOperationUnTenanted(Generic[TResponse], IReturn[TResponse], IPost):
    @staticmethod
    def response_type(): return TResponse


TResponse = TypeVar('TResponse')


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PostOperationTenanted(Generic[TResponse], PostOperationUnTenanted[TResponse], ITenantedRequest):
    organisation_id: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Machine(IIdentifiableResource):
    name: Optional[str] = None
    type: Optional[str] = None
    manufactured_on: Optional[datetime.datetime] = None
    location: Optional[str] = None
    configuration: Optional[str] = None
    id: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CreateMachineResponse:
    response_status: Optional[ResponseStatus] = None
    machine: Optional[Machine] = None
    api_key: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CreateMachineRequest(PostOperationTenanted[CreateMachineResponse]):
    name: Optional[str] = None
    type: Optional[str] = None
    manufactured_on: Optional[datetime.datetime] = None
    location: Optional[str] = None
    timezone: Optional[str] = None

Python CreateMachineRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /machines HTTP/1.1 
Host: foundrystage-api-app.azurewebsites.net 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"name":"String","type":"String","manufacturedOn":"0001-01-01","location":"String","timezone":"String","organisationId":"String"}

HTTP/1.1 200 OK
Content-Type: application/json
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"},"apiKey":"String"}