GET v1/companydirectory?sort={sort}

Gets the List of All Companies

Request Information

URI Parameters

Name	Description	Type	Additional information
sort	A comma delimited list of columns to sort by. Field are sorted in ascending order by default. To have a field sort in descending order, preface it with the minus (-) sign.	string	Default value is

Body Parameters

None.

Response Information

Resource Description

Collection of GetAllCompaniesOutput

Name	Description	Type	Additional information
Id	Company id	integer	None.
Name	Company Name	string	None.
AddressLine1	Company Address Line 1	string	None.
AddressLine2	Company Address Line 2	string	None.
City	Company City	string	None.
State	Company State	string	None.
ZipCode	Company Zip code	string	None.
Country	Company Country	string	None.
StreetAddress	Company complete Street Address	string	None.
MainPhone	Company Phone Number	string	None.
MainFaxNumber	Company Fax Number	string	None.
CompanyType	Company Type	string	None.
MemberSince	Company Joining date	string	None.
Description	Company Comments	string	None.
PhoneAreaCode	Company Phone Area code	string	None.
FaxAreaCode	Company Fax Area code	string	None.
WebSite	Company Website link	string	None.
TopicCode	Topic Code	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "Id": 1,
    "Name": "sample string 2",
    "AddressLine1": "sample string 3",
    "AddressLine2": "sample string 4",
    "City": "sample string 5",
    "State": "sample string 6",
    "ZipCode": "sample string 7",
    "Country": "sample string 8",
    "StreetAddress": "sample string 9",
    "MainPhone": "sample string 10",
    "MainFaxNumber": "sample string 11",
    "CompanyType": "sample string 12",
    "MemberSince": "sample string 13",
    "Description": "sample string 14",
    "PhoneAreaCode": "sample string 15",
    "FaxAreaCode": "sample string 16",
    "WebSite": "sample string 17",
    "TopicCode": "sample string 18"
  },
  {
    "Id": 1,
    "Name": "sample string 2",
    "AddressLine1": "sample string 3",
    "AddressLine2": "sample string 4",
    "City": "sample string 5",
    "State": "sample string 6",
    "ZipCode": "sample string 7",
    "Country": "sample string 8",
    "StreetAddress": "sample string 9",
    "MainPhone": "sample string 10",
    "MainFaxNumber": "sample string 11",
    "CompanyType": "sample string 12",
    "MemberSince": "sample string 13",
    "Description": "sample string 14",
    "PhoneAreaCode": "sample string 15",
    "FaxAreaCode": "sample string 16",
    "WebSite": "sample string 17",
    "TopicCode": "sample string 18"
  }
]

text/html

Sample:

[{"Id":1,"Name":"sample string 2","AddressLine1":"sample string 3","AddressLine2":"sample string 4","City":"sample string 5","State":"sample string 6","ZipCode":"sample string 7","Country":"sample string 8","StreetAddress":"sample string 9","MainPhone":"sample string 10","MainFaxNumber":"sample string 11","CompanyType":"sample string 12","MemberSince":"sample string 13","Description":"sample string 14","PhoneAreaCode":"sample string 15","FaxAreaCode":"sample string 16","WebSite":"sample string 17","TopicCode":"sample string 18"},{"Id":1,"Name":"sample string 2","AddressLine1":"sample string 3","AddressLine2":"sample string 4","City":"sample string 5","State":"sample string 6","ZipCode":"sample string 7","Country":"sample string 8","StreetAddress":"sample string 9","MainPhone":"sample string 10","MainFaxNumber":"sample string 11","CompanyType":"sample string 12","MemberSince":"sample string 13","Description":"sample string 14","PhoneAreaCode":"sample string 15","FaxAreaCode":"sample string 16","WebSite":"sample string 17","TopicCode":"sample string 18"}]

application/xml, text/xml

Sample:

<ArrayOfv1_Directory_DirectoryEndpointController.GetAllCompaniesOutput xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Aptify.Services.Generated.v1_Directory_DirectoryEndpoint">
  <v1_Directory_DirectoryEndpointController.GetAllCompaniesOutput>
    <AddressLine1>sample string 3</AddressLine1>
    <AddressLine2>sample string 4</AddressLine2>
    <City>sample string 5</City>
    <CompanyType>sample string 12</CompanyType>
    <Country>sample string 8</Country>
    <Description>sample string 14</Description>
    <FaxAreaCode>sample string 16</FaxAreaCode>
    <Id>1</Id>
    <MainFaxNumber>sample string 11</MainFaxNumber>
    <MainPhone>sample string 10</MainPhone>
    <MemberSince>sample string 13</MemberSince>
    <Name>sample string 2</Name>
    <PhoneAreaCode>sample string 15</PhoneAreaCode>
    <State>sample string 6</State>
    <StreetAddress>sample string 9</StreetAddress>
    <TopicCode>sample string 18</TopicCode>
    <WebSite>sample string 17</WebSite>
    <ZipCode>sample string 7</ZipCode>
  </v1_Directory_DirectoryEndpointController.GetAllCompaniesOutput>
  <v1_Directory_DirectoryEndpointController.GetAllCompaniesOutput>
    <AddressLine1>sample string 3</AddressLine1>
    <AddressLine2>sample string 4</AddressLine2>
    <City>sample string 5</City>
    <CompanyType>sample string 12</CompanyType>
    <Country>sample string 8</Country>
    <Description>sample string 14</Description>
    <FaxAreaCode>sample string 16</FaxAreaCode>
    <Id>1</Id>
    <MainFaxNumber>sample string 11</MainFaxNumber>
    <MainPhone>sample string 10</MainPhone>
    <MemberSince>sample string 13</MemberSince>
    <Name>sample string 2</Name>
    <PhoneAreaCode>sample string 15</PhoneAreaCode>
    <State>sample string 6</State>
    <StreetAddress>sample string 9</StreetAddress>
    <TopicCode>sample string 18</TopicCode>
    <WebSite>sample string 17</WebSite>
    <ZipCode>sample string 7</ZipCode>
  </v1_Directory_DirectoryEndpointController.GetAllCompaniesOutput>
</ArrayOfv1_Directory_DirectoryEndpointController.GetAllCompaniesOutput>