Offices

Deletes an existing office, scoped by the company/business unit of the current user

Deletes the office and dissociate it from a vendor

Securitybearer
Request
path Parameters
officeId
required
string <uuid>

The office's guid

header Parameters
BusinessUnitId
string

The business unit's guid

Responses
204

No Content

400

Bad Request. See https://developer.hcssapps.com/getting-started/troubleshoot-bad-request for more information.

401

Unauthorized. See https://developer.hcssapps.com/getting-started/troubleshoot-unauthorized for more information.

403

Forbidden. See https://developer.hcssapps.com/getting-started/troubleshoot-forbidden for more information.

delete/api/v1/offices/{officeId}
Request samples 
Returns an office with the provided id, scoped by the company/business unit of the current user
Securitybearer 
Request 
path Parameters
officeId
required
string <uuid> 
The office's guid


 
header Parameters
BusinessUnitId
string
The business unit's guid


 
Responses 
get/api/v1/offices/{officeId}
Request samples 
Response samples 
application/json
{
  • "vendorId": "4b1cf9a0-bbc9-4afa-b18d-c75744fed885",
  • "id": "204060a1-ef8e-42e8-9fb9-8c9461949eb9",
  • "address": {
    },
  • "phoneNumber": "800-277-2828",
  • "faxNumber": "800-278-2727",
  • "webAddress": "contact@petersons-construction.com",
  • "region": {
    },
  • "nickname": "Main Office",
  • "isQualified": true,
  • "isBlacklisted": false,
  • "communicationMethod": "Email",
  • "isPrimary": true,
  • "isAlternate": false
}
Updates an existing office, scoped by the company/business unit of the current user
Securitybearer 
Request 
path Parameters
officeId
required
string <uuid> 
The office's guid


 
header Parameters
BusinessUnitId
string
The business unit's guid


 
Request Body schema: application/json
The office


vendorId
required
string <uuid> 
The vendor's unique id.


 
id
required
string <uuid> 
The locations's unique id.


 
object (Address) 
 
phoneNumber
string or null
The vendor location's phonenumber.


 
faxNumber
string or null
The vendor location's faxnumber.


 
webAddress
string or null
The vendor location's website address.


 
regionId
string or null <uuid> 
The unique identifier of the region the vendor location operates in.


 
nickname
string or null
The nickname for a vendor location.


 
isQualified
boolean
A flag if a vendor location is qualified.


 
isBlacklisted
boolean
A flag if a vendor location is blacklisted.


 
communicationMethod
string (CommunicationMethod) 
 Enum: "None" "Email" "Fax" "Print"  
Responses 
put/api/v1/offices/{officeId}
Request samples 
application/json
{
  • "vendorId": "db53bb75-7403-4019-b042-343bb79a75a3",
  • "id": "a5a2a420-75ae-4330-b571-a443ce4e6695",
  • "address": {
    },
  • "phoneNumber": "800-277-2828",
  • "faxNumber": "800-278-2727",
  • "webAddress": "contact@petersons-construction.com",
  • "regionId": "e392849d-d1c0-4bdc-ab63-59567faebcd1",
  • "nickname": "Main Office",
  • "isQualified": true,
  • "isBlacklisted": false,
  • "communicationMethod": "Email"
}
Returns a list of all offices of a vendor, scoped by the company/business unit of the current user
Securitybearer 
Request 
query Parameters
vendorId
required
string <uuid> 
The vendor's guid


 
header Parameters
BusinessUnitId
string
The business unit's guid


 
Responses 
get/api/v1/offices
Request samples 
Response samples 
application/json
[
  • {
    }
]
Creates a new office, scoped by the company/business unit of the current user
Securitybearer 
Request 
header Parameters
BusinessUnitId
string
The business unit's guid


 
Request Body schema: 
The office


vendorId
required
string <uuid> 
The vendor's unique id.


 
object (Address) 
 
phoneNumber
string or null
The vendor location's phonenumber.


 
faxNumber
string or null
The vendor location's faxnumber.


 
webAddress
string or null
The vendor location's website address.


 
regionId
string or null <uuid> 
The unique identifier of the region the vendor location operates in.


 
nickname
string or null
The nickname for a vendor location.


 
isQualified
boolean
A flag if a vendor location is qualified.


 
isBlacklisted
boolean
A flag if a vendor location is blacklisted.


 
communicationMethod
string (CommunicationMethod) 
 Enum: "None" "Email" "Fax" "Print"  
Responses 
post/api/v1/offices
Request samples 
{
  • "vendorId": "3b5d38a0-73d6-4762-b298-1fa4f8c40ed9",
  • "address": {
    },
  • "phoneNumber": "800-277-2828",
  • "faxNumber": "800-278-2727",
  • "webAddress": "contact@petersons-construction.com",
  • "regionId": "f3f652ed-d048-4a02-be92-984b9207cecf",
  • "nickname": "Main Office",
  • "isQualified": true,
  • "isBlacklisted": false,
  • "communicationMethod": "Email"
}
Response samples 
application/json
"497f6eca-6276-4993-bfeb-53cbbbba6f08"