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": "b50885dc-9e26-4363-b893-73d2eb548995", "ProgramType": { "Id": "19f49322-8db7-4a7b-807d-91c45f00e5a3", "Name": "sample string 2" }, "ProgramId": "sample string 2", "ProgramTitle": "sample string 3", "ProgramStartDate": "2025-01-17T18:57:20.8193041-05:00", "ProgramEndDate": "2025-01-17T18:57:20.8193041-05:00", "ProgramURL": "sample string 6", "LearningObjectives": "sample string 7", "PresenterName": "sample string 8", "CreditType": { "Id": "19f49322-8db7-4a7b-807d-91c45f00e5a3", "Name": "sample string 2" }, "EducationalTime": 9.0, "IsAvailableOnline": true, "CourseLocations": [ { "Id": "50da749a-ad6f-44d7-b362-9ad898e38883", "Country": { "Id": "19f49322-8db7-4a7b-807d-91c45f00e5a3", "Name": "sample string 2" }, "StateProvince": { "Id": "19f49322-8db7-4a7b-807d-91c45f00e5a3", "Name": "sample string 2" }, "StateProvinceString": "sample string 2", "City": "sample string 3" }, { "Id": "50da749a-ad6f-44d7-b362-9ad898e38883", "Country": { "Id": "19f49322-8db7-4a7b-807d-91c45f00e5a3", "Name": "sample string 2" }, "StateProvince": { "Id": "19f49322-8db7-4a7b-807d-91c45f00e5a3", "Name": "sample string 2" }, "StateProvinceString": "sample string 2", "City": "sample string 3" } ], "IsAttested": true, "IsRequirementMet": true, "ParentProgram": { "Id": "19f49322-8db7-4a7b-807d-91c45f00e5a3", "Name": "sample string 2" }, "CreditHours": 13.0, "IsOngoingProgram": true, "IsDuplicate": true, "NonLearningTime": 16.0, "ProgramStatus": { "Label": "sample string 1", "Value": 2 }, "SubmitProgram": true, "ContactId": "434dae53-824b-49ee-98c9-77b4f5b2ebf0", "WebProductId": "666c0b58-b58e-4326-ba91-920e92b00f4e", "WebProductName": "sample string 20", "Receipt": { "InvoiceId": "4d14828a-ceb8-4ee0-b64b-dd8bf12c8dad", "Messages": [ "sample string 1", "sample string 2" ], "InvoiceNumber": "sample string 2", "InvoiceDate": "2025-01-17T18:57:20.8193041-05: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>434dae53-824b-49ee-98c9-77b4f5b2ebf0</ContactId> <CourseLocations> <CourseLocation> <City>sample string 3</City> <Country xmlns:d4p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers"> <d4p1:Id>19f49322-8db7-4a7b-807d-91c45f00e5a3</d4p1:Id> <d4p1:Name>sample string 2</d4p1:Name> </Country> <Id>50da749a-ad6f-44d7-b362-9ad898e38883</Id> <StateProvince xmlns:d4p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers"> <d4p1:Id>19f49322-8db7-4a7b-807d-91c45f00e5a3</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>19f49322-8db7-4a7b-807d-91c45f00e5a3</d4p1:Id> <d4p1:Name>sample string 2</d4p1:Name> </Country> <Id>50da749a-ad6f-44d7-b362-9ad898e38883</Id> <StateProvince xmlns:d4p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers"> <d4p1:Id>19f49322-8db7-4a7b-807d-91c45f00e5a3</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>19f49322-8db7-4a7b-807d-91c45f00e5a3</d2p1:Id> <d2p1:Name>sample string 2</d2p1:Name> </CreditType> <EducationalTime>9</EducationalTime> <Id>b50885dc-9e26-4363-b893-73d2eb548995</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>19f49322-8db7-4a7b-807d-91c45f00e5a3</d2p1:Id> <d2p1:Name>sample string 2</d2p1:Name> </ParentProgram> <PresenterName>sample string 8</PresenterName> <ProgramEndDate>2025-01-17T18:57:20.8193041-05:00</ProgramEndDate> <ProgramId>sample string 2</ProgramId> <ProgramStartDate>2025-01-17T18:57:20.8193041-05: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>19f49322-8db7-4a7b-807d-91c45f00e5a3</d2p1:Id> <d2p1:Name>sample string 2</d2p1:Name> </ProgramType> <ProgramURL>sample string 6</ProgramURL> <Receipt> <InvoiceDate>2025-01-17T18:57:20.8193041-05:00</InvoiceDate> <InvoiceId>4d14828a-ceb8-4ee0-b64b-dd8bf12c8dad</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>666c0b58-b58e-4326-ba91-920e92b00f4e</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": "275f8ebc-5ee3-4db9-b37b-1530f9478c5e", "ProgramType": { "Id": "de245367-f9f8-434d-9d63-4016451cbcf1", "Name": "sample string 2" }, "ProgramId": "sample string 2", "ProgramTitle": "sample string 3", "ProgramStartDate": "2025-01-17T18:57:20.8193041-05:00", "ProgramEndDate": "2025-01-17T18:57:20.8193041-05:00", "ProgramURL": "sample string 6", "LearningObjectives": "sample string 7", "PresenterName": "sample string 8", "CreditType": { "Id": "de245367-f9f8-434d-9d63-4016451cbcf1", "Name": "sample string 2" }, "EducationalTime": 9.0, "IsAvailableOnline": true, "CourseLocations": [ { "Id": "0393114b-dc45-46fd-9f96-6ec324b24631", "Country": { "Id": "de245367-f9f8-434d-9d63-4016451cbcf1", "Name": "sample string 2" }, "StateProvince": { "Id": "de245367-f9f8-434d-9d63-4016451cbcf1", "Name": "sample string 2" }, "StateProvinceString": "sample string 2", "City": "sample string 3" }, { "Id": "0393114b-dc45-46fd-9f96-6ec324b24631", "Country": { "Id": "de245367-f9f8-434d-9d63-4016451cbcf1", "Name": "sample string 2" }, "StateProvince": { "Id": "de245367-f9f8-434d-9d63-4016451cbcf1", "Name": "sample string 2" }, "StateProvinceString": "sample string 2", "City": "sample string 3" } ], "IsAttested": true, "IsRequirementMet": true, "ParentProgram": { "Id": "de245367-f9f8-434d-9d63-4016451cbcf1", "Name": "sample string 2" }, "CreditHours": 13.0, "IsOngoingProgram": true, "IsDuplicate": true, "NonLearningTime": 16.0, "ProgramStatus": { "Label": "sample string 1", "Value": 2 }, "SubmitProgram": true, "ContactId": "d6c5b48a-ec69-4fd1-aac4-0f81e649f1b0", "WebProductId": "78514bcb-671a-43d0-999b-51bf0e4763f7", "WebProductName": "sample string 20", "Receipt": { "InvoiceId": "e0e180ad-eb2c-48ba-a805-7aad0d26d72a", "Messages": [ "sample string 1", "sample string 2" ], "InvoiceNumber": "sample string 2", "InvoiceDate": "2025-01-17T18:57:20.8193041-05: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>d6c5b48a-ec69-4fd1-aac4-0f81e649f1b0</ContactId> <CourseLocations> <CourseLocation> <City>sample string 3</City> <Country xmlns:d4p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers"> <d4p1:Id>de245367-f9f8-434d-9d63-4016451cbcf1</d4p1:Id> <d4p1:Name>sample string 2</d4p1:Name> </Country> <Id>0393114b-dc45-46fd-9f96-6ec324b24631</Id> <StateProvince xmlns:d4p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers"> <d4p1:Id>de245367-f9f8-434d-9d63-4016451cbcf1</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>de245367-f9f8-434d-9d63-4016451cbcf1</d4p1:Id> <d4p1:Name>sample string 2</d4p1:Name> </Country> <Id>0393114b-dc45-46fd-9f96-6ec324b24631</Id> <StateProvince xmlns:d4p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers"> <d4p1:Id>de245367-f9f8-434d-9d63-4016451cbcf1</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>de245367-f9f8-434d-9d63-4016451cbcf1</d2p1:Id> <d2p1:Name>sample string 2</d2p1:Name> </CreditType> <EducationalTime>9</EducationalTime> <Id>275f8ebc-5ee3-4db9-b37b-1530f9478c5e</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>de245367-f9f8-434d-9d63-4016451cbcf1</d2p1:Id> <d2p1:Name>sample string 2</d2p1:Name> </ParentProgram> <PresenterName>sample string 8</PresenterName> <ProgramEndDate>2025-01-17T18:57:20.8193041-05:00</ProgramEndDate> <ProgramId>sample string 2</ProgramId> <ProgramStartDate>2025-01-17T18:57:20.8193041-05: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>de245367-f9f8-434d-9d63-4016451cbcf1</d2p1:Id> <d2p1:Name>sample string 2</d2p1:Name> </ProgramType> <ProgramURL>sample string 6</ProgramURL> <Receipt> <InvoiceDate>2025-01-17T18:57:20.8193041-05:00</InvoiceDate> <InvoiceId>e0e180ad-eb2c-48ba-a805-7aad0d26d72a</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>78514bcb-671a-43d0-999b-51bf0e4763f7</WebProductId> <WebProductName>sample string 20</WebProductName> </ProviderProgram>