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": "65b1ba99-4211-4662-8f72-e4b7c12b88be", "ProviderProgramId": "eb008a17-0c0e-4ec8-a8e3-c7d684da9e6c", "ProviderApplicationId": "5f72d8bc-ef71-4a8a-a745-bb2303724fba", "WebProductId": "a131118b-eceb-4bb3-973b-e5dc82a67226", "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>65b1ba99-4211-4662-8f72-e4b7c12b88be</CartId> <ProviderApplicationId>5f72d8bc-ef71-4a8a-a745-bb2303724fba</ProviderApplicationId> <ProviderProgramId>eb008a17-0c0e-4ec8-a8e3-c7d684da9e6c</ProviderProgramId> <WebProductId>a131118b-eceb-4bb3-973b-e5dc82a67226</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": "5d9b0c4d-52b4-4c95-9452-b751a60cc2fd", "Messages": [ "sample string 1", "sample string 2" ], "InvoiceNumber": "sample string 2", "InvoiceDate": "2024-09-16T19:59:39.4523672+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-09-16T19:59:39.4523672+00:00</InvoiceDate> <InvoiceId>5d9b0c4d-52b4-4c95-9452-b751a60cc2fd</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>