PUT api/provider/program/update?accountId={accountId}
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
accountId | globally unique identifier |
Required |
Body Parameters
ProviderProgramName | Description | Type | Additional information |
---|---|---|---|
Id | globally unique identifier |
None. |
|
ProgramType | IdNamePair |
None. |
|
ProgramId | string |
None. |
|
ProgramTitle | string |
None. |
|
ProgramStartDate | date |
None. |
|
ProgramEndDate | date |
None. |
|
ProgramURL | string |
None. |
|
LearningObjectives | string |
None. |
|
PresenterName | string |
None. |
|
CreditType | IdNamePair |
None. |
|
EducationalTime | decimal number |
None. |
|
IsAvailableOnline | boolean |
None. |
|
CourseLocations | Collection of CourseLocation |
None. |
|
IsAttested | boolean |
None. |
|
IsRequirementMet | boolean |
None. |
|
ParentProgram | IdNamePair |
None. |
|
CreditHours | decimal number |
None. |
|
IsOngoingProgram | boolean |
None. |
|
IsDuplicate | boolean |
None. |
|
NonLearningTime | decimal number |
None. |
|
ProgramStatus | OptionSetValueModel |
None. |
|
SubmitProgram | boolean |
None. |
|
ContactId | globally unique identifier |
None. |
|
WebProductId | globally unique identifier |
None. |
|
WebProductName | string |
None. |
|
Receipt | Receipt |
None. |
|
IsDuplicateAllowed | boolean |
None. |
|
IsRosterUploadAllowed | boolean |
None. |
|
SubmissionDate | string |
None. |
Request Formats
application/json, text/json
Sample:
{ "Id": "46b5a251-7240-4f08-b0d7-f17f3769e0d7", "ProgramType": { "Id": "ddbf81f7-9b5c-4724-a674-f1f9815ad182", "Name": "sample string 2" }, "ProgramId": "sample string 2", "ProgramTitle": "sample string 3", "ProgramStartDate": "2025-07-04T22:50:10.7864542-04:00", "ProgramEndDate": "2025-07-04T22:50:10.7864542-04:00", "ProgramURL": "sample string 6", "LearningObjectives": "sample string 7", "PresenterName": "sample string 8", "CreditType": { "Id": "ddbf81f7-9b5c-4724-a674-f1f9815ad182", "Name": "sample string 2" }, "EducationalTime": 9.0, "IsAvailableOnline": true, "CourseLocations": [ { "Id": "0333baf7-319c-4064-a85c-427ff52b0d72", "Country": { "Id": "ddbf81f7-9b5c-4724-a674-f1f9815ad182", "Name": "sample string 2" }, "StateProvince": { "Id": "ddbf81f7-9b5c-4724-a674-f1f9815ad182", "Name": "sample string 2" }, "StateProvinceString": "sample string 2", "City": "sample string 3" }, { "Id": "0333baf7-319c-4064-a85c-427ff52b0d72", "Country": { "Id": "ddbf81f7-9b5c-4724-a674-f1f9815ad182", "Name": "sample string 2" }, "StateProvince": { "Id": "ddbf81f7-9b5c-4724-a674-f1f9815ad182", "Name": "sample string 2" }, "StateProvinceString": "sample string 2", "City": "sample string 3" } ], "IsAttested": true, "IsRequirementMet": true, "ParentProgram": { "Id": "ddbf81f7-9b5c-4724-a674-f1f9815ad182", "Name": "sample string 2" }, "CreditHours": 13.0, "IsOngoingProgram": true, "IsDuplicate": true, "NonLearningTime": 16.0, "ProgramStatus": { "Label": "sample string 1", "Value": 2 }, "SubmitProgram": true, "ContactId": "cfa4c992-9352-4d8d-9501-fcef55cd659e", "WebProductId": "a402c60d-01e4-49e3-8091-4f31964bb55f", "WebProductName": "sample string 20", "Receipt": { "InvoiceId": "87b602bf-10fc-4673-a527-0affe0ca60b3", "Messages": [ "sample string 1", "sample string 2" ], "InvoiceNumber": "sample string 2", "InvoiceDate": "2025-07-04T22:50:10.7864542-04:00", "TotalAmountPaid": 4.0, "PaymentAuthorizationNumber": "sample string 5" }, "IsDuplicateAllowed": true, "IsRosterUploadAllowed": true, "SubmissionDate": "sample string 23" }
application/xml, text/xml
Sample:
<ProviderProgram xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models"> <ContactId>cfa4c992-9352-4d8d-9501-fcef55cd659e</ContactId> <CourseLocations> <CourseLocation> <City>sample string 3</City> <Country xmlns:d4p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers"> <d4p1:Id>ddbf81f7-9b5c-4724-a674-f1f9815ad182</d4p1:Id> <d4p1:Name>sample string 2</d4p1:Name> </Country> <Id>0333baf7-319c-4064-a85c-427ff52b0d72</Id> <StateProvince xmlns:d4p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers"> <d4p1:Id>ddbf81f7-9b5c-4724-a674-f1f9815ad182</d4p1:Id> <d4p1:Name>sample string 2</d4p1:Name> </StateProvince> <StateProvinceString>sample string 2</StateProvinceString> </CourseLocation> <CourseLocation> <City>sample string 3</City> <Country xmlns:d4p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers"> <d4p1:Id>ddbf81f7-9b5c-4724-a674-f1f9815ad182</d4p1:Id> <d4p1:Name>sample string 2</d4p1:Name> </Country> <Id>0333baf7-319c-4064-a85c-427ff52b0d72</Id> <StateProvince xmlns:d4p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers"> <d4p1:Id>ddbf81f7-9b5c-4724-a674-f1f9815ad182</d4p1:Id> <d4p1:Name>sample string 2</d4p1:Name> </StateProvince> <StateProvinceString>sample string 2</StateProvinceString> </CourseLocation> </CourseLocations> <CreditHours>13</CreditHours> <CreditType xmlns:d2p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers"> <d2p1:Id>ddbf81f7-9b5c-4724-a674-f1f9815ad182</d2p1:Id> <d2p1:Name>sample string 2</d2p1:Name> </CreditType> <EducationalTime>9</EducationalTime> <Id>46b5a251-7240-4f08-b0d7-f17f3769e0d7</Id> <IsAttested>true</IsAttested> <IsAvailableOnline>true</IsAvailableOnline> <IsDuplicate>true</IsDuplicate> <IsDuplicateAllowed>true</IsDuplicateAllowed> <IsOngoingProgram>true</IsOngoingProgram> <IsRequirementMet>true</IsRequirementMet> <IsRosterUploadAllowed>true</IsRosterUploadAllowed> <LearningObjectives>sample string 7</LearningObjectives> <NonLearningTime>16</NonLearningTime> <ParentProgram xmlns:d2p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers"> <d2p1:Id>ddbf81f7-9b5c-4724-a674-f1f9815ad182</d2p1:Id> <d2p1:Name>sample string 2</d2p1:Name> </ParentProgram> <PresenterName>sample string 8</PresenterName> <ProgramEndDate>2025-07-04T22:50:10.7864542-04:00</ProgramEndDate> <ProgramId>sample string 2</ProgramId> <ProgramStartDate>2025-07-04T22:50:10.7864542-04:00</ProgramStartDate> <ProgramStatus xmlns:d2p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers"> <d2p1:Label>sample string 1</d2p1:Label> <d2p1:Value>2</d2p1:Value> </ProgramStatus> <ProgramTitle>sample string 3</ProgramTitle> <ProgramType xmlns:d2p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers"> <d2p1:Id>ddbf81f7-9b5c-4724-a674-f1f9815ad182</d2p1:Id> <d2p1:Name>sample string 2</d2p1:Name> </ProgramType> <ProgramURL>sample string 6</ProgramURL> <Receipt> <InvoiceDate>2025-07-04T22:50:10.7864542-04:00</InvoiceDate> <InvoiceId>87b602bf-10fc-4673-a527-0affe0ca60b3</InvoiceId> <InvoiceNumber>sample string 2</InvoiceNumber> <Messages xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:string>sample string 1</d3p1:string> <d3p1:string>sample string 2</d3p1:string> </Messages> <PaymentAuthorizationNumber>sample string 5</PaymentAuthorizationNumber> <TotalAmountPaid>4</TotalAmountPaid> </Receipt> <SubmissionDate>sample string 23</SubmissionDate> <SubmitProgram>true</SubmitProgram> <WebProductId>a402c60d-01e4-49e3-8091-4f31964bb55f</WebProductId> <WebProductName>sample string 20</WebProductName> </ProviderProgram>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
ProviderProgramName | Description | Type | Additional information |
---|---|---|---|
Id | globally unique identifier |
None. |
|
ProgramType | IdNamePair |
None. |
|
ProgramId | string |
None. |
|
ProgramTitle | string |
None. |
|
ProgramStartDate | date |
None. |
|
ProgramEndDate | date |
None. |
|
ProgramURL | string |
None. |
|
LearningObjectives | string |
None. |
|
PresenterName | string |
None. |
|
CreditType | IdNamePair |
None. |
|
EducationalTime | decimal number |
None. |
|
IsAvailableOnline | boolean |
None. |
|
CourseLocations | Collection of CourseLocation |
None. |
|
IsAttested | boolean |
None. |
|
IsRequirementMet | boolean |
None. |
|
ParentProgram | IdNamePair |
None. |
|
CreditHours | decimal number |
None. |
|
IsOngoingProgram | boolean |
None. |
|
IsDuplicate | boolean |
None. |
|
NonLearningTime | decimal number |
None. |
|
ProgramStatus | OptionSetValueModel |
None. |
|
SubmitProgram | boolean |
None. |
|
ContactId | globally unique identifier |
None. |
|
WebProductId | globally unique identifier |
None. |
|
WebProductName | string |
None. |
|
Receipt | Receipt |
None. |
|
IsDuplicateAllowed | boolean |
None. |
|
IsRosterUploadAllowed | boolean |
None. |
|
SubmissionDate | string |
None. |
Response Formats
application/json, text/json
Sample:
{ "Id": "e9fcddb0-e909-4915-ba22-7f1ed3c369b3", "ProgramType": { "Id": "5e1313b6-22e6-499e-bd7a-cf521335e881", "Name": "sample string 2" }, "ProgramId": "sample string 2", "ProgramTitle": "sample string 3", "ProgramStartDate": "2025-07-04T22:50:10.7864542-04:00", "ProgramEndDate": "2025-07-04T22:50:10.7864542-04:00", "ProgramURL": "sample string 6", "LearningObjectives": "sample string 7", "PresenterName": "sample string 8", "CreditType": { "Id": "5e1313b6-22e6-499e-bd7a-cf521335e881", "Name": "sample string 2" }, "EducationalTime": 9.0, "IsAvailableOnline": true, "CourseLocations": [ { "Id": "67060c20-345d-4d63-a85a-b098518a41e3", "Country": { "Id": "5e1313b6-22e6-499e-bd7a-cf521335e881", "Name": "sample string 2" }, "StateProvince": { "Id": "5e1313b6-22e6-499e-bd7a-cf521335e881", "Name": "sample string 2" }, "StateProvinceString": "sample string 2", "City": "sample string 3" }, { "Id": "67060c20-345d-4d63-a85a-b098518a41e3", "Country": { "Id": "5e1313b6-22e6-499e-bd7a-cf521335e881", "Name": "sample string 2" }, "StateProvince": { "Id": "5e1313b6-22e6-499e-bd7a-cf521335e881", "Name": "sample string 2" }, "StateProvinceString": "sample string 2", "City": "sample string 3" } ], "IsAttested": true, "IsRequirementMet": true, "ParentProgram": { "Id": "5e1313b6-22e6-499e-bd7a-cf521335e881", "Name": "sample string 2" }, "CreditHours": 13.0, "IsOngoingProgram": true, "IsDuplicate": true, "NonLearningTime": 16.0, "ProgramStatus": { "Label": "sample string 1", "Value": 2 }, "SubmitProgram": true, "ContactId": "ebe1d21a-bc94-40ed-9cfa-b37393d1af8c", "WebProductId": "f4de9a35-be5d-4c12-bf79-c99da1054120", "WebProductName": "sample string 20", "Receipt": { "InvoiceId": "92c885ab-8420-4506-b886-816ab8ea0b9c", "Messages": [ "sample string 1", "sample string 2" ], "InvoiceNumber": "sample string 2", "InvoiceDate": "2025-07-04T22:50:10.7864542-04:00", "TotalAmountPaid": 4.0, "PaymentAuthorizationNumber": "sample string 5" }, "IsDuplicateAllowed": true, "IsRosterUploadAllowed": true, "SubmissionDate": "sample string 23" }
application/xml, text/xml
Sample:
<ProviderProgram xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models"> <ContactId>ebe1d21a-bc94-40ed-9cfa-b37393d1af8c</ContactId> <CourseLocations> <CourseLocation> <City>sample string 3</City> <Country xmlns:d4p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers"> <d4p1:Id>5e1313b6-22e6-499e-bd7a-cf521335e881</d4p1:Id> <d4p1:Name>sample string 2</d4p1:Name> </Country> <Id>67060c20-345d-4d63-a85a-b098518a41e3</Id> <StateProvince xmlns:d4p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers"> <d4p1:Id>5e1313b6-22e6-499e-bd7a-cf521335e881</d4p1:Id> <d4p1:Name>sample string 2</d4p1:Name> </StateProvince> <StateProvinceString>sample string 2</StateProvinceString> </CourseLocation> <CourseLocation> <City>sample string 3</City> <Country xmlns:d4p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers"> <d4p1:Id>5e1313b6-22e6-499e-bd7a-cf521335e881</d4p1:Id> <d4p1:Name>sample string 2</d4p1:Name> </Country> <Id>67060c20-345d-4d63-a85a-b098518a41e3</Id> <StateProvince xmlns:d4p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers"> <d4p1:Id>5e1313b6-22e6-499e-bd7a-cf521335e881</d4p1:Id> <d4p1:Name>sample string 2</d4p1:Name> </StateProvince> <StateProvinceString>sample string 2</StateProvinceString> </CourseLocation> </CourseLocations> <CreditHours>13</CreditHours> <CreditType xmlns:d2p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers"> <d2p1:Id>5e1313b6-22e6-499e-bd7a-cf521335e881</d2p1:Id> <d2p1:Name>sample string 2</d2p1:Name> </CreditType> <EducationalTime>9</EducationalTime> <Id>e9fcddb0-e909-4915-ba22-7f1ed3c369b3</Id> <IsAttested>true</IsAttested> <IsAvailableOnline>true</IsAvailableOnline> <IsDuplicate>true</IsDuplicate> <IsDuplicateAllowed>true</IsDuplicateAllowed> <IsOngoingProgram>true</IsOngoingProgram> <IsRequirementMet>true</IsRequirementMet> <IsRosterUploadAllowed>true</IsRosterUploadAllowed> <LearningObjectives>sample string 7</LearningObjectives> <NonLearningTime>16</NonLearningTime> <ParentProgram xmlns:d2p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers"> <d2p1:Id>5e1313b6-22e6-499e-bd7a-cf521335e881</d2p1:Id> <d2p1:Name>sample string 2</d2p1:Name> </ParentProgram> <PresenterName>sample string 8</PresenterName> <ProgramEndDate>2025-07-04T22:50:10.7864542-04:00</ProgramEndDate> <ProgramId>sample string 2</ProgramId> <ProgramStartDate>2025-07-04T22:50:10.7864542-04:00</ProgramStartDate> <ProgramStatus xmlns:d2p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers"> <d2p1:Label>sample string 1</d2p1:Label> <d2p1:Value>2</d2p1:Value> </ProgramStatus> <ProgramTitle>sample string 3</ProgramTitle> <ProgramType xmlns:d2p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers"> <d2p1:Id>5e1313b6-22e6-499e-bd7a-cf521335e881</d2p1:Id> <d2p1:Name>sample string 2</d2p1:Name> </ProgramType> <ProgramURL>sample string 6</ProgramURL> <Receipt> <InvoiceDate>2025-07-04T22:50:10.7864542-04:00</InvoiceDate> <InvoiceId>92c885ab-8420-4506-b886-816ab8ea0b9c</InvoiceId> <InvoiceNumber>sample string 2</InvoiceNumber> <Messages xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:string>sample string 1</d3p1:string> <d3p1:string>sample string 2</d3p1:string> </Messages> <PaymentAuthorizationNumber>sample string 5</PaymentAuthorizationNumber> <TotalAmountPaid>4</TotalAmountPaid> </Receipt> <SubmissionDate>sample string 23</SubmissionDate> <SubmitProgram>true</SubmitProgram> <WebProductId>f4de9a35-be5d-4c12-bf79-c99da1054120</WebProductId> <WebProductName>sample string 20</WebProductName> </ProviderProgram>