SmartAcc DynaMod Web API v2024.4 Build 0000 - Local

<back to all web services

StockColors

Stock Module

Stock Colors API

Requires Authentication
Required permission:StockColor-Setup.GET
The following routes are available for this service:
GET/StockColors
GET/StockColors/page/{Page}Get records by given a page numberEach page consists of 20 records
GET/StockColors/AcStockColorID/{AcStockColorID}Get records for given ID
StockColors Parameters:
NameParameterData TypeRequiredDescription
Pagepathint?NoPage Number. Default 1.
RecordsPerPagequeryint?NoRecords Per Page. Default 20 Records.
AcStockColorIDpathstringNo
StockColorsResponse Parameters:
NameParameterData TypeRequiredDescription
StockColorsformList<AcStockColor>No
ResponseStatusformResponseStatusNo
TotalRecordsformintNoTotal records in all pages.
TotalRecordsInPageformintNoTotal records in current page.
AcStockColor Parameters:
NameParameterData TypeRequiredDescription
AcStockColorIDformstringYesStock Color ID
AcStockColorDescformstringYesDescription

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /StockColors HTTP/1.1 
Host: snr2u.com 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"StockColors":[{"AcStockColorID":"String","AcStockColorDesc":"String"}],"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"TotalRecords":0,"TotalRecordsInPage":0}