Ctrlk
For the complete documentation index, see llms.txt. This page is also available as Markdown.

OnlineNet

Perform various operations for Symitar parameters.

Symitar eDocs References: Coming soon.

Operations

getOnlineNet

post

Retrieve OnlineNet parameter records. ParameterService is available for SymXchange 2022.01 in this documentation set.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
OnlineNetNetworkMessageFormatintegerRequired
Responses
200

Successful operation.

application/json
post/getOnlineNet
POST /nexum/627/2022.01/parameter/getOnlineNet HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 183

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "OnlineNetNetworkMessageFormat": "example-value",
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}
200

Successful operation.

{
  "OnlineNet": {
    "RecordChangeDate": "2010-05-08"
  },
  "MessageId": "getOnlineNet"
}

getOnlineNetSelectFields

post

Retrieve OnlineNet parameter records. ParameterService is available for SymXchange 2022.01 in this documentation set.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
OnlineNetNetworkMessageFormatintegerOptional
Responses
200

Successful operation.

application/json
post/getOnlineNetSelectFields
POST /nexum/627/2022.01/parameter/getOnlineNetSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 279

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "parameter-reference"
    }
  },
  "OnlineNetNetworkMessageFormat": 2,
  "SelectableFields": {
    "OnlineNetFields": {
      "NetworkMessageFormat": true,
      "LogicalNetwork": true,
      "SystemId": true
    }
  }
}
200

Successful operation.

{
  "OnlineNet": {
    "LogicalNetwork": null,
    "NetworkMessageFormat": 2,
    "SystemId": null
  },
  "MessageId": "getOnlineNetSelectFields"
}

getOnlineNetPagedList

post

Retrieve OnlineNet parameter records. ParameterService is available for SymXchange 2022.01 in this documentation set.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
Responses
200

Successful operation.

application/json
TokenstringOptional
post/getOnlineNetPagedList
POST /nexum/627/2022.01/parameter/getOnlineNetPagedList HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 238

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 5,
    "NumberOfRecordsToSkip": 0,
    "Token": "example-token"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}
200

Successful operation.

{
  "OnlineNet": [],
  "Token": null,
  "MessageId": "getOnlineNetPagedList"
}

getOnlineNetListSelectFields

post

Retrieve OnlineNet parameter records. ParameterService is available for SymXchange 2022.01 in this documentation set.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
Responses
200

Successful operation.

application/json
post/getOnlineNetListSelectFields
POST /nexum/627/2022.01/parameter/getOnlineNetListSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 192

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "parameter-reference"
    }
  },
  "SelectableFields": {
    "IncludeAllOnlineNetFields": true
  }
}
200

Successful operation.

{
  "OnlineNetList": [],
  "MessageId": "getOnlineNetListSelectFields"
}

searchOnlineNetSelectFields

post

Search OnlineNet parameter records. ParameterService is available for SymXchange 2022.01 in this documentation set.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
Responses
200

Successful operation.

application/json
post/searchOnlineNetSelectFields
POST /nexum/627/2022.01/parameter/searchOnlineNetSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 230

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "SelectableFields": {
    "IncludeAllOnlineNetFields": true
  },
  "SearchFilter": {
    "Query": "example-query"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}
200

Successful operation.

{
  "OnlineNetList": [],
  "MessageId": "searchOnlineNetSelectFields"
}

getOnlineNetPagedListSelectFields

post

Retrieve OnlineNet parameter records. ParameterService is available for SymXchange 2022.01 in this documentation set.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
Responses
200

Successful operation.

application/json
TokenstringOptional
post/getOnlineNetPagedListSelectFields
POST /nexum/627/2022.01/parameter/getOnlineNetPagedListSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 324

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "parameter-reference"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 0
  },
  "SelectableFields": {
    "OnlineNetFields": {
      "NetworkMessageFormat": true,
      "LogicalNetwork": true,
      "SystemId": true
    }
  }
}
200

Successful operation.

{
  "OnlineNet": [
    {
      "LogicalNetwork": null,
      "NetworkMessageFormat": 2,
      "SystemId": null
    }
  ],
  "Token": "{paging-token}",
  "MessageId": "getOnlineNetPagedListSelectFields"
}

searchOnlineNetPagedSelectFields

post

Search OnlineNet parameter records. ParameterService is available for SymXchange 2022.01 in this documentation set.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
QuerystringOptional
Responses
200

Successful operation.

application/json
TokenstringOptional
post/searchOnlineNetPagedSelectFields
POST /nexum/627/2022.01/parameter/searchOnlineNetPagedSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 335

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "parameter-reference"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 0
  },
  "Query": "",
  "SelectableFields": {
    "OnlineNetFields": {
      "NetworkMessageFormat": true,
      "LogicalNetwork": true,
      "SystemId": true
    }
  }
}
200

Successful operation.

{
  "OnlineNet": [
    {
      "LogicalNetwork": null,
      "NetworkMessageFormat": 2,
      "SystemId": null
    }
  ],
  "Token": "{paging-token}",
  "MessageId": "searchOnlineNetPagedSelectFields"
}

updateOnlineNetByID

post

Update OnlineNet parameter configuration. Parameter updates can change institution behavior and should be tested in a controlled environment before use.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
OnlineNetNetworkMessageFormatintegerOptional
Responses
200

Successful operation.

application/json
post/updateOnlineNetByID
POST /nexum/627/2022.01/parameter/updateOnlineNetByID HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 251

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "OnlineNetNetworkMessageFormat": "example-value",
  "OnlineNetUpdatableFields": {
    "Type": 0,
    "Description": "NEXUM EXAMPLE"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}
200

Successful operation.

{
  "UpdateStatus": {
    "isAllFieldsUpdateSuccess": true,
    "FailedUpdateStatus": []
  },
  "MessageId": "updateOnlineNetByID"
}
PreviousOnlineMain
NextOnlineOutlet

Last updated

Was this helpful?