Foundry API

SearchMachinesRequest

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

namespace Application.Interfaces

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

    type SortDirection =
        | Ascending = 0
        | Descending = 1

    [<AllowNullLiteral>]
    type Sorting() = 
        member val By:String = null with get,set
        member val Direction:SortDirection = new SortDirection() with get,set

    [<AllowNullLiteral>]
    type Filtering() = 
        member val Fields:ResizeArray<String> = new ResizeArray<String>() with get,set

    [<AllowNullLiteral>]
    type SearchMetadata() = 
        member val Total:Int32 = new Int32() with get,set
        member val Limit:Int32 = new Int32() with get,set
        member val Offset:Int32 = new Int32() with get,set
        member val Sort:Sorting = null with get,set
        member val Filter:Filtering = null with get,set

    [<AllowNullLiteral>]
    type SearchOperationResponse() = 
        member val Metadata:SearchMetadata = null with get,set

    [<AllowNullLiteral>]
    type SearchMachine() = 
        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 Id:String = null with get,set

    [<AllowNullLiteral>]
    type SearchMachinesResponse() = 
        inherit SearchOperationResponse()
        member val ResponseStatus:ResponseStatus = null with get,set
        member val Machines:ResizeArray<SearchMachine> = new ResizeArray<SearchMachine>() with get,set

    [<AllowNullLiteral>]
    type SearchMachinesRequest() = 
        inherit SearchOperationTenanted<SearchMachinesResponse>()

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

    [<AllowNullLiteral>]
    type SearchOperationUnTenanted<'TResponse>() = 
        inherit GetOperationUnTenanted<TResponse>()
        member val Distinct:String = null with get,set
        member val Limit:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val Offset:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val Sort:String = null with get,set
        member val Filter:String = null with get,set

    [<AllowNullLiteral>]
    type GetOperationUnTenanted<'TResponse>() = 
        interface IGet
        member val Embed:String = null with get,set

F# SearchMachinesRequest DTOs

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.

GET /machines HTTP/1.1 
Host: staging-api.foundrylab.com 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<SearchMachinesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Infrastructure.Api.Interfaces.ServiceOperations.Machines">
  <Metadata xmlns:d2p1="http://schemas.datacontract.org/2004/07/Application.Interfaces" xmlns="http://schemas.datacontract.org/2004/07/Infrastructure.Api.Interfaces.ServiceOperations">
    <d2p1:Filter>
      <d2p1:Fields xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </d2p1:Fields>
    </d2p1:Filter>
    <d2p1:Limit>0</d2p1:Limit>
    <d2p1:Offset>0</d2p1:Offset>
    <d2p1:Sort>
      <d2p1:By>String</d2p1:By>
      <d2p1:Direction>Ascending</d2p1:Direction>
    </d2p1:Sort>
    <d2p1:Total>0</d2p1:Total>
  </Metadata>
  <Machines xmlns:d2p1="http://schemas.datacontract.org/2004/07/Application.Interfaces.Resources">
    <d2p1:SearchMachine>
      <d2p1:Id>String</d2p1:Id>
      <d2p1:Location>String</d2p1:Location>
      <d2p1:ManufacturedOn xmlns:d4p1="http://schemas.datacontract.org/2004/07/System" />
      <d2p1:Name>String</d2p1:Name>
      <d2p1:Type>String</d2p1:Type>
    </d2p1:SearchMachine>
  </Machines>
  <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>
</SearchMachinesResponse>