GET api/v2/General/Locations/{LocationCode}

Retrieves the list of business locations.

Request Information

URI Parameters

Name	Description	Type	Additional information
LocationCode		string	Default value is

Body Parameters

None.

Response Information

Resource Description

Collection of Location

Name	Type	Additional information
Id	string	None.
Name	string	None.
LocationNumber	string	None.
Address1	string	None.
Address2	string	None.
Address3	string	None.
City	string	None.
State	string	None.
ZipCode	string	None.
Country	string	None.
Phone	string	None.
Fax	string	None.
BillToAddress1	string	None.
BillToAddress2	string	None.
BillToAddress3	string	None.
BillToCity	string	None.
BillToState	string	None.
BillToZip	string	None.
BillToCountry	string	None.
BillToPhone	string	None.
BillToFax	string	None.
DMPayClientId	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "Id": "sample string 1",
    "Name": "sample string 2",
    "LocationNumber": "sample string 3",
    "Address1": "sample string 4",
    "Address2": "sample string 5",
    "Address3": "sample string 6",
    "City": "sample string 7",
    "State": "sample string 8",
    "ZipCode": "sample string 9",
    "Country": "sample string 10",
    "Phone": "sample string 11",
    "Fax": "sample string 12",
    "BillToAddress1": "sample string 13",
    "BillToAddress2": "sample string 14",
    "BillToAddress3": "sample string 15",
    "BillToCity": "sample string 16",
    "BillToState": "sample string 17",
    "BillToZip": "sample string 18",
    "BillToCountry": "sample string 19",
    "BillToPhone": "sample string 20",
    "BillToFax": "sample string 21",
    "DMPayClientId": "sample string 22"
  },
  {
    "Id": "sample string 1",
    "Name": "sample string 2",
    "LocationNumber": "sample string 3",
    "Address1": "sample string 4",
    "Address2": "sample string 5",
    "Address3": "sample string 6",
    "City": "sample string 7",
    "State": "sample string 8",
    "ZipCode": "sample string 9",
    "Country": "sample string 10",
    "Phone": "sample string 11",
    "Fax": "sample string 12",
    "BillToAddress1": "sample string 13",
    "BillToAddress2": "sample string 14",
    "BillToAddress3": "sample string 15",
    "BillToCity": "sample string 16",
    "BillToState": "sample string 17",
    "BillToZip": "sample string 18",
    "BillToCountry": "sample string 19",
    "BillToPhone": "sample string 20",
    "BillToFax": "sample string 21",
    "DMPayClientId": "sample string 22"
  }
]

application/xml, text/xml

Sample:

<ArrayOfLocation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/com.dockmaster.lib.models">
  <Location>
    <Address1>sample string 4</Address1>
    <Address2>sample string 5</Address2>
    <Address3>sample string 6</Address3>
    <BillToAddress1>sample string 13</BillToAddress1>
    <BillToAddress2>sample string 14</BillToAddress2>
    <BillToAddress3>sample string 15</BillToAddress3>
    <BillToCity>sample string 16</BillToCity>
    <BillToCountry>sample string 19</BillToCountry>
    <BillToFax>sample string 21</BillToFax>
    <BillToPhone>sample string 20</BillToPhone>
    <BillToState>sample string 17</BillToState>
    <BillToZip>sample string 18</BillToZip>
    <City>sample string 7</City>
    <Country>sample string 10</Country>
    <DMPayClientId>sample string 22</DMPayClientId>
    <Fax>sample string 12</Fax>
    <Id>sample string 1</Id>
    <LocationNumber>sample string 3</LocationNumber>
    <Name>sample string 2</Name>
    <Phone>sample string 11</Phone>
    <State>sample string 8</State>
    <ZipCode>sample string 9</ZipCode>
  </Location>
  <Location>
    <Address1>sample string 4</Address1>
    <Address2>sample string 5</Address2>
    <Address3>sample string 6</Address3>
    <BillToAddress1>sample string 13</BillToAddress1>
    <BillToAddress2>sample string 14</BillToAddress2>
    <BillToAddress3>sample string 15</BillToAddress3>
    <BillToCity>sample string 16</BillToCity>
    <BillToCountry>sample string 19</BillToCountry>
    <BillToFax>sample string 21</BillToFax>
    <BillToPhone>sample string 20</BillToPhone>
    <BillToState>sample string 17</BillToState>
    <BillToZip>sample string 18</BillToZip>
    <City>sample string 7</City>
    <Country>sample string 10</Country>
    <DMPayClientId>sample string 22</DMPayClientId>
    <Fax>sample string 12</Fax>
    <Id>sample string 1</Id>
    <LocationNumber>sample string 3</LocationNumber>
    <Name>sample string 2</Name>
    <Phone>sample string 11</Phone>
    <State>sample string 8</State>
    <ZipCode>sample string 9</ZipCode>
  </Location>
</ArrayOfLocation>