Stock

Perform various operations for Symitar parameters.

Symitar eDocs References: Coming soon.

Operations

getStock

post

Retrieve getStock data.

Authorizations

Body

StockTypeintegerRequired

Responses

200

Successful operation.

application/json

post

/getStock

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "StockType": 1,
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "Stock": {
    "Type": 1,
    "TypeCollateralPercent": 1,
    "TypeDecimalPrice": 1,
    "TypeDescription": "text",
    "TypeFractionPrice": [
      {
        "EntryId": 1,
        "TypeFractionPrice": "text"
      }
    ],
    "TypeStockDollars": 1,
    "TypeStockEighths": 1,
    "TypeTickerSymbol": "text"
  }
}

getStockSelectFields

post

Retrieve getStockSelectFields data.

Authorizations

Body

StockTypeintegerOptional

Responses

200

Successful operation.

application/json

post

/getStockSelectFields

POST /nexum/627/2022.01/parameter/getStockSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
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"
    }
  }
}

200

Successful operation.

{
  "Stock": {
    "Type": 1,
    "TypeCollateralPercent": 1,
    "TypeDecimalPrice": 1,
    "TypeDescription": "text",
    "TypeFractionPrice": [
      {
        "EntryId": 1,
        "TypeFractionPrice": "text"
      }
    ],
    "TypeStockDollars": 1,
    "TypeStockEighths": 1,
    "TypeTickerSymbol": "text"
  }
}

getStockPagedList

post

Retrieve getStockPagedList data.

Authorizations

Body

Responses

200

Successful operation.

application/json

post

/getStockPagedList

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 1,
    "Token": "text"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "Stock": [
    {
      "Type": 1,
      "TypeCollateralPercent": 1,
      "TypeDecimalPrice": 1,
      "TypeDescription": "text",
      "TypeFractionPrice": [
        {
          "EntryId": 1,
          "TypeFractionPrice": "text"
        }
      ],
      "TypeStockDollars": 1,
      "TypeStockEighths": 1,
      "TypeTickerSymbol": "text"
    }
  ],
  "Token": "text"
}

getStockListSelectFields

post

Retrieve getStockListSelectFields data.

Authorizations

Body

Responses

200

Successful operation.

application/json

post

/getStockListSelectFields

POST /nexum/627/2022.01/parameter/getStockListSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
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"
    }
  }
}

200

Successful operation.

{
  "StockList": {
    "hasReachedMaximumListSize": true,
    "Stock": [
      {
        "Type": 1,
        "TypeCollateralPercent": 1,
        "TypeDecimalPrice": 1,
        "TypeDescription": "text",
        "TypeFractionPrice": [
          {
            "EntryId": 1,
            "TypeFractionPrice": "text"
          }
        ],
        "TypeStockDollars": 1,
        "TypeStockEighths": 1,
        "TypeTickerSymbol": "text"
      }
    ]
  }
}

searchStockSelectFields

post

Retrieve a list of select fields for stock items

Authorizations

Body

Responses

200

Successful operation.

application/json

post

/searchStockSelectFields

POST /nexum/627/2022.01/parameter/searchStockSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
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"
    }
  }
}

200

Successful operation.

{
  "StockList": {
    "hasReachedMaximumListSize": true,
    "Stock": [
      {
        "Type": 1,
        "TypeCollateralPercent": 1,
        "TypeDecimalPrice": 1,
        "TypeDescription": "text",
        "TypeFractionPrice": [
          {
            "EntryId": 1,
            "TypeFractionPrice": "text"
          }
        ],
        "TypeStockDollars": 1,
        "TypeStockEighths": 1,
        "TypeTickerSymbol": "text"
      }
    ]
  }
}

getStockPagedListSelectFields

post

Retrieve getStockPagedListSelectFields data.

Authorizations

Body

Responses

200

Successful operation.

application/json

post

/getStockPagedListSelectFields

POST /nexum/627/2022.01/parameter/getStockPagedListSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
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"
    }
  }
}

200

Successful operation.

{
  "Stock": [
    {
      "Type": 1,
      "TypeCollateralPercent": 1,
      "TypeDecimalPrice": 1,
      "TypeDescription": "text",
      "TypeFractionPrice": [
        {
          "EntryId": 1,
          "TypeFractionPrice": "text"
        }
      ],
      "TypeStockDollars": 1,
      "TypeStockEighths": 1,
      "TypeTickerSymbol": "text"
    }
  ],
  "Token": "text"
}

searchStockPagedSelectFields

post

Retrieve a paged list of select fields for stock items

Authorizations

Body

QuerystringOptional

Responses

200

Successful operation.

application/json

post

/searchStockPagedSelectFields

POST /nexum/627/2022.01/parameter/searchStockPagedSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
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"
    }
  }
}

200

Successful operation.

{
  "Stock": [
    {
      "Type": 1,
      "TypeCollateralPercent": 1,
      "TypeDecimalPrice": 1,
      "TypeDescription": "text",
      "TypeFractionPrice": [
        {
          "EntryId": 1,
          "TypeFractionPrice": "text"
        }
      ],
      "TypeStockDollars": 1,
      "TypeStockEighths": 1,
      "TypeTickerSymbol": "text"
    }
  ],
  "Token": "text"
}

updateStockByID

post

Update stocks by ID

Authorizations

Body

StockTypeintegerOptional

Responses

200

Successful operation.

application/json

post

/updateStockByID

POST /nexum/627/2022.01/parameter/updateStockByID HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
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"
    }
  }
}

200

Successful operation.

{
  "UpdateStatus": {
    "isAllFieldsUpdateSuccess": true,
    "FailedUpdateStatus": [
      {
        "Record": "text",
        "ErrorCode": "text",
        "ErrorMessage": "text",
        "PrimaryKeyField": [
          {
            "Name": "text",
            "Value": "text"
          }
        ]
      }
    ]
  }
}

PreviousStmtMessages NextSycClient

Last updated 1 year ago

Was this helpful?