Skip to main content

GetVendorsBySystemId

Overview​

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

Request Information​

Method​

GET - api/Vendor/GetVendorsBySystemId/{ACSystemId}

URI Parameters​

NameDescriptionTypeAdditional information
ACSystemIdglobally unique identifierRequired

Body Parameters​

None.

Response Information​

Resource Description​

Collection of VendorViewModel

NameDescriptionTypeAdditional information
VendorIdRepresents the PK of the Vendorglobally unique identifierNone.
NameRepresents the name of the VendorstringNone.
ACSystemIdRepresents the PK of the Access Control System for the Vendorglobally unique identifierNone.
ACSystemNameRepresents the name of the Access Control System for the VendorstringNone.
OccupancyIdRepresents the PK of the Occupancy the Vendor performs work for (if applicable)globally unique identifierNone.
OccupancyNameRepresents the name of the Occupancy the Vendor performs work for (if applicable)stringNone.
CompanyIdRepresents the PK of the global company that the Vendor is an instance of.globally unique identifierNone.
CompanyNameRepresents the name of the global company that the Vendor is an instance of.stringNone.
StreetAddress1Represents the primary street address of the VendorstringNone.
StreetAddress2Represents the secondary street address of the VendorstringNone.
CityRepresents the city of the VendorstringNone.
RegionIdRepresents the PK of the region (State, Province, County, etc) of the Vendorglobally unique identifierNone.
RegionNameRepresents the name of the region (State, Province, County, etc) of the VendorstringNone.
CountryIdRepresents the PK of the country of the Vendorglobally unique identifierNone.
CountryNameRepresents the name of the country of the VendorstringNone.
PostalCodeRepresents the Postal Code/Zip Code of the VendorstringNone.
PhoneRepresents the primary phone number of the VendorstringNone.
VendorNumberRepresents the vendor number used to refer to the vendor (typically from an accounting package)stringNone.
TimeZoneInfoIdRepresents the TimeZone of the FacilitystringNone.
DeletedRepresents the deleted status of the VendorbooleanNone.

Response Formats​

JSON​

\\\\[ { "VendorId": "5a967b7e-999d-41fb-99c2-f69c4f2fda5e", "Name": "sample string 2", "ACSystemId": "37409d01-c46f-4bf9-9e45-7ef3524c4a24", "ACSystemName": "sample string 4", "OccupancyId": "30540d15-d177-45d6-bdd9-b23e8160a652", "OccupancyName": "sample string 5", "CompanyId": "d890a472-89c7-42de-b7e3-1ca22218f893", "CompanyName": "sample string 7", "StreetAddress1": "sample string 8", "StreetAddress2": "sample string 9", "City": "sample string 10", "RegionId": "901edae1-7993-4900-a030-f429c051d493", "RegionName": "sample string 12", "CountryId": "c3783693-f574-49f5-a5f0-9b4879eac127", "CountryName": "sample string 14", "PostalCode": "sample string 15", "Phone": "sample string 16", "VendorNumber": "sample string 17", "TimeZoneInfoId": "sample string 18", "Deleted": true }, { "VendorId": "5a967b7e-999d-41fb-99c2-f69c4f2fda5e", "Name": "sample string 2", "ACSystemId": "37409d01-c46f-4bf9-9e45-7ef3524c4a24", "ACSystemName": "sample string 4", "OccupancyId": "30540d15-d177-45d6-bdd9-b23e8160a652", "OccupancyName": "sample string 5", "CompanyId": "d890a472-89c7-42de-b7e3-1ca22218f893", "CompanyName": "sample string 7", "StreetAddress1": "sample string 8", "StreetAddress2": "sample string 9", "City": "sample string 10", "RegionId": "901edae1-7993-4900-a030-f429c051d493", "RegionName": "sample string 12", "CountryId": "c3783693-f574-49f5-a5f0-9b4879eac127", "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>37409d01-c46f-4bf9-9e45-7ef3524c4a24</ACSystemId>
 <ACSystemName>sample string 4</ACSystemName>
 <City>sample string 10</City>
 <CompanyId>d890a472-89c7-42de-b7e3-1ca22218f893</CompanyId>
 <CompanyName>sample string 7</CompanyName>
 <CountryId>c3783693-f574-49f5-a5f0-9b4879eac127</CountryId>
 <CountryName>sample string 14</CountryName>
 <Deleted>true</Deleted>
 `<Name>`sample string 2</Name>
 <OccupancyId>30540d15-d177-45d6-bdd9-b23e8160a652</OccupancyId>
 <OccupancyName>sample string 5</OccupancyName>
 <Phone>sample string 16</Phone>
 <PostalCode>sample string 15</PostalCode>
 <RegionId>901edae1-7993-4900-a030-f429c051d493</RegionId>
 <RegionName>sample string 12</RegionName>
 <StreetAddress1>sample string 8</StreetAddress1>
 <StreetAddress2>sample string 9</StreetAddress2>
 <TimeZoneInfoId>sample string 18</TimeZoneInfoId>
 <VendorId>5a967b7e-999d-41fb-99c2-f69c4f2fda5e</VendorId>
 <VendorNumber>sample string 17</VendorNumber>
 </VendorViewModel>
 <VendorViewModel>
 <ACSystemId>37409d01-c46f-4bf9-9e45-7ef3524c4a24</ACSystemId>
 <ACSystemName>sample string 4</ACSystemName>
 <City>sample string 10</City>
 <CompanyId>d890a472-89c7-42de-b7e3-1ca22218f893</CompanyId>
 <CompanyName>sample string 7</CompanyName>
 <CountryId>c3783693-f574-49f5-a5f0-9b4879eac127</CountryId>
 <CountryName>sample string 14</CountryName>
 <Deleted>true</Deleted>
 `<Name>`sample string 2</Name>
 <OccupancyId>30540d15-d177-45d6-bdd9-b23e8160a652</OccupancyId>
 <OccupancyName>sample string 5</OccupancyName>
 <Phone>sample string 16</Phone>
 <PostalCode>sample string 15</PostalCode>
 <RegionId>901edae1-7993-4900-a030-f429c051d493</RegionId>
 <RegionName>sample string 12</RegionName>
 <StreetAddress1>sample string 8</StreetAddress1>
 <StreetAddress2>sample string 9</StreetAddress2>
 <TimeZoneInfoId>sample string 18</TimeZoneInfoId>
 <VendorId>5a967b7e-999d-41fb-99c2-f69c4f2fda5e</VendorId>
 <VendorNumber>sample string 17</VendorNumber>
 </VendorViewModel>
</ArrayOfVendorViewModel>