| Required permission: | Salesman-Setup.GET |
| GET | /Salesmans | Salesmans List | Salesmans records available in system |
|---|---|---|---|
| GET | /Salesmans/page/{Page} | Salesman List. Get records by given a page number | Each page consists of 20 records |
| GET | /Salesmans/AcSalesmanID/{AcSalesmanID} | Get records for given ID |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AcSalesmanID | path | string | No | |
| Page | path | int? | No | Page Number. Default 1. |
| RecordsPerPage | query | int? | No | Records Per Page. Default 20 Records. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Salesmans | form | List<AcSalesman> | No | |
| ResponseStatus | form | ResponseStatus | No | |
| TotalRecords | form | int | No | Total records in all pages. |
| TotalRecordsInPage | form | int | No | Total records in current page. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AcSalesmanID | form | string | No | |
| AcSalesmanName | form | string | No | |
| AcSalesmanGroupID | form | string | No | |
| SmPhoneNumber | form | string | No | |
| SmEmail | form | string | No | |
| SmCountry | form | string | No | |
| SmRegion | form | string | No | |
| SmCity | form | string | No | |
| SmPostalCode | form | string | No | |
| SmAddress | form | string | No | |
| SmNotes | form | string | No | |
| Active | form | string | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /Salesmans HTTP/1.1 Host: snr2u.com Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"Salesmans":[{"AcSalesmanID":"String","AcSalesmanName":"String","AcSalesmanGroupID":"String","SmPhoneNumber":"String","SmEmail":"String","SmCountry":"String","SmRegion":"String","SmCity":"String","SmPostalCode":"String","SmAddress":"String","SmNotes":"String","Active":"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}