BazeField Services

<back to all web services

DeviceInfoGetRequest

Configuration API
Requires Authentication
The following routes are available for this service:
GET, POST/configuration/objects/{ObjectIds}/devices
namespace Bazefield.Configuration.Entity

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

    [<AllowNullLiteral>]
    type DeviceInfoEntity() = 
        member val Id:Int32 = new Int32() with get,set
        member val Description:String = null with get,set
        member val Name:String = null with get,set
        member val LoadOrder:Int32 = new Int32() with get,set
        member val NodeId:Guid = new Guid() with get,set
        member val NodeName:String = null with get,set
        member val ProtocolId:Int32 = new Int32() with get,set
        member val ProtocolName:String = null with get,set
        member val ConnectionString:String = null with get,set

    [<AllowNullLiteral>]
    type DeviceInfoGetResponse() = 
        member val Devices:Dictionary<Int32, DeviceInfoEntity> = new Dictionary<Int32, DeviceInfoEntity>() with get,set

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

F# DeviceInfoGetRequest 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.

POST /configuration/objects/{ObjectIds}/devices HTTP/1.1 
Host: monitoring.ox2.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	objectIds: 
	[
		String
	]
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	devices: 
	{
		0: 
		{
			id: 0,
			description: String,
			name: String,
			loadOrder: 0,
			nodeName: String,
			protocolId: 0,
			protocolName: String,
			connectionString: String
		}
	}
}