POST api/Practice/ClientInfoPublicKey
Allow inserting into DynamicIQ > ClientInfo for existing practices (located via ExternalId)
Request Information
URI Parameters
None.
Body Parameters
Collection of PracticeClientInfoPublicKey| Name | Description | Type | Additional information |
|---|---|---|---|
| ExternalId | string |
None. |
|
| DynamicIqPracticeDetails | DynamicIqPracticeDetails |
None. |
Request Formats
application/json, text/json
Sample:
[
{
"ExternalId": "sample string 1",
"DynamicIqPracticeDetails": {
"DynamicIqPracticePublicKey": "sample string 1"
}
},
{
"ExternalId": "sample string 1",
"DynamicIqPracticeDetails": {
"DynamicIqPracticePublicKey": "sample string 1"
}
}
]
application/xml, text/xml
Sample:
<ArrayOfPracticeClientInfoPublicKey xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OnboardingApi.ApiModel">
<PracticeClientInfoPublicKey>
<DynamicIqPracticeDetails>
<DynamicIqPracticePublicKey>sample string 1</DynamicIqPracticePublicKey>
</DynamicIqPracticeDetails>
<ExternalId>sample string 1</ExternalId>
</PracticeClientInfoPublicKey>
<PracticeClientInfoPublicKey>
<DynamicIqPracticeDetails>
<DynamicIqPracticePublicKey>sample string 1</DynamicIqPracticePublicKey>
</DynamicIqPracticeDetails>
<ExternalId>sample string 1</ExternalId>
</PracticeClientInfoPublicKey>
</ArrayOfPracticeClientInfoPublicKey>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
Collection of ClientInfoPublicKeyResult| Name | Description | Type | Additional information |
|---|---|---|---|
| Success |
Indicates successful insert/update |
boolean |
None. |
| Message |
Error message |
string |
None. |
| InReferenceToExternalId |
External ID of the Practice or User |
string |
None. |
| Product |
CQMsolution |
string |
None. |
Response Formats
application/json, text/json
Sample:
[
{
"Success": true,
"Message": "sample string 2",
"InReferenceToExternalId": "sample string 3",
"Product": "sample string 4"
},
{
"Success": true,
"Message": "sample string 2",
"InReferenceToExternalId": "sample string 3",
"Product": "sample string 4"
}
]
application/xml, text/xml
Sample:
<ArrayOfClientInfoPublicKeyResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OnboardingApi.Api_Model.DynamicIQ">
<ClientInfoPublicKeyResult>
<InReferenceToExternalId>sample string 3</InReferenceToExternalId>
<Message>sample string 2</Message>
<Product>sample string 4</Product>
<Success>true</Success>
</ClientInfoPublicKeyResult>
<ClientInfoPublicKeyResult>
<InReferenceToExternalId>sample string 3</InReferenceToExternalId>
<Message>sample string 2</Message>
<Product>sample string 4</Product>
<Success>true</Success>
</ClientInfoPublicKeyResult>
</ArrayOfClientInfoPublicKeyResult>