PUT api/provider/program/update?accountId={accountId}
Update Program Record
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": "01c03811-726c-41de-91f4-ea4c79de332f", "ProgramType": { "Id": "e0c3fa50-d5a0-4712-a682-dd47da62ae1f", "Name": "sample string 2" }, "ProgramId": "sample string 2", "ProgramTitle": "sample string 3", "ProgramStartDate": "2024-09-16T13:44:54.7009121+00:00", "ProgramEndDate": "2024-09-16T13:44:54.7009121+00:00", "ProgramURL": "sample string 6", "LearningObjectives": "sample string 7", "PresenterName": "sample string 8", "CreditType": { "Id": "e0c3fa50-d5a0-4712-a682-dd47da62ae1f", "Name": "sample string 2" }, "EducationalTime": 9.0, "IsAvailableOnline": true, "CourseLocations": [ { "Id": "9d0ff709-eb6b-4d96-b10e-40abdc362d2c", "Country": { "Id": "e0c3fa50-d5a0-4712-a682-dd47da62ae1f", "Name": "sample string 2" }, "StateProvince": { "Id": "e0c3fa50-d5a0-4712-a682-dd47da62ae1f", "Name": "sample string 2" }, "StateProvinceString": "sample string 2", "City": "sample string 3" }, { "Id": "9d0ff709-eb6b-4d96-b10e-40abdc362d2c", "Country": { "Id": "e0c3fa50-d5a0-4712-a682-dd47da62ae1f", "Name": "sample string 2" }, "StateProvince": { "Id": "e0c3fa50-d5a0-4712-a682-dd47da62ae1f", "Name": "sample string 2" }, "StateProvinceString": "sample string 2", "City": "sample string 3" } ], "IsAttested": true, "IsRequirementMet": true, "ParentProgram": { "Id": "e0c3fa50-d5a0-4712-a682-dd47da62ae1f", "Name": "sample string 2" }, "CreditHours": 13.0, "IsOngoingProgram": true, "IsDuplicate": true, "NonLearningTime": 16.0, "ProgramStatus": { "Label": "sample string 1", "Value": 2 }, "SubmitProgram": true, "ContactId": "f9df802b-3211-441c-af6b-a6ec75a12389", "WebProductId": "5ec2771f-e50e-41a7-ad13-26c387d62ec3", "WebProductName": "sample string 20", "Receipt": { "InvoiceId": "afa5c7a0-bd03-4a6e-8968-935e78fbc58a", "Messages": [ "sample string 1", "sample string 2" ], "InvoiceNumber": "sample string 2", "InvoiceDate": "2024-09-16T13:44:54.7165391+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>f9df802b-3211-441c-af6b-a6ec75a12389</ContactId> <CourseLocations> <CourseLocation> <City>sample string 3</City> <Country xmlns:d4p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers"> <d4p1:Id>e0c3fa50-d5a0-4712-a682-dd47da62ae1f</d4p1:Id> <d4p1:Name>sample string 2</d4p1:Name> </Country> <Id>9d0ff709-eb6b-4d96-b10e-40abdc362d2c</Id> <StateProvince xmlns:d4p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers"> <d4p1:Id>e0c3fa50-d5a0-4712-a682-dd47da62ae1f</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>e0c3fa50-d5a0-4712-a682-dd47da62ae1f</d4p1:Id> <d4p1:Name>sample string 2</d4p1:Name> </Country> <Id>9d0ff709-eb6b-4d96-b10e-40abdc362d2c</Id> <StateProvince xmlns:d4p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers"> <d4p1:Id>e0c3fa50-d5a0-4712-a682-dd47da62ae1f</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>e0c3fa50-d5a0-4712-a682-dd47da62ae1f</d2p1:Id> <d2p1:Name>sample string 2</d2p1:Name> </CreditType> <EducationalTime>9</EducationalTime> <Id>01c03811-726c-41de-91f4-ea4c79de332f</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>e0c3fa50-d5a0-4712-a682-dd47da62ae1f</d2p1:Id> <d2p1:Name>sample string 2</d2p1:Name> </ParentProgram> <PresenterName>sample string 8</PresenterName> <ProgramEndDate>2024-09-16T13:44:54.7009121+00:00</ProgramEndDate> <ProgramId>sample string 2</ProgramId> <ProgramStartDate>2024-09-16T13:44:54.7009121+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>e0c3fa50-d5a0-4712-a682-dd47da62ae1f</d2p1:Id> <d2p1:Name>sample string 2</d2p1:Name> </ProgramType> <ProgramURL>sample string 6</ProgramURL> <Receipt> <InvoiceDate>2024-09-16T13:44:54.7165391+00:00</InvoiceDate> <InvoiceId>afa5c7a0-bd03-4a6e-8968-935e78fbc58a</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>5ec2771f-e50e-41a7-ad13-26c387d62ec3</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": "185acf93-acde-4bd8-a0e3-b339bb320995", "ProgramType": { "Id": "571b05fc-dba3-45c1-a626-4110ac11643e", "Name": "sample string 2" }, "ProgramId": "sample string 2", "ProgramTitle": "sample string 3", "ProgramStartDate": "2024-09-16T13:44:54.7321646+00:00", "ProgramEndDate": "2024-09-16T13:44:54.7321646+00:00", "ProgramURL": "sample string 6", "LearningObjectives": "sample string 7", "PresenterName": "sample string 8", "CreditType": { "Id": "571b05fc-dba3-45c1-a626-4110ac11643e", "Name": "sample string 2" }, "EducationalTime": 9.0, "IsAvailableOnline": true, "CourseLocations": [ { "Id": "d008aca6-28ec-498a-bae6-2ec9960dc2fd", "Country": { "Id": "571b05fc-dba3-45c1-a626-4110ac11643e", "Name": "sample string 2" }, "StateProvince": { "Id": "571b05fc-dba3-45c1-a626-4110ac11643e", "Name": "sample string 2" }, "StateProvinceString": "sample string 2", "City": "sample string 3" }, { "Id": "d008aca6-28ec-498a-bae6-2ec9960dc2fd", "Country": { "Id": "571b05fc-dba3-45c1-a626-4110ac11643e", "Name": "sample string 2" }, "StateProvince": { "Id": "571b05fc-dba3-45c1-a626-4110ac11643e", "Name": "sample string 2" }, "StateProvinceString": "sample string 2", "City": "sample string 3" } ], "IsAttested": true, "IsRequirementMet": true, "ParentProgram": { "Id": "571b05fc-dba3-45c1-a626-4110ac11643e", "Name": "sample string 2" }, "CreditHours": 13.0, "IsOngoingProgram": true, "IsDuplicate": true, "NonLearningTime": 16.0, "ProgramStatus": { "Label": "sample string 1", "Value": 2 }, "SubmitProgram": true, "ContactId": "4c2d05eb-4585-45e0-b6b1-ba71c82992be", "WebProductId": "accbab4d-5115-4895-accd-b1dfe95c14e5", "WebProductName": "sample string 20", "Receipt": { "InvoiceId": "1827d2f3-ffd5-47af-9efd-84e8089f19b9", "Messages": [ "sample string 1", "sample string 2" ], "InvoiceNumber": "sample string 2", "InvoiceDate": "2024-09-16T13:44:54.7321646+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>4c2d05eb-4585-45e0-b6b1-ba71c82992be</ContactId> <CourseLocations> <CourseLocation> <City>sample string 3</City> <Country xmlns:d4p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers"> <d4p1:Id>571b05fc-dba3-45c1-a626-4110ac11643e</d4p1:Id> <d4p1:Name>sample string 2</d4p1:Name> </Country> <Id>d008aca6-28ec-498a-bae6-2ec9960dc2fd</Id> <StateProvince xmlns:d4p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers"> <d4p1:Id>571b05fc-dba3-45c1-a626-4110ac11643e</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>571b05fc-dba3-45c1-a626-4110ac11643e</d4p1:Id> <d4p1:Name>sample string 2</d4p1:Name> </Country> <Id>d008aca6-28ec-498a-bae6-2ec9960dc2fd</Id> <StateProvince xmlns:d4p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers"> <d4p1:Id>571b05fc-dba3-45c1-a626-4110ac11643e</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>571b05fc-dba3-45c1-a626-4110ac11643e</d2p1:Id> <d2p1:Name>sample string 2</d2p1:Name> </CreditType> <EducationalTime>9</EducationalTime> <Id>185acf93-acde-4bd8-a0e3-b339bb320995</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>571b05fc-dba3-45c1-a626-4110ac11643e</d2p1:Id> <d2p1:Name>sample string 2</d2p1:Name> </ParentProgram> <PresenterName>sample string 8</PresenterName> <ProgramEndDate>2024-09-16T13:44:54.7321646+00:00</ProgramEndDate> <ProgramId>sample string 2</ProgramId> <ProgramStartDate>2024-09-16T13:44:54.7321646+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>571b05fc-dba3-45c1-a626-4110ac11643e</d2p1:Id> <d2p1:Name>sample string 2</d2p1:Name> </ProgramType> <ProgramURL>sample string 6</ProgramURL> <Receipt> <InvoiceDate>2024-09-16T13:44:54.7321646+00:00</InvoiceDate> <InvoiceId>1827d2f3-ffd5-47af-9efd-84e8089f19b9</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>accbab4d-5115-4895-accd-b1dfe95c14e5</WebProductId> <WebProductName>sample string 20</WebProductName> </ProviderProgram>