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": "531da78d-5e97-47e9-be7a-5f8e790c2322",
"ProviderProgramId": "eb13ba7f-0c57-442b-9ef7-bd6b93376ce7",
"ProviderApplicationId": "24b0e817-ab1f-41e7-ac36-cb16d5f43361",
"WebProductId": "fcfdb6f5-bddf-4234-a357-160c1f5e614c",
"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>531da78d-5e97-47e9-be7a-5f8e790c2322</CartId> <ProviderApplicationId>24b0e817-ab1f-41e7-ac36-cb16d5f43361</ProviderApplicationId> <ProviderProgramId>eb13ba7f-0c57-442b-9ef7-bd6b93376ce7</ProviderProgramId> <WebProductId>fcfdb6f5-bddf-4234-a357-160c1f5e614c</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": "88c1abbc-c855-4dd9-98c1-a6189061f911",
"Messages": [
"sample string 1",
"sample string 2"
],
"InvoiceNumber": "sample string 2",
"InvoiceDate": "2026-06-21T08:31:39.3515432+00: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-06-21T08:31:39.3515432+00:00</InvoiceDate>
<InvoiceId>88c1abbc-c855-4dd9-98c1-a6189061f911</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>