ApexERPHost

<back to all web services

GetLocations

Requires Authentication
The following routes are available for this service:
GET/Accounting/Locations/
GetLocations Parameters:
NameParameterData TypeRequiredDescription
LocationIdqueryint?No
BrIdqueryint?No
MgrIdqueryint?No
BranchIdqueryint?No
BrChildLocqueryboolNo
GetLocationsResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
ResultformList<Location>No
Location Parameters:
NameParameterData TypeRequiredDescription
locationidformintNo
mgridformint?No
nameformstringNo
nameeformstringNo
hcodeformstringNo
bridformintNo
hrclvlformintNo
hccrtformstringNo
mgridpformintNo
BranchformBranchNo
branch_idformint?No
Branch Parameters:
NameParameterData TypeRequiredDescription
BranchIDformintNo
NameformstringNo
DescriptionformstringNo
SpendformboolNo
CompanyBranchIdformint?No

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 /Accounting/Locations/ HTTP/1.1 
Host: apex.nikoratrade.ge 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetLocationsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Apex.Services.Accounting">
  <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>
  <Result>
    <Location>
      <locationid>0</locationid>
      <mgrid>0</mgrid>
      <name>String</name>
      <namee>String</namee>
      <hcode>String</hcode>
      <brid>0</brid>
      <hrclvl>0</hrclvl>
      <hccrt>String</hccrt>
      <mgridp>0</mgridp>
      <Branch xmlns:d4p1="http://schemas.datacontract.org/2004/07/Apex.Services.Common">
        <d4p1:BranchID>0</d4p1:BranchID>
        <d4p1:Name>String</d4p1:Name>
        <d4p1:Description>String</d4p1:Description>
        <d4p1:Spend>false</d4p1:Spend>
        <d4p1:CompanyBranchId>0</d4p1:CompanyBranchId>
      </Branch>
      <branch_id>0</branch_id>
    </Location>
  </Result>
</GetLocationsResponse>