Last updated 9 months ago
Was this helpful?
Perform various operations for Symitar parameters.
Symitar eDocs References: Coming soon.
Retrieve getStock data.
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/getStock HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 138 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "StockType": 1, "nxAttributes": { "customFields": { "appId": "glaci" } } }
Successful operation.
{ "Stock": { "Type": 1, "TypeCollateralPercent": 1, "TypeDecimalPrice": 1, "TypeDescription": "text", "TypeFractionPrice": [ { "EntryId": 1, "TypeFractionPrice": "text" } ], "TypeStockDollars": 1, "TypeStockEighths": 1, "TypeTickerSymbol": "text" } }
Retrieve getStockSelectFields data.
POST /nexum/627/2022.01/parameter/getStockSelectFields HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 388 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "StockType": 1, "SelectableFields": { "IncludeAllStockFields": true, "StockFields": { "Type": true, "TypeCollateralPercent": true, "TypeDecimalPrice": true, "TypeDescription": true, "TypeFractionPrice": [ 1 ], "TypeStockDollars": true, "TypeStockEighths": true, "TypeTickerSymbol": true } }, "nxAttributes": { "customFields": { "appId": "glaci" } } }
Retrieve getStockPagedList data.
POST /nexum/627/2022.01/parameter/getStockPagedList 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" } } }
{ "Stock": [ { "Type": 1, "TypeCollateralPercent": 1, "TypeDecimalPrice": 1, "TypeDescription": "text", "TypeFractionPrice": [ { "EntryId": 1, "TypeFractionPrice": "text" } ], "TypeStockDollars": 1, "TypeStockEighths": 1, "TypeTickerSymbol": "text" } ], "Token": "text" }
Retrieve getStockListSelectFields data.
POST /nexum/627/2022.01/parameter/getStockListSelectFields HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 374 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "SelectableFields": { "IncludeAllStockFields": true, "StockFields": { "Type": true, "TypeCollateralPercent": true, "TypeDecimalPrice": true, "TypeDescription": true, "TypeFractionPrice": [ 1 ], "TypeStockDollars": true, "TypeStockEighths": true, "TypeTickerSymbol": true } }, "nxAttributes": { "customFields": { "appId": "glaci" } } }
{ "StockList": { "hasReachedMaximumListSize": true, "Stock": [ { "Type": 1, "TypeCollateralPercent": 1, "TypeDecimalPrice": 1, "TypeDescription": "text", "TypeFractionPrice": [ { "EntryId": 1, "TypeFractionPrice": "text" } ], "TypeStockDollars": 1, "TypeStockEighths": 1, "TypeTickerSymbol": "text" } ] } }
Retrieve a list of select fields for stock items
POST /nexum/627/2022.01/parameter/searchStockSelectFields HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 406 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "SelectableFields": { "IncludeAllStockFields": true, "StockFields": { "Type": true, "TypeCollateralPercent": true, "TypeDecimalPrice": true, "TypeDescription": true, "TypeFractionPrice": [ 1 ], "TypeStockDollars": true, "TypeStockEighths": true, "TypeTickerSymbol": true } }, "SearchFilter": { "Query": "text" }, "nxAttributes": { "customFields": { "appId": "glaci" } } }
Retrieve getStockPagedListSelectFields data.
POST /nexum/627/2022.01/parameter/getStockPagedListSelectFields HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 468 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "PagingRequestContext": { "NumberOfRecordsToReturn": 1, "NumberOfRecordsToSkip": 1, "Token": "text" }, "SelectableFields": { "IncludeAllStockFields": true, "StockFields": { "Type": true, "TypeCollateralPercent": true, "TypeDecimalPrice": true, "TypeDescription": true, "TypeFractionPrice": [ 1 ], "TypeStockDollars": true, "TypeStockEighths": true, "TypeTickerSymbol": true } }, "nxAttributes": { "customFields": { "appId": "glaci" } } }
Retrieve a paged list of select fields for stock items
POST /nexum/627/2022.01/parameter/searchStockPagedSelectFields HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 483 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "PagingRequestContext": { "NumberOfRecordsToReturn": 1, "NumberOfRecordsToSkip": 1, "Token": "text" }, "SelectableFields": { "IncludeAllStockFields": true, "StockFields": { "Type": true, "TypeCollateralPercent": true, "TypeDecimalPrice": true, "TypeDescription": true, "TypeFractionPrice": [ 1 ], "TypeStockDollars": true, "TypeStockEighths": true, "TypeTickerSymbol": true } }, "Query": "text", "nxAttributes": { "customFields": { "appId": "glaci" } } }
Update stocks by ID
POST /nexum/627/2022.01/parameter/updateStockByID HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 366 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "StockType": 1, "StockUpdatableFields": { "TypeCollateralPercent": 1, "TypeDecimalPrice": 1, "TypeDescription": "text", "TypeFractionPrice": [ { "EntryId": 1, "TypeFractionPrice": "text" } ], "TypeStockDollars": 1, "TypeStockEighths": 1, "TypeTickerSymbol": "text" }, "nxAttributes": { "customFields": { "appId": "glaci" } } }
{ "UpdateStatus": { "isAllFieldsUpdateSuccess": true, "FailedUpdateStatus": [ { "Record": "text", "ErrorCode": "text", "ErrorMessage": "text", "PrimaryKeyField": [ { "Name": "text", "Value": "text" } ] } ] } }
