Day Intervals

Create DayInterval

Creates a new DayInterval

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
interval_Year
required
integer <int32>

Year of the date or interval used in internal date calculations

interval_Month
required
integer <int32>

Month of the date or interval used in internal date calculations

interval_Day
required
integer <int32>

Day of the date or interval used in internal date calculations

day_From_Date
string or null <date-time>

Date and time stamp of the beginning of the specified day

day_Name
string or null <= 12 characters

Full name of the day of the week

day_Short_Name
string or null <= 3 characters

Abbreviated name of the day of the week

day_Thru_Date
string or null <date-time>

Date and time stamp of the end of the specified day

entry_Date
string <date-time>

Date record was first added to the system

entry_User
string or null <= 20 characters

User that first added the record to the system

holiday
required
boolean

Bit indicating if the specified day falls on recognized holiday

month_From_Date
string or null <date-time>

First day of the month containing the date specified

month_Thru_Date
string or null <date-time>

Last day of the month containing the date specified

quarter
integer or null <int32>

Number indicating the quarter containing the date specified

quarter_From_Date
string or null <date-time>

First day of the quarter containing the date specified

quarter_Thru_Date
string or null <date-time>

Last day of the quarter containing the date specified

update_Date
string <date-time>

Date the record was last updated in the system

update_User
string or null <= 20 characters

User that last updated the record in the system

week_Day
integer or null <int32>

Number of the day of the week where Sunday is 1

weekend
boolean or null

Bit indicating if the specified day falls on the weekend

yearMonthDay_Seq
integer or null <int32>

Sequence number used for simple date comparisons

Responses
200

Success

401

Unauthorized

