GetAllVendors
Overview
Returns a list of Vendors that the API token has rights to view.
Request Information
Method
GET - api/Vendor/GetAllVendors
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
JSON
\\\\[ { "VendorId": "978e1cc5-91f9-4e25-9450-6c90504d828f", "Name": "sample string 2", "ACSystemId": "6d7bcb3d-a25c-4fac-a1c1-325fb22e66e6", "ACSystemName": "sample string 4", "OccupancyId": "e42ad384-6478-4028-b512-65d116108330", "OccupancyName": "sample string 5", "CompanyId": "164684c8-5c9f-45d0-a202-55eb3b8a1a40", "CompanyName": "sample string 7", "StreetAddress1": "sample string 8", "StreetAddress2": "sample string 9", "City": "sample string 10", "RegionId": "cd8c41d2-be11-4c2d-8202-ea1716acdbc8", "RegionName": "sample string 12", "CountryId": "1b52ca8c-dd15-4010-b0eb-d88d5e6a8eac", "CountryName": "sample string 14", "PostalCode": "sample string 15", "Phone": "sample string 16", "VendorNumber": "sample string 17", "TimeZoneInfoId": "sample string 18", "Deleted": true }, { "VendorId": "978e1cc5-91f9-4e25-9450-6c90504d828f", "Name": "sample string 2", "ACSystemId": "6d7bcb3d-a25c-4fac-a1c1-325fb22e66e6", "ACSystemName": "sample string 4", "OccupancyId": "e42ad384-6478-4028-b512-65d116108330", "OccupancyName": "sample string 5", "CompanyId": "164684c8-5c9f-45d0-a202-55eb3b8a1a40", "CompanyName": "sample string 7", "StreetAddress1": "sample string 8", "StreetAddress2": "sample string 9", "City": "sample string 10", "RegionId": "cd8c41d2-be11-4c2d-8202-ea1716acdbc8", "RegionName": "sample string 12", "CountryId": "1b52ca8c-dd15-4010-b0eb-d88d5e6a8eac", "CountryName": "sample string 14", "PostalCode": "sample string 15", "Phone": "sample string 16", "VendorNumber": "sample string 17", "TimeZoneInfoId": "sample string 18", "Deleted": true } ]
XML
<ArrayOfVendorViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BluSKYWebAPI.Controllers">
<VendorViewModel>
<ACSystemId>6d7bcb3d-a25c-4fac-a1c1-325fb22e66e6</ACSystemId>
<ACSystemName>sample string 4</ACSystemName>
<City>sample string 10</City>
<CompanyId>164684c8-5c9f-45d0-a202-55eb3b8a1a40</CompanyId>
<CompanyName>sample string 7</CompanyName>
<CountryId>1b52ca8c-dd15-4010-b0eb-d88d5e6a8eac</CountryId>
<CountryName>sample string 14</CountryName>
<Deleted>true</Deleted>
`<Name>`sample string 2</Name>
<OccupancyId>e42ad384-6478-4028-b512-65d116108330</OccupancyId>
<OccupancyName>sample string 5</OccupancyName>
<Phone>sample string 16</Phone>
<PostalCode>sample string 15</PostalCode>
<RegionId>cd8c41d2-be11-4c2d-8202-ea1716acdbc8</RegionId>
<RegionName>sample string 12</RegionName>
<StreetAddress1>sample string 8</StreetAddress1>
<StreetAddress2>sample string 9</StreetAddress2>
<TimeZoneInfoId>sample string 18</TimeZoneInfoId>
<VendorId>978e1cc5-91f9-4e25-9450-6c90504d828f</VendorId>
<VendorNumber>sample string 17</VendorNumber>
</VendorViewModel>
<VendorViewModel>
<ACSystemId>6d7bcb3d-a25c-4fac-a1c1-325fb22e66e6</ACSystemId>
<ACSystemName>sample string 4</ACSystemName>
<City>sample string 10</City>
<CompanyId>164684c8-5c9f-45d0-a202-55eb3b8a1a40</CompanyId>
<CompanyName>sample string 7</CompanyName>
<CountryId>1b52ca8c-dd15-4010-b0eb-d88d5e6a8eac</CountryId>
<CountryName>sample string 14</CountryName>
<Deleted>true</Deleted>
`<Name>`sample string 2</Name>
<OccupancyId>e42ad384-6478-4028-b512-65d116108330</OccupancyId>
<OccupancyName>sample string 5</OccupancyName>
<Phone>sample string 16</Phone>
<PostalCode>sample string 15</PostalCode>
<RegionId>cd8c41d2-be11-4c2d-8202-ea1716acdbc8</RegionId>
<RegionName>sample string 12</RegionName>
<StreetAddress1>sample string 8</StreetAddress1>
<StreetAddress2>sample string 9</StreetAddress2>
<TimeZoneInfoId>sample string 18</TimeZoneInfoId>
<VendorId>978e1cc5-91f9-4e25-9450-6c90504d828f</VendorId>
<VendorNumber>sample string 17</VendorNumber>
</VendorViewModel>
</ArrayOfVendorViewModel>