GetAllVendors
Overview
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
01 | [ |
02 | { |
03 | "VendorId" : "978e1cc5-91f9-4e25-9450-6c90504d828f" , |
04 | "Name" : "sample string 2" , |
05 | "ACSystemId" : "6d7bcb3d-a25c-4fac-a1c1-325fb22e66e6" , |
06 | "ACSystemName" : "sample string 4" , |
07 | "OccupancyId" : "e42ad384-6478-4028-b512-65d116108330" , |
08 | "OccupancyName" : "sample string 5" , |
09 | "CompanyId" : "164684c8-5c9f-45d0-a202-55eb3b8a1a40" , |
10 | "CompanyName" : "sample string 7" , |
11 | "StreetAddress1" : "sample string 8" , |
12 | "StreetAddress2" : "sample string 9" , |
13 | "City" : "sample string 10" , |
14 | "RegionId" : "cd8c41d2-be11-4c2d-8202-ea1716acdbc8" , |
15 | "RegionName" : "sample string 12" , |
16 | "CountryId" : "1b52ca8c-dd15-4010-b0eb-d88d5e6a8eac" , |
17 | "CountryName" : "sample string 14" , |
18 | "PostalCode" : "sample string 15" , |
19 | "Phone" : "sample string 16" , |
20 | "VendorNumber" : "sample string 17" , |
21 | "TimeZoneInfoId" : "sample string 18" , |
22 | "Deleted" : true |
23 | }, |
24 | { |
25 | "VendorId" : "978e1cc5-91f9-4e25-9450-6c90504d828f" , |
26 | "Name" : "sample string 2" , |
27 | "ACSystemId" : "6d7bcb3d-a25c-4fac-a1c1-325fb22e66e6" , |
28 | "ACSystemName" : "sample string 4" , |
29 | "OccupancyId" : "e42ad384-6478-4028-b512-65d116108330" , |
30 | "OccupancyName" : "sample string 5" , |
31 | "CompanyId" : "164684c8-5c9f-45d0-a202-55eb3b8a1a40" , |
32 | "CompanyName" : "sample string 7" , |
33 | "StreetAddress1" : "sample string 8" , |
34 | "StreetAddress2" : "sample string 9" , |
35 | "City" : "sample string 10" , |
36 | "RegionId" : "cd8c41d2-be11-4c2d-8202-ea1716acdbc8" , |
37 | "RegionName" : "sample string 12" , |
38 | "CountryId" : "1b52ca8c-dd15-4010-b0eb-d88d5e6a8eac" , |
39 | "CountryName" : "sample string 14" , |
40 | "PostalCode" : "sample string 15" , |
41 | "Phone" : "sample string 16" , |
42 | "VendorNumber" : "sample string 17" , |
43 | "TimeZoneInfoId" : "sample string 18" , |
44 | "Deleted" : true |
45 | } |
46 | ] |
XML
01 | < ArrayOfVendorViewModel xmlns:i = "http://www.w3.org/2001/XMLSchema-instance" xmlns = "http://schemas.datacontract.org/2004/07/BluSKYWebAPI.Controllers" > |
02 | < VendorViewModel > |
03 | < ACSystemId >6d7bcb3d-a25c-4fac-a1c1-325fb22e66e6</ ACSystemId > |
04 | < ACSystemName >sample string 4</ ACSystemName > |
05 | < City >sample string 10</ City > |
06 | < CompanyId >164684c8-5c9f-45d0-a202-55eb3b8a1a40</ CompanyId > |
07 | < CompanyName >sample string 7</ CompanyName > |
08 | < CountryId >1b52ca8c-dd15-4010-b0eb-d88d5e6a8eac</ CountryId > |
09 | < CountryName >sample string 14</ CountryName > |
10 | < Deleted >true</ Deleted > |
11 | < Name >sample string 2</ Name > |
12 | < OccupancyId >e42ad384-6478-4028-b512-65d116108330</ OccupancyId > |
13 | < OccupancyName >sample string 5</ OccupancyName > |
14 | < Phone >sample string 16</ Phone > |
15 | < PostalCode >sample string 15</ PostalCode > |
16 | < RegionId >cd8c41d2-be11-4c2d-8202-ea1716acdbc8</ RegionId > |
17 | < RegionName >sample string 12</ RegionName > |
18 | < StreetAddress1 >sample string 8</ StreetAddress1 > |
19 | < StreetAddress2 >sample string 9</ StreetAddress2 > |
20 | < TimeZoneInfoId >sample string 18</ TimeZoneInfoId > |
21 | < VendorId >978e1cc5-91f9-4e25-9450-6c90504d828f</ VendorId > |
22 | < VendorNumber >sample string 17</ VendorNumber > |
23 | </ VendorViewModel > |
24 | < VendorViewModel > |
25 | < ACSystemId >6d7bcb3d-a25c-4fac-a1c1-325fb22e66e6</ ACSystemId > |
26 | < ACSystemName >sample string 4</ ACSystemName > |
27 | < City >sample string 10</ City > |
28 | < CompanyId >164684c8-5c9f-45d0-a202-55eb3b8a1a40</ CompanyId > |
29 | < CompanyName >sample string 7</ CompanyName > |
30 | < CountryId >1b52ca8c-dd15-4010-b0eb-d88d5e6a8eac</ CountryId > |
31 | < CountryName >sample string 14</ CountryName > |
32 | < Deleted >true</ Deleted > |
33 | < Name >sample string 2</ Name > |
34 | < OccupancyId >e42ad384-6478-4028-b512-65d116108330</ OccupancyId > |
35 | < OccupancyName >sample string 5</ OccupancyName > |
36 | < Phone >sample string 16</ Phone > |
37 | < PostalCode >sample string 15</ PostalCode > |
38 | < RegionId >cd8c41d2-be11-4c2d-8202-ea1716acdbc8</ RegionId > |
39 | < RegionName >sample string 12</ RegionName > |
40 | < StreetAddress1 >sample string 8</ StreetAddress1 > |
41 | < StreetAddress2 >sample string 9</ StreetAddress2 > |
42 | < TimeZoneInfoId >sample string 18</ TimeZoneInfoId > |
43 | < VendorId >978e1cc5-91f9-4e25-9450-6c90504d828f</ VendorId > |
44 | < VendorNumber >sample string 17</ VendorNumber > |
45 | </ VendorViewModel > |
46 | </ ArrayOfVendorViewModel > |