Subscriber ID Code History

Create SubscriberIDHistory

Creates a new SubscriberIDHistory

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
newSubscriberID
required
string

New Subscriber ID

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
change_ID
required
integer <int32>

Unique identifier for each Subscriber ID change process. Note: This field is marked as NOT NULL in the database and therefore required by the API.

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.

error_Number
integer or null <int32>

Indicates if the process returned an error during the change procedure.

new_Subscriber_ID
string or null <= 9 characters

The Subscriber_ID that Old_Subscriber_ID was changed to.

old_Subscriber_ID
string or null <= 9 characters

The Subscriber_ID value that was changed.

table_Name
string or null <= 64 characters

Indicates the table that an error occurred during the change procedure.

Responses
200

Success

401

Unauthorized

post/subscribers/{newSubscriberID}/id-codes-history
Request samples
{
  • "change_ID": 0,
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "error_Number": 0,
  • "new_Subscriber_ID": "string",
  • "old_Subscriber_ID": "string",
  • "table_Name": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List SubscriberIDHistory

Lists all SubscriberIDHistory for the given newSubscriberID

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
newSubscriberID
required
string

New Subscriber ID

query Parameters
page
integer <int32>
Default: 1

Page

pageSize
integer <int32>
Default: 100

Page Size

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.

header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/subscribers/{newSubscriberID}/id-codes-history
Request samples 
Response samples 
No sample
Create or Update Batch SubscriberIDHistory
Create or Update multiple SubscriberIDHistory 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
newSubscriberID
required
string
New Subscriber ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
 Array 
change_ID
required
integer <int32> 
Unique identifier for each Subscriber ID change process. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
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.


 
error_Number
integer or null <int32> 
Indicates if the process returned an error during the change procedure.


 
new_Subscriber_ID
string or null  <= 9 characters 
The Subscriber_ID that Old_Subscriber_ID was changed to.


 
old_Subscriber_ID
string or null  <= 9 characters 
The Subscriber_ID value that was changed.


 
table_Name
string or null  <= 64 characters 
Indicates the table that an error occurred during the change procedure.


 
Responses 
207
Success


401
Unauthorized


put/subscribers/{newSubscriberID}/id-codes-history-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}
Get SubscriberIDHistory
Gets SubscriberIDHistory


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
newSubscriberID
required
string
New Subscriber ID


 
changeID
required
integer <int32> 
Change ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/subscribers/{newSubscriberID}/id-codes-history/{changeID}
Request samples 
Response samples 
No sample
Update SubscriberIDHistory
Updates a specific SubscriberIDHistory.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
newSubscriberID
required
string
New Subscriber ID


 
changeID
required
integer <int32> 
Change ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
change_ID
required
integer <int32> 
Unique identifier for each Subscriber ID change process. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
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.


 
error_Number
integer or null <int32> 
Indicates if the process returned an error during the change procedure.


 
new_Subscriber_ID
string or null  <= 9 characters 
The Subscriber_ID that Old_Subscriber_ID was changed to.


 
old_Subscriber_ID
string or null  <= 9 characters 
The Subscriber_ID value that was changed.


 
table_Name
string or null  <= 64 characters 
Indicates the table that an error occurred during the change procedure.


 
Responses 
200
Success


401
Unauthorized


put/subscribers/{newSubscriberID}/id-codes-history/{changeID}
Request samples 
{
  • "change_ID": 0,
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "error_Number": 0,
  • "new_Subscriber_ID": "string",
  • "old_Subscriber_ID": "string",
  • "table_Name": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete SubscriberIDHistory
Deletes an SubscriberIDHistory


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
newSubscriberID
required
string
New Subscriber ID


 
changeID
required
integer <int32> 
Change ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/subscribers/{newSubscriberID}/id-codes-history/{changeID}
Request samples