PUT api/provider/program/submit?contactId={contactId}&accountId={accountId}

Submit a zero $ Provider Application or Provider Program

Request Information

URI Parameters

NameDescriptionTypeAdditional information
contactId

globally unique identifier

Required

accountId

globally unique identifier

Required

Body Parameters

FreeProviderProgramSubmitModel
NameDescriptionTypeAdditional 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": "86ef8333-290f-4d73-b93c-d8b5eae35e0d",
  "ProviderProgramId": "6de09e23-4460-4dcf-a70c-8c116accd3a1",
  "ProviderApplicationId": "5e55f78b-17ba-454c-96fe-1d370b5924ab",
  "WebProductId": "292f1fb2-83ef-4612-8224-6b2fd04e23f2",
  "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>86ef8333-290f-4d73-b93c-d8b5eae35e0d</CartId>
  <ProviderApplicationId>5e55f78b-17ba-454c-96fe-1d370b5924ab</ProviderApplicationId>
  <ProviderProgramId>6de09e23-4460-4dcf-a70c-8c116accd3a1</ProviderProgramId>
  <WebProductId>292f1fb2-83ef-4612-8224-6b2fd04e23f2</WebProductId>
  <WebProductName>sample string 5</WebProductName>
</FreeProviderProgramSubmitModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Receipt
NameDescriptionTypeAdditional 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": "73ea920f-54ac-40f9-9215-a1e7430c3733",
  "Messages": [
    "sample string 1",
    "sample string 2"
  ],
  "InvoiceNumber": "sample string 2",
  "InvoiceDate": "2024-06-18T18:36:44.7926233+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-06-18T18:36:44.7926233+00:00</InvoiceDate>
  <InvoiceId>73ea920f-54ac-40f9-9215-a1e7430c3733</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>