LocationWorkingHours - v1

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

  1. apiKey: In order to obtain your API KEY, first log into logvrp web application and click "Manage API Key" button.
  2. computationTicketID: You will get this using Ticket service.
  3. locationWorkingHours: Array of "LocationWeeklyWorkingHours" where "LocationWeeklyWorkingHours" is defined as follows:
    1. 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.
    2. WeeklyWorkingHours: Array of "WeeklyWorkingHours" where "WeeklyWorkingHours" is defined as follows:
      1. 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
      2. WorkingHours: Object for defining working hours of this location.
        1. Start: Starting hour of work. A string with the format "hh:mm". For example: "08:00".
        2. End: Ending hour of work. A string with the format "hh:mm". For example: "17:00".
      3. BreakHours: Object for defining allowed break hours of this location.
        1. Start: Starting hour of break. A string with the format "hh:mm". For example: "08:00".
        2. End: Ending hour of break. A string with the format "hh:mm". For example: "17:00".
      4. 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
Body

{

  "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

        }

      ]

    }

  ]

}

 
Headers
 
Content-Type: application/json
 
Method:
 
POST 
 
Output
Response
{
  "Data": null,
  "Message": null,
  "ReturnCode": 0,
  "Success": true,
  "success": true
}

 

Have more questions? Submit a request

0 Comments

Article is closed for comments.
Powered by Zendesk