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": "96450dff-f50b-44ba-ba51-b59299801e7c",
"ProviderProgramId": "246897af-fc94-4ce6-9249-edec7c93f535",
"ProviderApplicationId": "5f22ff78-6a54-43ce-b6d8-c96251f242d6",
"WebProductId": "c2c5bce5-d14e-41c4-8a7d-d07f6379f1ec",
"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>96450dff-f50b-44ba-ba51-b59299801e7c</CartId> <ProviderApplicationId>5f22ff78-6a54-43ce-b6d8-c96251f242d6</ProviderApplicationId> <ProviderProgramId>246897af-fc94-4ce6-9249-edec7c93f535</ProviderProgramId> <WebProductId>c2c5bce5-d14e-41c4-8a7d-d07f6379f1ec</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": "6e5f0789-bd36-4d71-a450-0688ee5e67b7",
"Messages": [
"sample string 1",
"sample string 2"
],
"InvoiceNumber": "sample string 2",
"InvoiceDate": "2026-01-25T09:03:34.0141369-05: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-01-25T09:03:34.0141369-05:00</InvoiceDate>
<InvoiceId>6e5f0789-bd36-4d71-a450-0688ee5e67b7</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>