UpdateVendor

Overview

Updates a single Vendor that is already in the system. Returns Success/Error code.

Request Information

Method

POST - api/Vendor/UpdateVendor

URI Parameters

None.

Body Parameters

AddUpdateVendorViewModel

Name	Description	Type	Additional information
VendorId	Conditional: Represents the PK of the Vendor. Only populated when calling an Update method.	globally unique identifier	None.
Name	Required: Represents the name of the Vendor. Max Length = 50	string	None.
ACSystemId	Required: Represents the PK of the Access Control System that the Vendor belongs to.	globally unique identifier	None.
OccupancyId	Optional: Represents the PK of the Occupancy the Vendor performs work for (if applicable)	globally unique identifier	None.
CompanyId	Required: Represents the PK of the global company that the Vendor is an instance of.	globally unique identifier	None.
StreetAddress1	Required: Represents the primary street address of the Vendor	string	None.
StreetAddress2	Optional: Represents the secondary street address of the Vendor	string	None.
City	Required:Represents the city of the Vendor	string	None.
RegionId	Required:Represents the PK of the region (State, Province, County, etc) of the Vendor	globally unique identifier	None.
CountryId	Required:Represents the PK of the country of the Vendor	globally unique identifier	None.
PostalCode	Required: Represents the Postal Code/Zip Code of the Vendor	string	None.
Phone	Optional: Represents the primary phone number of the Vendor	string	None.
VendorNumber	Optional: Represents the vendor number used to refer to the vendor (typically from an accounting package)	string	None.
TimeZoneInfoId	Required: Represents the TimeZone of the Facility	string	None.
Deleted	Represents the deleted status of the Vendor	boolean	None.

JSON

01{
02  "VendorId": "67d18f23-fc72-482e-a270-e2fd3b9ac819",
03  "Name": "sample string 1",
04  "ACSystemId": "d0b50ddc-4a66-4b3b-afd8-06ef4c0f90fb",
05  "OccupancyId": "3bda463e-69f2-4be5-9c2c-6657c4d5c1a2",
06  "CompanyId": "f5dfd13a-265e-4b84-9c46-a4182789af09",
07  "StreetAddress1": "sample string 4",
08  "StreetAddress2": "sample string 5",
09  "City": "sample string 6",
10  "RegionId": "149b0f62-b590-40bf-9f2e-e98c42527a43",
11  "CountryId": "44a8cf10-a64e-4f77-b5c2-82baf6cbf97d",
12  "PostalCode": "sample string 9",
13  "Phone": "sample string 10",
14  "VendorNumber": "sample string 11",
15  "TimeZoneInfoId": "sample string 12",
16  "Deleted": true
17}

XML

01<AddUpdateVendorViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BluSKYWebAPI.Controllers">
02  <ACSystemId>d0b50ddc-4a66-4b3b-afd8-06ef4c0f90fb</ACSystemId>
03  <City>sample string 6</City>
04  <CompanyId>f5dfd13a-265e-4b84-9c46-a4182789af09</CompanyId>
05  <CountryId>44a8cf10-a64e-4f77-b5c2-82baf6cbf97d</CountryId>
06  <Deleted>true</Deleted>
07  <Name>sample string 1</Name>
08  <OccupancyId>3bda463e-69f2-4be5-9c2c-6657c4d5c1a2</OccupancyId>
09  <Phone>sample string 10</Phone>
10  <PostalCode>sample string 9</PostalCode>
11  <RegionId>149b0f62-b590-40bf-9f2e-e98c42527a43</RegionId>
12  <StreetAddress1>sample string 4</StreetAddress1>
13  <StreetAddress2>sample string 5</StreetAddress2>
14  <TimeZoneInfoId>sample string 12</TimeZoneInfoId>
15  <VendorId>67d18f23-fc72-482e-a270-e2fd3b9ac819</VendorId>
16  <VendorNumber>sample string 11</VendorNumber>
17</AddUpdateVendorViewModel>

Response Information

Resource Description

Result

Name	Description	Type	Additional information
ResultCode	Represents the result code	integer	None.
Description	Represents a description of the result code	string	None.

Response Formats

JSON

1{
2  "ResultCode": 1,
3  "Description": "sample string 2"
4}

XML

1<Result xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BluSKYWebAPI.Controllers">
2  <Description>sample string 2</Description>
3  <ResultCode>1</ResultCode>
4</Result>