GET api/v1/Vendors

Returns a list of Vendors that the API token has rights to view.

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Collection of VendorViewModel

Name	Description	Type	Additional information
VendorId	Represents the PK of the Vendor	globally unique identifier	None.
Name	Represents the name of the Vendor	string	None.
ACSystemId	Represents the PK of the Access Control System for the Vendor	globally unique identifier	None.
ACSystemName	Represents the name of the Access Control System for the Vendor	string	None.
OccupancyId	Represents the PK of the Occupancy the Vendor performs work for (if applicable)	globally unique identifier	None.
OccupancyName	Represents the name of the Occupancy the Vendor performs work for (if applicable)	string	None.
CompanyId	Represents the PK of the global company that the Vendor is an instance of.	globally unique identifier	None.
CompanyName	Represents the name of the global company that the Vendor is an instance of.	string	None.
StreetAddress1	Represents the primary street address of the Vendor	string	None.
StreetAddress2	Represents the secondary street address of the Vendor	string	None.
City	Represents the city of the Vendor	string	None.
RegionId	Represents the PK of the region (State, Province, County, etc) of the Vendor	globally unique identifier	None.
RegionName	Represents the name of the region (State, Province, County, etc) of the Vendor	string	None.
CountryId	Represents the PK of the country of the Vendor	globally unique identifier	None.
CountryName	Represents the name of the country of the Vendor	string	None.
PostalCode	Represents the Postal Code/Zip Code of the Vendor	string	None.
Phone	Represents the primary phone number of the Vendor	string	None.
VendorNumber	Represents the vendor number used to refer to the vendor (typically from an accounting package)	string	None.
TimeZoneInfoId	Represents the TimeZone of the Facility	string	None.
Deleted	Represents the deleted status of the Vendor	boolean	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "VendorId": "e6c13bbd-0ebd-4a2a-a106-c864e1d8e014",
    "Name": "sample string 2",
    "ACSystemId": "a8e84ff4-7b23-428d-a43d-7bc92e32f776",
    "ACSystemName": "sample string 3",
    "OccupancyId": "f730b28c-229a-4e91-96c5-629e54e799bd",
    "OccupancyName": "sample string 4",
    "CompanyId": "5a8d2ac2-7c70-422d-9c0d-c421f5dc44b2",
    "CompanyName": "sample string 6",
    "StreetAddress1": "sample string 7",
    "StreetAddress2": "sample string 8",
    "City": "sample string 9",
    "RegionId": "ca3d78e7-02b1-4282-a427-ac7120112658",
    "RegionName": "sample string 11",
    "CountryId": "950203e2-0813-41c7-99ae-c70619d42133",
    "CountryName": "sample string 13",
    "PostalCode": "sample string 14",
    "Phone": "sample string 15",
    "VendorNumber": "sample string 16",
    "TimeZoneInfoId": "sample string 17",
    "Deleted": true
  },
  {
    "VendorId": "e6c13bbd-0ebd-4a2a-a106-c864e1d8e014",
    "Name": "sample string 2",
    "ACSystemId": "a8e84ff4-7b23-428d-a43d-7bc92e32f776",
    "ACSystemName": "sample string 3",
    "OccupancyId": "f730b28c-229a-4e91-96c5-629e54e799bd",
    "OccupancyName": "sample string 4",
    "CompanyId": "5a8d2ac2-7c70-422d-9c0d-c421f5dc44b2",
    "CompanyName": "sample string 6",
    "StreetAddress1": "sample string 7",
    "StreetAddress2": "sample string 8",
    "City": "sample string 9",
    "RegionId": "ca3d78e7-02b1-4282-a427-ac7120112658",
    "RegionName": "sample string 11",
    "CountryId": "950203e2-0813-41c7-99ae-c70619d42133",
    "CountryName": "sample string 13",
    "PostalCode": "sample string 14",
    "Phone": "sample string 15",
    "VendorNumber": "sample string 16",
    "TimeZoneInfoId": "sample string 17",
    "Deleted": true
  }
]

application/xml, text/xml

Sample:

<ArrayOfVendorViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/APIWebRole.Controllers">
  <VendorViewModel>
    <ACSystemId>a8e84ff4-7b23-428d-a43d-7bc92e32f776</ACSystemId>
    <ACSystemName>sample string 3</ACSystemName>
    <City>sample string 9</City>
    <CompanyId>5a8d2ac2-7c70-422d-9c0d-c421f5dc44b2</CompanyId>
    <CompanyName>sample string 6</CompanyName>
    <CountryId>950203e2-0813-41c7-99ae-c70619d42133</CountryId>
    <CountryName>sample string 13</CountryName>
    <Deleted>true</Deleted>
    <Name>sample string 2</Name>
    <OccupancyId>f730b28c-229a-4e91-96c5-629e54e799bd</OccupancyId>
    <OccupancyName>sample string 4</OccupancyName>
    <Phone>sample string 15</Phone>
    <PostalCode>sample string 14</PostalCode>
    <RegionId>ca3d78e7-02b1-4282-a427-ac7120112658</RegionId>
    <RegionName>sample string 11</RegionName>
    <StreetAddress1>sample string 7</StreetAddress1>
    <StreetAddress2>sample string 8</StreetAddress2>
    <TimeZoneInfoId>sample string 17</TimeZoneInfoId>
    <VendorId>e6c13bbd-0ebd-4a2a-a106-c864e1d8e014</VendorId>
    <VendorNumber>sample string 16</VendorNumber>
  </VendorViewModel>
  <VendorViewModel>
    <ACSystemId>a8e84ff4-7b23-428d-a43d-7bc92e32f776</ACSystemId>
    <ACSystemName>sample string 3</ACSystemName>
    <City>sample string 9</City>
    <CompanyId>5a8d2ac2-7c70-422d-9c0d-c421f5dc44b2</CompanyId>
    <CompanyName>sample string 6</CompanyName>
    <CountryId>950203e2-0813-41c7-99ae-c70619d42133</CountryId>
    <CountryName>sample string 13</CountryName>
    <Deleted>true</Deleted>
    <Name>sample string 2</Name>
    <OccupancyId>f730b28c-229a-4e91-96c5-629e54e799bd</OccupancyId>
    <OccupancyName>sample string 4</OccupancyName>
    <Phone>sample string 15</Phone>
    <PostalCode>sample string 14</PostalCode>
    <RegionId>ca3d78e7-02b1-4282-a427-ac7120112658</RegionId>
    <RegionName>sample string 11</RegionName>
    <StreetAddress1>sample string 7</StreetAddress1>
    <StreetAddress2>sample string 8</StreetAddress2>
    <TimeZoneInfoId>sample string 17</TimeZoneInfoId>
    <VendorId>e6c13bbd-0ebd-4a2a-a106-c864e1d8e014</VendorId>
    <VendorNumber>sample string 16</VendorNumber>
  </VendorViewModel>
</ArrayOfVendorViewModel>