Subscriber Writing Agents

Create SubscriberWritingAgent

Creates a new SubscriberWritingAgent

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
Subscriber_ID
required
string

Subscriber ID

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
subscriberWritingAgent_Key
required
integer <int32>

Unique identifier for the Subscriber Writing Agent entry. Note: This field is marked as NOT NULL in the database and therefore required by the API.

effective_Date
required
string <date-time>

Date account is effective for the Rep 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

plan_ID
required
string [ 1 .. 20 ] characters

ID of the plan that the commission is associated with.

split
required
number <double>

The percentage the Rep receives for this Commission. Note: This field is marked as NOT NULL in the database and therefore required by the API.

subscriber_ID
required
string [ 1 .. 9 ] characters

Unique identifier assigned to the Subscriber by the system.

term_Date
required
string <date-time>

Date account is no longer effective for the Rep 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

writing_CommissionAgencyRep_Key
required
integer <int32>

Unique identifier for the CommissionAgencyRep table Note: This field is marked as NOT NULL in the database and therefore required by the API.

Responses
200

Success

401

Unauthorized

post/subscribers/{Subscriber_ID}/writing-agents
Request samples
{
  • "subscriberWritingAgent_Key": 0,
  • "effective_Date": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "plan_ID": "string",
  • "split": 0.1,
  • "subscriber_ID": "string",
  • "term_Date": "2019-08-24T14:15:22Z",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string",
  • "writing_CommissionAgencyRep_Key": 0
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List SubscriberWritingAgent

Lists all SubscriberWritingAgent for the given Subscriber_ID

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
Subscriber_ID
required
string

Subscriber ID

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/subscribers/{Subscriber_ID}/writing-agents
Request samples 
Response samples 
No sample
Get SubscriberWritingAgent
Gets SubscriberWritingAgent


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
Subscriber_ID
required
string
Subscriber ID


 
SubscriberWritingAgent_Key
required
integer <int32> 
SubscriberWritingAgent Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/subscribers/{Subscriber_ID}/writing-agents/{SubscriberWritingAgent_Key}
Request samples 
Response samples 
No sample
Update SubscriberWritingAgent
Updates a specific SubscriberWritingAgent.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
Subscriber_ID
required
string
Subscriber ID


 
SubscriberWritingAgent_Key
required
integer <int32> 
SubscriberWritingAgent Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
subscriberWritingAgent_Key
required
integer <int32> 
Unique identifier for the Subscriber Writing Agent entry. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
effective_Date
required
string <date-time> 
Date account is effective for the Rep 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


 
plan_ID
required
string  [ 1 .. 20 ] characters 
ID of the plan that the commission is associated with.


 
split
required
number <double> 
The percentage the Rep receives for this Commission. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
subscriber_ID
required
string  [ 1 .. 9 ] characters 
Unique identifier assigned to the Subscriber by the system.


 
term_Date
required
string <date-time> 
Date account is no longer effective for the Rep 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


 
writing_CommissionAgencyRep_Key
required
integer <int32> 
Unique identifier for the CommissionAgencyRep table Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
Responses 
200
Success


401
Unauthorized


put/subscribers/{Subscriber_ID}/writing-agents/{SubscriberWritingAgent_Key}
Request samples 
{
  • "subscriberWritingAgent_Key": 0,
  • "effective_Date": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "plan_ID": "string",
  • "split": 0.1,
  • "subscriber_ID": "string",
  • "term_Date": "2019-08-24T14:15:22Z",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string",
  • "writing_CommissionAgencyRep_Key": 0
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete SubscriberWritingAgent
Deletes an SubscriberWritingAgent


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
Subscriber_ID
required
string
Subscriber ID


 
SubscriberWritingAgent_Key
required
integer <int32> 
SubscriberWritingAgent Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/subscribers/{Subscriber_ID}/writing-agents/{SubscriberWritingAgent_Key}
Request samples 
Create or Update Batch SubscriberWritingAgent
Create or Update multiple SubscriberWritingAgent 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
Subscriber_ID
required
string
Subscriber ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
 Array 
subscriberWritingAgent_Key
required
integer <int32> 
Unique identifier for the Subscriber Writing Agent entry. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
effective_Date
required
string <date-time> 
Date account is effective for the Rep 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


 
plan_ID
required
string  [ 1 .. 20 ] characters 
ID of the plan that the commission is associated with.


 
split
required
number <double> 
The percentage the Rep receives for this Commission. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
subscriber_ID
required
string  [ 1 .. 9 ] characters 
Unique identifier assigned to the Subscriber by the system.


 
term_Date
required
string <date-time> 
Date account is no longer effective for the Rep 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


 
writing_CommissionAgencyRep_Key
required
integer <int32> 
Unique identifier for the CommissionAgencyRep table Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
Responses 
207
Success


401
Unauthorized


put/subscribers/{Subscriber_ID}/writing-agents-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}