Network Profile Assignments

Create NetworkProfileAssign

Creates a new NetworkProfileAssign

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
profile_ID
required
string [ 1 .. 32 ] characters

Unique idenfitier assigned to the Network Profile record.

assign_Type
required
string [ 1 .. 16 ] characters

Defines the type of record match used by the assignment. Supports Provider_ID, Profile_Provider_ID, or Federal_ID

assign_ID
required
string [ 1 .. 64 ] characters

Holds ID value used in conjunction with the Assign_Type to define the desired provider match.

effective_Date
required
string <date-time>

Date when the Network Profile becomes/became effective. Note: This field is marked as NOT NULL in the database and therefore required by the API.

entry_Date
string <date-time>

Date record was first added to the system

entry_User
string or null <= 200 characters

User that first added the record to the system

term_Date
string or null <date-time>

Date when the Network Profile no longer applies.

update_Date
string <date-time>

Date 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/network-profile-assignments
Request samples
{
  • "profile_ID": "string",
  • "assign_Type": "string",
  • "assign_ID": "string",
  • "effective_Date": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "term_Date": "2019-08-24T14:15:22Z",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List NetworkProfileAssign

Lists all NetworkProfileAssign for the given Profile_ID

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
Profile_ID
required
string

Profile ID

query Parameters
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.

page
integer <int32>
Default: 1

Page

pageSize
integer <int32>
Default: 100

Page Size

header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/network-profiles/{Profile_ID}/assignments
Request samples 
Response samples 
No sample
Get NetworkProfileAssign
Gets NetworkProfileAssign


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
Profile_ID
required
string
Profile ID


 
Assign_Type
required
string
Assign Type


 
Assign_ID
required
string
Assign ID


 
Effective_Date
required
string <date-time> 
Effective Date


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/network-profiles/{Profile_ID}/types/{Assign_Type}/assignments/{Assign_ID}/effective/{Effective_Date}
Request samples 
Response samples 
No sample
Update NetworkProfileAssign
Updates a specific NetworkProfileAssign.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
Profile_ID
required
string
Profile ID


 
Assign_Type
required
string
Assign Type


 
Assign_ID
required
string
Assign ID


 
Effective_Date
required
string <date-time> 
Effective Date


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
profile_ID
required
string  [ 1 .. 32 ] characters 
Unique idenfitier assigned to the Network Profile record.


 
assign_Type
required
string  [ 1 .. 16 ] characters 
Defines the type of record match used by the assignment.  Supports Provider_ID, Profile_Provider_ID, or Federal_ID


 
assign_ID
required
string  [ 1 .. 64 ] characters 
Holds ID value used in conjunction with the Assign_Type to define the desired provider match.


 
effective_Date
required
string <date-time> 
Date when the Network Profile becomes/became effective. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
entry_Date
string <date-time> 
Date record was first added to the system


 
entry_User
string or null  <= 200 characters 
User that first added the record to the system


 
term_Date
string or null <date-time> 
Date when the Network Profile no longer applies.


 
update_Date
string <date-time> 
Date 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/network-profiles/{Profile_ID}/types/{Assign_Type}/assignments/{Assign_ID}/effective/{Effective_Date}
Request samples 
{
  • "profile_ID": "string",
  • "assign_Type": "string",
  • "assign_ID": "string",
  • "effective_Date": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "term_Date": "2019-08-24T14:15:22Z",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete NetworkProfileAssign
Deletes an NetworkProfileAssign


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
Profile_ID
required
string
Profile ID


 
Assign_Type
required
string
Assign Type


 
Assign_ID
required
string
Assign ID


 
Effective_Date
required
string <date-time> 
Effective Date


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/network-profiles/{Profile_ID}/types/{Assign_Type}/assignments/{Assign_ID}/effective/{Effective_Date}
Request samples 
Create or Update Batch NetworkProfileAssign
Create or Update multiple NetworkProfileAssign 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 
profile_ID
required
string  [ 1 .. 32 ] characters 
Unique idenfitier assigned to the Network Profile record.


 
assign_Type
required
string  [ 1 .. 16 ] characters 
Defines the type of record match used by the assignment.  Supports Provider_ID, Profile_Provider_ID, or Federal_ID


 
assign_ID
required
string  [ 1 .. 64 ] characters 
Holds ID value used in conjunction with the Assign_Type to define the desired provider match.


 
effective_Date
required
string <date-time> 
Date when the Network Profile becomes/became effective. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
entry_Date
string <date-time> 
Date record was first added to the system


 
entry_User
string or null  <= 200 characters 
User that first added the record to the system


 
term_Date
string or null <date-time> 
Date when the Network Profile no longer applies.


 
update_Date
string <date-time> 
Date 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/network-profile-assignments-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}
List Assign Types
List Assign Types


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


 
Responses 
200
Success


401
Unauthorized


get/network-profile-assign-types
Request samples 
Response samples 
No sample