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": "921ba184-250f-4087-a422-5fdf66a443b3", "ProgramType": { "Id": "18b6096b-ec35-4fb5-8157-a09cb09d3837", "Name": "sample string 2" }, "ProgramId": "sample string 2", "ProgramTitle": "sample string 3", "ProgramStartDate": "2024-12-14T04:04:51.9866138+00:00", "ProgramEndDate": "2024-12-14T04:04:51.9866138+00:00", "ProgramURL": "sample string 6", "LearningObjectives": "sample string 7", "PresenterName": "sample string 8", "CreditType": { "Id": "18b6096b-ec35-4fb5-8157-a09cb09d3837", "Name": "sample string 2" }, "EducationalTime": 9.0, "IsAvailableOnline": true, "CourseLocations": [ { "Id": "ca0cc3f6-b695-486a-943c-da78fb1082e4", "Country": { "Id": "18b6096b-ec35-4fb5-8157-a09cb09d3837", "Name": "sample string 2" }, "StateProvince": { "Id": "18b6096b-ec35-4fb5-8157-a09cb09d3837", "Name": "sample string 2" }, "StateProvinceString": "sample string 2", "City": "sample string 3" }, { "Id": "ca0cc3f6-b695-486a-943c-da78fb1082e4", "Country": { "Id": "18b6096b-ec35-4fb5-8157-a09cb09d3837", "Name": "sample string 2" }, "StateProvince": { "Id": "18b6096b-ec35-4fb5-8157-a09cb09d3837", "Name": "sample string 2" }, "StateProvinceString": "sample string 2", "City": "sample string 3" } ], "IsAttested": true, "IsRequirementMet": true, "ParentProgram": { "Id": "18b6096b-ec35-4fb5-8157-a09cb09d3837", "Name": "sample string 2" }, "CreditHours": 13.0, "IsOngoingProgram": true, "IsDuplicate": true, "NonLearningTime": 16.0, "ProgramStatus": { "Label": "sample string 1", "Value": 2 }, "SubmitProgram": true, "ContactId": "adad9b8e-41e6-40fa-b670-306d49a51cd5", "WebProductId": "8751f18c-5567-4b37-9816-09027db5f5ad", "WebProductName": "sample string 20", "Receipt": { "InvoiceId": "6f11fe9e-29b9-4445-85a2-00ba2bd35c7b", "Messages": [ "sample string 1", "sample string 2" ], "InvoiceNumber": "sample string 2", "InvoiceDate": "2024-12-14T04:04:51.9866138+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>adad9b8e-41e6-40fa-b670-306d49a51cd5</ContactId> <CourseLocations> <CourseLocation> <City>sample string 3</City> <Country xmlns:d4p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers"> <d4p1:Id>18b6096b-ec35-4fb5-8157-a09cb09d3837</d4p1:Id> <d4p1:Name>sample string 2</d4p1:Name> </Country> <Id>ca0cc3f6-b695-486a-943c-da78fb1082e4</Id> <StateProvince xmlns:d4p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers"> <d4p1:Id>18b6096b-ec35-4fb5-8157-a09cb09d3837</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>18b6096b-ec35-4fb5-8157-a09cb09d3837</d4p1:Id> <d4p1:Name>sample string 2</d4p1:Name> </Country> <Id>ca0cc3f6-b695-486a-943c-da78fb1082e4</Id> <StateProvince xmlns:d4p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers"> <d4p1:Id>18b6096b-ec35-4fb5-8157-a09cb09d3837</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>18b6096b-ec35-4fb5-8157-a09cb09d3837</d2p1:Id> <d2p1:Name>sample string 2</d2p1:Name> </CreditType> <EducationalTime>9</EducationalTime> <Id>921ba184-250f-4087-a422-5fdf66a443b3</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>18b6096b-ec35-4fb5-8157-a09cb09d3837</d2p1:Id> <d2p1:Name>sample string 2</d2p1:Name> </ParentProgram> <PresenterName>sample string 8</PresenterName> <ProgramEndDate>2024-12-14T04:04:51.9866138+00:00</ProgramEndDate> <ProgramId>sample string 2</ProgramId> <ProgramStartDate>2024-12-14T04:04:51.9866138+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>18b6096b-ec35-4fb5-8157-a09cb09d3837</d2p1:Id> <d2p1:Name>sample string 2</d2p1:Name> </ProgramType> <ProgramURL>sample string 6</ProgramURL> <Receipt> <InvoiceDate>2024-12-14T04:04:51.9866138+00:00</InvoiceDate> <InvoiceId>6f11fe9e-29b9-4445-85a2-00ba2bd35c7b</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>8751f18c-5567-4b37-9816-09027db5f5ad</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": "811cf80f-f5d2-48a1-b090-9cbf2f3d3ad8", "ProgramType": { "Id": "bf1eca61-64a8-483f-a57f-95cff3d95632", "Name": "sample string 2" }, "ProgramId": "sample string 2", "ProgramTitle": "sample string 3", "ProgramStartDate": "2024-12-14T04:04:52.0022349+00:00", "ProgramEndDate": "2024-12-14T04:04:52.0022349+00:00", "ProgramURL": "sample string 6", "LearningObjectives": "sample string 7", "PresenterName": "sample string 8", "CreditType": { "Id": "bf1eca61-64a8-483f-a57f-95cff3d95632", "Name": "sample string 2" }, "EducationalTime": 9.0, "IsAvailableOnline": true, "CourseLocations": [ { "Id": "f9a4ea88-6045-43f1-8bdd-4af3ee6481dd", "Country": { "Id": "bf1eca61-64a8-483f-a57f-95cff3d95632", "Name": "sample string 2" }, "StateProvince": { "Id": "bf1eca61-64a8-483f-a57f-95cff3d95632", "Name": "sample string 2" }, "StateProvinceString": "sample string 2", "City": "sample string 3" }, { "Id": "f9a4ea88-6045-43f1-8bdd-4af3ee6481dd", "Country": { "Id": "bf1eca61-64a8-483f-a57f-95cff3d95632", "Name": "sample string 2" }, "StateProvince": { "Id": "bf1eca61-64a8-483f-a57f-95cff3d95632", "Name": "sample string 2" }, "StateProvinceString": "sample string 2", "City": "sample string 3" } ], "IsAttested": true, "IsRequirementMet": true, "ParentProgram": { "Id": "bf1eca61-64a8-483f-a57f-95cff3d95632", "Name": "sample string 2" }, "CreditHours": 13.0, "IsOngoingProgram": true, "IsDuplicate": true, "NonLearningTime": 16.0, "ProgramStatus": { "Label": "sample string 1", "Value": 2 }, "SubmitProgram": true, "ContactId": "99426302-2664-4a32-87ab-6a2c6c0a9759", "WebProductId": "cfd586f9-d7e3-4ff8-afef-84d882e04d3c", "WebProductName": "sample string 20", "Receipt": { "InvoiceId": "1e2c2fd5-a388-401c-a822-4e56ca17c43c", "Messages": [ "sample string 1", "sample string 2" ], "InvoiceNumber": "sample string 2", "InvoiceDate": "2024-12-14T04:04:52.0022349+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>99426302-2664-4a32-87ab-6a2c6c0a9759</ContactId> <CourseLocations> <CourseLocation> <City>sample string 3</City> <Country xmlns:d4p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers"> <d4p1:Id>bf1eca61-64a8-483f-a57f-95cff3d95632</d4p1:Id> <d4p1:Name>sample string 2</d4p1:Name> </Country> <Id>f9a4ea88-6045-43f1-8bdd-4af3ee6481dd</Id> <StateProvince xmlns:d4p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers"> <d4p1:Id>bf1eca61-64a8-483f-a57f-95cff3d95632</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>bf1eca61-64a8-483f-a57f-95cff3d95632</d4p1:Id> <d4p1:Name>sample string 2</d4p1:Name> </Country> <Id>f9a4ea88-6045-43f1-8bdd-4af3ee6481dd</Id> <StateProvince xmlns:d4p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers"> <d4p1:Id>bf1eca61-64a8-483f-a57f-95cff3d95632</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>bf1eca61-64a8-483f-a57f-95cff3d95632</d2p1:Id> <d2p1:Name>sample string 2</d2p1:Name> </CreditType> <EducationalTime>9</EducationalTime> <Id>811cf80f-f5d2-48a1-b090-9cbf2f3d3ad8</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>bf1eca61-64a8-483f-a57f-95cff3d95632</d2p1:Id> <d2p1:Name>sample string 2</d2p1:Name> </ParentProgram> <PresenterName>sample string 8</PresenterName> <ProgramEndDate>2024-12-14T04:04:52.0022349+00:00</ProgramEndDate> <ProgramId>sample string 2</ProgramId> <ProgramStartDate>2024-12-14T04:04:52.0022349+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>bf1eca61-64a8-483f-a57f-95cff3d95632</d2p1:Id> <d2p1:Name>sample string 2</d2p1:Name> </ProgramType> <ProgramURL>sample string 6</ProgramURL> <Receipt> <InvoiceDate>2024-12-14T04:04:52.0022349+00:00</InvoiceDate> <InvoiceId>1e2c2fd5-a388-401c-a822-4e56ca17c43c</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>cfd586f9-d7e3-4ff8-afef-84d882e04d3c</WebProductId> <WebProductName>sample string 20</WebProductName> </ProviderProgram>