Plan Coordination

Create PlanCoordination

Creates a new PlanCoordination

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
planCoordination_Key
required
integer <int32>

Note: This field is marked as NOT NULL in the database and therefore required by the API.

criteria_Key
integer or null <int32>
destination_Ex_Code
string or null <= 6 characters
destination_Plan_ID
string or null <= 20 characters
division_ID
string or null <= 20 characters
eff_Date_Type
string or null <= 16 characters
effective_Date
string or null <date-time>
entry_Date
string <date-time>

Date when the record was added to the system.

entry_User
string or null <= 20 characters

User that first added the record to the system.

group_ID
string or null <= 20 characters
include_COB
required
boolean

Note: This field is marked as NOT NULL in the database and therefore required by the API.

originating_Plan_ID
string or null <= 20 characters
term_Date
string or null <date-time>
update_Date
string <date-time>

Date when 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/plan-coordinations
Request samples
{
  • "planCoordination_Key": 0,
  • "criteria_Key": 0,
  • "destination_Ex_Code": "string",
  • "destination_Plan_ID": "string",
  • "division_ID": "string",
  • "eff_Date_Type": "string",
  • "effective_Date": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "group_ID": "string",
  • "include_COB": true,
  • "originating_Plan_ID": "string",
  • "term_Date": "2019-08-24T14:15:22Z",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List PlanCoordination

Lists all PlanCoordination

SecurityapiKeyAuth and bearerAuth
Request
query Parameters
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/plan-coordinations
Request samples 
Response samples 
No sample
Get PlanCoordination
Gets PlanCoordination


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
PlanCoordination_Key
required
integer <int32> 
PlanCoordination Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/plan-coordinations/{PlanCoordination_Key}
Request samples 
Response samples 
No sample
Update PlanCoordination
Updates a specific PlanCoordination.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
PlanCoordination_Key
required
integer <int32> 
PlanCoordination Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
planCoordination_Key
required
integer <int32> 
Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
criteria_Key
integer or null <int32> 
 
destination_Ex_Code
string or null  <= 6 characters 
 
destination_Plan_ID
string or null  <= 20 characters 
 
division_ID
string or null  <= 20 characters 
 
eff_Date_Type
string or null  <= 16 characters 
 
effective_Date
string or null <date-time> 
 
entry_Date
string <date-time> 
Date when the record was added to the system.


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


 
group_ID
string or null  <= 20 characters 
 
include_COB
required
boolean
Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
originating_Plan_ID
string or null  <= 20 characters 
 
term_Date
string or null <date-time> 
 
update_Date
string <date-time> 
Date when 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/plan-coordinations/{PlanCoordination_Key}
Request samples 
{
  • "planCoordination_Key": 0,
  • "criteria_Key": 0,
  • "destination_Ex_Code": "string",
  • "destination_Plan_ID": "string",
  • "division_ID": "string",
  • "eff_Date_Type": "string",
  • "effective_Date": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "group_ID": "string",
  • "include_COB": true,
  • "originating_Plan_ID": "string",
  • "term_Date": "2019-08-24T14:15:22Z",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete PlanCoordination
Deletes an PlanCoordination


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
PlanCoordination_Key
required
integer <int32> 
PlanCoordination Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/plan-coordinations/{PlanCoordination_Key}
Request samples 
Create or Update Batch PlanCoordination
Create or Update multiple PlanCoordination 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 
planCoordination_Key
required
integer <int32> 
Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
criteria_Key
integer or null <int32> 
 
destination_Ex_Code
string or null  <= 6 characters 
 
destination_Plan_ID
string or null  <= 20 characters 
 
division_ID
string or null  <= 20 characters 
 
eff_Date_Type
string or null  <= 16 characters 
 
effective_Date
string or null <date-time> 
 
entry_Date
string <date-time> 
Date when the record was added to the system.


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


 
group_ID
string or null  <= 20 characters 
 
include_COB
required
boolean
Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
originating_Plan_ID
string or null  <= 20 characters 
 
term_Date
string or null <date-time> 
 
update_Date
string <date-time> 
Date when 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/plan-coordinations-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}