Credentialing Carriers

Create CredCarrier

Creates a new CredCarrier

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
credCarrier_Key
required
integer <int32>

Unique Identity Key associated with this table. Note: This field is marked as NOT NULL in the database and therefore required by the API.

address
string or null <= 128 characters

Address of the credentialing Carrier.

address2
string or null <= 128 characters

Address line 2 of the credentialing Carrier.

city
string or null <= 32 characters

City of the address of the credentialing Carrier.

country_ID
string or null <= 8 characters

Country ID of the credentialing Carrier's address.

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.

fax
string or null <= 32 characters

Fax number of the credentialing Carrier.

fax_Country_Code
string or null <= 8 characters

Country code of the credentialing Carrier's fax number.

name
string or null <= 128 characters

Name of the credentialing Carrier.

phone
string or null <= 32 characters

Phone number of the credentialing Carrier.

phone_Country_Code
string or null <= 8 characters

Country code of the credentialing Carrier's phone number.

state
string or null <= 2 characters

State of the address of the credentialing Carrier.

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.

zip_Code
string or null <= 32 characters

Zip code of the credentialing Carrier.

Responses
200

Success

401

Unauthorized

post/credentialing-carriers
Request samples
{
  • "credCarrier_Key": 0,
  • "address": "string",
  • "address2": "string",
  • "city": "string",
  • "country_ID": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "fax": "string",
  • "fax_Country_Code": "string",
  • "name": "string",
  • "phone": "string",
  • "phone_Country_Code": "string",
  • "state": "st",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string",
  • "zip_Code": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List CredCarrier

Lists all CredCarrier

SecurityapiKeyAuth and bearerAuth
Request
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/credentialing-carriers
Request samples 
Response samples 
No sample
Get CredCarrier
Gets CredCarrier


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
credCarrierKey
required
integer <int32> 
CredCarrier Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/credentialing-carriers/{credCarrierKey}
Request samples 
Response samples 
No sample
Update CredCarrier
Updates a specific CredCarrier.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
credCarrierKey
required
integer <int32> 
CredCarrier Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
credCarrier_Key
required
integer <int32> 
Unique Identity Key associated with this table. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
address
string or null  <= 128 characters 
Address of the credentialing Carrier.


 
address2
string or null  <= 128 characters 
Address line 2 of the credentialing Carrier.


 
city
string or null  <= 32 characters 
City of the address of the credentialing Carrier.


 
country_ID
string or null  <= 8 characters 
Country ID of the credentialing Carrier's address.


 
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.


 
fax
string or null  <= 32 characters 
Fax number of the credentialing Carrier.


 
fax_Country_Code
string or null  <= 8 characters 
Country code of the credentialing Carrier's fax number.


 
name
string or null  <= 128 characters 
Name of the credentialing Carrier.


 
phone
string or null  <= 32 characters 
Phone number of the credentialing Carrier.


 
phone_Country_Code
string or null  <= 8 characters 
Country code of the credentialing Carrier's phone number.


 
state
string or null  <= 2 characters 
State of the address of the credentialing Carrier.


 
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.


 
zip_Code
string or null  <= 32 characters 
Zip code of the credentialing Carrier.


 
Responses 
200
Success


401
Unauthorized


put/credentialing-carriers/{credCarrierKey}
Request samples 
{
  • "credCarrier_Key": 0,
  • "address": "string",
  • "address2": "string",
  • "city": "string",
  • "country_ID": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "fax": "string",
  • "fax_Country_Code": "string",
  • "name": "string",
  • "phone": "string",
  • "phone_Country_Code": "string",
  • "state": "st",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string",
  • "zip_Code": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete CredCarrier
Deletes an CredCarrier


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
credCarrierKey
required
integer <int32> 
CredCarrier Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/credentialing-carriers/{credCarrierKey}
Request samples 
Create or Update Batch CredCarrier
Create or Update multiple CredCarrier at once.  If the entity exists, it will be updated.  If the entity does not exist, it will be created.


SecurityapiKeyAuth and bearerAuth 
Request 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
 Array 
credCarrier_Key
required
integer <int32> 
Unique Identity Key associated with this table. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
address
string or null  <= 128 characters 
Address of the credentialing Carrier.


 
address2
string or null  <= 128 characters 
Address line 2 of the credentialing Carrier.


 
city
string or null  <= 32 characters 
City of the address of the credentialing Carrier.


 
country_ID
string or null  <= 8 characters 
Country ID of the credentialing Carrier's address.


 
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.


 
fax
string or null  <= 32 characters 
Fax number of the credentialing Carrier.


 
fax_Country_Code
string or null  <= 8 characters 
Country code of the credentialing Carrier's fax number.


 
name
string or null  <= 128 characters 
Name of the credentialing Carrier.


 
phone
string or null  <= 32 characters 
Phone number of the credentialing Carrier.


 
phone_Country_Code
string or null  <= 8 characters 
Country code of the credentialing Carrier's phone number.


 
state
string or null  <= 2 characters 
State of the address of the credentialing Carrier.


 
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.


 
zip_Code
string or null  <= 32 characters 
Zip code of the credentialing Carrier.


 
Responses 
207
Success


401
Unauthorized


put/credentialing-carriers-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}