Group Day Interval

Create GroupDayInterval

Creates a new GroupDayInterval

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
group_ID
required
string [ 1 .. 20 ] characters

The Group this Day Interval belongs to

interval_Year
required
integer <int32>

Which Year this Group Day Interval is Note: This field is marked as NOT NULL in the database and therefore required by the API.

interval_Month
required
integer <int32>

Which Month this Group Day Interval is Note: This field is marked as NOT NULL in the database and therefore required by the API.

interval_Day
required
integer <int32>

Which Day this Group Day Interval is Note: This field is marked as NOT NULL in the database and therefore required by the API.

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

payday
required
boolean

Whether or not the date this record belongs to is a Payday or not Note: This field is marked as NOT NULL in the database and therefore required by the API.

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

Responses
200

Success

401

Unauthorized

post/group-day-intervals
Request samples
{
  • "group_ID": "string",
  • "interval_Year": 0,
  • "interval_Month": 0,
  • "interval_Day": 0,
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "payday": true,
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List GroupDayInterval

Lists all GroupDayInterval for the given Group_ID and Interval_Year and Interval_Month and Interval_Day

SecurityapiKeyAuth and bearerAuth
Request
query Parameters
Group_ID
string

Optional filter for Group ID

Interval_Year
integer <int32>

Optional filter for Interval Year

Interval_Month
integer <int32>

Optional filter for Interval Month

Interval_Day
integer <int32>

Optional filter for Interval Day

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.

page
integer <int32>
Default: 1

Page

pageSize
integer <int32>
Default: 100

Page Size

header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

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


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
Group_ID
required
string
Group ID


 
Interval_Year
required
integer <int32> 
Interval Year


 
Interval_Month
required
integer <int32> 
Interval Month


 
Interval_Day
required
integer <int32> 
Interval Day


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/group-day-intervals/{Group_ID}/{Interval_Year}/{Interval_Month}/{Interval_Day}
Request samples 
Response samples 
No sample
Update GroupDayInterval
Updates a specific GroupDayInterval.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
Group_ID
required
string
Group ID


 
Interval_Year
required
integer <int32> 
Interval Year


 
Interval_Month
required
integer <int32> 
Interval Month


 
Interval_Day
required
integer <int32> 
Interval Day


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
group_ID
required
string  [ 1 .. 20 ] characters 
The Group this Day Interval belongs to


 
interval_Year
required
integer <int32> 
Which Year this Group Day Interval is Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
interval_Month
required
integer <int32> 
Which Month this Group Day Interval is Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
interval_Day
required
integer <int32> 
Which Day this Group Day Interval is Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
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


 
payday
required
boolean
Whether or not the date this record belongs to is a Payday or not Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
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


 
Responses 
200
Success


401
Unauthorized


put/group-day-intervals/{Group_ID}/{Interval_Year}/{Interval_Month}/{Interval_Day}
Request samples 
{
  • "group_ID": "string",
  • "interval_Year": 0,
  • "interval_Month": 0,
  • "interval_Day": 0,
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "payday": true,
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete GroupDayInterval
Deletes an GroupDayInterval


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
Group_ID
required
string
Group ID


 
Interval_Year
required
integer <int32> 
Interval Year


 
Interval_Month
required
integer <int32> 
Interval Month


 
Interval_Day
required
integer <int32> 
Interval Day


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/group-day-intervals/{Group_ID}/{Interval_Year}/{Interval_Month}/{Interval_Day}
Request samples 
Create or Update Batch GroupDayInterval
Create or Update multiple GroupDayInterval 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 
group_ID
required
string  [ 1 .. 20 ] characters 
The Group this Day Interval belongs to


 
interval_Year
required
integer <int32> 
Which Year this Group Day Interval is Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
interval_Month
required
integer <int32> 
Which Month this Group Day Interval is Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
interval_Day
required
integer <int32> 
Which Day this Group Day Interval is Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
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


 
payday
required
boolean
Whether or not the date this record belongs to is a Payday or not Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
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


 
Responses 
207
Success


401
Unauthorized


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