VBAGateway Subscription Detail

Create VBAGatewaySubscriptionDetail

Creates a new VBAGatewaySubscriptionDetail

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
userID
required
string

User ID

vBAGatewaySubscriptionKey
required
integer <int32>

VBAGatewaySubscription Key

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
vbaGatewaySubscriptionDetail_Key
required
integer <int32>

ID of the VBAGateway subscribtion detail. 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

restriction_ID
string or null <= 512 characters

ID of the restriction.

restriction_Type
string or null <= 32 characters

Type associated with the restriction.

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

vbaGatewaySubscription_Key
required
integer <int32>

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

Responses
200

Success

401

Unauthorized

post/users/{userID}/vbagateway-subscriptions/{vBAGatewaySubscriptionKey}/details
Request samples
{
  • "vbaGatewaySubscriptionDetail_Key": 0,
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "restriction_ID": "string",
  • "restriction_Type": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string",
  • "vbaGatewaySubscription_Key": 0
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List VBAGatewaySubscriptionDetail

Lists all VBAGatewaySubscriptionDetail given a specific vBAGatewaySubscriptionKey

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
userID
required
string

User ID

vBAGatewaySubscriptionKey
required
integer <int32>

VBAGatewaySubscription Key

header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/users/{userID}/vbagateway-subscriptions/{vBAGatewaySubscriptionKey}/details
Request samples 
Response samples 
No sample
Get VBAGatewaySubscriptionDetail
Gets VBAGatewaySubscriptionDetail


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
userID
required
string
User ID


 
vBAGatewaySubscriptionKey
required
integer <int32> 
VBAGatewaySubscription Key


 
vBAGatewaySubscriptionDetailKey
required
integer <int32> 
VBAGatewaySubscriptionDetail Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/users/{userID}/vbagateway-subscriptions/{vBAGatewaySubscriptionKey}/details/{vBAGatewaySubscriptionDetailKey}
Request samples 
Response samples 
No sample
Update VBAGatewaySubscriptionDetail
Updates a specific VBAGatewaySubscriptionDetail.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
userID
required
string
User ID


 
vBAGatewaySubscriptionKey
required
integer <int32> 
VBAGatewaySubscription Key


 
vBAGatewaySubscriptionDetailKey
required
integer <int32> 
VBAGatewaySubscriptionDetail Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
vbaGatewaySubscriptionDetail_Key
required
integer <int32> 
ID of the VBAGateway subscribtion detail. 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


 
restriction_ID
string or null  <= 512 characters 
ID of the restriction.


 
restriction_Type
string or null  <= 32 characters 
Type associated with the restriction.


 
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


 
vbaGatewaySubscription_Key
required
integer <int32> 
ID of the VBAGateway subscription. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
Responses 
200
Success


401
Unauthorized


put/users/{userID}/vbagateway-subscriptions/{vBAGatewaySubscriptionKey}/details/{vBAGatewaySubscriptionDetailKey}
Request samples 
{
  • "vbaGatewaySubscriptionDetail_Key": 0,
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "restriction_ID": "string",
  • "restriction_Type": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string",
  • "vbaGatewaySubscription_Key": 0
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete VBAGatewaySubscriptionDetail
Deletes an VBAGatewaySubscriptionDetail


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
userID
required
string
User ID


 
vBAGatewaySubscriptionKey
required
integer <int32> 
VBAGatewaySubscription Key


 
vBAGatewaySubscriptionDetailKey
required
integer <int32> 
VBAGatewaySubscriptionDetail Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/users/{userID}/vbagateway-subscriptions/{vBAGatewaySubscriptionKey}/details/{vBAGatewaySubscriptionDetailKey}
Request samples 
Create or Update Batch VBAGatewaySubscriptionDetail
Create or Update multiple VBAGatewaySubscriptionDetail at once.  If the entity exists, it will be updated.  If the entity does not exist, it will be created.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
userID
required
string
User ID


 
vBAGatewaySubscriptionKey
required
integer <int32> 
VBAGatewaySubscription Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
 Array 
vbaGatewaySubscriptionDetail_Key
required
integer <int32> 
ID of the VBAGateway subscribtion detail. 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


 
restriction_ID
string or null  <= 512 characters 
ID of the restriction.


 
restriction_Type
string or null  <= 32 characters 
Type associated with the restriction.


 
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


 
vbaGatewaySubscription_Key
required
integer <int32> 
ID of the VBAGateway subscription. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
Responses 
207
Success


401
Unauthorized


put/users/{userID}/vbagateway-subscriptions/{vBAGatewaySubscriptionKey}/details-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}