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
FreeProviderProgramSubmitModelName | 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": "653c68f0-b472-4329-822e-254ac2b6222c", "ProviderProgramId": "9b2f534c-1719-407b-86a8-ffef4cf98441", "ProviderApplicationId": "d40704ab-f131-48cb-a85b-a29d5bfb5cce", "WebProductId": "dbf99e9c-7849-407a-b129-0f74923e2c51", "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>653c68f0-b472-4329-822e-254ac2b6222c</CartId> <ProviderApplicationId>d40704ab-f131-48cb-a85b-a29d5bfb5cce</ProviderApplicationId> <ProviderProgramId>9b2f534c-1719-407b-86a8-ffef4cf98441</ProviderProgramId> <WebProductId>dbf99e9c-7849-407a-b129-0f74923e2c51</WebProductId> <WebProductName>sample string 5</WebProductName> </FreeProviderProgramSubmitModel>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
ReceiptName | 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": "155e3bad-5f8e-4106-9fda-b7772cd6a631", "Messages": [ "sample string 1", "sample string 2" ], "InvoiceNumber": "sample string 2", "InvoiceDate": "2025-02-18T07:42:42.7249741-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>2025-02-18T07:42:42.7249741-05:00</InvoiceDate> <InvoiceId>155e3bad-5f8e-4106-9fda-b7772cd6a631</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>