Provider Rate Criteria

Create Provider Rate Criteria

Creates a new Provider Rate Criteria

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
providerId
required
string

Provider ID

providerRateKey
required
integer <int32>

Provider Rate Key

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
providerRateCriteria_Key
required
integer <int32>

References. The ProviderRateCriteria.ProviderRateCriteria_Key value on the parent table.

criteria_From
string or null <= 64 characters

Beginning of selected criteria range.

criteria_Operator
string or null <= 1 characters

Defines how the ‘From’ and ‘Thru’ range is treated: inclusive, exclusive, matching, etc.

criteria_Thru
string or null <= 64 characters

End of selected criteria range. This criterion is only used for the ‘Between’ operation.

providerRateColumn_Key
required
integer <int32>

References the ProviderRateColumn.ProviderRateColumn_Key on the parent table.

providerRate_Key
required
integer <int32>

References the ProviderRate.ProviderRate_Key value on the parent table.

Responses
200

Success

401

Unauthorized

post/providers/{providerId}/rates/{providerRateKey}/criterias
Request samples
{
  • "providerRateCriteria_Key": 0,
  • "criteria_From": "string",
  • "criteria_Operator": "s",
  • "criteria_Thru": "string",
  • "providerRateColumn_Key": 0,
  • "providerRate_Key": 0
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List ProviderRateCriteria

Lists all ProviderRateCriteria given a ProviderID and ProviderRateKey

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
providerId
required
string

Provider ID

providerRateKey
required
integer <int32>

Provider Rate Key

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}/rates/{providerRateKey}/criterias
Request samples 
Response samples 
No sample
Get ProviderRateCriteria
Gets ProviderRateCriteria


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
providerId
required
string
Provider ID


 
providerRateKey
required
integer <int32> 
Provider Rate Key


 
providerRateCriteriaKey
required
integer <int32> 
ProviderRateCriteria Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/providers/{providerId}/rates/{providerRateKey}/criterias/{providerRateCriteriaKey}
Request samples 
Response samples 
No sample
Update ProviderRateCriteria
Updates a specific ProviderRateCriteria.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
providerId
required
string
Provider ID


 
providerRateKey
required
integer <int32> 
Provider Rate Key


 
providerRateCriteriaKey
required
integer <int32> 
ProviderRateCriteria Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
providerRateCriteria_Key
required
integer <int32> 
References. The ProviderRateCriteria.ProviderRateCriteria_Key value on the parent table.


 
criteria_From
string or null  <= 64 characters 
Beginning of selected criteria range.


 
criteria_Operator
string or null  <= 1 characters 
Defines how the ‘From’ and ‘Thru’ range is treated: inclusive, exclusive, matching, etc.


 
criteria_Thru
string or null  <= 64 characters 
End of selected criteria range. This criterion is only used for the ‘Between’ operation.


 
providerRateColumn_Key
required
integer <int32> 
References the ProviderRateColumn.ProviderRateColumn_Key on the parent table.


 
providerRate_Key
required
integer <int32> 
References the ProviderRate.ProviderRate_Key value on the parent table.


 
Responses 
200
Success


401
Unauthorized


put/providers/{providerId}/rates/{providerRateKey}/criterias/{providerRateCriteriaKey}
Request samples 
{
  • "providerRateCriteria_Key": 0,
  • "criteria_From": "string",
  • "criteria_Operator": "s",
  • "criteria_Thru": "string",
  • "providerRateColumn_Key": 0,
  • "providerRate_Key": 0
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete ProviderRateCriteria
Deletes an ProviderRateCriteria


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
providerId
required
string
Provider ID


 
providerRateKey
required
integer <int32> 
Provider Rate Key


 
providerRateCriteriaKey
required
integer <int32> 
ProviderRateCriteria Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/providers/{providerId}/rates/{providerRateKey}/criterias/{providerRateCriteriaKey}
Request samples 
Update Batch ProviderRateCriteria
Updates a multiple ProviderRateCriteria.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
providerId
required
string
Provider ID


 
providerRateKey
required
integer <int32> 
Provider Rate Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
 Array 
providerRateCriteria_Key
required
integer <int32> 
References. The ProviderRateCriteria.ProviderRateCriteria_Key value on the parent table.


 
criteria_From
string or null  <= 64 characters 
Beginning of selected criteria range.


 
criteria_Operator
string or null  <= 1 characters 
Defines how the ‘From’ and ‘Thru’ range is treated: inclusive, exclusive, matching, etc.


 
criteria_Thru
string or null  <= 64 characters 
End of selected criteria range. This criterion is only used for the ‘Between’ operation.


 
providerRateColumn_Key
required
integer <int32> 
References the ProviderRateColumn.ProviderRateColumn_Key on the parent table.


 
providerRate_Key
required
integer <int32> 
References the ProviderRate.ProviderRate_Key value on the parent table.


 
Responses 
207
Success


401
Unauthorized


put/providers/{providerId}/rates/{providerRateKey}/criterias-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}