SmartAcc DynaMod Web API v2024.4 Build 0000 - Local

<back to all web services

Locations

Common Module

Locations API

Requires Authentication
Required permission:Location-Setup.GET
The following routes are available for this service:
GET/LocationsLocation (Outlets) recordsList of location available
LocationsResponse Parameters:
NameParameterData TypeRequiredDescription
LocationsformList<AcLocation>No
ResponseStatusformResponseStatusNo
AcLocation Parameters:
NameParameterData TypeRequiredDescription
AcLocationIdformstringYesLocation ID
AcLocationDescformstringYesDescription
AcCompanyIDformstringYesCompany ID
Address1formstringNoAddress 1
Address2formstringNoAddress 2
Address3formstringNoAddress 3
Address4formstringNoAddress 4
Phone1formstringNoPhone 1
Phone2formstringNoPhone 2
FaxformstringNoFax Number
Contact1formstringNoContact 1
Contact2formstringNoContact 2
AttentionformstringNoAttention
IsActiveformstringNoActive?

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 /Locations HTTP/1.1 
Host: snr2u.com 
Accept: application/xml

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

<LocationsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SmartDynaModWebAPI.ServiceModel">
  <Locations xmlns:d2p1="http://schemas.datacontract.org/2004/07/SmartDynaModWebAPI.ServiceModel.Types">
    <d2p1:AcLocation>
      <d2p1:AcCompanyID>String</d2p1:AcCompanyID>
      <d2p1:AcLocationDesc>String</d2p1:AcLocationDesc>
      <d2p1:AcLocationId>String</d2p1:AcLocationId>
      <d2p1:Address1>String</d2p1:Address1>
      <d2p1:Address2>String</d2p1:Address2>
      <d2p1:Address3>String</d2p1:Address3>
      <d2p1:Address4>String</d2p1:Address4>
      <d2p1:Attention>String</d2p1:Attention>
      <d2p1:Contact1>String</d2p1:Contact1>
      <d2p1:Contact2>String</d2p1:Contact2>
      <d2p1:Fax>String</d2p1:Fax>
      <d2p1:IsActive>String</d2p1:IsActive>
      <d2p1:Phone1>String</d2p1:Phone1>
      <d2p1:Phone2>String</d2p1:Phone2>
    </d2p1:AcLocation>
  </Locations>
  <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>
</LocationsResponse>