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": "8d26f54f-8ec9-4dc0-a1f5-fdee747d2387",
"ProviderProgramId": "9e5ba478-c163-4708-9ffc-a7e399d1c533",
"ProviderApplicationId": "ee34bba3-ee60-4ce7-ac82-80e2de55bb23",
"WebProductId": "d8daf53f-b865-40a9-9932-1a01dbd57eb1",
"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>8d26f54f-8ec9-4dc0-a1f5-fdee747d2387</CartId> <ProviderApplicationId>ee34bba3-ee60-4ce7-ac82-80e2de55bb23</ProviderApplicationId> <ProviderProgramId>9e5ba478-c163-4708-9ffc-a7e399d1c533</ProviderProgramId> <WebProductId>d8daf53f-b865-40a9-9932-1a01dbd57eb1</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": "f60a4ce4-8b4e-4d15-8fc7-421acc822077",
"Messages": [
"sample string 1",
"sample string 2"
],
"InvoiceNumber": "sample string 2",
"InvoiceDate": "2026-03-15T16:09:41.3648452+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-03-15T16:09:41.3648452+00:00</InvoiceDate>
<InvoiceId>f60a4ce4-8b4e-4d15-8fc7-421acc822077</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>