Foundry API

<back to all web services

CreateMachineRequest

Requires Authentication
The following routes are available for this service:
POST/machines
CreateMachineRequest Parameters:
NameParameterData TypeRequiredDescription
NamebodystringNo
TypebodystringNo
ManufacturedOnbodyDateOnlyNo
LocationbodystringNo
TimezonebodystringNo
PostOperationTenanted<TResponse> Parameters:
NameParameterData TypeRequiredDescription
OrganisationIdformstringNo
CreateMachineResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
MachineformMachineNo
ApiKeyformstringNo
Machine Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
TypeformstringNo
ManufacturedOnformDateOnlyNo
LocationformstringNo
ConfigurationformstringNo
IdformstringNo
CreateMachineResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
MachineformMachineNo
ApiKeyformstringNo

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

HTTP + XML

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/xml
Content-Type: application/xml
Content-Length: length

<CreateMachineRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Infrastructure.Api.Interfaces.ServiceOperations.Machines">
  <OrganisationId xmlns="http://schemas.datacontract.org/2004/07/Infrastructure.Api.Interfaces.ServiceOperations">String</OrganisationId>
  <Location>String</Location>
  <ManufacturedOn xmlns:d2p1="http://schemas.datacontract.org/2004/07/System" />
  <Name>String</Name>
  <Timezone>String</Timezone>
  <Type>String</Type>
</CreateMachineRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CreateMachineResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Infrastructure.Api.Interfaces.ServiceOperations.Machines">
  <ApiKey>String</ApiKey>
  <Machine xmlns:d2p1="http://schemas.datacontract.org/2004/07/Application.Interfaces.Resources">
    <d2p1:Configuration>String</d2p1:Configuration>
    <d2p1:Id>String</d2p1:Id>
    <d2p1:Location>String</d2p1:Location>
    <d2p1:ManufacturedOn xmlns:d3p1="http://schemas.datacontract.org/2004/07/System" />
    <d2p1:Name>String</d2p1:Name>
    <d2p1:Type>String</d2p1:Type>
  </Machine>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</CreateMachineResponse>