POST api/RCPSettings
Sets RCP settings.
Request Information
URI Parameters
None.
Body Parameters
RCPSettingsModel| Name | Description | Type | Additional information |
|---|---|---|---|
| AccountId |
Account's unique identifier (Read only). |
globally unique identifier |
None. |
| EclClientAccountNumber |
ECL client account number. |
string |
None. |
| RcpInterfaceActive |
VDT transmission active. |
boolean |
None. |
| RcpStartDate |
Start date. |
date |
None. |
| RcpUsername |
Username. |
string |
None. |
| RcpVendorId |
Vendor ID. |
string |
None. |
| RcpPracticeId |
Practice ID. |
string |
None. |
| RcpRole |
Role. |
string |
None. |
| RcpProductKey |
Product key. |
string |
None. |
| RcpVdtInformationUrl |
VDT upload URL. |
string |
None. |
| RcpVdtBatchResponseUrl |
VDT batch response URL. |
string |
None. |
| RcpPublicKey |
Public key. |
string |
None. |
Request Formats
application/json, text/json
Sample:
{
"accountId": "73d44ad8-b59c-4aa0-ba33-4ca1c8f8af50",
"eclClientAccountNumber": "sample string 2",
"rcpInterfaceActive": true,
"rcpStartDate": "2026-08-28T05:44:45.0882503+00:00",
"rcpUsername": "sample string 4",
"rcpVendorId": "sample string 5",
"rcpPracticeId": "sample string 6",
"rcpRole": "sample string 7",
"rcpProductKey": "sample string 8",
"rcpVdtInformationUrl": "sample string 9",
"rcpVdtBatchResponseUrl": "sample string 10",
"rcpPublicKey": "sample string 11"
}
application/xml, text/xml
Sample:
<RCPSettingsModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GlobalPortal.Api.Models.RCPSettings"> <AccountId>73d44ad8-b59c-4aa0-ba33-4ca1c8f8af50</AccountId> <EclClientAccountNumber>sample string 2</EclClientAccountNumber> <RcpInterfaceActive>true</RcpInterfaceActive> <RcpPracticeId>sample string 6</RcpPracticeId> <RcpProductKey>sample string 8</RcpProductKey> <RcpPublicKey>sample string 11</RcpPublicKey> <RcpRole>sample string 7</RcpRole> <RcpStartDate>2026-08-28T05:44:45.0882503+00:00</RcpStartDate> <RcpUsername>sample string 4</RcpUsername> <RcpVdtBatchResponseUrl>sample string 10</RcpVdtBatchResponseUrl> <RcpVdtInformationUrl>sample string 9</RcpVdtInformationUrl> <RcpVendorId>sample string 5</RcpVendorId> </RCPSettingsModel>
application/x-www-form-urlencoded
Sample:
Response Information
Resource Description
RCPSettingsModel| Name | Description | Type | Additional information |
|---|---|---|---|
| AccountId |
Account's unique identifier (Read only). |
globally unique identifier |
None. |
| EclClientAccountNumber |
ECL client account number. |
string |
None. |
| RcpInterfaceActive |
VDT transmission active. |
boolean |
None. |
| RcpStartDate |
Start date. |
date |
None. |
| RcpUsername |
Username. |
string |
None. |
| RcpVendorId |
Vendor ID. |
string |
None. |
| RcpPracticeId |
Practice ID. |
string |
None. |
| RcpRole |
Role. |
string |
None. |
| RcpProductKey |
Product key. |
string |
None. |
| RcpVdtInformationUrl |
VDT upload URL. |
string |
None. |
| RcpVdtBatchResponseUrl |
VDT batch response URL. |
string |
None. |
| RcpPublicKey |
Public key. |
string |
None. |
Response Formats
application/json, text/json
Sample:
{
"accountId": "aa1c4688-302e-43f4-bd30-e769eebe61c2",
"eclClientAccountNumber": "sample string 2",
"rcpInterfaceActive": true,
"rcpStartDate": "2026-08-28T05:44:45.094347+00:00",
"rcpUsername": "sample string 4",
"rcpVendorId": "sample string 5",
"rcpPracticeId": "sample string 6",
"rcpRole": "sample string 7",
"rcpProductKey": "sample string 8",
"rcpVdtInformationUrl": "sample string 9",
"rcpVdtBatchResponseUrl": "sample string 10",
"rcpPublicKey": "sample string 11"
}
application/xml, text/xml
Sample:
<RCPSettingsModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GlobalPortal.Api.Models.RCPSettings"> <AccountId>aa1c4688-302e-43f4-bd30-e769eebe61c2</AccountId> <EclClientAccountNumber>sample string 2</EclClientAccountNumber> <RcpInterfaceActive>true</RcpInterfaceActive> <RcpPracticeId>sample string 6</RcpPracticeId> <RcpProductKey>sample string 8</RcpProductKey> <RcpPublicKey>sample string 11</RcpPublicKey> <RcpRole>sample string 7</RcpRole> <RcpStartDate>2026-08-28T05:44:45.094347+00:00</RcpStartDate> <RcpUsername>sample string 4</RcpUsername> <RcpVdtBatchResponseUrl>sample string 10</RcpVdtBatchResponseUrl> <RcpVdtInformationUrl>sample string 9</RcpVdtInformationUrl> <RcpVendorId>sample string 5</RcpVendorId> </RCPSettingsModel>