post/day-intervals
Request samples
{
  • "interval_Year": 0,
  • "interval_Month": 0,
  • "interval_Day": 0,
  • "day_From_Date": "2019-08-24T14:15:22Z",
  • "day_Name": "string",
  • "day_Short_Name": "str",
  • "day_Thru_Date": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "holiday": true,
  • "month_From_Date": "2019-08-24T14:15:22Z",
  • "month_Thru_Date": "2019-08-24T14:15:22Z",
  • "quarter": 0,
  • "quarter_From_Date": "2019-08-24T14:15:22Z",
  • "quarter_Thru_Date": "2019-08-24T14:15:22Z",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string",
  • "week_Day": 0,
  • "weekend": true,
  • "yearMonthDay_Seq": 0
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List DayInterval

Lists all DayInterval

SecurityapiKeyAuth and bearerAuth
Request
query Parameters
page
integer <int32>
Default: 1

Page

pageSize
integer <int32>
Default: 100

Page Size

sortBy
string

Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., 'Property1:desc,Property2:asc,Property3:asc' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.

header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/day-intervals
Request samples 
Response samples 
No sample
Get DayInterval
Gets DayInterval


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
intervalYear
required
integer <int32> 
Interval Year


 
intervalMonth
required
integer <int32> 
Interval Month


 
intervalDay
required
integer <int32> 
Interval Day


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/day-intervals/{intervalYear}/{intervalMonth}/{intervalDay}
Request samples 
Response samples 
No sample
Update DayInterval
Updates a specific DayInterval.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
intervalYear
required
integer <int32> 
Interval Year


 
intervalMonth
required
integer <int32> 
Interval Month


 
intervalDay
required
integer <int32> 
Interval Day


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
interval_Year
required
integer <int32> 
Year of the date or interval used in internal date calculations


 
interval_Month
required
integer <int32> 
Month of the date or interval used in internal date calculations


 
interval_Day
required
integer <int32> 
Day of the date or interval used in internal date calculations


 
day_From_Date
string or null <date-time> 
Date and time stamp of the beginning of the specified day


 
day_Name
string or null  <= 12 characters 
Full name of the day of the week


 
day_Short_Name
string or null  <= 3 characters 
Abbreviated name of the day of the week


 
day_Thru_Date
string or null <date-time> 
Date and time stamp of the end of the specified day


 
entry_Date
string <date-time> 
Date record was first added to the system


 
entry_User
string or null  <= 20 characters 
User that first added the record to the system


 
holiday
required
boolean
Bit indicating if the specified day falls on recognized holiday


 
month_From_Date
string or null <date-time> 
First day of the month containing the date specified


 
month_Thru_Date
string or null <date-time> 
Last day of the month containing the date specified


 
quarter
integer or null <int32> 
Number indicating the quarter containing the date specified


 
quarter_From_Date
string or null <date-time> 
First day of the quarter containing the date specified


 
quarter_Thru_Date
string or null <date-time> 
Last day of the quarter containing the date specified


 
update_Date
string <date-time> 
Date the record was last updated in the system


 
update_User
string or null  <= 20 characters 
User that last updated the record in the system


 
week_Day
integer or null <int32> 
Number of the day of the week where Sunday is 1


 
weekend
boolean or null
Bit indicating if the specified day falls on the weekend


 
yearMonthDay_Seq
integer or null <int32> 
Sequence number used for simple date comparisons


 
Responses 
200
Success


401
Unauthorized


put/day-intervals/{intervalYear}/{intervalMonth}/{intervalDay}
Request samples 
{
  • "interval_Year": 0,
  • "interval_Month": 0,
  • "interval_Day": 0,
  • "day_From_Date": "2019-08-24T14:15:22Z",
  • "day_Name": "string",
  • "day_Short_Name": "str",
  • "day_Thru_Date": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "holiday": true,
  • "month_From_Date": "2019-08-24T14:15:22Z",
  • "month_Thru_Date": "2019-08-24T14:15:22Z",
  • "quarter": 0,
  • "quarter_From_Date": "2019-08-24T14:15:22Z",
  • "quarter_Thru_Date": "2019-08-24T14:15:22Z",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string",
  • "week_Day": 0,
  • "weekend": true,
  • "yearMonthDay_Seq": 0
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete DayInterval
Deletes an DayInterval


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
intervalYear
required
integer <int32> 
Interval Year


 
intervalMonth
required
integer <int32> 
Interval Month


 
intervalDay
required
integer <int32> 
Interval Day


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/day-intervals/{intervalYear}/{intervalMonth}/{intervalDay}
Request samples 
Create or Update Batch DayInterval
Create or Update multiple DayInterval at once.  If the entity exists, it will be updated.  If the entity does not exist, it will be created.


SecurityapiKeyAuth and bearerAuth 
Request 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
 Array 
interval_Year
required
integer <int32> 
Year of the date or interval used in internal date calculations


 
interval_Month
required
integer <int32> 
Month of the date or interval used in internal date calculations


 
interval_Day
required
integer <int32> 
Day of the date or interval used in internal date calculations


 
day_From_Date
string or null <date-time> 
Date and time stamp of the beginning of the specified day


 
day_Name
string or null  <= 12 characters 
Full name of the day of the week


 
day_Short_Name
string or null  <= 3 characters 
Abbreviated name of the day of the week


 
day_Thru_Date
string or null <date-time> 
Date and time stamp of the end of the specified day


 
entry_Date
string <date-time> 
Date record was first added to the system


 
entry_User
string or null  <= 20 characters 
User that first added the record to the system


 
holiday
required
boolean
Bit indicating if the specified day falls on recognized holiday


 
month_From_Date
string or null <date-time> 
First day of the month containing the date specified


 
month_Thru_Date
string or null <date-time> 
Last day of the month containing the date specified


 
quarter
integer or null <int32> 
Number indicating the quarter containing the date specified


 
quarter_From_Date
string or null <date-time> 
First day of the quarter containing the date specified


 
quarter_Thru_Date
string or null <date-time> 
Last day of the quarter containing the date specified


 
update_Date
string <date-time> 
Date the record was last updated in the system


 
update_User
string or null  <= 20 characters 
User that last updated the record in the system


 
week_Day
integer or null <int32> 
Number of the day of the week where Sunday is 1


 
weekend
boolean or null
Bit indicating if the specified day falls on the weekend


 
yearMonthDay_Seq
integer or null <int32> 
Sequence number used for simple date comparisons


 
Responses 
207
Success


401
Unauthorized


put/day-intervals-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}