SmartAcc DynaMod Web API v2024.4 Build 0000 - Local

<back to all web services

Salesmans

Customer Module

Salesmans API

Requires Authentication
Required permission:Salesman-Setup.GET
The following routes are available for this service:
GET/SalesmansSalesmans ListSalesmans records available in system
GET/Salesmans/page/{Page}Salesman List. Get records by given a page numberEach page consists of 20 records
GET/Salesmans/AcSalesmanID/{AcSalesmanID}Get records for given ID
Salesmans Parameters:
NameParameterData TypeRequiredDescription
AcSalesmanIDpathstringNo
Pagepathint?NoPage Number. Default 1.
RecordsPerPagequeryint?NoRecords Per Page. Default 20 Records.
SalesmansResponse Parameters:
NameParameterData TypeRequiredDescription
SalesmansformList<AcSalesman>No
ResponseStatusformResponseStatusNo
TotalRecordsformintNoTotal records in all pages.
TotalRecordsInPageformintNoTotal records in current page.
AcSalesman Parameters:
NameParameterData TypeRequiredDescription
AcSalesmanIDformstringNo
AcSalesmanNameformstringNo
AcSalesmanGroupIDformstringNo
SmPhoneNumberformstringNo
SmEmailformstringNo
SmCountryformstringNo
SmRegionformstringNo
SmCityformstringNo
SmPostalCodeformstringNo
SmAddressformstringNo
SmNotesformstringNo
ActiveformstringNo

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

HTTP + XML

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: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<SalesmansResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SmartDynaModWebAPI.ServiceModel">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <Salesmans xmlns:d2p1="http://schemas.datacontract.org/2004/07/SmartDynaModWebAPI.ServiceModel.Types">
    <d2p1:AcSalesman>
      <d2p1:AcSalesmanGroupID>String</d2p1:AcSalesmanGroupID>
      <d2p1:AcSalesmanID>String</d2p1:AcSalesmanID>
      <d2p1:AcSalesmanName>String</d2p1:AcSalesmanName>
      <d2p1:Active>String</d2p1:Active>
      <d2p1:SmAddress>String</d2p1:SmAddress>
      <d2p1:SmCity>String</d2p1:SmCity>
      <d2p1:SmCountry>String</d2p1:SmCountry>
      <d2p1:SmEmail>String</d2p1:SmEmail>
      <d2p1:SmNotes>String</d2p1:SmNotes>
      <d2p1:SmPhoneNumber>String</d2p1:SmPhoneNumber>
      <d2p1:SmPostalCode>String</d2p1:SmPostalCode>
      <d2p1:SmRegion>String</d2p1:SmRegion>
    </d2p1:AcSalesman>
  </Salesmans>
  <TotalRecords>0</TotalRecords>
  <TotalRecordsInPage>0</TotalRecordsInPage>
</SalesmansResponse>