Provider Credentialing Hyperlinks

Create ProviderCredHyperlink

Creates a new ProviderCredHyperlink

SecurityapiKeyAuth and bearerAuth

Request

path Parameters

providerCredKey

required

integer <int32>

ProviderCred Key

header Parameters

vbasoftware-database

required

string

Target database

Request Body schema:
application/json
required

providerCredHyperlink_Key required	integer <int32> Unique identifier for each hyperlink record. Note: This field is marked as NOT NULL in the database and therefore required by the API.
display	string or null <= 256 characters Indicates display order for export.
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.
hyperlink	string or null <= 1024 characters Hyperlink associated with the Provider's credential.
providerCred_Key required	integer <int32> Associates these custom hyperlink values with the credentialing process (ProviderCred.ProviderCred_Key) Note: This field is marked as NOT NULL in the database and therefore required by the API.
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.

Responses

200

Success

401

Unauthorized

post/provider-credentialing/{providerCredKey}/hyperlinks

Request samples

Payload
C#
JavaScript
curl
Java

{"providerCredHyperlink_Key": 0,
"display": "string",
"entry_Date": "2019-08-24T14:15:22Z",
"entry_User": "string",
"hyperlink": "string",
"providerCred_Key": 0,
"update_Date": "2019-08-24T14:15:22Z",
"update_User": "string"
}

Response samples

{"data": {"providerCredHyperlink_Key": 0,
"display": "string",
"entry_Date": "2019-08-24T14:15:22Z",
"entry_User": "string",
"hyperlink": "string",
"providerCred_Key": 0,
"update_Date": "2019-08-24T14:15:22Z",
"update_User": "string"
},
"error": {"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"debug": {"activityID": "string"
}
}

List ProviderCredHyperlink

Lists all ProviderCredHyperlink for the given providerCredKey

SecurityapiKeyAuth and bearerAuth

Request

path Parameters

providerCredKey

required

integer <int32>

ProviderCred 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/provider-credentialing/{providerCredKey}/hyperlinks

Request samples

C#
JavaScript
curl
Java

Response samples

No sample

Get ProviderCredHyperlink

Gets ProviderCredHyperlink

SecurityapiKeyAuth and bearerAuth

Request

path Parameters

providerCredKey required	integer <int32> ProviderCred Key
providerCredHyperlinkKey required	integer <int32> ProviderCredHyperlink Key

header Parameters

vbasoftware-database

required

string

Target database

Responses

200

Success

401

Unauthorized

get/provider-credentialing/{providerCredKey}/hyperlinks/{providerCredHyperlinkKey}

Request samples

C#
JavaScript
curl
Java

Response samples

No sample

Update ProviderCredHyperlink

Updates a specific ProviderCredHyperlink.

SecurityapiKeyAuth and bearerAuth

Request

path Parameters

providerCredKey required	integer <int32> ProviderCred Key
providerCredHyperlinkKey required	integer <int32> ProviderCredHyperlink Key

header Parameters

vbasoftware-database

required

string

Target database

Request Body schema:
application/json
required

providerCredHyperlink_Key required	integer <int32> Unique identifier for each hyperlink record. Note: This field is marked as NOT NULL in the database and therefore required by the API.
display	string or null <= 256 characters Indicates display order for export.
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.
hyperlink	string or null <= 1024 characters Hyperlink associated with the Provider's credential.
providerCred_Key required	integer <int32> Associates these custom hyperlink values with the credentialing process (ProviderCred.ProviderCred_Key) Note: This field is marked as NOT NULL in the database and therefore required by the API.
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.

Responses

200

Success

401

Unauthorized

put/provider-credentialing/{providerCredKey}/hyperlinks/{providerCredHyperlinkKey}

Request samples

Payload
C#
JavaScript
curl
Java

{"providerCredHyperlink_Key": 0,
"display": "string",
"entry_Date": "2019-08-24T14:15:22Z",
"entry_User": "string",
"hyperlink": "string",
"providerCred_Key": 0,
"update_Date": "2019-08-24T14:15:22Z",
"update_User": "string"
}

Response samples

{"data": {"providerCredHyperlink_Key": 0,
"display": "string",
"entry_Date": "2019-08-24T14:15:22Z",
"entry_User": "string",
"hyperlink": "string",
"providerCred_Key": 0,
"update_Date": "2019-08-24T14:15:22Z",
"update_User": "string"
},
"error": {"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"debug": {"activityID": "string"
}
}

Delete ProviderCredHyperlink

Deletes an ProviderCredHyperlink

SecurityapiKeyAuth and bearerAuth

Request

path Parameters

providerCredKey required	integer <int32> ProviderCred Key
providerCredHyperlinkKey required	integer <int32> ProviderCredHyperlink Key

header Parameters

vbasoftware-database

required

string

Target database

Responses

204

Success

401

Unauthorized

delete/provider-credentialing/{providerCredKey}/hyperlinks/{providerCredHyperlinkKey}

Request samples

C#
JavaScript
curl
Java

Create or Update Batch ProviderCredHyperlink

Create or Update multiple ProviderCredHyperlink 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

providerCredKey

required

integer <int32>

ProviderCred Key

header Parameters

vbasoftware-database

required

string

Target database

Request Body schema:
application/json
required

Array

providerCredHyperlink_Key required	integer <int32> Unique identifier for each hyperlink record. Note: This field is marked as NOT NULL in the database and therefore required by the API.
display	string or null <= 256 characters Indicates display order for export.
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.
hyperlink	string or null <= 1024 characters Hyperlink associated with the Provider's credential.
providerCred_Key required	integer <int32> Associates these custom hyperlink values with the credentialing process (ProviderCred.ProviderCred_Key) Note: This field is marked as NOT NULL in the database and therefore required by the API.
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.

Responses

207

Success

401

Unauthorized

put/provider-credentialing/{providerCredKey}/hyperlinks-batch

Request samples

Payload
C#
JavaScript
curl
Java

[{"providerCredHyperlink_Key": 0,
"display": "string",
"entry_Date": "2019-08-24T14:15:22Z",
"entry_User": "string",
"hyperlink": "string",
"providerCred_Key": 0,
"update_Date": "2019-08-24T14:15:22Z",
"update_User": "string"
}
]

Response samples

{"data": [{"id": [{"key": "string",
"value": "string"
}
],
"status": 0,
"body": "string"
}
],
"error": {"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"debug": {"activityID": "string"
}
}

Provider Credentialing Hyperlinks

Create ProviderCredHyperlink

path Parameters

header Parameters

Request Body schema: application/jsontext/jsonapplication/*+jsonapplication/jsonrequired

List ProviderCredHyperlink

path Parameters

query Parameters

header Parameters

Get ProviderCredHyperlink

path Parameters

header Parameters

Update ProviderCredHyperlink

path Parameters

header Parameters

Request Body schema: application/jsontext/jsonapplication/*+jsonapplication/jsonrequired

Delete ProviderCredHyperlink

path Parameters

header Parameters

Create or Update Batch ProviderCredHyperlink

path Parameters

header Parameters

Request Body schema: application/jsontext/jsonapplication/*+jsonapplication/jsonrequired

Request Body schema:
application/json
required

Request Body schema:
application/json
required

Request Body schema:
application/json
required