GetEndpointInformationResponse Class

[This is preliminary documentation and is subject to change.]

Allows any CFX endpoint to request the capabilities of a specified single endpoint. The response sends basic information about the endpoint, including its CFX Handle, and network hostname / address.

Copy

{
  "Result": {
    "Result": "Success",
    "ResultCode": 0,
    "Message": null
  },
  "CFXHandle": "SMTPlus.Model_21232.SN23123",
  "RequestNetworkUri": "amqp://host33:5688/",
  "RequestTargetAddress": "/queue/SN23123",
  "UniqueIdentifier": "UID564545645645656564",
  "FriendlyName": "SMD Placer 23123",
  "Vendor": "SMT Plus",
  "ModelNumber": "Model_21232",
  "SerialNumber": "SN23123",
  "NumberOfStages": 4,
  "NumberOfLanes": 1,
  "SupportedTopics": [
    {
      "TopicName": "CFX.Production",
      "TopicSupportType": "PublisherConsumer",
      "SupportedMessages": []
    },
    {
      "TopicName": "CFX.Production.Assembly",
      "TopicSupportType": "Publisher",
      "SupportedMessages": []
    },
    {
      "TopicName": "CFX.ResourcePerformance",
      "TopicSupportType": "Publisher",
      "SupportedMessages": []
    }
  ]
}

Inheritance Hierarchy

SystemObject
CFXCFXMessage
CFXGetEndpointInformationResponse

Namespace: CFX
Assembly: CFXnet46 (in CFXnet46.dll) Version: 1.0.5

Syntax

Copy

public class GetEndpointInformationResponse : CFXMessage

Public Class GetEndpointInformationResponse
	Inherits CFXMessage

The GetEndpointInformationResponse type exposes the following members.

Properties

	Name	Description
	CFXHandle	The handle of the endpoint that is responding
	FriendlyName	The name of the endpoint to be used in GUIs or reporting
	ModelNumber	The model number of the endpoint
	NumberOfLanes	The number of production lanes of the endpoint
	NumberOfStages	The number of stages (zones) of the endpoint
	RequestNetworkUri	The network address / Uri to be used for requests to this endpoint
	RequestTargetAddress	The AMQP 1.0 target address to be used for requests to this endpoint
	Result	The result of the request
	SerialNumber	The serial number of the endpoint
	SupportedTopics	A list of the SupportedTopics structures describing the level of support for this endpoint
	UniqueIdentifier	The barcode, RFID, or other unique identifier that is used to identify this machine / endpoint.
	Vendor	The name of the vendor of the endpoint.

Top

Reference

CFX Namespace