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": "80899e88-3649-442d-aed0-e96f37edafb1", "ProgramType": { "Id": "26d7dc8d-1961-4899-b754-e4b210b4224c", "Name": "sample string 2" }, "ProgramId": "sample string 2", "ProgramTitle": "sample string 3", "ProgramStartDate": "2025-09-15T12:40:57.032372+00:00", "ProgramEndDate": "2025-09-15T12:40:57.032372+00:00", "ProgramURL": "sample string 6", "LearningObjectives": "sample string 7", "PresenterName": "sample string 8", "CreditType": { "Id": "26d7dc8d-1961-4899-b754-e4b210b4224c", "Name": "sample string 2" }, "EducationalTime": 9.0, "IsAvailableOnline": true, "CourseLocations": [ { "Id": "81c965a9-4d5e-4982-af72-a9558063d416", "Country": { "Id": "26d7dc8d-1961-4899-b754-e4b210b4224c", "Name": "sample string 2" }, "StateProvince": { "Id": "26d7dc8d-1961-4899-b754-e4b210b4224c", "Name": "sample string 2" }, "StateProvinceString": "sample string 2", "City": "sample string 3" }, { "Id": "81c965a9-4d5e-4982-af72-a9558063d416", "Country": { "Id": "26d7dc8d-1961-4899-b754-e4b210b4224c", "Name": "sample string 2" }, "StateProvince": { "Id": "26d7dc8d-1961-4899-b754-e4b210b4224c", "Name": "sample string 2" }, "StateProvinceString": "sample string 2", "City": "sample string 3" } ], "IsAttested": true, "IsRequirementMet": true, "ParentProgram": { "Id": "26d7dc8d-1961-4899-b754-e4b210b4224c", "Name": "sample string 2" }, "CreditHours": 13.0, "IsOngoingProgram": true, "IsDuplicate": true, "NonLearningTime": 16.0, "ProgramStatus": { "Label": "sample string 1", "Value": 2 }, "SubmitProgram": true, "ContactId": "a2f49d37-8dbc-4886-8a51-407810ba3d17", "WebProductId": "c59b9480-55fd-4a93-aa65-0040b498e9ff", "WebProductName": "sample string 20", "Receipt": { "InvoiceId": "8bfa06b5-8cfb-4eda-84a7-5022e7f28674", "Messages": [ "sample string 1", "sample string 2" ], "InvoiceNumber": "sample string 2", "InvoiceDate": "2025-09-15T12:40:57.0479745+00: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>a2f49d37-8dbc-4886-8a51-407810ba3d17</ContactId> <CourseLocations> <CourseLocation> <City>sample string 3</City> <Country xmlns:d4p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers"> <d4p1:Id>26d7dc8d-1961-4899-b754-e4b210b4224c</d4p1:Id> <d4p1:Name>sample string 2</d4p1:Name> </Country> <Id>81c965a9-4d5e-4982-af72-a9558063d416</Id> <StateProvince xmlns:d4p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers"> <d4p1:Id>26d7dc8d-1961-4899-b754-e4b210b4224c</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>26d7dc8d-1961-4899-b754-e4b210b4224c</d4p1:Id> <d4p1:Name>sample string 2</d4p1:Name> </Country> <Id>81c965a9-4d5e-4982-af72-a9558063d416</Id> <StateProvince xmlns:d4p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers"> <d4p1:Id>26d7dc8d-1961-4899-b754-e4b210b4224c</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>26d7dc8d-1961-4899-b754-e4b210b4224c</d2p1:Id> <d2p1:Name>sample string 2</d2p1:Name> </CreditType> <EducationalTime>9</EducationalTime> <Id>80899e88-3649-442d-aed0-e96f37edafb1</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>26d7dc8d-1961-4899-b754-e4b210b4224c</d2p1:Id> <d2p1:Name>sample string 2</d2p1:Name> </ParentProgram> <PresenterName>sample string 8</PresenterName> <ProgramEndDate>2025-09-15T12:40:57.032372+00:00</ProgramEndDate> <ProgramId>sample string 2</ProgramId> <ProgramStartDate>2025-09-15T12:40:57.032372+00: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>26d7dc8d-1961-4899-b754-e4b210b4224c</d2p1:Id> <d2p1:Name>sample string 2</d2p1:Name> </ProgramType> <ProgramURL>sample string 6</ProgramURL> <Receipt> <InvoiceDate>2025-09-15T12:40:57.0479745+00:00</InvoiceDate> <InvoiceId>8bfa06b5-8cfb-4eda-84a7-5022e7f28674</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>c59b9480-55fd-4a93-aa65-0040b498e9ff</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": "374930b6-e4b6-4d25-84fc-fdef221a63e3", "ProgramType": { "Id": "b76a9fa9-2afd-4b8c-b880-f00e2f3b8769", "Name": "sample string 2" }, "ProgramId": "sample string 2", "ProgramTitle": "sample string 3", "ProgramStartDate": "2025-09-15T12:40:57.2408067+00:00", "ProgramEndDate": "2025-09-15T12:40:57.2408067+00:00", "ProgramURL": "sample string 6", "LearningObjectives": "sample string 7", "PresenterName": "sample string 8", "CreditType": { "Id": "b76a9fa9-2afd-4b8c-b880-f00e2f3b8769", "Name": "sample string 2" }, "EducationalTime": 9.0, "IsAvailableOnline": true, "CourseLocations": [ { "Id": "8d165964-af3c-4bb0-b753-224faa6ecb75", "Country": { "Id": "b76a9fa9-2afd-4b8c-b880-f00e2f3b8769", "Name": "sample string 2" }, "StateProvince": { "Id": "b76a9fa9-2afd-4b8c-b880-f00e2f3b8769", "Name": "sample string 2" }, "StateProvinceString": "sample string 2", "City": "sample string 3" }, { "Id": "8d165964-af3c-4bb0-b753-224faa6ecb75", "Country": { "Id": "b76a9fa9-2afd-4b8c-b880-f00e2f3b8769", "Name": "sample string 2" }, "StateProvince": { "Id": "b76a9fa9-2afd-4b8c-b880-f00e2f3b8769", "Name": "sample string 2" }, "StateProvinceString": "sample string 2", "City": "sample string 3" } ], "IsAttested": true, "IsRequirementMet": true, "ParentProgram": { "Id": "b76a9fa9-2afd-4b8c-b880-f00e2f3b8769", "Name": "sample string 2" }, "CreditHours": 13.0, "IsOngoingProgram": true, "IsDuplicate": true, "NonLearningTime": 16.0, "ProgramStatus": { "Label": "sample string 1", "Value": 2 }, "SubmitProgram": true, "ContactId": "e4038160-b1e8-4a7c-83b7-afadceb0acf1", "WebProductId": "2a4a43d7-47c1-4b66-887a-b17a6b33acb6", "WebProductName": "sample string 20", "Receipt": { "InvoiceId": "1897129e-d9f9-4884-9bdd-7c3beb9b75c1", "Messages": [ "sample string 1", "sample string 2" ], "InvoiceNumber": "sample string 2", "InvoiceDate": "2025-09-15T12:40:57.2408067+00: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>e4038160-b1e8-4a7c-83b7-afadceb0acf1</ContactId> <CourseLocations> <CourseLocation> <City>sample string 3</City> <Country xmlns:d4p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers"> <d4p1:Id>b76a9fa9-2afd-4b8c-b880-f00e2f3b8769</d4p1:Id> <d4p1:Name>sample string 2</d4p1:Name> </Country> <Id>8d165964-af3c-4bb0-b753-224faa6ecb75</Id> <StateProvince xmlns:d4p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers"> <d4p1:Id>b76a9fa9-2afd-4b8c-b880-f00e2f3b8769</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>b76a9fa9-2afd-4b8c-b880-f00e2f3b8769</d4p1:Id> <d4p1:Name>sample string 2</d4p1:Name> </Country> <Id>8d165964-af3c-4bb0-b753-224faa6ecb75</Id> <StateProvince xmlns:d4p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers"> <d4p1:Id>b76a9fa9-2afd-4b8c-b880-f00e2f3b8769</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>b76a9fa9-2afd-4b8c-b880-f00e2f3b8769</d2p1:Id> <d2p1:Name>sample string 2</d2p1:Name> </CreditType> <EducationalTime>9</EducationalTime> <Id>374930b6-e4b6-4d25-84fc-fdef221a63e3</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>b76a9fa9-2afd-4b8c-b880-f00e2f3b8769</d2p1:Id> <d2p1:Name>sample string 2</d2p1:Name> </ParentProgram> <PresenterName>sample string 8</PresenterName> <ProgramEndDate>2025-09-15T12:40:57.2408067+00:00</ProgramEndDate> <ProgramId>sample string 2</ProgramId> <ProgramStartDate>2025-09-15T12:40:57.2408067+00: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>b76a9fa9-2afd-4b8c-b880-f00e2f3b8769</d2p1:Id> <d2p1:Name>sample string 2</d2p1:Name> </ProgramType> <ProgramURL>sample string 6</ProgramURL> <Receipt> <InvoiceDate>2025-09-15T12:40:57.2408067+00:00</InvoiceDate> <InvoiceId>1897129e-d9f9-4884-9bdd-7c3beb9b75c1</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>2a4a43d7-47c1-4b66-887a-b17a6b33acb6</WebProductId> <WebProductName>sample string 20</WebProductName> </ProviderProgram>