Subscriber Sponsors

Create SubscriberSponsor

Creates a new SubscriberSponsor

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
subscriberSponsor_Key
required
integer <int32>

Unique identifier for the Subscriber Sponsor entry. This is the primary key of the table. Note: This field is marked as NOT NULL in the database and therefore required by the API.

effective_Date
string or null <date-time>

Beginning date for this sponsor record to apply.

entry_Date
string <date-time>

Date when the record was first added to the system.

entry_User
string or null <= 20 characters

User that first added the record to the system.

sponsor_ID
required
string [ 1 .. 9 ] characters

Identifier for the sponsor of this subscriber, matches Subscribers.Subscriber_ID.

sponsor_Relate_Code
string or null <= 8 characters

Relation of the sponsor to the subscriber, matches Relationships.Relate_Code.

subscriber_ID
required
string [ 1 .. 9 ] characters

Unique ID assigned to the Subscriber

term_Date
string or null <date-time>

Ending date for this sponsor record to apply.

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/subscriber-sponsors
Request samples
{
  • "subscriberSponsor_Key": 0,
  • "effective_Date": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "sponsor_ID": "string",
  • "sponsor_Relate_Code": "string",
  • "subscriber_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 SubscriberSponsor

Lists all SubscriberSponsor

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/subscriber-sponsors
Request samples 
Response samples 
No sample
Get SubscriberSponsor
Gets SubscriberSponsor


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
SubscriberSponsor_Key
required
integer <int32> 
SubscriberSponsor Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/subscriber-sponsors/{SubscriberSponsor_Key}
Request samples 
Response samples 
No sample
Update SubscriberSponsor
Updates a specific SubscriberSponsor.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
SubscriberSponsor_Key
required
integer <int32> 
SubscriberSponsor Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
subscriberSponsor_Key
required
integer <int32> 
Unique identifier for the Subscriber Sponsor entry. This is the primary key of the table. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
effective_Date
string or null <date-time> 
Beginning date for this sponsor record to apply.


 
entry_Date
string <date-time> 
Date when the record was first added to the system.


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


 
sponsor_ID
required
string  [ 1 .. 9 ] characters 
Identifier for the sponsor of this subscriber, matches Subscribers.Subscriber_ID.


 
sponsor_Relate_Code
string or null  <= 8 characters 
Relation of the sponsor to the subscriber, matches Relationships.Relate_Code.


 
subscriber_ID
required
string  [ 1 .. 9 ] characters 
Unique ID assigned to the Subscriber


 
term_Date
string or null <date-time> 
Ending date for this sponsor record to apply.


 
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/subscriber-sponsors/{SubscriberSponsor_Key}
Request samples 
{
  • "subscriberSponsor_Key": 0,
  • "effective_Date": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "sponsor_ID": "string",
  • "sponsor_Relate_Code": "string",
  • "subscriber_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 SubscriberSponsor
Deletes an SubscriberSponsor


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
SubscriberSponsor_Key
required
integer <int32> 
SubscriberSponsor Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/subscriber-sponsors/{SubscriberSponsor_Key}
Request samples 
Create or Update Batch SubscriberSponsor
Create or Update multiple SubscriberSponsor 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 
subscriberSponsor_Key
required
integer <int32> 
Unique identifier for the Subscriber Sponsor entry. This is the primary key of the table. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
effective_Date
string or null <date-time> 
Beginning date for this sponsor record to apply.


 
entry_Date
string <date-time> 
Date when the record was first added to the system.


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


 
sponsor_ID
required
string  [ 1 .. 9 ] characters 
Identifier for the sponsor of this subscriber, matches Subscribers.Subscriber_ID.


 
sponsor_Relate_Code
string or null  <= 8 characters 
Relation of the sponsor to the subscriber, matches Relationships.Relate_Code.


 
subscriber_ID
required
string  [ 1 .. 9 ] characters 
Unique ID assigned to the Subscriber


 
term_Date
string or null <date-time> 
Ending date for this sponsor record to apply.


 
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/subscriber-sponsors-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}