Group Night Forwarding

Retrieve configuration

GET /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/users/(string: user_id)/services/night_forwarding/

Get the details about the user’s group night forwarding service.

Example request:

GET /api/v1/tenants/foo/groups/foogroup/users/foouser/services/night_forwarding/ HTTP/1.1
Host: example.com

Example response:

HTTP/1.1 200 OK
Content-Type: "application/json"

{
   "nightForwarding": "Off",
   "groupNightForwarding": "Off"
}

Response JSON Object:

• nightForwarding (string) – See nightForwarding from User Group Night Forwarding.

• groupNightForwarding (string) – See nightForwarding from User Group Night Forwarding.

• businessHours (object) – See businessHours from User Group Night Forwarding.

• holidaySchedule (object) – See holidaySchedule from User Group Night Forwarding.

Status Codes:

• 200 OK – no error.

Update configuration

PUT /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/users/(string: user_id)/services/night_forwarding/

Update the details about the user’s group night forwarding service.

Example request:

PUT /api/v1/tenants/foo/groups/foogroup/users/foouser/services/night_forwarding/ HTTP/1.1
Host: example.com
Content-Type: "application/json"

{
   "nightForwarding": "On"
}

Request JSON Object:

• nightForwarding (string) – See nightForwarding from User Group Night Forwarding.

Example response:

Response:

Similar to GET method response.

Status Codes:

• 200 OK – no error.

• 400 Bad Request – failed to update.

User Group Night Forwarding

Name	Type	Methods		Description
		GET	PUT
nightForwarding	String	A	O	Choices for the User Group Night Forwarding Service Activation. Allowed values are: “Off”, “On”, “Use Group”
groupNightForwarding	String	A	F	See nightForwarding from Attributes Description
businessHours	Object/String	C	F	See Schedule attributes. Empty string to revert to default value.
holidaySchedule	Object/String	C	F	See Schedule attributes. Empty string to revert to default value.