GET api/v1/Vendors?VendorId={VendorId}
Returns a single VendorViewModel if the API token has rights to view it
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
VendorId | globally unique identifier |
Required |
Body Parameters
None.
Response Information
Resource Description
VendorViewModelName | 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
{ "VendorId": "aee0a7e5-db63-484d-b795-41a0dcf04389", "Name": "sample string 2", "ACSystemId": "f058ca15-2a61-4403-879d-8427feaccaf7", "ACSystemName": "sample string 3", "OccupancyId": "1f24fc7c-ff5d-4e07-a509-dace17683cd5", "OccupancyName": "sample string 4", "CompanyId": "b86bb99b-443d-4573-a476-7af97242f1a9", "CompanyName": "sample string 6", "StreetAddress1": "sample string 7", "StreetAddress2": "sample string 8", "City": "sample string 9", "RegionId": "81d5baad-be6f-4af9-91fa-eae03ba1d600", "RegionName": "sample string 11", "CountryId": "3cc4108f-daf6-4f75-a742-429fbdd02983", "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
<VendorViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/APIWebRole.Controllers"> <ACSystemId>f058ca15-2a61-4403-879d-8427feaccaf7</ACSystemId> <ACSystemName>sample string 3</ACSystemName> <City>sample string 9</City> <CompanyId>b86bb99b-443d-4573-a476-7af97242f1a9</CompanyId> <CompanyName>sample string 6</CompanyName> <CountryId>3cc4108f-daf6-4f75-a742-429fbdd02983</CountryId> <CountryName>sample string 13</CountryName> <Deleted>true</Deleted> <Name>sample string 2</Name> <OccupancyId>1f24fc7c-ff5d-4e07-a509-dace17683cd5</OccupancyId> <OccupancyName>sample string 4</OccupancyName> <Phone>sample string 15</Phone> <PostalCode>sample string 14</PostalCode> <RegionId>81d5baad-be6f-4af9-91fa-eae03ba1d600</RegionId> <RegionName>sample string 11</RegionName> <StreetAddress1>sample string 7</StreetAddress1> <StreetAddress2>sample string 8</StreetAddress2> <TimeZoneInfoId>sample string 17</TimeZoneInfoId> <VendorId>aee0a7e5-db63-484d-b795-41a0dcf04389</VendorId> <VendorNumber>sample string 16</VendorNumber> </VendorViewModel>