VBAGateway Subscription

Create VBAGatewaySubscription

Creates a new VBAGatewaySubscription

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
userID
required
string

User ID

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
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.

auto_Process
required
boolean

Indicates that the requests associated with this subscription will be automatically processed. Note: This field is marked as NOT NULL in the database and therefore required by the API.

auto_Process_Custom_Class
string or null <= 128 characters

Custom class associated with the auto-process request

auto_Process_Response_Message
string or null <= 512 characters

Free text area where the message that will be sent as a response to auto-processed requests.

auto_Process_Status
string or null <= 32 characters

Indicates the status that will be assigned to auto-processed requests.

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

idCard_Request_Type
string or null <= 32 characters

Request type used when the process involves ID Card requests

notify_Me
required
boolean

Flag indicating the user would like to be notified regarding the request Note: This field is marked as NOT NULL in the database and therefore required by the API.

request_From
string or null <date-time>

Indicates the beginning date for the date range of requests that will be associated with subscription.

request_Source
string or null <= 32 characters

Indicates which terminal the subscription's requests will generate from.

request_Status
string or null <= 32 characters

Indicates which request status will be associated with the subscription.

request_Thru
string or null <date-time>

Indicates the ending date for the date range of requests that will be associated with subscription.

request_Type
string or null <= 32 characters

Indicates which type of request will be associated with the subscription.

subscription_Description
string or null <= 256 characters

Description of the VBAGateway subscription.

subscription_Type
string or null <= 32 characters

Indicates the type of the VBAGateway subscription.

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

user_ID
string or null <= 32 characters

ID of the User associated with the VBAGateway subscription.

Responses
200

Success

401

Unauthorized

post/users/{userID}/vbagateway-subscriptions
Request samples
{
  • "vbaGatewaySubscription_Key": 0,
  • "auto_Process": true,
  • "auto_Process_Custom_Class": "string",
  • "auto_Process_Response_Message": "string",
  • "auto_Process_Status": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "idCard_Request_Type": "string",
  • "notify_Me": true,
  • "request_From": "2019-08-24T14:15:22Z",
  • "request_Source": "string",
  • "request_Status": "string",
  • "request_Thru": "2019-08-24T14:15:22Z",
  • "request_Type": "string",
  • "subscription_Description": "string",
  • "subscription_Type": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string",
  • "user_ID": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List VBAGatewaySubscription

Lists all VBAGatewaySubscription given a specific userID

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
userID
required
string

User ID

header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

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


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}
Request samples 
Response samples 
No sample
Update VBAGatewaySubscription
Updates a specific VBAGatewaySubscription.


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
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.


 
auto_Process
required
boolean
Indicates that the requests associated with this subscription will be automatically processed. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
auto_Process_Custom_Class
string or null  <= 128 characters 
Custom class associated with the auto-process request


 
auto_Process_Response_Message
string or null  <= 512 characters 
Free text area where the message that will be sent as a response to auto-processed requests.


 
auto_Process_Status
string or null  <= 32 characters 
Indicates the status that will be assigned to auto-processed requests.


 
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


 
idCard_Request_Type
string or null  <= 32 characters 
Request type used when the process involves ID Card requests


 
notify_Me
required
boolean
Flag indicating the user would like to be notified regarding the request Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
request_From
string or null <date-time> 
Indicates the beginning date for the date range of requests that will be associated with subscription.


 
request_Source
string or null  <= 32 characters 
Indicates which terminal the subscription's requests will generate from.


 
request_Status
string or null  <= 32 characters 
Indicates which request status will be associated with the subscription.


 
request_Thru
string or null <date-time> 
Indicates the ending date for the date range of requests that will be associated with subscription.


 
request_Type
string or null  <= 32 characters 
Indicates which type of request will be associated with the subscription.


 
subscription_Description
string or null  <= 256 characters 
Description of the VBAGateway subscription.


 
subscription_Type
string or null  <= 32 characters 
Indicates the type of the VBAGateway subscription.


 
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


 
user_ID
string or null  <= 32 characters 
ID of the User associated with the VBAGateway subscription.


 
Responses 
200
Success


401
Unauthorized


put/users/{userID}/vbagateway-subscriptions/{vBAGatewaySubscriptionKey}
Request samples 
{
  • "vbaGatewaySubscription_Key": 0,
  • "auto_Process": true,
  • "auto_Process_Custom_Class": "string",
  • "auto_Process_Response_Message": "string",
  • "auto_Process_Status": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "idCard_Request_Type": "string",
  • "notify_Me": true,
  • "request_From": "2019-08-24T14:15:22Z",
  • "request_Source": "string",
  • "request_Status": "string",
  • "request_Thru": "2019-08-24T14:15:22Z",
  • "request_Type": "string",
  • "subscription_Description": "string",
  • "subscription_Type": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string",
  • "user_ID": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete VBAGatewaySubscription
Deletes an VBAGatewaySubscription


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 
204
Success


401
Unauthorized


delete/users/{userID}/vbagateway-subscriptions/{vBAGatewaySubscriptionKey}
Request samples 
Create or Update Batch VBAGatewaySubscription
Create or Update multiple VBAGatewaySubscription 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


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
 Array 
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.


 
auto_Process
required
boolean
Indicates that the requests associated with this subscription will be automatically processed. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
auto_Process_Custom_Class
string or null  <= 128 characters 
Custom class associated with the auto-process request


 
auto_Process_Response_Message
string or null  <= 512 characters 
Free text area where the message that will be sent as a response to auto-processed requests.


 
auto_Process_Status
string or null  <= 32 characters 
Indicates the status that will be assigned to auto-processed requests.


 
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


 
idCard_Request_Type
string or null  <= 32 characters 
Request type used when the process involves ID Card requests


 
notify_Me
required
boolean
Flag indicating the user would like to be notified regarding the request Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
request_From
string or null <date-time> 
Indicates the beginning date for the date range of requests that will be associated with subscription.


 
request_Source
string or null  <= 32 characters 
Indicates which terminal the subscription's requests will generate from.


 
request_Status
string or null  <= 32 characters 
Indicates which request status will be associated with the subscription.


 
request_Thru
string or null <date-time> 
Indicates the ending date for the date range of requests that will be associated with subscription.


 
request_Type
string or null  <= 32 characters 
Indicates which type of request will be associated with the subscription.


 
subscription_Description
string or null  <= 256 characters 
Description of the VBAGateway subscription.


 
subscription_Type
string or null  <= 32 characters 
Indicates the type of the VBAGateway subscription.


 
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


 
user_ID
string or null  <= 32 characters 
ID of the User associated with the VBAGateway subscription.


 
Responses 
207
Success


401
Unauthorized


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