Member Provider Alternates

Create MemberProviderAlternate

Creates a new MemberProviderAlternate

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
subscriberID
required
string

Subscriber ID

memberSeq
required
string

Member Seq

memberProviderKey
required
integer <int32>

MemberProvider Key

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
memberProvider_Key
required
integer <int32>

References MemberProvider.MemberProvider_Key value on the parent record. Note: This field is marked as NOT NULL in the database and therefore required by the API.

provider_ID
required
string [ 1 .. 20 ] characters

References MemberProvider.Provider_ID value on the parent record.

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.

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/subscribers/{subscriberID}/members/{memberSeq}/providers/{memberProviderKey}/alternates
Request samples
{
  • "memberProvider_Key": 0,
  • "provider_ID": "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 MemberProviderAlternate

Lists all MemberProviderAlternate for the given memberProviderKey

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
subscriberID
required
string

Subscriber ID

memberSeq
required
string

Member Seq

memberProviderKey
required
integer <int32>

MemberProvider Key

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}/members/{memberSeq}/providers/{memberProviderKey}/alternates
Request samples 
Response samples 
No sample
Get MemberProviderAlternate
Gets MemberProviderAlternate


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
subscriberID
required
string
Subscriber ID


 
memberSeq
required
string
Member Seq


 
memberProviderKey
required
integer <int32> 
MemberProvider Key


 
providerID
required
string
Provider ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/subscribers/{subscriberID}/members/{memberSeq}/providers/{memberProviderKey}/alternates/{providerID}
Request samples 
Response samples 
No sample
Update MemberProviderAlternate
Updates a specific MemberProviderAlternate.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
subscriberID
required
string
Subscriber ID


 
memberSeq
required
string
Member Seq


 
memberProviderKey
required
integer <int32> 
MemberProvider Key


 
providerID
required
string
Provider ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
memberProvider_Key
required
integer <int32> 
References MemberProvider.MemberProvider_Key value on the parent record. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
provider_ID
required
string  [ 1 .. 20 ] characters 
References MemberProvider.Provider_ID value on the parent record.


 
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.


 
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/subscribers/{subscriberID}/members/{memberSeq}/providers/{memberProviderKey}/alternates/{providerID}
Request samples 
{
  • "memberProvider_Key": 0,
  • "provider_ID": "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 MemberProviderAlternate
Deletes an MemberProviderAlternate


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
subscriberID
required
string
Subscriber ID


 
memberSeq
required
string
Member Seq


 
memberProviderKey
required
integer <int32> 
MemberProvider Key


 
providerID
required
string
Provider ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/subscribers/{subscriberID}/members/{memberSeq}/providers/{memberProviderKey}/alternates/{providerID}
Request samples 
Create or Update Batch MemberProviderAlternate
Create or Update multiple MemberProviderAlternate 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


 
memberSeq
required
string
Member Seq


 
memberProviderKey
required
integer <int32> 
MemberProvider Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
 Array 
memberProvider_Key
required
integer <int32> 
References MemberProvider.MemberProvider_Key value on the parent record. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
provider_ID
required
string  [ 1 .. 20 ] characters 
References MemberProvider.Provider_ID value on the parent record.


 
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.


 
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/subscribers/{subscriberID}/members/{memberSeq}/providers/{memberProviderKey}/alternates-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}