PUT api/provider/program/submit?contactId={contactId}&accountId={accountId}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| contactId | globally unique identifier |
Required |
|
| accountId | globally unique identifier |
Required |
Body Parameters
FreeProviderProgramSubmitModel| Name | Description | Type | Additional information |
|---|---|---|---|
| CartId | globally unique identifier |
None. |
|
| ProviderProgramId | globally unique identifier |
None. |
|
| ProviderApplicationId | globally unique identifier |
None. |
|
| WebProductId | globally unique identifier |
None. |
|
| WebProductName | string |
None. |
Request Formats
application/json, text/json
Sample:
{
"CartId": "4f67a2cb-d392-4e2e-896b-7c2af438a0c8",
"ProviderProgramId": "b031be6d-c828-460b-8f7b-44aee30cf266",
"ProviderApplicationId": "b4216792-501b-460a-880c-f3ba36321993",
"WebProductId": "9836d863-696a-4fb8-ae8f-83bb6881292d",
"WebProductName": "sample string 5"
}
application/xml, text/xml
Sample:
<FreeProviderProgramSubmitModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models"> <CartId>4f67a2cb-d392-4e2e-896b-7c2af438a0c8</CartId> <ProviderApplicationId>b4216792-501b-460a-880c-f3ba36321993</ProviderApplicationId> <ProviderProgramId>b031be6d-c828-460b-8f7b-44aee30cf266</ProviderProgramId> <WebProductId>9836d863-696a-4fb8-ae8f-83bb6881292d</WebProductId> <WebProductName>sample string 5</WebProductName> </FreeProviderProgramSubmitModel>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
Receipt| Name | Description | Type | Additional information |
|---|---|---|---|
| InvoiceId | globally unique identifier |
None. |
|
| Messages | Collection of string |
None. |
|
| InvoiceNumber | string |
None. |
|
| InvoiceDate | date |
None. |
|
| TotalAmountPaid | decimal number |
None. |
|
| PaymentAuthorizationNumber | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"InvoiceId": "65fcdaa3-53a8-46c9-b2fe-f631c4d99ad0",
"Messages": [
"sample string 1",
"sample string 2"
],
"InvoiceNumber": "sample string 2",
"InvoiceDate": "2026-09-23T19:04:53.0798631-04:00",
"TotalAmountPaid": 4.0,
"PaymentAuthorizationNumber": "sample string 5"
}
application/xml, text/xml
Sample:
<Receipt xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models">
<InvoiceDate>2026-09-23T19:04:53.0798631-04:00</InvoiceDate>
<InvoiceId>65fcdaa3-53a8-46c9-b2fe-f631c4d99ad0</InvoiceId>
<InvoiceNumber>sample string 2</InvoiceNumber>
<Messages xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>sample string 1</d2p1:string>
<d2p1:string>sample string 2</d2p1:string>
</Messages>
<PaymentAuthorizationNumber>sample string 5</PaymentAuthorizationNumber>
<TotalAmountPaid>4</TotalAmountPaid>
</Receipt>