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	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": "5cbb14ec-c4e0-490a-8e91-ea5bb91bbf9c",
  "ProviderProgramId": "01dde486-6e99-4099-bcba-55b3127d17f5",
  "ProviderApplicationId": "8e4cb57d-646e-41d1-a4f3-4eddcbeea527",
  "WebProductId": "f6bb7153-4e12-4d66-8d8f-57d55b6d5cc7",
  "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>5cbb14ec-c4e0-490a-8e91-ea5bb91bbf9c</CartId>
  <ProviderApplicationId>8e4cb57d-646e-41d1-a4f3-4eddcbeea527</ProviderApplicationId>
  <ProviderProgramId>01dde486-6e99-4099-bcba-55b3127d17f5</ProviderProgramId>
  <WebProductId>f6bb7153-4e12-4d66-8d8f-57d55b6d5cc7</WebProductId>
  <WebProductName>sample string 5</WebProductName>
</FreeProviderProgramSubmitModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Receipt

Name	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": "fd26a169-97d0-4a27-948a-8fd6d2bb2855",
  "Messages": [
    "sample string 1",
    "sample string 2"
  ],
  "InvoiceNumber": "sample string 2",
  "InvoiceDate": "2025-04-24T20:17:09.8768224+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>2025-04-24T20:17:09.8768224+00:00</InvoiceDate>
  <InvoiceId>fd26a169-97d0-4a27-948a-8fd6d2bb2855</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>