GET api/Location/GetValues?AuthenticationGUID={AuthenticationGUID}&CompanyID={CompanyID}
Returns a list of Active Locations for the supplied Authentication GUID and Company.
Request Information
Parameters
Name | Description | Additional information |
---|---|---|
AuthenticationGUID |
The Authentication GUID provided to you by your Account Manager |
Define this parameter in the request URI. |
CompanyID |
The EHX Company ID |
Define this parameter in the request URI. |
Response Information
Response body formats
application/json, text/json
Sample:
[ { "Active_AI": "sample string 1", "City": "sample string 2", "CompanyID": 3, "Email": "sample string 4", "ExportExternalID": "sample string 5", "FEIN": "sample string 6", "ImportExternalID": "sample string 7", "LocationID": "sample string 8", "LocationName": "sample string 9", "LocationNumber": "sample string 10", "Phone": "sample string 11", "State": "sample string 12", "Status": "sample string 13", "Street1": "sample string 14", "Street2": "sample string 15", "ZipCode": "sample string 16" }, { "Active_AI": "sample string 1", "City": "sample string 2", "CompanyID": 3, "Email": "sample string 4", "ExportExternalID": "sample string 5", "FEIN": "sample string 6", "ImportExternalID": "sample string 7", "LocationID": "sample string 8", "LocationName": "sample string 9", "LocationNumber": "sample string 10", "Phone": "sample string 11", "State": "sample string 12", "Status": "sample string 13", "Street1": "sample string 14", "Street2": "sample string 15", "ZipCode": "sample string 16" }, { "Active_AI": "sample string 1", "City": "sample string 2", "CompanyID": 3, "Email": "sample string 4", "ExportExternalID": "sample string 5", "FEIN": "sample string 6", "ImportExternalID": "sample string 7", "LocationID": "sample string 8", "LocationName": "sample string 9", "LocationNumber": "sample string 10", "Phone": "sample string 11", "State": "sample string 12", "Status": "sample string 13", "Street1": "sample string 14", "Street2": "sample string 15", "ZipCode": "sample string 16" } ]
application/xml, text/xml
Sample:
<ArrayOfMainAPI.LocationClass xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EFAPIWeb"> <MainAPI.LocationClass> <Active_AI>sample string 1</Active_AI> <City>sample string 2</City> <CompanyID>3</CompanyID> <Email>sample string 4</Email> <ExportExternalID>sample string 5</ExportExternalID> <FEIN>sample string 6</FEIN> <ImportExternalID>sample string 7</ImportExternalID> <LocationID>sample string 8</LocationID> <LocationName>sample string 9</LocationName> <LocationNumber>sample string 10</LocationNumber> <Phone>sample string 11</Phone> <State>sample string 12</State> <Status>sample string 13</Status> <Street1>sample string 14</Street1> <Street2>sample string 15</Street2> <ZipCode>sample string 16</ZipCode> </MainAPI.LocationClass> <MainAPI.LocationClass> <Active_AI>sample string 1</Active_AI> <City>sample string 2</City> <CompanyID>3</CompanyID> <Email>sample string 4</Email> <ExportExternalID>sample string 5</ExportExternalID> <FEIN>sample string 6</FEIN> <ImportExternalID>sample string 7</ImportExternalID> <LocationID>sample string 8</LocationID> <LocationName>sample string 9</LocationName> <LocationNumber>sample string 10</LocationNumber> <Phone>sample string 11</Phone> <State>sample string 12</State> <Status>sample string 13</Status> <Street1>sample string 14</Street1> <Street2>sample string 15</Street2> <ZipCode>sample string 16</ZipCode> </MainAPI.LocationClass> <MainAPI.LocationClass> <Active_AI>sample string 1</Active_AI> <City>sample string 2</City> <CompanyID>3</CompanyID> <Email>sample string 4</Email> <ExportExternalID>sample string 5</ExportExternalID> <FEIN>sample string 6</FEIN> <ImportExternalID>sample string 7</ImportExternalID> <LocationID>sample string 8</LocationID> <LocationName>sample string 9</LocationName> <LocationNumber>sample string 10</LocationNumber> <Phone>sample string 11</Phone> <State>sample string 12</State> <Status>sample string 13</Status> <Street1>sample string 14</Street1> <Street2>sample string 15</Street2> <ZipCode>sample string 16</ZipCode> </MainAPI.LocationClass> </ArrayOfMainAPI.LocationClass>