Business Hour Status Reason API

Use this API to list the currently defined business hour status reasons, define new status reasons, and view, edit, and delete the existing status reasons.

URL

https://<server>/unifiedconfig/config/businesshourstatusreason

Operations

  • create: Creates one business hour status reason.

  • get: Returns one business hour status reason using the URL https://<server>/unifiedconfig/config/businesshourstatusreason/<id>

  • list: Retrieves a list of business hour status reasons.

  • update: Updates one business hour status reason.

  • delete: Permanently deletes one business hour status reason.

Parameters

  • category: Optional. The category of the reason codes: User-defined or System-defined.

  • reasonCode: Required. The unique status reason code for business hour. Range is 1001 to 65535.

    Note

    Codes 1 to 1000 are reserved as system defined reason codes. The System-defined reason codes cannot be deleted.

  • reasonText: Optional. The reason for the business schedule. Maximum of 255 characters.

Example Create Request

Code Snippet
Copy<businessHourStatusReason>
 <category>User-defined</category>
<reasonCode>1234</reasonCode>
<reasonText>Emergency</reasonText>
</businessHourStatusReason>

Example Get Response

Code Snippet
Copy<businessHourStatusReason>
 <refURL>/unifiedconfig/config/businesshourstatusreason/5000</refURL>
 <changeStamp>0</changeStamp>
 <category>User-defined</category>
 <reasonCode>2550</reasonCode>
 <reasonText>Open</reasonText>
 </businessHourStatusReason>