Provider Languages

Create ProviderLanguages

Creates a new ProviderLanguages

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
providerID
required
string

Provider ID

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
provider_ID
required
string [ 1 .. 20 ] characters

Unique idenfitier assigned to the Proivider record.

language_ID
required
string [ 1 .. 8 ] characters

Name of the language.

entry_Date
string <date-time>

User that first added the record to the system.

entry_User
string or null <= 20 characters

Date when the record was first added to the system.

language_Skill_Level
string or null <= 1 characters

Indicates the fluency of the Provider in the selected language.

primary_Language
required
boolean

Indicates that the selected language is the Provider's primary language. Note: This field is marked as NOT NULL in the database and therefore required by the API.

secondary_Language
required
boolean

Indicates that the selected language is a secondary language for the Provider. Note: This field is marked as NOT NULL in the database and therefore required by the API.

update_Date
string <date-time>

User that last updated the record in the system.

update_User
string or null <= 20 characters

Date when the record was last updated in the system.

Responses
200

Success

401

Unauthorized

post/providers/{providerID}/languages
Request samples
{
  • "provider_ID": "string",
  • "language_ID": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "language_Skill_Level": "s",
  • "primary_Language": true,
  • "secondary_Language": true,
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List ProviderLanguages

Lists all ProviderLanguages for the given providerID

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
providerID
required
string

Provider 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/providers/{providerID}/languages
Request samples 
Response samples 
No sample
Get ProviderLanguages
Gets ProviderLanguages


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
providerID
required
string
Provider ID


 
languageID
required
string
Language ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/providers/{providerID}/languages/{languageID}
Request samples 
Response samples 
No sample
Update ProviderLanguages
Updates a specific ProviderLanguages.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
providerID
required
string
Provider ID


 
languageID
required
string
Language ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
provider_ID
required
string  [ 1 .. 20 ] characters 
Unique idenfitier assigned to the Proivider record.


 
language_ID
required
string  [ 1 .. 8 ] characters 
Name of the language.


 
entry_Date
string <date-time> 
User that first added the record to the system.


 
entry_User
string or null  <= 20 characters 
Date when the record was first added to the system.


 
language_Skill_Level
string or null  <= 1 characters 
Indicates the fluency of the Provider in the selected language.


 
primary_Language
required
boolean
Indicates that the selected language is the Provider's primary language. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
secondary_Language
required
boolean
Indicates that the selected language is a secondary language for the Provider. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
update_Date
string <date-time> 
User that last updated the record in the system.


 
update_User
string or null  <= 20 characters 
Date when the record was last updated in the system.


 
Responses 
200
Success


401
Unauthorized


put/providers/{providerID}/languages/{languageID}
Request samples 
{
  • "provider_ID": "string",
  • "language_ID": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "language_Skill_Level": "s",
  • "primary_Language": true,
  • "secondary_Language": true,
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete ProviderLanguages
Deletes an ProviderLanguages


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
providerID
required
string
Provider ID


 
languageID
required
string
Language ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/providers/{providerID}/languages/{languageID}
Request samples 
Create or Update Batch ProviderLanguages
Create or Update multiple ProviderLanguages 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
providerID
required
string
Provider ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
 Array 
provider_ID
required
string  [ 1 .. 20 ] characters 
Unique idenfitier assigned to the Proivider record.


 
language_ID
required
string  [ 1 .. 8 ] characters 
Name of the language.


 
entry_Date
string <date-time> 
User that first added the record to the system.


 
entry_User
string or null  <= 20 characters 
Date when the record was first added to the system.


 
language_Skill_Level
string or null  <= 1 characters 
Indicates the fluency of the Provider in the selected language.


 
primary_Language
required
boolean
Indicates that the selected language is the Provider's primary language. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
secondary_Language
required
boolean
Indicates that the selected language is a secondary language for the Provider. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
update_Date
string <date-time> 
User that last updated the record in the system.


 
update_User
string or null  <= 20 characters 
Date when the record was last updated in the system.


 
Responses 
207
Success


401
Unauthorized


put/providers/{providerID}/languages-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}