Description
This service, is optional. You do not have to use this service.
This service should be used if you would like to set the working hours of stations/locations.
Input
- apiKey: In order to obtain your API KEY, first log into logvrp web application and click "Manage API Key" button.
- computationTicketID: You will get this using Ticket service.
- locationWorkingHours: Array of "LocationWeeklyWorkingHours" where "LocationWeeklyWorkingHours" is defined as follows:
- LocationId: String. The Id of the station/location that this working hours to be set. This location id must exist in the stations list provided in the "Stations" service.
- WeeklyWorkingHours: Array of "WeeklyWorkingHours" where "WeeklyWorkingHours" is defined as follows:
- WeekDay: Integer starting from 1 as Monday, to 7 as Sunday. That is, 1:Monday, 2: Tuesday, 3: Wednesday, 4: Thursday, 5: Friday, 6: Saturday, 7: Sunday
- WorkingHours: Object for defining working hours of this location.
- Start: Starting hour of work. A string with the format "hh:mm". For example: "08:00".
- End: Ending hour of work. A string with the format "hh:mm". For example: "17:00".
- BreakHours: Object for defining allowed break hours of this location.
- Start: Starting hour of break. A string with the format "hh:mm". For example: "08:00".
- End: Ending hour of break. A string with the format "hh:mm". For example: "17:00".
- BreakDuration: Integer. Defines the duration of breaks in minutes
Output
Data: Returned data
Message: Output message
ReturnCode: Return code of the output. If "Success" is true, then check this value.
Success: If unpected errors, or exceptions occur, this will be false.
success: Same as Success
REST - JSON
URL
Input
{ "apiKey": "your API key here", "computationTicketID": "your computation ticket here", "locationWorkingHours": [ { LocationId: "1", WeeklyWorkingHours: [ { WeekDay: 1, WorkingHours: { Start: "08:00", End: "17:00" }, BreakHours: { Start: "12:00", End: "13:00" }, BreakDuration: 30 }, { WeekDay: 2, WorkingHours: { Start: "08:00", End: "17:00" }, BreakHours: { Start: "12:00", End: "13:00" }, BreakDuration: 30 }, { WeekDay: 3, WorkingHours: { Start: "08:00", End: "17:00" }, BreakHours: { Start: "12:00", End: "13:00" }, BreakDuration: 30 }, { WeekDay: 4, WorkingHours: { Start: "08:00", End: "17:00" }, BreakHours: { Start: "12:00", End: "13:00" }, BreakDuration: 30 }, { WeekDay: 5, WorkingHours: { Start: "08:00", End: "17:00" }, BreakHours: { Start: "12:00", End: "13:00" }, BreakDuration: 30 } ] } ] } |
Content-Type: application/json |
Output
{ "Data" : null , "Message" : null , "ReturnCode" : 0, "Success" : true , "success" : true } |
0 Comments