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": "28e043d9-c801-4547-bfa8-527e84311df4", "ProviderProgramId": "aea6ed3d-56dc-42f5-8802-5666e01eeaea", "ProviderApplicationId": "28f56a6d-0823-4ecd-bd71-b5d22b7c38e7", "WebProductId": "2110be89-a13c-4dce-98fc-001ee85c3f01", "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>28e043d9-c801-4547-bfa8-527e84311df4</CartId> <ProviderApplicationId>28f56a6d-0823-4ecd-bd71-b5d22b7c38e7</ProviderApplicationId> <ProviderProgramId>aea6ed3d-56dc-42f5-8802-5666e01eeaea</ProviderProgramId> <WebProductId>2110be89-a13c-4dce-98fc-001ee85c3f01</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": "f84e81e6-ad0d-467c-a19b-fae83001b842", "Messages": [ "sample string 1", "sample string 2" ], "InvoiceNumber": "sample string 2", "InvoiceDate": "2024-11-05T00:40:42.561469+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>2024-11-05T00:40:42.561469+00:00</InvoiceDate> <InvoiceId>f84e81e6-ad0d-467c-a19b-fae83001b842</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>