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. |
Request Formats
application/json, text/json
Sample:
{ "Id": "4efe4881-3c4c-4e1e-8c71-240b78fa386a", "ProgramType": { "Id": "a5d5e8d0-e291-4003-afc7-f800ae2dcb7c", "Name": "sample string 2" }, "ProgramId": "sample string 2", "ProgramTitle": "sample string 3", "ProgramStartDate": "2025-04-26T14:41:42.3919541+00:00", "ProgramEndDate": "2025-04-26T14:41:42.3919541+00:00", "ProgramURL": "sample string 6", "LearningObjectives": "sample string 7", "PresenterName": "sample string 8", "CreditType": { "Id": "a5d5e8d0-e291-4003-afc7-f800ae2dcb7c", "Name": "sample string 2" }, "EducationalTime": 9.0, "IsAvailableOnline": true, "CourseLocations": [ { "Id": "d406e370-c971-496d-b59b-e0ac8d50b7cd", "Country": { "Id": "a5d5e8d0-e291-4003-afc7-f800ae2dcb7c", "Name": "sample string 2" }, "StateProvince": { "Id": "a5d5e8d0-e291-4003-afc7-f800ae2dcb7c", "Name": "sample string 2" }, "StateProvinceString": "sample string 2", "City": "sample string 3" }, { "Id": "d406e370-c971-496d-b59b-e0ac8d50b7cd", "Country": { "Id": "a5d5e8d0-e291-4003-afc7-f800ae2dcb7c", "Name": "sample string 2" }, "StateProvince": { "Id": "a5d5e8d0-e291-4003-afc7-f800ae2dcb7c", "Name": "sample string 2" }, "StateProvinceString": "sample string 2", "City": "sample string 3" } ], "IsAttested": true, "IsRequirementMet": true, "ParentProgram": { "Id": "a5d5e8d0-e291-4003-afc7-f800ae2dcb7c", "Name": "sample string 2" }, "CreditHours": 13.0, "IsOngoingProgram": true, "IsDuplicate": true, "NonLearningTime": 16.0, "ProgramStatus": { "Label": "sample string 1", "Value": 2 }, "SubmitProgram": true, "ContactId": "63dd517d-c127-4a20-b114-4532ca6672fa", "WebProductId": "ec6925de-8850-424b-9e97-019a751f8b4b", "WebProductName": "sample string 20", "Receipt": { "InvoiceId": "e2fb94e8-76b2-4d4e-b459-a2808a9fb217", "Messages": [ "sample string 1", "sample string 2" ], "InvoiceNumber": "sample string 2", "InvoiceDate": "2025-04-26T14:41:42.3919541+00:00", "TotalAmountPaid": 4.0, "PaymentAuthorizationNumber": "sample string 5" } }
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>63dd517d-c127-4a20-b114-4532ca6672fa</ContactId> <CourseLocations> <CourseLocation> <City>sample string 3</City> <Country xmlns:d4p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers"> <d4p1:Id>a5d5e8d0-e291-4003-afc7-f800ae2dcb7c</d4p1:Id> <d4p1:Name>sample string 2</d4p1:Name> </Country> <Id>d406e370-c971-496d-b59b-e0ac8d50b7cd</Id> <StateProvince xmlns:d4p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers"> <d4p1:Id>a5d5e8d0-e291-4003-afc7-f800ae2dcb7c</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>a5d5e8d0-e291-4003-afc7-f800ae2dcb7c</d4p1:Id> <d4p1:Name>sample string 2</d4p1:Name> </Country> <Id>d406e370-c971-496d-b59b-e0ac8d50b7cd</Id> <StateProvince xmlns:d4p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers"> <d4p1:Id>a5d5e8d0-e291-4003-afc7-f800ae2dcb7c</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>a5d5e8d0-e291-4003-afc7-f800ae2dcb7c</d2p1:Id> <d2p1:Name>sample string 2</d2p1:Name> </CreditType> <EducationalTime>9</EducationalTime> <Id>4efe4881-3c4c-4e1e-8c71-240b78fa386a</Id> <IsAttested>true</IsAttested> <IsAvailableOnline>true</IsAvailableOnline> <IsDuplicate>true</IsDuplicate> <IsOngoingProgram>true</IsOngoingProgram> <IsRequirementMet>true</IsRequirementMet> <LearningObjectives>sample string 7</LearningObjectives> <NonLearningTime>16</NonLearningTime> <ParentProgram xmlns:d2p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers"> <d2p1:Id>a5d5e8d0-e291-4003-afc7-f800ae2dcb7c</d2p1:Id> <d2p1:Name>sample string 2</d2p1:Name> </ParentProgram> <PresenterName>sample string 8</PresenterName> <ProgramEndDate>2025-04-26T14:41:42.3919541+00:00</ProgramEndDate> <ProgramId>sample string 2</ProgramId> <ProgramStartDate>2025-04-26T14:41:42.3919541+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>a5d5e8d0-e291-4003-afc7-f800ae2dcb7c</d2p1:Id> <d2p1:Name>sample string 2</d2p1:Name> </ProgramType> <ProgramURL>sample string 6</ProgramURL> <Receipt> <InvoiceDate>2025-04-26T14:41:42.3919541+00:00</InvoiceDate> <InvoiceId>e2fb94e8-76b2-4d4e-b459-a2808a9fb217</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> <SubmitProgram>true</SubmitProgram> <WebProductId>ec6925de-8850-424b-9e97-019a751f8b4b</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. |
Response Formats
application/json, text/json
Sample:
{ "Id": "c767d88f-b0e4-4e16-926d-a14417fdddbe", "ProgramType": { "Id": "f6b78069-337d-4f38-8085-c81adacd74d7", "Name": "sample string 2" }, "ProgramId": "sample string 2", "ProgramTitle": "sample string 3", "ProgramStartDate": "2025-04-26T14:41:42.3919541+00:00", "ProgramEndDate": "2025-04-26T14:41:42.3919541+00:00", "ProgramURL": "sample string 6", "LearningObjectives": "sample string 7", "PresenterName": "sample string 8", "CreditType": { "Id": "f6b78069-337d-4f38-8085-c81adacd74d7", "Name": "sample string 2" }, "EducationalTime": 9.0, "IsAvailableOnline": true, "CourseLocations": [ { "Id": "1854bb1a-6f2c-4af8-8bd5-c0bdfdba6a76", "Country": { "Id": "f6b78069-337d-4f38-8085-c81adacd74d7", "Name": "sample string 2" }, "StateProvince": { "Id": "f6b78069-337d-4f38-8085-c81adacd74d7", "Name": "sample string 2" }, "StateProvinceString": "sample string 2", "City": "sample string 3" }, { "Id": "1854bb1a-6f2c-4af8-8bd5-c0bdfdba6a76", "Country": { "Id": "f6b78069-337d-4f38-8085-c81adacd74d7", "Name": "sample string 2" }, "StateProvince": { "Id": "f6b78069-337d-4f38-8085-c81adacd74d7", "Name": "sample string 2" }, "StateProvinceString": "sample string 2", "City": "sample string 3" } ], "IsAttested": true, "IsRequirementMet": true, "ParentProgram": { "Id": "f6b78069-337d-4f38-8085-c81adacd74d7", "Name": "sample string 2" }, "CreditHours": 13.0, "IsOngoingProgram": true, "IsDuplicate": true, "NonLearningTime": 16.0, "ProgramStatus": { "Label": "sample string 1", "Value": 2 }, "SubmitProgram": true, "ContactId": "07c04c8c-4c16-4606-8118-644ae43b2d38", "WebProductId": "e65fa1ef-af3d-4e34-87de-68455083653d", "WebProductName": "sample string 20", "Receipt": { "InvoiceId": "f0cd7c7a-1a1f-4320-a114-28ee9894bd56", "Messages": [ "sample string 1", "sample string 2" ], "InvoiceNumber": "sample string 2", "InvoiceDate": "2025-04-26T14:41:42.3919541+00:00", "TotalAmountPaid": 4.0, "PaymentAuthorizationNumber": "sample string 5" } }
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>07c04c8c-4c16-4606-8118-644ae43b2d38</ContactId> <CourseLocations> <CourseLocation> <City>sample string 3</City> <Country xmlns:d4p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers"> <d4p1:Id>f6b78069-337d-4f38-8085-c81adacd74d7</d4p1:Id> <d4p1:Name>sample string 2</d4p1:Name> </Country> <Id>1854bb1a-6f2c-4af8-8bd5-c0bdfdba6a76</Id> <StateProvince xmlns:d4p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers"> <d4p1:Id>f6b78069-337d-4f38-8085-c81adacd74d7</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>f6b78069-337d-4f38-8085-c81adacd74d7</d4p1:Id> <d4p1:Name>sample string 2</d4p1:Name> </Country> <Id>1854bb1a-6f2c-4af8-8bd5-c0bdfdba6a76</Id> <StateProvince xmlns:d4p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers"> <d4p1:Id>f6b78069-337d-4f38-8085-c81adacd74d7</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>f6b78069-337d-4f38-8085-c81adacd74d7</d2p1:Id> <d2p1:Name>sample string 2</d2p1:Name> </CreditType> <EducationalTime>9</EducationalTime> <Id>c767d88f-b0e4-4e16-926d-a14417fdddbe</Id> <IsAttested>true</IsAttested> <IsAvailableOnline>true</IsAvailableOnline> <IsDuplicate>true</IsDuplicate> <IsOngoingProgram>true</IsOngoingProgram> <IsRequirementMet>true</IsRequirementMet> <LearningObjectives>sample string 7</LearningObjectives> <NonLearningTime>16</NonLearningTime> <ParentProgram xmlns:d2p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers"> <d2p1:Id>f6b78069-337d-4f38-8085-c81adacd74d7</d2p1:Id> <d2p1:Name>sample string 2</d2p1:Name> </ParentProgram> <PresenterName>sample string 8</PresenterName> <ProgramEndDate>2025-04-26T14:41:42.3919541+00:00</ProgramEndDate> <ProgramId>sample string 2</ProgramId> <ProgramStartDate>2025-04-26T14:41:42.3919541+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>f6b78069-337d-4f38-8085-c81adacd74d7</d2p1:Id> <d2p1:Name>sample string 2</d2p1:Name> </ProgramType> <ProgramURL>sample string 6</ProgramURL> <Receipt> <InvoiceDate>2025-04-26T14:41:42.3919541+00:00</InvoiceDate> <InvoiceId>f0cd7c7a-1a1f-4320-a114-28ee9894bd56</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> <SubmitProgram>true</SubmitProgram> <WebProductId>e65fa1ef-af3d-4e34-87de-68455083653d</WebProductId> <WebProductName>sample string 20</WebProductName> </ProviderProgram>