POST api/provider/program/create?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": "70a6f637-fb4f-402c-8d16-608cf8c9ceee", "ProgramType": { "Id": "7d9cf686-bc14-4347-a96a-b48a2e3c47ea", "Name": "sample string 2" }, "ProgramId": "sample string 2", "ProgramTitle": "sample string 3", "ProgramStartDate": "2025-07-03T10:08:13.7175367+00:00", "ProgramEndDate": "2025-07-03T10:08:13.7175367+00:00", "ProgramURL": "sample string 6", "LearningObjectives": "sample string 7", "PresenterName": "sample string 8", "CreditType": { "Id": "7d9cf686-bc14-4347-a96a-b48a2e3c47ea", "Name": "sample string 2" }, "EducationalTime": 9.0, "IsAvailableOnline": true, "CourseLocations": [ { "Id": "629836e4-67a9-4a98-a6f2-d643ddc9a8c5", "Country": { "Id": "7d9cf686-bc14-4347-a96a-b48a2e3c47ea", "Name": "sample string 2" }, "StateProvince": { "Id": "7d9cf686-bc14-4347-a96a-b48a2e3c47ea", "Name": "sample string 2" }, "StateProvinceString": "sample string 2", "City": "sample string 3" }, { "Id": "629836e4-67a9-4a98-a6f2-d643ddc9a8c5", "Country": { "Id": "7d9cf686-bc14-4347-a96a-b48a2e3c47ea", "Name": "sample string 2" }, "StateProvince": { "Id": "7d9cf686-bc14-4347-a96a-b48a2e3c47ea", "Name": "sample string 2" }, "StateProvinceString": "sample string 2", "City": "sample string 3" } ], "IsAttested": true, "IsRequirementMet": true, "ParentProgram": { "Id": "7d9cf686-bc14-4347-a96a-b48a2e3c47ea", "Name": "sample string 2" }, "CreditHours": 13.0, "IsOngoingProgram": true, "IsDuplicate": true, "NonLearningTime": 16.0, "ProgramStatus": { "Label": "sample string 1", "Value": 2 }, "SubmitProgram": true, "ContactId": "8682e23c-285c-4966-8879-95a937824e1b", "WebProductId": "9966611e-5b3a-44a5-8bb4-d037519ea85f", "WebProductName": "sample string 20", "Receipt": { "InvoiceId": "db67b4c5-d5dc-4b9e-823c-bd453b2f5395", "Messages": [ "sample string 1", "sample string 2" ], "InvoiceNumber": "sample string 2", "InvoiceDate": "2025-07-03T10:08:13.7175367+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>8682e23c-285c-4966-8879-95a937824e1b</ContactId> <CourseLocations> <CourseLocation> <City>sample string 3</City> <Country xmlns:d4p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers"> <d4p1:Id>7d9cf686-bc14-4347-a96a-b48a2e3c47ea</d4p1:Id> <d4p1:Name>sample string 2</d4p1:Name> </Country> <Id>629836e4-67a9-4a98-a6f2-d643ddc9a8c5</Id> <StateProvince xmlns:d4p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers"> <d4p1:Id>7d9cf686-bc14-4347-a96a-b48a2e3c47ea</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>7d9cf686-bc14-4347-a96a-b48a2e3c47ea</d4p1:Id> <d4p1:Name>sample string 2</d4p1:Name> </Country> <Id>629836e4-67a9-4a98-a6f2-d643ddc9a8c5</Id> <StateProvince xmlns:d4p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers"> <d4p1:Id>7d9cf686-bc14-4347-a96a-b48a2e3c47ea</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>7d9cf686-bc14-4347-a96a-b48a2e3c47ea</d2p1:Id> <d2p1:Name>sample string 2</d2p1:Name> </CreditType> <EducationalTime>9</EducationalTime> <Id>70a6f637-fb4f-402c-8d16-608cf8c9ceee</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>7d9cf686-bc14-4347-a96a-b48a2e3c47ea</d2p1:Id> <d2p1:Name>sample string 2</d2p1:Name> </ParentProgram> <PresenterName>sample string 8</PresenterName> <ProgramEndDate>2025-07-03T10:08:13.7175367+00:00</ProgramEndDate> <ProgramId>sample string 2</ProgramId> <ProgramStartDate>2025-07-03T10:08:13.7175367+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>7d9cf686-bc14-4347-a96a-b48a2e3c47ea</d2p1:Id> <d2p1:Name>sample string 2</d2p1:Name> </ProgramType> <ProgramURL>sample string 6</ProgramURL> <Receipt> <InvoiceDate>2025-07-03T10:08:13.7175367+00:00</InvoiceDate> <InvoiceId>db67b4c5-d5dc-4b9e-823c-bd453b2f5395</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>9966611e-5b3a-44a5-8bb4-d037519ea85f</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": "a92cc569-2c11-442b-9952-bc6b4adbbde6", "ProgramType": { "Id": "ad49a1f8-5cd4-4ce0-be84-0d5595e7dd46", "Name": "sample string 2" }, "ProgramId": "sample string 2", "ProgramTitle": "sample string 3", "ProgramStartDate": "2025-07-03T10:08:13.7175367+00:00", "ProgramEndDate": "2025-07-03T10:08:13.7175367+00:00", "ProgramURL": "sample string 6", "LearningObjectives": "sample string 7", "PresenterName": "sample string 8", "CreditType": { "Id": "ad49a1f8-5cd4-4ce0-be84-0d5595e7dd46", "Name": "sample string 2" }, "EducationalTime": 9.0, "IsAvailableOnline": true, "CourseLocations": [ { "Id": "46be2cde-fe27-4cd4-8ea6-24f91b2933c1", "Country": { "Id": "ad49a1f8-5cd4-4ce0-be84-0d5595e7dd46", "Name": "sample string 2" }, "StateProvince": { "Id": "ad49a1f8-5cd4-4ce0-be84-0d5595e7dd46", "Name": "sample string 2" }, "StateProvinceString": "sample string 2", "City": "sample string 3" }, { "Id": "46be2cde-fe27-4cd4-8ea6-24f91b2933c1", "Country": { "Id": "ad49a1f8-5cd4-4ce0-be84-0d5595e7dd46", "Name": "sample string 2" }, "StateProvince": { "Id": "ad49a1f8-5cd4-4ce0-be84-0d5595e7dd46", "Name": "sample string 2" }, "StateProvinceString": "sample string 2", "City": "sample string 3" } ], "IsAttested": true, "IsRequirementMet": true, "ParentProgram": { "Id": "ad49a1f8-5cd4-4ce0-be84-0d5595e7dd46", "Name": "sample string 2" }, "CreditHours": 13.0, "IsOngoingProgram": true, "IsDuplicate": true, "NonLearningTime": 16.0, "ProgramStatus": { "Label": "sample string 1", "Value": 2 }, "SubmitProgram": true, "ContactId": "c92ab6c7-3fa4-41b6-98d0-c8e104d32f03", "WebProductId": "dde52eb5-38e0-4fea-9b3d-84a662265287", "WebProductName": "sample string 20", "Receipt": { "InvoiceId": "ebdf3aed-49c0-49a6-9c35-83e7006652eb", "Messages": [ "sample string 1", "sample string 2" ], "InvoiceNumber": "sample string 2", "InvoiceDate": "2025-07-03T10:08:13.7175367+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>c92ab6c7-3fa4-41b6-98d0-c8e104d32f03</ContactId> <CourseLocations> <CourseLocation> <City>sample string 3</City> <Country xmlns:d4p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers"> <d4p1:Id>ad49a1f8-5cd4-4ce0-be84-0d5595e7dd46</d4p1:Id> <d4p1:Name>sample string 2</d4p1:Name> </Country> <Id>46be2cde-fe27-4cd4-8ea6-24f91b2933c1</Id> <StateProvince xmlns:d4p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers"> <d4p1:Id>ad49a1f8-5cd4-4ce0-be84-0d5595e7dd46</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>ad49a1f8-5cd4-4ce0-be84-0d5595e7dd46</d4p1:Id> <d4p1:Name>sample string 2</d4p1:Name> </Country> <Id>46be2cde-fe27-4cd4-8ea6-24f91b2933c1</Id> <StateProvince xmlns:d4p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers"> <d4p1:Id>ad49a1f8-5cd4-4ce0-be84-0d5595e7dd46</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>ad49a1f8-5cd4-4ce0-be84-0d5595e7dd46</d2p1:Id> <d2p1:Name>sample string 2</d2p1:Name> </CreditType> <EducationalTime>9</EducationalTime> <Id>a92cc569-2c11-442b-9952-bc6b4adbbde6</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>ad49a1f8-5cd4-4ce0-be84-0d5595e7dd46</d2p1:Id> <d2p1:Name>sample string 2</d2p1:Name> </ParentProgram> <PresenterName>sample string 8</PresenterName> <ProgramEndDate>2025-07-03T10:08:13.7175367+00:00</ProgramEndDate> <ProgramId>sample string 2</ProgramId> <ProgramStartDate>2025-07-03T10:08:13.7175367+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>ad49a1f8-5cd4-4ce0-be84-0d5595e7dd46</d2p1:Id> <d2p1:Name>sample string 2</d2p1:Name> </ProgramType> <ProgramURL>sample string 6</ProgramURL> <Receipt> <InvoiceDate>2025-07-03T10:08:13.7175367+00:00</InvoiceDate> <InvoiceId>ebdf3aed-49c0-49a6-9c35-83e7006652eb</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>dde52eb5-38e0-4fea-9b3d-84a662265287</WebProductId> <WebProductName>sample string 20</WebProductName> </ProviderProgram>