Pro Series API

Schemas

Fort.ProSeriesApi.Models.Dtos.AddNetworkDeviceRequest

serialNumberstring | null
The serial number identifying the device.
ipAddressstring | null
The IP address of the device. Only required when network uses IP communications.
deviceConfigurationTypestring · enum
The role that the device will be in the configuration. All configurations must have at least one sender and one receiver.
Enum values:
Sender
Receiver
EStopSender
commInterfacestring · enum
Device communication interface flags. Can be used individually or combined. (e.g., "Wifi", "BLE, Ethernet" or "BLE,ISM,Wifi").
Enum values:
None
BLE
ISM
Ethernet
Wifi
inputConfiguration1string · enum
Input 1's function(pin 3 and 6) on the endpoint controller's J1 connector. Input 1 must be set to NOT_USED on SRCP and WESP devices. Input 2's function(pin 2 and 5) on the endpoint controller's J1 connector. Input 2 is not applicable to NSC Pro devices that use CAT 1 stop category. Input 2 must be set to NOT_USED on SRCP and WESP devices. Must be set to NOT_USED on SRCP and WESP devices.
Enum values:
NOT_USED
ESTOP_TYPE_SWITCH
SOLID_STATE_SAFETY_DEVICE
REMOTE_SAFETY_REQUEST
REMOTE_SAFETY_REQUEST_WITH_AUTONOMY_SELECT
inputConfiguration2string · enum
Input 1's function(pin 3 and 6) on the endpoint controller's J1 connector. Input 1 must be set to NOT_USED on SRCP and WESP devices. Input 2's function(pin 2 and 5) on the endpoint controller's J1 connector. Input 2 is not applicable to NSC Pro devices that use CAT 1 stop category. Input 2 must be set to NOT_USED on SRCP and WESP devices. Must be set to NOT_USED on SRCP and WESP devices.
Enum values:
NOT_USED
ESTOP_TYPE_SWITCH
SOLID_STATE_SAFETY_DEVICE
REMOTE_SAFETY_REQUEST
REMOTE_SAFETY_REQUEST_WITH_AUTONOMY_SELECT
inputConfiguration3string · enum
Input 1's function(pin 3 and 6) on the endpoint controller's J1 connector. Input 1 must be set to NOT_USED on SRCP and WESP devices. Input 2's function(pin 2 and 5) on the endpoint controller's J1 connector. Input 2 is not applicable to NSC Pro devices that use CAT 1 stop category. Input 2 must be set to NOT_USED on SRCP and WESP devices. Must be set to NOT_USED on SRCP and WESP devices.
Enum values:
NOT_USED
ESTOP_TYPE_SWITCH
SOLID_STATE_SAFETY_DEVICE
REMOTE_SAFETY_REQUEST
REMOTE_SAFETY_REQUEST_WITH_AUTONOMY_SELECT
can0Idinteger · int32
The id of can interface
serial0Usagestring · enum
NSC Pro only. The physical output interface between the FORT Pro device and your equipment under control. Can be FORT SDK(comms) or Data Output Control(control). FORT SDK and Data Output Control can each only be set on one serial at a time."
Enum values:
comms
control
serial1Usagestring · enum
NSC Pro only. The physical output interface between the FORT Pro device and your equipment under control. Can be FORT SDK(comms) or Data Output Control(control). FORT SDK and Data Output Control can each only be set on one serial at a time."
Enum values:
comms
control
stopCategorystring · enum
NSC Pro only. E-Stop category CAT0: For an EPC Sender - If ESTOP is on input #1 it disables receiver output #1; if ESTOP on input #2 it disables receiver output #2. For an SRCP transmitter - The last output of the receiver (output #2 for NSCP or output #3 for EPC) is turned off. CAT1: Output #1 of the receiver is turned off immediately, and after a user-defined delay (CAT1 Delay), output #2 of the receiver is turned off.
Enum values:
CAT0
CAT1
cat1StopDelaynumber | null · float
Delay for the CAT1 E-Stop.
ethNetmaskstring | null
The ethernet interface netmask. Only used in networks that use ethernet communications
ethGatewaystring | null
The ethernet interface gateway. Only used in networks that use ethernet communications
ethNameserversarray | null
The ethernet interface nameservers. Only used in networks that use ethernet communications
wifiNetmaskstring | null
The wifi interface netmask. Only used in networks that use wifi communications
wifiGatewaystring | null
The wifi interface gateway. Only used in networks that use wifi communications
wifiNameserversarray | null
The wifi interface nameservers
wifiSsidstring | null
The wifi SSID
wifiPasswordstring | null
The wifi password
networkTemplateIdstring · uuid
The network template id

Fort.ProSeriesApi.Models.Dtos.AddNetworkDeviceResponse

idstring · uuid
The network id
namestring | null
createdstring · date-time
isNetworkCompleteboolean
Indicates whether the network is complete or has any validation errors.
devicesarray | null
impactsarray | null

Fort.ProSeriesApi.Models.Dtos.AddNetworkDeviceResponseDevice

idstring · uuid
The device id
namestring | null
deviceConfigurationTypestring · enum
The role that the device will be in the configuration. All configurations must have at least one sender and one receiver.
Enum values:
Sender
Receiver
EStopSender
serialNumberstring | null
The serial number identifying the device.
modelNamestring | null
typestring · enum
Enum values:
SRCP
WESP
EPC
NSCP

Fort.ProSeriesApi.Models.Dtos.AddNetworkDeviceResponseUser

idstring · uuid
The user id
firstNamestring | null
lastNamestring | null
emailstring | null
The user's email
createdstring · date-time

Fort.ProSeriesApi.Models.Dtos.ApiConsumer

createdOnstring · date-time · required
When the consumer was created
updatedOnstring · date-time · required
When the consumer was updated
idstring · minLength: 1 · required
The consumer Id
namestring · minLength: 1 · required
The name of the consumer
descriptionstring · minLength: 1 · required
The description of the consumer
tagsobject · required
The consumer tags. Used to tag a service account user to the consumer
userRolesstring[] · required
Roles the service account associated with this key has.
Enum values:
Operator
DeviceManager
ConfigManager
Admin

apiKeyobject

Fort.ProSeriesApi.Models.Dtos.ApiKey

createdOnstring · date-time · required
When the item was created.
updatedOnstring · date-time · required
When the item was last updated.
idstring · minLength: 1 · required
descriptionstring · minLength: 1 · required
The description of the api key.
keystring · minLength: 1 · required
The API key's value.

expiresOnstring | null · date-time
When the key expires.

