Subscriber ID Codes

Create SubscriberIDCode

Creates a new SubscriberIDCode

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
subscriberID
required
string

Subscriber ID

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
subscriber_ID
required
string [ 1 .. 9 ] characters

No longer in use.

iD_Code
required
string [ 1 .. 6 ] characters

No longer in use.

description
string or null <= 64 characters

No longer in use.

entry_Date
string <date-time>

No longer in use.

entry_User
string or null <= 20 characters

No longer in use.

update_Date
string <date-time>

No longer in use.

update_User
string or null <= 20 characters

No longer in use.

Responses
200

Success

401

Unauthorized

post/subscribers/{subscriberID}/id-codes
Request samples
{
  • "subscriber_ID": "string",
  • "iD_Code": "string",
  • "description": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List SubscriberIDCode

Lists all SubscriberIDCode for the given subscriberID

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
subscriberID
required
string

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/{subscriberID}/id-codes
Request samples 
Response samples 
No sample
Create or Update Batch SubscriberIDCode
Create or Update multiple SubscriberIDCode 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
subscriberID
required
string
Subscriber ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
 Array 
subscriber_ID
required
string  [ 1 .. 9 ] characters 
No longer in use.


 
iD_Code
required
string  [ 1 .. 6 ] characters 
No longer in use.


 
description
string or null  <= 64 characters 
No longer in use.


 
entry_Date
string <date-time> 
No longer in use.


 
entry_User
string or null  <= 20 characters 
No longer in use.


 
update_Date
string <date-time> 
No longer in use.


 
update_User
string or null  <= 20 characters 
No longer in use.


 
Responses 
207
Success


401
Unauthorized


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


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
subscriberID
required
string
Subscriber ID


 
iDCode
required
string
ID Code


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/subscribers/{subscriberID}/id-codes/{iDCode}
Request samples 
Response samples 
No sample
Update SubscriberIDCode
Updates a specific SubscriberIDCode.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
subscriberID
required
string
Subscriber ID


 
iDCode
required
string
ID Code


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
subscriber_ID
required
string  [ 1 .. 9 ] characters 
No longer in use.


 
iD_Code
required
string  [ 1 .. 6 ] characters 
No longer in use.


 
description
string or null  <= 64 characters 
No longer in use.


 
entry_Date
string <date-time> 
No longer in use.


 
entry_User
string or null  <= 20 characters 
No longer in use.


 
update_Date
string <date-time> 
No longer in use.


 
update_User
string or null  <= 20 characters 
No longer in use.


 
Responses 
200
Success


401
Unauthorized


put/subscribers/{subscriberID}/id-codes/{iDCode}
Request samples 
{
  • "subscriber_ID": "string",
  • "iD_Code": "string",
  • "description": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete SubscriberIDCode
Deletes an SubscriberIDCode


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
subscriberID
required
string
Subscriber ID


 
iDCode
required
string
ID Code


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/subscribers/{subscriberID}/id-codes/{iDCode}
Request samples