Business Hours APIs
These APIs allow an admin user to configure business hours in Applications Manager. Business hours is a pre-determined set of hours which helps you to view reports for the particular hours during the day. Business hours APIs are designed to support GET and POST requests:
Supported HTTP methods: GET, POST
Allowed roles: Administrator
Request Parameters
The parameters involved in executing this API request are:
| Field | Description |
|---|
| mondaystarthour, tuesdaystarthour, wednesdaystarthour, thursdaystarthour, fridaystarthour, saturdaystarthour, sundaystarthour | The hour of the day at which business begins. |
| mondayendhour, tuesdayendhour, wednesdayendhour, thursdayendhour, fridayendhour, saturdayendhour, sundayendhour | The hour of the day at which business ends. |
| mondaystartminute, tuesdaystartminute, wednesdaystartminute, thursdaystartminute, fridaystartminute, saturdaystartminute, sundaystartminute | The minute of the day at which business begins. |
| mondayendminute, tuesdayendminute, wednesdayendminute, thursdayendminute, fridayendminute, saturdayendminute, sundayendminute | The minute of the day at which business ends. |
| workingdays - (Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday) | Working days of the week. |
Add Business Hour
This API allows an admin user to add business hours in Applications Manager.
Syntax
For XML Response:
https://[HOST]:[PORT]/AppManager/xml/businesshours?apikey=[ API Key ]&mondayendhour=[ Monday End Hour]&wednesdayendminute=[ Wednesday End Minute]&thursdaystarthour=[ Thursday Start Hour]&description=[Description]&name=[Name]&tuesdaystartminute=[Tuesday Start Minute]&mondaystarthour=[ Monday Start Hour]&fridaystartminute=[Friday Start Minute]&workingdays=[Working days like Monday,Tuesday,Wednesday,Thursday,Friday]&mondayendminute=[ Monday End Minute]&fridayendminute=[ Friday End Minute]&tuesdaystarthour=[ Tuesday End Hour]
For JSON Response:
https://[HOST]:[PORT]/AppManager/json/businesshours?apikey=[ API Key ]&mondayendhour=[ Monday End Hour]&wednesdayendminute=[ Wednesday End Minute]&thursdaystarthour=[ Thursday Start Hour]&description=[Description]&name=[Name]&tuesdaystartminute=[Tuesday Start Minute]&mondaystarthour=[ Monday Start Hour]&fridaystartminute=[Friday Start Minute]&workingdays=[Working days like Monday,Tuesday,Wednesday,Thursday,Friday]&mondayendminute=[ Monday End Minute]&fridayendminute=[ Friday End Minute]&tuesdaystarthour=[ Tuesday End Hour]
Sample Request
https://apm-prod-server:8443/AppManager/xml/businesshours?apikey=aaaaaabbbbbbccccccddddddeeeeee&mondayendhour=20&wednesdayendminute=0&saturdayendhour=00&thursdayendhour=20&saturdaystarthour=00&sundaystartminute=0&sundayendminute=0&mondaystartminute=0&thursdaystarthour=08&saturdayendminute=0&fridayendhour=20&description=sample description&name=Test Business Hour&tuesdaystartminute=0&mondaystarthour=08&fridaystartminute=0&sundayendhour=00&tuesdayendminute=0&fridaystarthour=08&thursdaystartminute=0&wednesdaystarthour=08&saturdaystartminute=0&sundaystarthour=00&wednesdayendhour=20&wednesdaystartminute=0&thursdayendminute=0&tuesdayendhour=20&workingdays=Monday,Tuesday,Wednesday,Thursday,Friday&mondayendminute=0&fridayendminute=0&tuesdaystarthour=08
Edit Business Hour
This API allows an admin user to edit the business hours added in Applications Manager.
Syntax
https://[HOST]:[PORT]/AppManager/xml/businesshours?apikey=[ API Key ]&mondayendhour=[ Monday End Hour]&wednesdayendminute=[ Wednesday End Minute]&thursdaystarthour=[ Thursday Start Hour]&description=[Description]&newbusinessname=[Name]&tuesdaystartminute=[Tuesday Start Minute]&mondaystarthour=[ Monday Start Hour]&fridaystartminute=[Friday Start Minute]&workingdays=[Working days like Monday,Tuesday,Wednesday,Thursday,Friday]&businessid=[Business Id]&mondayendminute=[ Monday End Minute]&fridayendminute=[ Friday End Minute]&tuesdaystarthour=[ Tuesday End Hour]
For JSON Response:
https://[HOST]:[PORT]/AppManager/json/businesshours?apikey=[ API Key ]&mondayendhour=[ Monday End Hour]&wednesdayendminute=[ Wednesday End Minute]&thursdaystarthour=[ Thursday Start Hour]&description=[Description]&newbusinessname=[Name]&tuesdaystartminute=[Tuesday Start Minute]&mondaystarthour=[ Monday Start Hour]&fridaystartminute=[Friday Start Minute]&workingdays=[Working days like Monday,Tuesday,Wednesday,Thursday,Friday]&businessid=[Business Id]&mondayendminute=[ Monday End Minute]&fridayendminute=[ Friday End Minute]&tuesdaystarthour=[ Tuesday End Hour]
Sample Request
https://apm-prod-server:8443/AppManager/xml/businesshours?apikey=aaaaaabbbbbbccccccddddddeeeeee&mondayendhour=20&wednesdayendminute=0&saturdayendhour=00&thursdayendhour=20&saturdaystarthour=00&sundaystartminute=0&sundayendminute=0&mondaystartminute=0&thursdaystarthour=08&saturdayendminute=0&fridayendhour=18&newbusinessname=Test Business Hour&description=sample description new description&tuesdaystartminute=0&mondaystarthour=08&fridaystartminute=0&sundayendhour=00&tuesdayendminute=0&fridaystarthour=15&thursdaystartminute=0&wednesdaystarthour=08&saturdaystartminute=0&sundaystarthour=00&wednesdayendhour=20&businessid=10000&wednesdaystartminute=0&thursdayendminute=0&tuesdayendhour=20&workingdays=Friday&mondayendminute=0&fridayendminute=0&tuesdaystarthour=08
Delete Business Hour
This API allows an admin user to delete business hours in Applications Manager.
Syntax
For XML Response:
https://[HOST]:[PORT]/AppManager/xml/businesshours?apikey=[ API Key ]&businessid=[Business Id],&TO_DELETE=true
For JSON Response:
https://[HOST]:[PORT]/AppManager/json/businesshours?apikey=[ API Key ]&businessid=[Business Id],&TO_DELETE=true
Sample Request
https://apm-prod-server:8443/AppManager/xml/businesshours?apikey=aaaaaabbbbbbccccccddddddeeeeee&businessid=10001,&TO_DELETE=true
List Business Hour
This API allows an admin user to list down the business hours in Applications Manager.
Syntax
For XML Response:
https://[HOST]:[PORT]/AppManager/xml/businesshours?apikey=[ API Key ]
For JSON Response:
https://[HOST]:[PORT]/AppManager/json/businesshours?apikey=[ API Key ]
Sample Request
https://apm-prod-server:8443/AppManager/xml/businesshours?apikey=aaaaaabbbbbbccccccddddddeeeeee