Fort.ProSeriesApi.Models.Dtos.ApiResponse`1[[Fort.ProSeriesApi.Models.Dtos.AddNetworkDeviceResponse, Fort.ProSeriesApi.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]

dataobject
successboolean
errorsarray | null

Fort.ProSeriesApi.Models.Dtos.ApiResponse`1[[Fort.ProSeriesApi.Models.Dtos.CreateNetworkResponse, Fort.ProSeriesApi.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]

dataobject
successboolean
errorsarray | null

Fort.ProSeriesApi.Models.Dtos.ApiResponse`1[[Fort.ProSeriesApi.Models.Dtos.DeleteNetworkDeviceResponse, Fort.ProSeriesApi.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]

dataobject
successboolean
errorsarray | null

Fort.ProSeriesApi.Models.Dtos.ApiResponse`1[[Fort.ProSeriesApi.Models.Dtos.GetNetworkByIdResponse, Fort.ProSeriesApi.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]

dataobject
successboolean
errorsarray | null

Fort.ProSeriesApi.Models.Dtos.ApiResponse`1[[Fort.ProSeriesApi.Models.Dtos.GetUserByIdResponse, Fort.ProSeriesApi.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]

dataobject
successboolean
errorsarray | null

Fort.ProSeriesApi.Models.Dtos.ApiResponse`1[[Fort.ProSeriesApi.Models.Dtos.IpNetworkTemplateDetail, Fort.ProSeriesApi.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]

dataobject
successboolean
errorsarray | null

Fort.ProSeriesApi.Models.Dtos.ApiResponse`1[[Fort.ProSeriesApi.Models.Dtos.PagedResults`1[[Fort.ProSeriesApi.Models.Dtos.GetAllDevicesResponse, Fort.ProSeriesApi.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], Fort.ProSeriesApi.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]

dataobject
successboolean
errorsarray | null

Fort.ProSeriesApi.Models.Dtos.ApiResponse`1[[Fort.ProSeriesApi.Models.Dtos.PagedResults`1[[Fort.ProSeriesApi.Models.Dtos.GetAllNetworksResponse, Fort.ProSeriesApi.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], Fort.ProSeriesApi.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]

dataobject
successboolean
errorsarray | null

Fort.ProSeriesApi.Models.Dtos.ApiResponse`1[[Fort.ProSeriesApi.Models.Dtos.PagedResults`1[[Fort.ProSeriesApi.Models.Dtos.GetAllUsersResponse, Fort.ProSeriesApi.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], Fort.ProSeriesApi.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]

dataobject
successboolean
errorsarray | null

Fort.ProSeriesApi.Models.Dtos.ApiResponse`1[[Fort.ProSeriesApi.Models.Dtos.RegisterDeviceResponse, Fort.ProSeriesApi.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]

dataobject
successboolean
errorsarray | null

Fort.ProSeriesApi.Models.Dtos.ApiResponse`1[[Fort.ProSeriesApi.Models.Dtos.UpdateDeviceResponse, Fort.ProSeriesApi.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]

dataobject
successboolean
errorsarray | null

Fort.ProSeriesApi.Models.Dtos.ApiResponse`1[[Fort.ProSeriesApi.Models.Dtos.UpdateNetworkDeviceResponse, Fort.ProSeriesApi.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]

dataobject
successboolean
errorsarray | null

Fort.ProSeriesApi.Models.Dtos.ApiResponse`1[[Fort.ProSeriesApi.Models.Dtos.UpdateNetworkResponse, Fort.ProSeriesApi.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]

dataobject
successboolean
errorsarray | null

Fort.ProSeriesApi.Models.Dtos.ApiResponse`1[[System.Boolean, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]

databoolean
successboolean
errorsarray | null

Fort.ProSeriesApi.Models.Dtos.ApiResponse`1[[System.Collections.Generic.IEnumerable`1[[Fort.ProSeriesApi.Models.Dtos.IpNetworkTemplateDetail, Fort.ProSeriesApi.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]

dataarray | null
successboolean
errorsarray | null

Fort.ProSeriesApi.Models.Dtos.ApiResponse`1[[System.Collections.Generic.List`1[[Fort.ProSeriesApi.Models.Dtos.ApiConsumer, Fort.ProSeriesApi.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]

dataarray | null
successboolean
errorsarray | null

Fort.ProSeriesApi.Models.Dtos.CreateNetworkRequest

namestring · minLength: 1 · required
The name of the network

startingIpAddressstring | null
The starting ip that will be used when assigning IP network capable devices.
ismTxPowerstring · enum
Enum values:
Medium
High
Low
ismTxChannelinteger | null · int32
The channel number that the ISM radio will use. North America should be between(inclusive) 1 and 21. EU must be set to 1.
canModestring · enum
The CAN mode
Enum values:
canopen
j1939
none
canKBitratestring · enum
Can bitrate options. EPC and NSCP devices can only be BITRATE_250000 and BITRATE_500000.
Enum values:
BITRATE_10000
BITRATE_20000
BITRATE_50000
BITRATE_125000
BITRATE_250000
BITRATE_500000
BITRATE_800000
BITRATE_1000000
displayTextPgninteger | null · int32
If CAN mode is J1939 then this can be set. If not set, it will be set to a default value of: 65281 (0xFF01). Must have a value between: 0xFF00 and 0xFFFF.
settingsPgninteger | null · int32
If CAN mode is J1939 then this can be set. If not set, it will be set to a default value of: 65282 (0xFF02). Must have a value between: 0xFF00 and 0xFFFF.
approvedSourceAddressesarray | null
Array of the node ids of ECUs to listen to. Addresses must be between 0 and 255.
receiverOutputControlinteger | null · int32
Which output on the receiver the sender will control. Must be 1 or 2
timeoutConfigurationstring · enum
The safety timeout delay for the configuration.
Enum values:
250ms
500ms
750ms
1000ms
3000ms
5000ms

Fort.ProSeriesApi.Models.Dtos.CreateNetworkResponse

idstring · uuid
namestring | null
createdstring · date-time

Fort.ProSeriesApi.Models.Dtos.DeleteNetworkDeviceResponse

idstring · uuid
The network id
namestring | null
createdstring · date-time
isNetworkCompleteboolean
Indicates whether the network is complete or has any validation errors.
devicesarray | null

Fort.ProSeriesApi.Models.Dtos.DeleteNetworkDeviceResponseDevice

idstring · uuid
The device id
namestring | null
deviceConfigurationTypestring · enum
The role that the device will be in the configuration. All configurations must have at least one sender and one receiver.
Enum values:
Sender
Receiver
EStopSender
serialNumberstring | null
The serial number identifying the device.
modelNamestring | null
typestring · enum
Enum values:
SRCP
WESP
EPC
NSCP

Fort.ProSeriesApi.Models.Dtos.DeleteNetworkDeviceResponseUser

idstring · uuid
The user id
firstNamestring | null
lastNamestring | null
emailstring | null
The user's email
createdstring · date-time

Fort.ProSeriesApi.Models.Dtos.GetAllDevicesResponse

idstring · uuid · required
The device id
deviceUidinteger · int32 · required
namestring · minLength: 1 · required
serialNumberstring · minLength: 1 · required
The serial number identifying the device.
isConfigurableboolean · required
typestring · enum · required
Enum values:
SRCP
WESP
EPC
NSCP
registeredstring · date-time · required
colorstring · enum · required
Enum values:
One
Two
Three
Four
Five
isConfigurableEstopSenderboolean · required

firmwareLastSyncedstring | null · date-time
configurationLastSyncedstring | null · date-time
imgUrlstring | null
thumbnailUrlstring | null
modelNamestring | null
eth0MacAddressstring | null
eth1MacAddressstring | null
wifiMacAddressstring | null
bleMacAddressstring | null
configsarray | null
deviceConfigurationTypestring · enum
The role that the device will be in the configuration. All configurations must have at least one sender and one receiver.
Enum values:
Sender
Receiver
EStopSender

Fort.ProSeriesApi.Models.Dtos.GetAllDevicesResponseSafetyConfigurationMin

idstring · uuid
The configuration id
namestring | null
lastUpdatedstring | null · date-time

Fort.ProSeriesApi.Models.Dtos.GetAllNetworksResponse

idstring · uuid
The network id
namestring | null
createdstring · date-time
startingIpAddressstring | null
The starting ip that will be used when assigning IP network capable devices.
devicesarray | null
createdByobject
lastUpdatedByobject
lastUpdatedstring | null · date-time
isUserAccountActiveboolean
receiversCountinteger · int32
configTypestring · enum
Enum values:
SRCP_Sender
EPC_Sender
WESP_Sender
EPC_Receiver
NSCP_Receiver
EPC_GlobalEstopSender
isNetworkCompleteboolean
Indicates whether the network is complete or has any validation errors.
estopSenderIdstring · uuid
The device id
timeoutConfigurationstring · enum
The safety timeout delay for the configuration.
Enum values:
250ms
500ms
750ms
1000ms
3000ms
5000ms

Fort.ProSeriesApi.Models.Dtos.GetAllNetworksResponseDevice

idstring · uuid
The device id
deviceUidinteger · int32
namestring | null
serialNumberstring | null
The serial number identifying the device.
isConfigurableboolean
typestring · enum
Enum values:
SRCP
WESP
EPC
NSCP
registeredstring · date-time
firmwareLastSyncedstring | null · date-time
configurationLastSyncedstring | null · date-time
imgUrlstring | null
thumbnailUrlstring | null
modelNamestring | null
configsarray | null
isConfigurableEstopSenderboolean
deviceConfigurationTypestring · enum
The role that the device will be in the configuration. All configurations must have at least one sender and one receiver.
Enum values:
Sender
Receiver
EStopSender

Fort.ProSeriesApi.Models.Dtos.GetAllNetworksResponseNetworkMin

idstring · uuid
The network id
namestring | null
lastUpdatedstring | null · date-time

Fort.ProSeriesApi.Models.Dtos.GetAllNetworksResponseUser

idstring · uuid
The user id
firstNamestring | null
lastNamestring | null
emailstring | null
The user's email
createdstring · date-time
deletedstring | null · date-time
thumbnailUrlstring | null

Fort.ProSeriesApi.Models.Dtos.GetAllUsersResponse

idstring · uuid
The user id
firstNamestring | null
lastNamestring | null
emailstring | null
The user's email
createdstring · date-time
thumbnailUrlstring | null
lastActivitystring · date-time
rolesstring · enum
Enum values:
Operator
DeviceManager
ConfigManager
Admin
isServiceAccountboolean

Fort.ProSeriesApi.Models.Dtos.GetNetworkByIdResponse

idstring · uuid
The network id
namestring | null
createdstring · date-time
isNetworkCompleteboolean
Indicates whether the network is complete or has any validation errors.
startingIpAddressstring | null
The starting ip that will be used when assigning IP network capable devices.
validationErrorsobject
lastUpdatedstring | null · date-time
devicesarray | null
createdByobject
ismTxPowerstring · enum
Enum values:
Medium
High
Low
ismTxChannelinteger | null · int32
The channel number that the ISM radio will use. North America should be between(inclusive) 1 and 21. EU must be set to 1.
canModestring · enum
The CAN mode
Enum values:
canopen
j1939
none
canKBitratestring · enum
Can bitrate options. EPC and NSCP devices can only be BITRATE_250000 and BITRATE_500000.
Enum values:
BITRATE_10000
BITRATE_20000
BITRATE_50000
BITRATE_125000
BITRATE_250000
BITRATE_500000
BITRATE_800000
BITRATE_1000000
configTypestring · enum
Enum values:
SRCP_Sender
EPC_Sender
WESP_Sender
EPC_Receiver
NSCP_Receiver
EPC_GlobalEstopSender
displayTextPgninteger | null · int32
If CAN mode is J1939 then this can be set. If not set, it will be set to a default value of: 65281 (0xFF01). Must have a value between: 0xFF00 and 0xFFFF.
settingsPgninteger | null · int32
If CAN mode is J1939 then this can be set. If not set, it will be set to a default value of: 65282 (0xFF02). Must have a value between: 0xFF00 and 0xFFFF.
approvedSourceAddressesarray | null
Array of the node ids of ECUs to listen to. Addresses must be between 0 and 255.
receiverOutputControlinteger | null · int32
Which output on the receiver the sender will control. Must be 1 or 2
timeoutConfigurationstring · enum
The safety timeout delay for the configuration.
Enum values:
250ms
500ms
750ms
1000ms
3000ms
5000ms

Fort.ProSeriesApi.Models.Dtos.GetNetworkByIdResponseDevice

idstring · uuid
The device id
namestring | null
deviceConfigurationTypestring · enum
The role that the device will be in the configuration. All configurations must have at least one sender and one receiver.
Enum values:
Sender
Receiver
EStopSender
serialNumberstring | null
The serial number identifying the device.
modelNamestring | null
typestring · enum
Enum values:
SRCP
WESP
EPC
NSCP
commInterfacestring · enum
Device communication interface flags. Can be used individually or combined. (e.g., "Wifi", "BLE, Ethernet" or "BLE,ISM,Wifi").
Enum values:
None
BLE
ISM
Ethernet
Wifi
ismRadioIdinteger | null · int32
ismNetworkIdinteger | null · int32
The network id of the ISM radio.
ipAddressstring | null
The IP address of the device. Only required when network uses IP communications.
receiverDeviceIdsarray | null
inputConfiguration1string · enum
Input 1's function(pin 3 and 6) on the endpoint controller's J1 connector. Input 1 must be set to NOT_USED on SRCP and WESP devices. Input 2's function(pin 2 and 5) on the endpoint controller's J1 connector. Input 2 is not applicable to NSC Pro devices that use CAT 1 stop category. Input 2 must be set to NOT_USED on SRCP and WESP devices. Must be set to NOT_USED on SRCP and WESP devices.
Enum values:
NOT_USED
ESTOP_TYPE_SWITCH
SOLID_STATE_SAFETY_DEVICE
REMOTE_SAFETY_REQUEST
REMOTE_SAFETY_REQUEST_WITH_AUTONOMY_SELECT
inputConfiguration2string · enum
Input 1's function(pin 3 and 6) on the endpoint controller's J1 connector. Input 1 must be set to NOT_USED on SRCP and WESP devices. Input 2's function(pin 2 and 5) on the endpoint controller's J1 connector. Input 2 is not applicable to NSC Pro devices that use CAT 1 stop category. Input 2 must be set to NOT_USED on SRCP and WESP devices. Must be set to NOT_USED on SRCP and WESP devices.
Enum values:
NOT_USED
ESTOP_TYPE_SWITCH
SOLID_STATE_SAFETY_DEVICE
REMOTE_SAFETY_REQUEST
REMOTE_SAFETY_REQUEST_WITH_AUTONOMY_SELECT
inputConfiguration3string · enum
Input 1's function(pin 3 and 6) on the endpoint controller's J1 connector. Input 1 must be set to NOT_USED on SRCP and WESP devices. Input 2's function(pin 2 and 5) on the endpoint controller's J1 connector. Input 2 is not applicable to NSC Pro devices that use CAT 1 stop category. Input 2 must be set to NOT_USED on SRCP and WESP devices. Must be set to NOT_USED on SRCP and WESP devices.
Enum values:
NOT_USED
ESTOP_TYPE_SWITCH
SOLID_STATE_SAFETY_DEVICE
REMOTE_SAFETY_REQUEST
REMOTE_SAFETY_REQUEST_WITH_AUTONOMY_SELECT
outputConfiguration1string · enum
Enum values:
NOT_USED
TRANSMIT_SAFETY_REQUEST
TWO_RELAYS_IN_SERIES
outputConfiguration2string · enum
Enum values:
NOT_USED
TRANSMIT_SAFETY_REQUEST
TWO_RELAYS_IN_SERIES
outputConfiguration3string · enum
Enum values:
NOT_USED
TRANSMIT_SAFETY_REQUEST
TWO_RELAYS_IN_SERIES
voltagestring · enum
Enum values:
VOLTAGE_12V
VOLTAGE_24V
VOLTAGE_5V
can0Idinteger · int32
The id of can interface
can1Idinteger · int32
The id of can interface
serial0Usagestring · enum
NSC Pro only. The physical output interface between the FORT Pro device and your equipment under control. Can be FORT SDK(comms) or Data Output Control(control). FORT SDK and Data Output Control can each only be set on one serial at a time."
Enum values:
comms
control
serial1Usagestring · enum
NSC Pro only. The physical output interface between the FORT Pro device and your equipment under control. Can be FORT SDK(comms) or Data Output Control(control). FORT SDK and Data Output Control can each only be set on one serial at a time."
Enum values:
comms
control
serial0Baudratestring · enum
Enum values:
BAUDRATE_115200
serial1Baudratestring · enum
Enum values:
BAUDRATE_115200
stopCategorystring · enum
NSC Pro only. E-Stop category CAT0: For an EPC Sender - If ESTOP is on input #1 it disables receiver output #1; if ESTOP on input #2 it disables receiver output #2. For an SRCP transmitter - The last output of the receiver (output #2 for NSCP or output #3 for EPC) is turned off. CAT1: Output #1 of the receiver is turned off immediately, and after a user-defined delay (CAT1 Delay), output #2 of the receiver is turned off.
Enum values:
CAT0
CAT1
cat1StopDelaynumber | null · float
Delay for the CAT1 E-Stop.
netmaskstring | null
gatewaystring | null
nameserversarray | null
wifiSsidstring | null
The wifi SSID
hasWifiPasswordboolean
networkTemplateIdstring · uuid
The network template id
networkTemplateNamestring | null
eth0MacAddressstring | null
eth1MacAddressstring | null
wifiMacAddressstring | null
bleMacAddressstring | null
configurationLastSyncedstring | null · date-time

Fort.ProSeriesApi.Models.Dtos.GetNetworkByIdResponseUser

idstring · uuid
The user id
firstNamestring | null
lastNamestring | null
emailstring | null
The user's email
createdstring · date-time

Fort.ProSeriesApi.Models.Dtos.GetUserByIdResponse

idstring · uuid
The user id
emailstring | null
The user's email
lastNamestring | null
firstNamestring | null
thumbnailUrlstring | null
isServiceAccountboolean
lastActivitystring | null · date-time

Fort.ProSeriesApi.Models.Dtos.IpNetworkTemplateDetail

idstring · uuid · required
The network template id
ipNetworkTemplateNamestring · minLength: 1 · required
commInterfacestring · enum · required
Enum values:
None
Ethernet
Wifi
netmaskstring · minLength: 1 · required
orgIdstring · uuid · required
The organization id
createdAtstring · date-time · required
The time when this template was created
createdByobject · required
devicesUsingTemplateobject[] · required
nameserversstring[] · required
configurationsUsingTemplateobject[] · required
List of safety configurations that are using this network template

gatewayIpAddressstring | null
ssidstring | null
passwordstring | null
updatedAtstring | null · date-time
The time when this template was last updated
updatedByobject

Fort.ProSeriesApi.Models.Dtos.IpNetworkTemplateRequest

ipNetworkTemplateNamestring · minLength: 1 · required
The name of the network template. The fields can be overridden after applying them to a device.
commInterfacestring · enum · required
Enum values:
None
Ethernet
Wifi
netmaskstring · minLength: 1 · required
The netmask of the template.

gatewayIpAddressstring | null
The gateway of the template.
nameserversarray | null
A list of nameservers for the template.
ssidstring | null
The Ssid for the network. Only applies to Wifi network templates.
passwordstring | null
The password for the network. Only applies to Wifi network templates.

Fort.ProSeriesApi.Models.Dtos.NetworkMin

idstring · uuid · required
The network id
namestring · minLength: 1 · required

lastUpdatedstring | null · date-time

Fort.ProSeriesApi.Models.Dtos.NetworkTemplateDeviceDetails

idstring · uuid · required
The device id
namestring · minLength: 1 · required
serialNumberstring · minLength: 1 · required
The serial number identifying the device.
typestring · enum · required
Enum values:
SRCP
WESP
EPC
NSCP

configsarray | null

Fort.ProSeriesApi.Models.Dtos.Optional`1[[Fort.ProSeriesApi.Models.ValueObjects.IpNetworkTemplateId, Fort.ProSeriesApi.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]

string · uuid

The network template id

Fort.ProSeriesApi.Models.Dtos.Optional`1[[System.Collections.Generic.List`1[[System.Int32, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]

Fort.ProSeriesApi.Models.Dtos.Optional`1[[System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]

Fort.ProSeriesApi.Models.Dtos.Optional`1[[System.Nullable`1[[Fort.ProSeriesApi.Models.Enums.BaudRate, Fort.ProSeriesApi.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]

string · enum

Enum values:

BAUDRATE_115200

Fort.ProSeriesApi.Models.Dtos.Optional`1[[System.Nullable`1[[Fort.ProSeriesApi.Models.Enums.CanBitrateOptions, Fort.ProSeriesApi.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]

string · enum

Enum values:

BITRATE_10000

BITRATE_20000

BITRATE_50000

BITRATE_125000

BITRATE_250000

BITRATE_500000

BITRATE_800000

BITRATE_1000000

Can bitrate options. EPC and NSCP devices can only be BITRATE_250000 and BITRATE_500000.

Fort.ProSeriesApi.Models.Dtos.Optional`1[[System.Nullable`1[[Fort.ProSeriesApi.Models.Enums.CanMode, Fort.ProSeriesApi.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]

string · enum

Enum values:

canopen

j1939

none

The CAN mode

Fort.ProSeriesApi.Models.Dtos.Optional`1[[System.Nullable`1[[Fort.ProSeriesApi.Models.Enums.DeviceCommInterface, Fort.ProSeriesApi.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]

string · enum

Enum values:

None

BLE

ISM

Ethernet

Wifi

Device communication interface flags. Can be used individually or combined. (e.g., "Wifi", "BLE, Ethernet" or "BLE,ISM,Wifi").

Fort.ProSeriesApi.Models.Dtos.Optional`1[[System.Nullable`1[[Fort.ProSeriesApi.Models.Enums.DeviceConfigurationType, Fort.ProSeriesApi.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]

string · enum

Enum values:

Sender

Receiver

EStopSender

The role that the device will be in the configuration. All configurations must have at least one sender and one receiver.

Fort.ProSeriesApi.Models.Dtos.Optional`1[[System.Nullable`1[[Fort.ProSeriesApi.Models.Enums.InputConfiguration, Fort.ProSeriesApi.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]

string · enum

Enum values:

NOT_USED

ESTOP_TYPE_SWITCH

SOLID_STATE_SAFETY_DEVICE

REMOTE_SAFETY_REQUEST

REMOTE_SAFETY_REQUEST_WITH_AUTONOMY_SELECT

Input 1's function(pin 3 and 6) on the endpoint controller's J1 connector. Input 1 must be set to NOT_USED on SRCP and WESP devices. Input 2's function(pin 2 and 5) on the endpoint controller's J1 connector. Input 2 is not applicable to NSC Pro devices that use CAT 1 stop category. Input 2 must be set to NOT_USED on SRCP and WESP devices. Must be set to NOT_USED on SRCP and WESP devices.

Fort.ProSeriesApi.Models.Dtos.Optional`1[[System.Nullable`1[[Fort.ProSeriesApi.Models.Enums.IsmTxPower, Fort.ProSeriesApi.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]

string · enum

Enum values:

Medium

High

Low

Fort.ProSeriesApi.Models.Dtos.Optional`1[[System.Nullable`1[[Fort.ProSeriesApi.Models.Enums.SerialUsage, Fort.ProSeriesApi.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]

string · enum

Enum values:

comms

control

NSC Pro only. The physical output interface between the FORT Pro device and your equipment under control. Can be FORT SDK(comms) or Data Output Control(control). FORT SDK and Data Output Control can each only be set on one serial at a time."

Fort.ProSeriesApi.Models.Dtos.Optional`1[[System.Nullable`1[[Fort.ProSeriesApi.Models.Enums.StopCategory, Fort.ProSeriesApi.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]

string · enum

Enum values:

CAT0

CAT1

NSC Pro only. E-Stop category CAT0: For an EPC Sender - If ESTOP is on input #1 it disables receiver output #1; if ESTOP on input #2 it disables receiver output #2. For an SRCP transmitter - The last output of the receiver (output #2 for NSCP or output #3 for EPC) is turned off. CAT1: Output #1 of the receiver is turned off immediately, and after a user-defined delay (CAT1 Delay), output #2 of the receiver is turned off.

Fort.ProSeriesApi.Models.Dtos.Optional`1[[System.Nullable`1[[Fort.ProSeriesApi.Models.Enums.Voltage, Fort.ProSeriesApi.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]

string · enum

Enum values:

VOLTAGE_12V

VOLTAGE_24V

VOLTAGE_5V

Fort.ProSeriesApi.Models.Dtos.Optional`1[[System.Nullable`1[[Fort.ProSeriesApi.Models.ValueObjects.CanId, Fort.ProSeriesApi.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]

integer · int32

The id of can interface

Fort.ProSeriesApi.Models.Dtos.Optional`1[[System.Nullable`1[[System.Int32, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]

integer | null · int32

Represents an optional property in a patch request body

Fort.ProSeriesApi.Models.Dtos.Optional`1[[System.Nullable`1[[System.Single, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]

number | null · float

Represents an optional property in a patch request body

Fort.ProSeriesApi.Models.Dtos.Optional`1[[System.String, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]

string | null

Represents an optional property in a patch request body

Fort.ProSeriesApi.Models.Dtos.PagedResults`1[[Fort.ProSeriesApi.Models.Dtos.GetAllDevicesResponse, Fort.ProSeriesApi.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]

hasMoreboolean · required
totalCountinteger · int32 · required
dataobject[] · required

Fort.ProSeriesApi.Models.Dtos.PagedResults`1[[Fort.ProSeriesApi.Models.Dtos.GetAllNetworksResponse, Fort.ProSeriesApi.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]

hasMoreboolean · required
totalCountinteger · int32 · required
dataobject[] · required

Fort.ProSeriesApi.Models.Dtos.PagedResults`1[[Fort.ProSeriesApi.Models.Dtos.GetAllUsersResponse, Fort.ProSeriesApi.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]

hasMoreboolean · required
totalCountinteger · int32 · required
dataobject[] · required

Fort.ProSeriesApi.Models.Dtos.RegisterDeviceResponse

idstring · uuid
The device id
deviceUidinteger · int32
namestring | null
serialNumberstring | null
The serial number identifying the device.
typestring · enum
Enum values:
SRCP
WESP
EPC
NSCP
registeredstring · date-time
colorstring · enum
Enum values:
One
Two
Three
Four
Five
imgUrlstring | null
thumbnailUrlstring | null
modelNamestring | null

Fort.ProSeriesApi.Models.Dtos.RegisterUserRequest

emailstring | null
The user's email
userRolestring · enum
Enum values:
Operator
DeviceManager
ConfigManager
Admin

Fort.ProSeriesApi.Models.Dtos.UpdateDeviceResponse

idstring · uuid
The device id
deviceUidinteger · int32
namestring | null
serialNumberstring | null
The serial number identifying the device.
typestring · enum
Enum values:
SRCP
WESP
EPC
NSCP
registeredstring · date-time
colorstring · enum
Enum values:
One
Two
Three
Four
Five
imgUrlstring | null
thumbnailUrlstring | null
modelNamestring | null

Fort.ProSeriesApi.Models.Dtos.UpdateNetworkDeviceRequest

ipAddressstring | null
Represents an optional property in a patch request body
deviceConfigurationTypestring · enum
The role that the device will be in the configuration. All configurations must have at least one sender and one receiver.
Enum values:
Sender
Receiver
EStopSender
commInterfacestring · enum
Device communication interface flags. Can be used individually or combined. (e.g., "Wifi", "BLE, Ethernet" or "BLE,ISM,Wifi").
Enum values:
None
BLE
ISM
Ethernet
Wifi
inputConfiguration1string · enum
Input 1's function(pin 3 and 6) on the endpoint controller's J1 connector. Input 1 must be set to NOT_USED on SRCP and WESP devices. Input 2's function(pin 2 and 5) on the endpoint controller's J1 connector. Input 2 is not applicable to NSC Pro devices that use CAT 1 stop category. Input 2 must be set to NOT_USED on SRCP and WESP devices. Must be set to NOT_USED on SRCP and WESP devices.
Enum values:
NOT_USED
ESTOP_TYPE_SWITCH
SOLID_STATE_SAFETY_DEVICE
REMOTE_SAFETY_REQUEST
REMOTE_SAFETY_REQUEST_WITH_AUTONOMY_SELECT
inputConfiguration2string · enum
Input 1's function(pin 3 and 6) on the endpoint controller's J1 connector. Input 1 must be set to NOT_USED on SRCP and WESP devices. Input 2's function(pin 2 and 5) on the endpoint controller's J1 connector. Input 2 is not applicable to NSC Pro devices that use CAT 1 stop category. Input 2 must be set to NOT_USED on SRCP and WESP devices. Must be set to NOT_USED on SRCP and WESP devices.
Enum values:
NOT_USED
ESTOP_TYPE_SWITCH
SOLID_STATE_SAFETY_DEVICE
REMOTE_SAFETY_REQUEST
REMOTE_SAFETY_REQUEST_WITH_AUTONOMY_SELECT
inputConfiguration3string · enum
Input 1's function(pin 3 and 6) on the endpoint controller's J1 connector. Input 1 must be set to NOT_USED on SRCP and WESP devices. Input 2's function(pin 2 and 5) on the endpoint controller's J1 connector. Input 2 is not applicable to NSC Pro devices that use CAT 1 stop category. Input 2 must be set to NOT_USED on SRCP and WESP devices. Must be set to NOT_USED on SRCP and WESP devices.
Enum values:
NOT_USED
ESTOP_TYPE_SWITCH
SOLID_STATE_SAFETY_DEVICE
REMOTE_SAFETY_REQUEST
REMOTE_SAFETY_REQUEST_WITH_AUTONOMY_SELECT
can0Idinteger · int32
The id of can interface
can1Idinteger · int32
The id of can interface
voltagestring · enum
Enum values:
VOLTAGE_12V
VOLTAGE_24V
VOLTAGE_5V
serial0Usagestring · enum
NSC Pro only. The physical output interface between the FORT Pro device and your equipment under control. Can be FORT SDK(comms) or Data Output Control(control). FORT SDK and Data Output Control can each only be set on one serial at a time."
Enum values:
comms
control
serial1Usagestring · enum
NSC Pro only. The physical output interface between the FORT Pro device and your equipment under control. Can be FORT SDK(comms) or Data Output Control(control). FORT SDK and Data Output Control can each only be set on one serial at a time."
Enum values:
comms
control
serial0Baudratestring · enum
Enum values:
BAUDRATE_115200
serial1Baudratestring · enum
Enum values:
BAUDRATE_115200
stopCategorystring · enum
NSC Pro only. E-Stop category CAT0: For an EPC Sender - If ESTOP is on input #1 it disables receiver output #1; if ESTOP on input #2 it disables receiver output #2. For an SRCP transmitter - The last output of the receiver (output #2 for NSCP or output #3 for EPC) is turned off. CAT1: Output #1 of the receiver is turned off immediately, and after a user-defined delay (CAT1 Delay), output #2 of the receiver is turned off.
Enum values:
CAT0
CAT1
cat1StopDelaynumber | null · float
Represents an optional property in a patch request body
ethNetmaskstring | null
Represents an optional property in a patch request body
ethGatewaystring | null
Represents an optional property in a patch request body
ethNameserversarray | null
Represents an optional property in a patch request body
wifiNetmaskstring | null
Represents an optional property in a patch request body
wifiGatewaystring | null
Represents an optional property in a patch request body
wifiNameserversarray | null
Represents an optional property in a patch request body
wifiSsidstring | null
Represents an optional property in a patch request body
wifiPasswordstring | null
Represents an optional property in a patch request body
networkTemplateIdstring · uuid
The network template id

Fort.ProSeriesApi.Models.Dtos.UpdateNetworkDeviceResponse

idstring · uuid
The network id
namestring | null
createdstring · date-time
isNetworkCompleteboolean
Indicates whether the network is complete or has any validation errors.
devicesarray | null
impactsarray | null

Fort.ProSeriesApi.Models.Dtos.UpdateNetworkDeviceResponseDevice

idstring · uuid
The device id
namestring | null
deviceConfigurationTypestring · enum
The role that the device will be in the configuration. All configurations must have at least one sender and one receiver.
Enum values:
Sender
Receiver
EStopSender
serialNumberstring | null
The serial number identifying the device.
modelNamestring | null
typestring · enum
Enum values:
SRCP
WESP
EPC
NSCP

Fort.ProSeriesApi.Models.Dtos.UpdateNetworkDeviceResponseUser

idstring · uuid
The user id
firstNamestring | null
lastNamestring | null
emailstring | null
The user's email
createdstring · date-time

Fort.ProSeriesApi.Models.Dtos.UpdateNetworkRequest

namestring | null
Represents an optional property in a patch request body
startingIpAddressstring | null
Represents an optional property in a patch request body
ismTxPowerstring · enum
Enum values:
Medium
High
Low
ismTxChannelinteger | null · int32
Represents an optional property in a patch request body
canModestring · enum
The CAN mode
Enum values:
canopen
j1939
none
canKBitratestring · enum
Can bitrate options. EPC and NSCP devices can only be BITRATE_250000 and BITRATE_500000.
Enum values:
BITRATE_10000
BITRATE_20000
BITRATE_50000
BITRATE_125000
BITRATE_250000
BITRATE_500000
BITRATE_800000
BITRATE_1000000
displayTextPgninteger | null · int32
Represents an optional property in a patch request body
settingsPgninteger | null · int32
Represents an optional property in a patch request body
approvedSourceAddressesarray | null
Represents an optional property in a patch request body
receiverOutputControlinteger | null · int32
Represents an optional property in a patch request body
timeoutConfigurationstring · enum
The safety timeout delay for the configuration.
Enum values:
250ms
500ms
750ms
1000ms
3000ms
5000ms

Fort.ProSeriesApi.Models.Dtos.UpdateNetworkResponse

idstring · uuid
The network id
namestring | null
createdstring · date-time
isNetworkCompleteboolean
Indicates whether the network is complete or has any validation errors.
devicesarray | null
impactsarray | null

Fort.ProSeriesApi.Models.Dtos.UpdateNetworkResponseDevice

idstring · uuid
The device id
namestring | null
deviceConfigurationTypestring · enum
The role that the device will be in the configuration. All configurations must have at least one sender and one receiver.
Enum values:
Sender
Receiver
EStopSender
serialNumberstring | null
The serial number identifying the device.
modelNamestring | null
typestring · enum
Enum values:
SRCP
WESP
EPC
NSCP

Fort.ProSeriesApi.Models.Dtos.UpdateNetworkResponseUser

idstring · uuid
The user id
firstNamestring | null
lastNamestring | null
emailstring | null
The user's email
createdstring · date-time

Fort.ProSeriesApi.Models.Dtos.Users.UserMinDetail

idstring · uuid · required
The user id
emailstring · minLength: 1 · required
The user's email

lastNamestring | null
firstNamestring | null
isServiceAccountboolean

Fort.ProSeriesApi.Models.Dtos.Users.UserRole

string · enum

Enum values:

DeviceManager

ConfigManager

Operator

Service

KeyManager

Admin

Fort.ProSeriesApi.Models.Enums.BaudRate

string · enum

Enum values:

BAUDRATE_115200

Fort.ProSeriesApi.Models.Enums.CanBitrateOptions

string · enum

Enum values:

BITRATE_10000

BITRATE_20000

BITRATE_50000

BITRATE_125000

BITRATE_250000

BITRATE_500000

BITRATE_800000

BITRATE_1000000

Can bitrate options. EPC and NSCP devices can only be BITRATE_250000 and BITRATE_500000.

Fort.ProSeriesApi.Models.Enums.CanMode

string · enum

Enum values:

canopen

j1939

none

The CAN mode

Fort.ProSeriesApi.Models.Enums.CommInterface

string · enum

Enum values:

None

Ethernet

Wifi

Fort.ProSeriesApi.Models.Enums.ConfigurationType

string · enum

Enum values:

SRCP_Sender

EPC_Sender

WESP_Sender

EPC_Receiver

NSCP_Receiver

EPC_GlobalEstopSender

Fort.ProSeriesApi.Models.Enums.DeviceColor

string · enum

Enum values:

One

Two

Three

Four

Five

Fort.ProSeriesApi.Models.Enums.DeviceCommInterface

string · enum

Enum values:

None

BLE

ISM

Ethernet

Wifi

Device communication interface flags. Can be used individually or combined. (e.g., "Wifi", "BLE, Ethernet" or "BLE,ISM,Wifi").

Fort.ProSeriesApi.Models.Enums.DeviceConfigurationType

string · enum

Enum values:

Sender

Receiver

EStopSender

The role that the device will be in the configuration. All configurations must have at least one sender and one receiver.

Fort.ProSeriesApi.Models.Enums.DeviceType

string · enum

Enum values:

SRCP

WESP

EPC

NSCP

Fort.ProSeriesApi.Models.Enums.InputConfiguration

string · enum

Enum values:

NOT_USED

ESTOP_TYPE_SWITCH

SOLID_STATE_SAFETY_DEVICE

REMOTE_SAFETY_REQUEST

REMOTE_SAFETY_REQUEST_WITH_AUTONOMY_SELECT

Fort.ProSeriesApi.Models.Enums.IsmTxPower

string · enum

Enum values:

Medium

High

Low

Fort.ProSeriesApi.Models.Enums.KeyFormat

string · enum

Enum values:

None

Visible

Masked

Fort.ProSeriesApi.Models.Enums.OutputConfiguration

string · enum

Enum values:

NOT_USED

TRANSMIT_SAFETY_REQUEST

TWO_RELAYS_IN_SERIES

Fort.ProSeriesApi.Models.Enums.SerialUsage

string · enum

Enum values:

comms

control

Fort.ProSeriesApi.Models.Enums.StopCategory

string · enum

Enum values:

CAT0

CAT1

Fort.ProSeriesApi.Models.Enums.Voltage

string · enum

Enum values:

VOLTAGE_12V

VOLTAGE_24V

VOLTAGE_5V

Fort.ProSeriesApi.Models.ValueObjects.CanId

integer · int32

The id of can interface

Fort.ProSeriesApi.Models.ValueObjects.DeviceId

string · uuid

The device id

Fort.ProSeriesApi.Models.ValueObjects.IpNetworkTemplateId

string · uuid

The network template id

Fort.ProSeriesApi.Models.ValueObjects.NetworkId

string · uuid

The network id

Fort.ProSeriesApi.Models.ValueObjects.OrganizationId

string · uuid

The organization id

Fort.ProSeriesApi.Models.ValueObjects.SafetyConfigurationId

string · uuid

The id of the network

Fort.ProSeriesApi.Models.ValueObjects.UserId

string · uuid

The user id

FortManager.ApiClient.ConfigError

errorstring · minLength: 1 · required

FortManager.ApiClient.ConfigurationSortOptions

string · enum

Enum values:

LastEditedASC

LastEditedDESC

ConfigNameASC

ConfigNameDESC

FortManager.ApiClient.ConfigurationValidationResult

configErrorsobject[] · required
deviceErrorsobject[] · required

FortManager.ApiClient.DeviceError

deviceIdstring · uuid · required
errorsstring[] · required

FortManager.ApiClient.UserRole

string · enum

Enum values:

Operator

DeviceManager

ConfigManager

Admin

FortManager.ApiClient.UsersSortOptions

string · enum

Enum values:

FirstNameASC

FirstNameDESC

LastActivityASC

LastActivityDESC

SafetyManager.Models.Common.Enum.CommInterface

string · enum

Enum values:

None

Ethernet

Wifi

SafetyManager.Models.Common.Enum.NetworkTemplateSortOptions

string · enum

Enum values:

Name

LastEdited

SafetyManager.Models.Common.Enum.SortDirection

string · enum

Enum values:

Ascending

Descending

SafetyManager.Models.Common.Enum.UserRole

string · enum

Enum values:

Operator

DeviceManager

ConfigManager

Admin

SafetyManager.Models.ValueObjects.SafetyConfigurationNewId

string · uuid

Fort.ProSeriesApi.Models.Dtos.ApiResponse`1[[Fort.ProSeriesApi.Models.Dtos.NetworkValidateResponse, Fort.ProSeriesApi.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]

dataobject
successboolean
errorsarray | null

Fort.ProSeriesApi.Models.Dtos.DeviceError

deviceIdstring · uuid
errorsarray | null

Fort.ProSeriesApi.Models.Dtos.NetworkError

errorstring | null

Fort.ProSeriesApi.Models.Dtos.NetworkValidateResponse

isNetworkCompleteboolean
Indicates whether the network is complete or has any validation errors.
validationErrorsobject

Fort.ProSeriesApi.Models.Dtos.NetworkValidationResult

networkErrorsarray | null
deviceErrorsarray | null

Fort.ProSeriesApi.Models.Dtos.Optional`1[[System.Nullable`1[[Fort.ProSeriesApi.Models.Enums.TimeoutConfiguration, Fort.ProSeriesApi.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]

string · enum

Enum values:

250ms

500ms

750ms

1000ms

3000ms

5000ms

The safety timeout delay for the configuration.

Fort.ProSeriesApi.Models.Enums.TimeoutConfiguration

string · enum

Enum values:

250ms

500ms

750ms

1000ms

3000ms

5000ms

The safety timeout delay for the configuration.

FortManager.ApiClient.ConfigUpdateImpact

configIdstring · uuid · required
devicesNeedingUpdatestring[] · required

updateMessagesarray | null

Fort.ProSeriesApi.Models.Dtos.AddConfigurationDeviceRequest

serialNumberstring | null
The serial number identifying the device.
ipAddressstring | null
The IP address of the device. Only required when configuration uses IP communications.
deviceConfigurationTypestring · enum
The role that the device will be in the configuration. All configurations must have at least one sender and one receiver.
Enum values:
Sender
Receiver
EStopSender
commInterfacestring · enum
Device communication interface flags. Can be used individually or combined. (e.g., "Wifi", "BLE, Ethernet" or "BLE,ISM,Wifi").
Enum values:
None
BLE
ISM
Ethernet
Wifi
inputConfiguration1string · enum
Input 1's function(pin 3 and 6) on the endpoint controller's J1 connector. Input 1 must be set to NOT_USED on SRCP and WESP devices. Input 2's function(pin 2 and 5) on the endpoint controller's J1 connector. Input 2 is not applicable to NSC Pro devices that use CAT 1 stop category. Input 2 must be set to NOT_USED on SRCP and WESP devices. Must be set to NOT_USED on SRCP and WESP devices.
Enum values:
NOT_USED
ESTOP_TYPE_SWITCH
SOLID_STATE_SAFETY_DEVICE
REMOTE_SAFETY_REQUEST
REMOTE_SAFETY_REQUEST_WITH_AUTONOMY_SELECT
inputConfiguration2string · enum
Input 1's function(pin 3 and 6) on the endpoint controller's J1 connector. Input 1 must be set to NOT_USED on SRCP and WESP devices. Input 2's function(pin 2 and 5) on the endpoint controller's J1 connector. Input 2 is not applicable to NSC Pro devices that use CAT 1 stop category. Input 2 must be set to NOT_USED on SRCP and WESP devices. Must be set to NOT_USED on SRCP and WESP devices.
Enum values:
NOT_USED
ESTOP_TYPE_SWITCH
SOLID_STATE_SAFETY_DEVICE
REMOTE_SAFETY_REQUEST
REMOTE_SAFETY_REQUEST_WITH_AUTONOMY_SELECT
inputConfiguration3string · enum
Input 1's function(pin 3 and 6) on the endpoint controller's J1 connector. Input 1 must be set to NOT_USED on SRCP and WESP devices. Input 2's function(pin 2 and 5) on the endpoint controller's J1 connector. Input 2 is not applicable to NSC Pro devices that use CAT 1 stop category. Input 2 must be set to NOT_USED on SRCP and WESP devices. Must be set to NOT_USED on SRCP and WESP devices.
Enum values:
NOT_USED
ESTOP_TYPE_SWITCH
SOLID_STATE_SAFETY_DEVICE
REMOTE_SAFETY_REQUEST
REMOTE_SAFETY_REQUEST_WITH_AUTONOMY_SELECT
can0Idinteger · int32
The id of can interface
serial0Usagestring · enum
NSC Pro only. The physical output interface between the FORT Pro device and your equipment under control. Can be FORT SDK(comms) or Data Output Control(control). FORT SDK and Data Output Control can each only be set on one serial at a time."
Enum values:
comms
control
serial1Usagestring · enum
NSC Pro only. The physical output interface between the FORT Pro device and your equipment under control. Can be FORT SDK(comms) or Data Output Control(control). FORT SDK and Data Output Control can each only be set on one serial at a time."
Enum values:
comms
control
stopCategorystring · enum
NSC Pro only. E-Stop category CAT0: For an EPC Sender - If ESTOP is on input #1 it disables receiver output #1; if ESTOP on input #2 it disables receiver output #2. For an SRCP transmitter - The last output of the receiver (output #2 for NSCP or output #3 for EPC) is turned off. CAT1: Output #1 of the receiver is turned off immediately, and after a user-defined delay (CAT1 Delay), output #2 of the receiver is turned off.
Enum values:
CAT0
CAT1
cat1StopDelaynumber | null · float
Delay for the CAT1 E-Stop.
ethNetmaskstring | null
The ethernet interface netmask. Only used in configurations that use ethernet communications
ethGatewaystring | null
The ethernet interface gateway. Only used in configurations that use ethernet communications
ethNameserversarray | null
The ethernet interface nameservers. Only used in configurations that use ethernet communications
wifiNetmaskstring | null
The wifi interface netmask. Only used in configurations that use wifi communications
wifiGatewaystring | null
The wifi interface gateway. Only used in configurations that use wifi communications
wifiNameserversarray | null
The wifi interface nameservers
wifiSsidstring | null
The wifi SSID
wifiPasswordstring | null
The wifi password
networkTemplateIdstring · uuid
The network template id

Fort.ProSeriesApi.Models.Dtos.AddConfigurationDeviceResponse

idstring · uuid
The configuration id
namestring | null
createdstring · date-time
isConfigurationCompleteboolean
Indicates whether the configuration is complete or has any validation errors.
devicesarray | null
impactsarray | null

Fort.ProSeriesApi.Models.Dtos.AddConfigurationDeviceResponseDevice

idstring · uuid
The device id
namestring | null
deviceConfigurationTypestring · enum
The role that the device will be in the configuration. All configurations must have at least one sender and one receiver.
Enum values:
Sender
Receiver
EStopSender
serialNumberstring | null
The serial number identifying the device.
modelNamestring | null
typestring · enum
Enum values:
SRCP
WESP
EPC
NSCP

Fort.ProSeriesApi.Models.Dtos.ApiResponse`1[[Fort.ProSeriesApi.Models.Dtos.AddConfigurationDeviceResponse, Fort.ProSeriesApi.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]

dataobject
successboolean
errorsarray | null

Fort.ProSeriesApi.Models.Dtos.ApiResponse`1[[Fort.ProSeriesApi.Models.Dtos.ConfigurationValidateResponse, Fort.ProSeriesApi.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]

dataobject
successboolean
errorsarray | null

Fort.ProSeriesApi.Models.Dtos.ApiResponse`1[[Fort.ProSeriesApi.Models.Dtos.CreateConfigurationResponse, Fort.ProSeriesApi.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]

dataobject
successboolean
errorsarray | null

Fort.ProSeriesApi.Models.Dtos.ApiResponse`1[[Fort.ProSeriesApi.Models.Dtos.DeleteConfigurationDeviceResponse, Fort.ProSeriesApi.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]

dataobject
successboolean
errorsarray | null

Fort.ProSeriesApi.Models.Dtos.ApiResponse`1[[Fort.ProSeriesApi.Models.Dtos.GetConfigurationByIdResponse, Fort.ProSeriesApi.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]

dataobject
successboolean
errorsarray | null

Fort.ProSeriesApi.Models.Dtos.ApiResponse`1[[Fort.ProSeriesApi.Models.Dtos.PagedResults`1[[Fort.ProSeriesApi.Models.Dtos.GetAllConfigurationsResponse, Fort.ProSeriesApi.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], Fort.ProSeriesApi.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]

dataobject
successboolean
errorsarray | null

Fort.ProSeriesApi.Models.Dtos.ApiResponse`1[[Fort.ProSeriesApi.Models.Dtos.UpdateConfigurationDeviceResponse, Fort.ProSeriesApi.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]

dataobject
successboolean
errorsarray | null

Fort.ProSeriesApi.Models.Dtos.ApiResponse`1[[Fort.ProSeriesApi.Models.Dtos.UpdateConfigurationResponse, Fort.ProSeriesApi.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]

dataobject
successboolean
errorsarray | null

Fort.ProSeriesApi.Models.Dtos.ConfigurationError

errorstring | null

Fort.ProSeriesApi.Models.Dtos.ConfigurationMin

idstring · uuid · required
The configuration id
namestring · minLength: 1 · required

lastUpdatedstring | null · date-time

Fort.ProSeriesApi.Models.Dtos.ConfigurationValidateResponse

isConfigurationCompleteboolean
Indicates whether the configuration is complete or has any validation errors.
validationErrorsobject

Fort.ProSeriesApi.Models.Dtos.ConfigurationValidationResult

configurationErrorsarray | null
deviceErrorsarray | null

Fort.ProSeriesApi.Models.Dtos.CreateConfigurationRequest

namestring · minLength: 1 · required
The name of the configuration

startingIpAddressstring | null
The starting ip that will be used when assigning IP network capable devices.
ismTxPowerstring · enum
Enum values:
Medium
High
Low
ismTxChannelinteger | null · int32
The channel number that the ISM radio will use. North America should be between(inclusive) 1 and 21. EU must be set to 1.
canModestring · enum
The CAN mode
Enum values:
canopen
j1939
none
canKBitratestring · enum
Can bitrate options. EPC and NSCP devices can only be BITRATE_250000 and BITRATE_500000.
Enum values:
BITRATE_10000
BITRATE_20000
BITRATE_50000
BITRATE_125000
BITRATE_250000
BITRATE_500000
BITRATE_800000
BITRATE_1000000
displayTextPgninteger | null · int32
If CAN mode is J1939 then this can be set. If not set, it will be set to a default value of: 65281 (0xFF01). Must have a value between: 0xFF00 and 0xFFFF.
settingsPgninteger | null · int32
If CAN mode is J1939 then this can be set. If not set, it will be set to a default value of: 65282 (0xFF02). Must have a value between: 0xFF00 and 0xFFFF.
approvedSourceAddressesarray | null
Array of the node ids of ECUs to listen to. Addresses must be between 0 and 255.
receiverOutputControlinteger | null · int32
Which output on the receiver the sender will control. Must be 1 or 2
timeoutConfigurationstring · enum
The safety timeout delay for the configuration.
Enum values:
250ms
500ms
750ms
1000ms
3000ms
5000ms

Fort.ProSeriesApi.Models.Dtos.CreateConfigurationResponse

idstring · uuid
namestring | null
createdstring · date-time

Fort.ProSeriesApi.Models.Dtos.DeleteConfigurationDeviceResponse

idstring · uuid
The configuration id
namestring | null
createdstring · date-time
isConfigurationCompleteboolean
Indicates whether the configuration is complete or has any validation errors.
devicesarray | null

Fort.ProSeriesApi.Models.Dtos.DeleteConfigurationDeviceResponseDevice

idstring · uuid
The device id
namestring | null
deviceConfigurationTypestring · enum
The role that the device will be in the configuration. All configurations must have at least one sender and one receiver.
Enum values:
Sender
Receiver
EStopSender
serialNumberstring | null
The serial number identifying the device.
modelNamestring | null
typestring · enum
Enum values:
SRCP
WESP
EPC
NSCP

Fort.ProSeriesApi.Models.Dtos.GetAllConfigurationsResponse

idstring · uuid
The configuration id
namestring | null
createdstring · date-time
startingIpAddressstring | null
The starting ip that will be used when assigning IP network capable devices.
devicesarray | null
createdByobject
lastUpdatedByobject
lastUpdatedstring | null · date-time
isUserAccountActiveboolean
receiversCountinteger · int32
configTypestring · enum
Enum values:
SRCP_Sender
EPC_Sender
WESP_Sender
EPC_Receiver
NSCP_Receiver
EPC_GlobalEstopSender
isConfigurationCompleteboolean
Indicates whether the configuration is complete or has any validation errors.
estopSenderIdstring · uuid
The device id
timeoutConfigurationstring · enum
The safety timeout delay for the configuration.
Enum values:
250ms
500ms
750ms
1000ms
3000ms
5000ms

Fort.ProSeriesApi.Models.Dtos.GetAllConfigurationsResponseConfigurationMin

idstring · uuid
The configuration id
namestring | null
lastUpdatedstring | null · date-time

Fort.ProSeriesApi.Models.Dtos.GetAllConfigurationsResponseDevice

idstring · uuid
The device id
deviceUidinteger · int32
namestring | null
serialNumberstring | null
The serial number identifying the device.
isConfigurableboolean
typestring · enum
Enum values:
SRCP
WESP
EPC
NSCP
registeredstring · date-time
firmwareLastSyncedstring | null · date-time
configurationLastSyncedstring | null · date-time
imgUrlstring | null
thumbnailUrlstring | null
modelNamestring | null
configsarray | null
isConfigurableEstopSenderboolean
deviceConfigurationTypestring · enum
The role that the device will be in the configuration. All configurations must have at least one sender and one receiver.
Enum values:
Sender
Receiver
EStopSender

Fort.ProSeriesApi.Models.Dtos.GetAllConfigurationsResponseUser

idstring · uuid
The user id
firstNamestring | null
lastNamestring | null
emailstring | null
The user's email
createdstring · date-time
deletedstring | null · date-time
thumbnailUrlstring | null

Fort.ProSeriesApi.Models.Dtos.GetConfigurationByIdResponse

idstring · uuid
The configuration id
namestring | null
createdstring · date-time
isConfigurationCompleteboolean
Indicates whether the configuration is complete or has any validation errors.
startingIpAddressstring | null
The starting ip that will be used when assigning IP network capable devices.
validationErrorsobject
lastUpdatedstring | null · date-time
devicesarray | null
createdByobject
ismTxPowerstring · enum
Enum values:
Medium
High
Low
ismTxChannelinteger | null · int32
The channel number that the ISM radio will use. North America should be between(inclusive) 1 and 21. EU must be set to 1.
canModestring · enum
The CAN mode
Enum values:
canopen
j1939
none
canKBitratestring · enum
Can bitrate options. EPC and NSCP devices can only be BITRATE_250000 and BITRATE_500000.
Enum values:
BITRATE_10000
BITRATE_20000
BITRATE_50000
BITRATE_125000
BITRATE_250000
BITRATE_500000
BITRATE_800000
BITRATE_1000000
configTypestring · enum
Enum values:
SRCP_Sender
EPC_Sender
WESP_Sender
EPC_Receiver
NSCP_Receiver
EPC_GlobalEstopSender
displayTextPgninteger | null · int32
If CAN mode is J1939 then this can be set. If not set, it will be set to a default value of: 65281 (0xFF01). Must have a value between: 0xFF00 and 0xFFFF.
settingsPgninteger | null · int32
If CAN mode is J1939 then this can be set. If not set, it will be set to a default value of: 65282 (0xFF02). Must have a value between: 0xFF00 and 0xFFFF.
approvedSourceAddressesarray | null
Array of the node ids of ECUs to listen to. Addresses must be between 0 and 255.
receiverOutputControlinteger | null · int32
Which output on the receiver the sender will control. Must be 1 or 2
timeoutConfigurationstring · enum
The safety timeout delay for the configuration.
Enum values:
250ms
500ms
750ms
1000ms
3000ms
5000ms

Fort.ProSeriesApi.Models.Dtos.GetConfigurationByIdResponseDevice

idstring · uuid
The device id
namestring | null
deviceConfigurationTypestring · enum
The role that the device will be in the configuration. All configurations must have at least one sender and one receiver.
Enum values:
Sender
Receiver
EStopSender
serialNumberstring | null
The serial number identifying the device.
modelNamestring | null
typestring · enum
Enum values:
SRCP
WESP
EPC
NSCP
commInterfacestring · enum
Device communication interface flags. Can be used individually or combined. (e.g., "Wifi", "BLE, Ethernet" or "BLE,ISM,Wifi").
Enum values:
None
BLE
ISM
Ethernet
Wifi
ismRadioIdinteger | null · int32
ismNetworkIdinteger | null · int32
The network id of the ISM radio.
ipAddressstring | null
The IP address of the device. Only required when configuration uses IP communications.
receiverDeviceIdsarray | null
inputConfiguration1string · enum
Input 1's function(pin 3 and 6) on the endpoint controller's J1 connector. Input 1 must be set to NOT_USED on SRCP and WESP devices. Input 2's function(pin 2 and 5) on the endpoint controller's J1 connector. Input 2 is not applicable to NSC Pro devices that use CAT 1 stop category. Input 2 must be set to NOT_USED on SRCP and WESP devices. Must be set to NOT_USED on SRCP and WESP devices.
Enum values:
NOT_USED
ESTOP_TYPE_SWITCH
SOLID_STATE_SAFETY_DEVICE
REMOTE_SAFETY_REQUEST
REMOTE_SAFETY_REQUEST_WITH_AUTONOMY_SELECT
inputConfiguration2string · enum
Input 1's function(pin 3 and 6) on the endpoint controller's J1 connector. Input 1 must be set to NOT_USED on SRCP and WESP devices. Input 2's function(pin 2 and 5) on the endpoint controller's J1 connector. Input 2 is not applicable to NSC Pro devices that use CAT 1 stop category. Input 2 must be set to NOT_USED on SRCP and WESP devices. Must be set to NOT_USED on SRCP and WESP devices.
Enum values:
NOT_USED
ESTOP_TYPE_SWITCH
SOLID_STATE_SAFETY_DEVICE
REMOTE_SAFETY_REQUEST
REMOTE_SAFETY_REQUEST_WITH_AUTONOMY_SELECT
inputConfiguration3string · enum
Input 1's function(pin 3 and 6) on the endpoint controller's J1 connector. Input 1 must be set to NOT_USED on SRCP and WESP devices. Input 2's function(pin 2 and 5) on the endpoint controller's J1 connector. Input 2 is not applicable to NSC Pro devices that use CAT 1 stop category. Input 2 must be set to NOT_USED on SRCP and WESP devices. Must be set to NOT_USED on SRCP and WESP devices.
Enum values:
NOT_USED
ESTOP_TYPE_SWITCH
SOLID_STATE_SAFETY_DEVICE
REMOTE_SAFETY_REQUEST
REMOTE_SAFETY_REQUEST_WITH_AUTONOMY_SELECT
outputConfiguration1string · enum
Enum values:
NOT_USED
TRANSMIT_SAFETY_REQUEST
TWO_RELAYS_IN_SERIES
outputConfiguration2string · enum
Enum values:
NOT_USED
TRANSMIT_SAFETY_REQUEST
TWO_RELAYS_IN_SERIES
outputConfiguration3string · enum
Enum values:
NOT_USED
TRANSMIT_SAFETY_REQUEST
TWO_RELAYS_IN_SERIES
voltagestring · enum
Enum values:
VOLTAGE_12V
VOLTAGE_24V
VOLTAGE_5V
can0Idinteger · int32
The id of can interface
can1Idinteger · int32
The id of can interface
serial0Usagestring · enum
NSC Pro only. The physical output interface between the FORT Pro device and your equipment under control. Can be FORT SDK(comms) or Data Output Control(control). FORT SDK and Data Output Control can each only be set on one serial at a time."
Enum values:
comms
control
serial1Usagestring · enum
NSC Pro only. The physical output interface between the FORT Pro device and your equipment under control. Can be FORT SDK(comms) or Data Output Control(control). FORT SDK and Data Output Control can each only be set on one serial at a time."
Enum values:
comms
control
serial0Baudratestring · enum
Enum values:
BAUDRATE_115200
serial1Baudratestring · enum
Enum values:
BAUDRATE_115200
stopCategorystring · enum
NSC Pro only. E-Stop category CAT0: For an EPC Sender - If ESTOP is on input #1 it disables receiver output #1; if ESTOP on input #2 it disables receiver output #2. For an SRCP transmitter - The last output of the receiver (output #2 for NSCP or output #3 for EPC) is turned off. CAT1: Output #1 of the receiver is turned off immediately, and after a user-defined delay (CAT1 Delay), output #2 of the receiver is turned off.
Enum values:
CAT0
CAT1
cat1StopDelaynumber | null · float
Delay for the CAT1 E-Stop.
netmaskstring | null
gatewaystring | null
nameserversarray | null
wifiSsidstring | null
The wifi SSID
hasWifiPasswordboolean
networkTemplateIdstring · uuid
The network template id
networkTemplateNamestring | null
eth0MacAddressstring | null
eth1MacAddressstring | null
wifiMacAddressstring | null
bleMacAddressstring | null
configurationLastSyncedstring | null · date-time

Fort.ProSeriesApi.Models.Dtos.GetConfigurationByIdResponseUser

idstring · uuid
The user id
firstNamestring | null
lastNamestring | null
emailstring | null
The user's email
createdstring · date-time

Fort.ProSeriesApi.Models.Dtos.PagedResults`1[[Fort.ProSeriesApi.Models.Dtos.GetAllConfigurationsResponse, Fort.ProSeriesApi.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]

hasMoreboolean · required
totalCountinteger · int32 · required
dataobject[] · required

Fort.ProSeriesApi.Models.Dtos.UpdateConfigurationDeviceRequest

ipAddressstring | null
Represents an optional property in a patch request body
deviceConfigurationTypestring · enum
The role that the device will be in the configuration. All configurations must have at least one sender and one receiver.
Enum values:
Sender
Receiver
EStopSender
commInterfacestring · enum
Device communication interface flags. Can be used individually or combined. (e.g., "Wifi", "BLE, Ethernet" or "BLE,ISM,Wifi").
Enum values:
None
BLE
ISM
Ethernet
Wifi
inputConfiguration1string · enum
Input 1's function(pin 3 and 6) on the endpoint controller's J1 connector. Input 1 must be set to NOT_USED on SRCP and WESP devices. Input 2's function(pin 2 and 5) on the endpoint controller's J1 connector. Input 2 is not applicable to NSC Pro devices that use CAT 1 stop category. Input 2 must be set to NOT_USED on SRCP and WESP devices. Must be set to NOT_USED on SRCP and WESP devices.
Enum values:
NOT_USED
ESTOP_TYPE_SWITCH
SOLID_STATE_SAFETY_DEVICE
REMOTE_SAFETY_REQUEST
REMOTE_SAFETY_REQUEST_WITH_AUTONOMY_SELECT
inputConfiguration2string · enum
Input 1's function(pin 3 and 6) on the endpoint controller's J1 connector. Input 1 must be set to NOT_USED on SRCP and WESP devices. Input 2's function(pin 2 and 5) on the endpoint controller's J1 connector. Input 2 is not applicable to NSC Pro devices that use CAT 1 stop category. Input 2 must be set to NOT_USED on SRCP and WESP devices. Must be set to NOT_USED on SRCP and WESP devices.
Enum values:
NOT_USED
ESTOP_TYPE_SWITCH
SOLID_STATE_SAFETY_DEVICE
REMOTE_SAFETY_REQUEST
REMOTE_SAFETY_REQUEST_WITH_AUTONOMY_SELECT
inputConfiguration3string · enum
Input 1's function(pin 3 and 6) on the endpoint controller's J1 connector. Input 1 must be set to NOT_USED on SRCP and WESP devices. Input 2's function(pin 2 and 5) on the endpoint controller's J1 connector. Input 2 is not applicable to NSC Pro devices that use CAT 1 stop category. Input 2 must be set to NOT_USED on SRCP and WESP devices. Must be set to NOT_USED on SRCP and WESP devices.
Enum values:
NOT_USED
ESTOP_TYPE_SWITCH
SOLID_STATE_SAFETY_DEVICE
REMOTE_SAFETY_REQUEST
REMOTE_SAFETY_REQUEST_WITH_AUTONOMY_SELECT
can0Idinteger · int32
The id of can interface
can1Idinteger · int32
The id of can interface
voltagestring · enum
Enum values:
VOLTAGE_12V
VOLTAGE_24V
VOLTAGE_5V
serial0Usagestring · enum
NSC Pro only. The physical output interface between the FORT Pro device and your equipment under control. Can be FORT SDK(comms) or Data Output Control(control). FORT SDK and Data Output Control can each only be set on one serial at a time."
Enum values:
comms
control
serial1Usagestring · enum
NSC Pro only. The physical output interface between the FORT Pro device and your equipment under control. Can be FORT SDK(comms) or Data Output Control(control). FORT SDK and Data Output Control can each only be set on one serial at a time."
Enum values:
comms
control
serial0Baudratestring · enum
Enum values:
BAUDRATE_115200
serial1Baudratestring · enum
Enum values:
BAUDRATE_115200
stopCategorystring · enum
NSC Pro only. E-Stop category CAT0: For an EPC Sender - If ESTOP is on input #1 it disables receiver output #1; if ESTOP on input #2 it disables receiver output #2. For an SRCP transmitter - The last output of the receiver (output #2 for NSCP or output #3 for EPC) is turned off. CAT1: Output #1 of the receiver is turned off immediately, and after a user-defined delay (CAT1 Delay), output #2 of the receiver is turned off.
Enum values:
CAT0
CAT1
cat1StopDelaynumber | null · float
Represents an optional property in a patch request body
ethNetmaskstring | null
Represents an optional property in a patch request body
ethGatewaystring | null
Represents an optional property in a patch request body
ethNameserversarray | null
Represents an optional property in a patch request body
wifiNetmaskstring | null
Represents an optional property in a patch request body
wifiGatewaystring | null
Represents an optional property in a patch request body
wifiNameserversarray | null
Represents an optional property in a patch request body
wifiSsidstring | null
Represents an optional property in a patch request body
wifiPasswordstring | null
Represents an optional property in a patch request body
networkTemplateIdstring · uuid
The network template id

Fort.ProSeriesApi.Models.Dtos.UpdateConfigurationDeviceResponse

idstring · uuid
The configuration id
namestring | null
createdstring · date-time
isConfigurationCompleteboolean
Indicates whether the configuration is complete or has any validation errors.
devicesarray | null
impactsarray | null

Fort.ProSeriesApi.Models.Dtos.UpdateConfigurationDeviceResponseDevice

idstring · uuid
The device id
namestring | null
deviceConfigurationTypestring · enum
The role that the device will be in the configuration. All configurations must have at least one sender and one receiver.
Enum values:
Sender
Receiver
EStopSender
serialNumberstring | null
The serial number identifying the device.
modelNamestring | null
typestring · enum
Enum values:
SRCP
WESP
EPC
NSCP

Fort.ProSeriesApi.Models.Dtos.UpdateConfigurationRequest

namestring | null
Represents an optional property in a patch request body
startingIpAddressstring | null
Represents an optional property in a patch request body
ismTxPowerstring · enum
Enum values:
Medium
High
Low
ismTxChannelinteger | null · int32
Represents an optional property in a patch request body
canModestring · enum
The CAN mode
Enum values:
canopen
j1939
none
canKBitratestring · enum
Can bitrate options. EPC and NSCP devices can only be BITRATE_250000 and BITRATE_500000.
Enum values:
BITRATE_10000
BITRATE_20000
BITRATE_50000
BITRATE_125000
BITRATE_250000
BITRATE_500000
BITRATE_800000
BITRATE_1000000
displayTextPgninteger | null · int32
Represents an optional property in a patch request body
settingsPgninteger | null · int32
Represents an optional property in a patch request body
approvedSourceAddressesarray | null
Represents an optional property in a patch request body
receiverOutputControlinteger | null · int32
Represents an optional property in a patch request body
timeoutConfigurationstring · enum
The safety timeout delay for the configuration.
Enum values:
250ms
500ms
750ms
1000ms
3000ms
5000ms

Fort.ProSeriesApi.Models.Dtos.UpdateConfigurationResponse

idstring · uuid
The configuration id
namestring | null
createdstring · date-time
isConfigurationCompleteboolean
Indicates whether the configuration is complete or has any validation errors.
devicesarray | null
impactsarray | null

Fort.ProSeriesApi.Models.Dtos.UpdateConfigurationResponseDevice

idstring · uuid
The device id
namestring | null
deviceConfigurationTypestring · enum
The role that the device will be in the configuration. All configurations must have at least one sender and one receiver.
Enum values:
Sender
Receiver
EStopSender
serialNumberstring | null
The serial number identifying the device.
modelNamestring | null
typestring · enum
Enum values:
SRCP
WESP
EPC
NSCP

Fort.ProSeriesApi.Models.ValueObjects.ConfigurationId

string · uuid

The configuration id

Fort.ProSeriesApi.Models.Dtos.ApiResponse`1[[Fort.ProSeriesApi.Models.Dtos.DeleteConfigurationResponse, Fort.ProSeriesApi.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]

dataobject
Result returned after attempting to delete a configuration.
successboolean
errorsarray | null

Fort.ProSeriesApi.Models.Dtos.ApiResponse`1[[Fort.ProSeriesApi.Models.Dtos.ValidateApiKeyResponse, Fort.ProSeriesApi.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]

dataobject
Response model for API key validation.
successboolean
errorsarray | null

Fort.ProSeriesApi.Models.Dtos.DeleteConfigurationResponse

idstring · uuid
The configuration id
deletedboolean
Indicates whether the configuration was deleted.
devicesThatNeedBlankConfigarray | null
A list of devices that should have a blank configuration applied to them. This prevents devices from listening to broadcasts from senders which have not yet been updated.

Fort.ProSeriesApi.Models.Dtos.DeviceFileActionConfirmationRequest

deviceFileActionTypestring · enum
Enum values:
None
Deploy
Download
deviceFileTypestring · enum
Enum values:
None
Firmware
Configuration
fileSucessfullyDeployedboolean | null
errorstring | null
firmwareVersionstring | null
safetyConfigurationSyncIdstring · uuid
The id of the configuration sync created when configuration files are generated.
actionTimeStampstring · date-time

Fort.ProSeriesApi.Models.Dtos.ValidateApiKeyRequest

apiKeystring | null

Fort.ProSeriesApi.Models.Dtos.ValidateApiKeyResponse

isValidboolean · required
Indicates whether the API key is valid and active.
messagestring · minLength: 1 · required
Message describing the validation result.

serviceAccountobject
userRolesarray | null
Roles assigned to the service account.
organizationIdstring | null · uuid
The organization ID that this API key belongs to.

Fort.ProSeriesApi.Models.Enums.DeviceFileActionType

string · enum

Enum values:

None

Deploy

Download

Fort.ProSeriesApi.Models.Enums.DeviceFileType

string · enum

Enum values:

None

Firmware

Configuration

Fort.ProSeriesApi.Models.ValueObjects.SafetyConfigurationSyncId

string · uuid

The id of the configuration sync created when configuration files are generated.