Member Languages

Create MemberLanguage

Creates a new MemberLanguage

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
subscriberID
required
string

Subscriber ID

memberSeq
required
string

Member Seq

header Parameters
vbasoftware-database
required
string

Target database

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

References Members.Subscriber_ID value on the parent record.

member_Seq
required
string [ 1 .. 2 ] characters

References Members.Member_Seq value on the parent record.

language_ID
required
string [ 1 .. 8 ] characters

References Languages.Language_ID value on the referenced 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.

primary_Language
required
boolean

Idenfities that the associated language is the Member's primary language. Note: The database will apply a default value of False for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of False to meet the API requirements and ensure that the functionality occurs as expected.

secondary_Language
required
boolean

Identifies that the associated language is the Member's secondary language. Note: The database will apply a default value of False for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of False to meet the API requirements and ensure that the functionality occurs as expected.

spoken_Language
required
boolean

A flag indicating a Member can speak the language. Note: The database will apply a default value of False for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of False to meet the API requirements and ensure that the functionality occurs as expected.

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.

written_Language
required
boolean

A flag indicating a Member can write the language. Note: The database will apply a default value of False for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of False to meet the API requirements and ensure that the functionality occurs as expected.

Responses
200

Success

401

Unauthorized

post/subscribers/{subscriberID}/members/{memberSeq}/languages
Request samples
{
  • "subscriber_ID": "string",
  • "member_Seq": "st",
  • "language_ID": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "primary_Language": true,
  • "secondary_Language": true,
  • "spoken_Language": true,
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string",
  • "written_Language": true
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List MemberLanguage

Lists all MemberLanguage for the given subscriberID and memberSeq

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
subscriberID
required
string

Subscriber ID

memberSeq
required
string

Member Seq

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}/languages
Request samples 
Response samples 
No sample
Get MemberLanguage
Gets MemberLanguage


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
subscriberID
required
string
Subscriber ID


 
memberSeq
required
string
Member Seq


 
languageID
required
string
Language ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/subscribers/{subscriberID}/members/{memberSeq}/languages/{languageID}
Request samples 
Response samples 
No sample
Update MemberLanguage
Updates a specific MemberLanguage.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
subscriberID
required
string
Subscriber ID


 
memberSeq
required
string
Member Seq


 
languageID
required
string
Language ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
subscriber_ID
required
string  [ 1 .. 9 ] characters 
References Members.Subscriber_ID value on the parent record.


 
member_Seq
required
string  [ 1 .. 2 ] characters 
References Members.Member_Seq value on the parent record.


 
language_ID
required
string  [ 1 .. 8 ] characters 
References Languages.Language_ID value on the referenced 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.


 
primary_Language
required
boolean
Idenfities that the associated language is the Member's primary language.  Note: The database will apply a default value of False for this field if a value is not provided.  This field is also marked as NOT NULL in the database and therefore required by the API.  If you do not have a value for this field, supply the database default value of False to meet the API requirements and ensure that the functionality occurs as expected.


 
secondary_Language
required
boolean
Identifies that the associated language is the Member's secondary language.  Note: The database will apply a default value of False for this field if a value is not provided.  This field is also marked as NOT NULL in the database and therefore required by the API.  If you do not have a value for this field, supply the database default value of False to meet the API requirements and ensure that the functionality occurs as expected.


 
spoken_Language
required
boolean
A flag indicating a Member can speak the language.  Note: The database will apply a default value of False for this field if a value is not provided.  This field is also marked as NOT NULL in the database and therefore required by the API.  If you do not have a value for this field, supply the database default value of False to meet the API requirements and ensure that the functionality occurs as expected.


 
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.


 
written_Language
required
boolean
A flag indicating a Member can write the language.  Note: The database will apply a default value of False for this field if a value is not provided.  This field is also marked as NOT NULL in the database and therefore required by the API.  If you do not have a value for this field, supply the database default value of False to meet the API requirements and ensure that the functionality occurs as expected.


 
Responses 
200
Success


401
Unauthorized


put/subscribers/{subscriberID}/members/{memberSeq}/languages/{languageID}
Request samples 
{
  • "subscriber_ID": "string",
  • "member_Seq": "st",
  • "language_ID": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "primary_Language": true,
  • "secondary_Language": true,
  • "spoken_Language": true,
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string",
  • "written_Language": true
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete MemberLanguage
Deletes an MemberLanguage


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
subscriberID
required
string
Subscriber ID


 
memberSeq
required
string
Member Seq


 
languageID
required
string
Language ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/subscribers/{subscriberID}/members/{memberSeq}/languages/{languageID}
Request samples 
Create or Update Batch MemberLanguage
Create or Update multiple MemberLanguage 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


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
 Array 
subscriber_ID
required
string  [ 1 .. 9 ] characters 
References Members.Subscriber_ID value on the parent record.


 
member_Seq
required
string  [ 1 .. 2 ] characters 
References Members.Member_Seq value on the parent record.


 
language_ID
required
string  [ 1 .. 8 ] characters 
References Languages.Language_ID value on the referenced 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.


 
primary_Language
required
boolean
Idenfities that the associated language is the Member's primary language.  Note: The database will apply a default value of False for this field if a value is not provided.  This field is also marked as NOT NULL in the database and therefore required by the API.  If you do not have a value for this field, supply the database default value of False to meet the API requirements and ensure that the functionality occurs as expected.


 
secondary_Language
required
boolean
Identifies that the associated language is the Member's secondary language.  Note: The database will apply a default value of False for this field if a value is not provided.  This field is also marked as NOT NULL in the database and therefore required by the API.  If you do not have a value for this field, supply the database default value of False to meet the API requirements and ensure that the functionality occurs as expected.


 
spoken_Language
required
boolean
A flag indicating a Member can speak the language.  Note: The database will apply a default value of False for this field if a value is not provided.  This field is also marked as NOT NULL in the database and therefore required by the API.  If you do not have a value for this field, supply the database default value of False to meet the API requirements and ensure that the functionality occurs as expected.


 
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.


 
written_Language
required
boolean
A flag indicating a Member can write the language.  Note: The database will apply a default value of False for this field if a value is not provided.  This field is also marked as NOT NULL in the database and therefore required by the API.  If you do not have a value for this field, supply the database default value of False to meet the API requirements and ensure that the functionality occurs as expected.


 
Responses 
207
Success


401
Unauthorized


put/subscribers/{subscriberID}/members/{memberSeq}/languages-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}