PUT api/provider/program/submit?contactId={contactId}&accountId={accountId}
Submit a zero $ Provider Application or Provider Program
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": "6f8853c1-8560-4e8e-85ad-02851535cc3d", "ProviderProgramId": "b11f0a0d-b48e-4090-9dce-8fcd2d97f1f6", "ProviderApplicationId": "36b60252-30ac-4f43-b9a4-388275363d88", "WebProductId": "0207036d-cb68-4a2a-b33e-0386e587289d", "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>6f8853c1-8560-4e8e-85ad-02851535cc3d</CartId> <ProviderApplicationId>36b60252-30ac-4f43-b9a4-388275363d88</ProviderApplicationId> <ProviderProgramId>b11f0a0d-b48e-4090-9dce-8fcd2d97f1f6</ProviderProgramId> <WebProductId>0207036d-cb68-4a2a-b33e-0386e587289d</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": "557e1022-2581-4f4f-8af1-d072d71d6bd3", "Messages": [ "sample string 1", "sample string 2" ], "InvoiceNumber": "sample string 2", "InvoiceDate": "2024-09-05T06:06:08.8525788-04: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-05T06:06:08.8525788-04:00</InvoiceDate> <InvoiceId>557e1022-2581-4f4f-8af1-d072d71d6bd3</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>