Places of Service

Create PlaceCodes

Creates a new PlaceCodes

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
place_Code
required
string [ 1 .. 4 ] characters

Code that identifies a specific place of service

all_Places
required
string = 1 characters

Flag that identifies if a place code refers to all places of service Note: This field is marked as NOT NULL in the database and therefore required by the API.

description
string or null <= 50 characters

Description of a specific place of service

entry_Date
string <date-time>

Date record was first added to the system

entry_User
string or null <= 20 characters

User that first added the record to the system

exclude_Proc_Auth
required
boolean

Flag that indicates if the place code will exclude an auth for procedures Note: This field is marked as NOT NULL in the database and therefore required by the API.

old_Place_Code
string or null <= 4 characters

Field identifying the old place code when the code on a place of service has changed

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/place-codes
Request samples
{
  • "place_Code": "stri",
  • "all_Places": "s",
  • "description": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "exclude_Proc_Auth": true,
  • "old_Place_Code": "stri",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List PlaceCodes

Lists all PlaceCodes

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/place-codes
Request samples 
Response samples 
No sample
Get PlaceCodes
Gets PlaceCodes


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
placeCode
required
string
Place Code


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/place-codes/{placeCode}
Request samples 
Response samples 
No sample
Update PlaceCodes
Updates a specific PlaceCodes.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
placeCode
required
string
Place Code


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
place_Code
required
string  [ 1 .. 4 ] characters 
Code that identifies a specific place of service


 
all_Places
required
string  = 1 characters 
Flag that identifies if a place code refers to all places of service Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
description
string or null  <= 50 characters 
Description of a specific place of service


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


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


 
exclude_Proc_Auth
required
boolean
Flag that indicates if the place code will exclude an auth for procedures Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
old_Place_Code
string or null  <= 4 characters 
Field identifying the old place code when the code on a place of service has changed


 
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/place-codes/{placeCode}
Request samples 
{
  • "place_Code": "stri",
  • "all_Places": "s",
  • "description": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "exclude_Proc_Auth": true,
  • "old_Place_Code": "stri",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete PlaceCodes
Deletes an PlaceCodes


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
placeCode
required
string
Place Code


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/place-codes/{placeCode}
Request samples 
Create or Update Batch PlaceCodes
Create or Update multiple PlaceCodes 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 
place_Code
required
string  [ 1 .. 4 ] characters 
Code that identifies a specific place of service


 
all_Places
required
string  = 1 characters 
Flag that identifies if a place code refers to all places of service Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
description
string or null  <= 50 characters 
Description of a specific place of service


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


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


 
exclude_Proc_Auth
required
boolean
Flag that indicates if the place code will exclude an auth for procedures Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
old_Place_Code
string or null  <= 4 characters 
Field identifying the old place code when the code on a place of service has changed


 
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/place-codes-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}