Last updated 9 months ago
Was this helpful?
Perform various operations for Symitar parameters.
Symitar eDocs References: Coming soon.
Online outlet
The authorization object required for the operation. Only one credential type is required (if multiple are available) as long as it is configured in SymXchange parameters.
{"AdministrativeCredentials":{"Password":"suwn37834b91&"}}
The custom object for NexumAPI request attributes.
{"customFields":{"appId":"glaci"}}
POST /nexum/627/2022.01/parameter/getOnlineOutlet HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 153 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "OnlineOutletBranchNumber": 1, "nxAttributes": { "customFields": { "appId": "glaci" } } }
Successful operation.
{ "OnlineOutlet": { "BranchNumber": 1, "InstitutionId": "text", "NetworkId": "text", "PseudoTerminalId": "text", "TerminalIdPrefix": "text" } }
Online outlet select fields
POST /nexum/627/2022.01/parameter/getOnlineOutletSelectFields HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 339 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "OnlineOutletBranchNumber": 1, "SelectableFields": { "IncludeAllOnlineOutletFields": true, "OnlineOutletFields": { "BranchNumber": true, "InstitutionId": true, "NetworkId": true, "PseudoTerminalId": true, "TerminalIdPrefix": true } }, "nxAttributes": { "customFields": { "appId": "glaci" } } }
Online outlet paged list
POST /nexum/627/2022.01/parameter/getOnlineOutletPagedList HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 218 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "PagingRequestContext": { "NumberOfRecordsToReturn": 1, "NumberOfRecordsToSkip": 1, "Token": "text" }, "nxAttributes": { "customFields": { "appId": "glaci" } } }
{ "OnlineOutlet": [ { "BranchNumber": 1, "InstitutionId": "text", "NetworkId": "text", "PseudoTerminalId": "text", "TerminalIdPrefix": "text" } ], "Token": "text" }
Online outlet list select fields
POST /nexum/627/2022.01/parameter/getOnlineOutletListSelectFields HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 310 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "SelectableFields": { "IncludeAllOnlineOutletFields": true, "OnlineOutletFields": { "BranchNumber": true, "InstitutionId": true, "NetworkId": true, "PseudoTerminalId": true, "TerminalIdPrefix": true } }, "nxAttributes": { "customFields": { "appId": "glaci" } } }
{ "OnlineOutletList": { "hasReachedMaximumListSize": true, "OnlineOutlet": [ { "BranchNumber": 1, "InstitutionId": "text", "NetworkId": "text", "PseudoTerminalId": "text", "TerminalIdPrefix": "text" } ] } }
Retrieve a list of select fields for online outlets
POST /nexum/627/2022.01/parameter/searchOnlineOutletSelectFields HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 342 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "SelectableFields": { "IncludeAllOnlineOutletFields": true, "OnlineOutletFields": { "BranchNumber": true, "InstitutionId": true, "NetworkId": true, "PseudoTerminalId": true, "TerminalIdPrefix": true } }, "SearchFilter": { "Query": "text" }, "nxAttributes": { "customFields": { "appId": "glaci" } } }
Online outlet paged list select fields
POST /nexum/627/2022.01/parameter/getOnlineOutletPagedListSelectFields HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 404 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "PagingRequestContext": { "NumberOfRecordsToReturn": 1, "NumberOfRecordsToSkip": 1, "Token": "text" }, "SelectableFields": { "IncludeAllOnlineOutletFields": true, "OnlineOutletFields": { "BranchNumber": true, "InstitutionId": true, "NetworkId": true, "PseudoTerminalId": true, "TerminalIdPrefix": true } }, "nxAttributes": { "customFields": { "appId": "glaci" } } }
Retrieve a paged list of select fields for online outlets
POST /nexum/627/2022.01/parameter/searchOnlineOutletPagedSelectFields HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 419 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "PagingRequestContext": { "NumberOfRecordsToReturn": 1, "NumberOfRecordsToSkip": 1, "Token": "text" }, "SelectableFields": { "IncludeAllOnlineOutletFields": true, "OnlineOutletFields": { "BranchNumber": true, "InstitutionId": true, "NetworkId": true, "PseudoTerminalId": true, "TerminalIdPrefix": true } }, "Query": "text", "nxAttributes": { "customFields": { "appId": "glaci" } } }
Update online outlets by ID
POST /nexum/627/2022.01/parameter/updateOnlineOutletByID HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 279 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "OnlineOutletBranchNumber": 1, "OnlineOutletUpdatableFields": { "InstitutionId": "text", "NetworkId": "text", "PseudoTerminalId": "text", "TerminalIdPrefix": "text" }, "nxAttributes": { "customFields": { "appId": "glaci" } } }
{ "UpdateStatus": { "isAllFieldsUpdateSuccess": true, "FailedUpdateStatus": [ { "Record": "text", "ErrorCode": "text", "ErrorMessage": "text", "PrimaryKeyField": [ { "Name": "text", "Value": "text" } ] } ] } }
