POST api/provider/program/create?accountId={accountId}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| accountId | globally unique identifier |
Required |
Body Parameters
ProviderProgram| Name | 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": "2033a1b9-ef15-4860-b6f5-97ec3d61a0d1",
"ProgramType": {
"Id": "b30fd6ad-9222-4370-a278-f0fb96f1acb8",
"Name": "sample string 2"
},
"ProgramId": "sample string 2",
"ProgramTitle": "sample string 3",
"ProgramStartDate": "2025-12-18T09:00:53.6309658+00:00",
"ProgramEndDate": "2025-12-18T09:00:53.6309658+00:00",
"ProgramURL": "sample string 6",
"LearningObjectives": "sample string 7",
"PresenterName": "sample string 8",
"CreditType": {
"Id": "b30fd6ad-9222-4370-a278-f0fb96f1acb8",
"Name": "sample string 2"
},
"EducationalTime": 9.0,
"IsAvailableOnline": true,
"CourseLocations": [
{
"Id": "8f101097-789d-4813-8693-bdf815b126da",
"Country": {
"Id": "b30fd6ad-9222-4370-a278-f0fb96f1acb8",
"Name": "sample string 2"
},
"StateProvince": {
"Id": "b30fd6ad-9222-4370-a278-f0fb96f1acb8",
"Name": "sample string 2"
},
"StateProvinceString": "sample string 2",
"City": "sample string 3"
},
{
"Id": "8f101097-789d-4813-8693-bdf815b126da",
"Country": {
"Id": "b30fd6ad-9222-4370-a278-f0fb96f1acb8",
"Name": "sample string 2"
},
"StateProvince": {
"Id": "b30fd6ad-9222-4370-a278-f0fb96f1acb8",
"Name": "sample string 2"
},
"StateProvinceString": "sample string 2",
"City": "sample string 3"
}
],
"IsAttested": true,
"IsRequirementMet": true,
"ParentProgram": {
"Id": "b30fd6ad-9222-4370-a278-f0fb96f1acb8",
"Name": "sample string 2"
},
"CreditHours": 13.0,
"IsOngoingProgram": true,
"IsDuplicate": true,
"NonLearningTime": 16.0,
"ProgramStatus": {
"Label": "sample string 1",
"Value": 2
},
"SubmitProgram": true,
"ContactId": "fdea70e9-765a-4388-9ade-bcf9b6a1329a",
"WebProductId": "c90b3c37-ed81-4130-bbc7-4d4c3f3e3288",
"WebProductName": "sample string 20",
"Receipt": {
"InvoiceId": "d283237b-2b5b-411f-ab3c-9f1d8e9d33e6",
"Messages": [
"sample string 1",
"sample string 2"
],
"InvoiceNumber": "sample string 2",
"InvoiceDate": "2025-12-18T09:00:53.6309658+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>fdea70e9-765a-4388-9ade-bcf9b6a1329a</ContactId>
<CourseLocations>
<CourseLocation>
<City>sample string 3</City>
<Country xmlns:d4p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers">
<d4p1:Id>b30fd6ad-9222-4370-a278-f0fb96f1acb8</d4p1:Id>
<d4p1:Name>sample string 2</d4p1:Name>
</Country>
<Id>8f101097-789d-4813-8693-bdf815b126da</Id>
<StateProvince xmlns:d4p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers">
<d4p1:Id>b30fd6ad-9222-4370-a278-f0fb96f1acb8</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>b30fd6ad-9222-4370-a278-f0fb96f1acb8</d4p1:Id>
<d4p1:Name>sample string 2</d4p1:Name>
</Country>
<Id>8f101097-789d-4813-8693-bdf815b126da</Id>
<StateProvince xmlns:d4p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers">
<d4p1:Id>b30fd6ad-9222-4370-a278-f0fb96f1acb8</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>b30fd6ad-9222-4370-a278-f0fb96f1acb8</d2p1:Id>
<d2p1:Name>sample string 2</d2p1:Name>
</CreditType>
<EducationalTime>9</EducationalTime>
<Id>2033a1b9-ef15-4860-b6f5-97ec3d61a0d1</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>b30fd6ad-9222-4370-a278-f0fb96f1acb8</d2p1:Id>
<d2p1:Name>sample string 2</d2p1:Name>
</ParentProgram>
<PresenterName>sample string 8</PresenterName>
<ProgramEndDate>2025-12-18T09:00:53.6309658+00:00</ProgramEndDate>
<ProgramId>sample string 2</ProgramId>
<ProgramStartDate>2025-12-18T09:00:53.6309658+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>b30fd6ad-9222-4370-a278-f0fb96f1acb8</d2p1:Id>
<d2p1:Name>sample string 2</d2p1:Name>
</ProgramType>
<ProgramURL>sample string 6</ProgramURL>
<Receipt>
<InvoiceDate>2025-12-18T09:00:53.6309658+00:00</InvoiceDate>
<InvoiceId>d283237b-2b5b-411f-ab3c-9f1d8e9d33e6</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>c90b3c37-ed81-4130-bbc7-4d4c3f3e3288</WebProductId>
<WebProductName>sample string 20</WebProductName>
</ProviderProgram>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
ProviderProgram| Name | 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": "24482a76-2f46-438e-be98-189d9a611d48",
"ProgramType": {
"Id": "f25a3096-4f34-41c2-a163-3d698b081c48",
"Name": "sample string 2"
},
"ProgramId": "sample string 2",
"ProgramTitle": "sample string 3",
"ProgramStartDate": "2025-12-18T09:00:53.7715974+00:00",
"ProgramEndDate": "2025-12-18T09:00:53.7715974+00:00",
"ProgramURL": "sample string 6",
"LearningObjectives": "sample string 7",
"PresenterName": "sample string 8",
"CreditType": {
"Id": "f25a3096-4f34-41c2-a163-3d698b081c48",
"Name": "sample string 2"
},
"EducationalTime": 9.0,
"IsAvailableOnline": true,
"CourseLocations": [
{
"Id": "67a77342-976f-40ae-8aff-dfea4db6eebb",
"Country": {
"Id": "f25a3096-4f34-41c2-a163-3d698b081c48",
"Name": "sample string 2"
},
"StateProvince": {
"Id": "f25a3096-4f34-41c2-a163-3d698b081c48",
"Name": "sample string 2"
},
"StateProvinceString": "sample string 2",
"City": "sample string 3"
},
{
"Id": "67a77342-976f-40ae-8aff-dfea4db6eebb",
"Country": {
"Id": "f25a3096-4f34-41c2-a163-3d698b081c48",
"Name": "sample string 2"
},
"StateProvince": {
"Id": "f25a3096-4f34-41c2-a163-3d698b081c48",
"Name": "sample string 2"
},
"StateProvinceString": "sample string 2",
"City": "sample string 3"
}
],
"IsAttested": true,
"IsRequirementMet": true,
"ParentProgram": {
"Id": "f25a3096-4f34-41c2-a163-3d698b081c48",
"Name": "sample string 2"
},
"CreditHours": 13.0,
"IsOngoingProgram": true,
"IsDuplicate": true,
"NonLearningTime": 16.0,
"ProgramStatus": {
"Label": "sample string 1",
"Value": 2
},
"SubmitProgram": true,
"ContactId": "80992aee-a83c-42b5-8962-9b7c1c8aedb9",
"WebProductId": "efae1593-0a65-40e6-ad9c-974dce854178",
"WebProductName": "sample string 20",
"Receipt": {
"InvoiceId": "9576f827-182c-413e-892d-78cc71224430",
"Messages": [
"sample string 1",
"sample string 2"
],
"InvoiceNumber": "sample string 2",
"InvoiceDate": "2025-12-18T09:00:53.7715974+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>80992aee-a83c-42b5-8962-9b7c1c8aedb9</ContactId>
<CourseLocations>
<CourseLocation>
<City>sample string 3</City>
<Country xmlns:d4p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers">
<d4p1:Id>f25a3096-4f34-41c2-a163-3d698b081c48</d4p1:Id>
<d4p1:Name>sample string 2</d4p1:Name>
</Country>
<Id>67a77342-976f-40ae-8aff-dfea4db6eebb</Id>
<StateProvince xmlns:d4p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers">
<d4p1:Id>f25a3096-4f34-41c2-a163-3d698b081c48</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>f25a3096-4f34-41c2-a163-3d698b081c48</d4p1:Id>
<d4p1:Name>sample string 2</d4p1:Name>
</Country>
<Id>67a77342-976f-40ae-8aff-dfea4db6eebb</Id>
<StateProvince xmlns:d4p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers">
<d4p1:Id>f25a3096-4f34-41c2-a163-3d698b081c48</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>f25a3096-4f34-41c2-a163-3d698b081c48</d2p1:Id>
<d2p1:Name>sample string 2</d2p1:Name>
</CreditType>
<EducationalTime>9</EducationalTime>
<Id>24482a76-2f46-438e-be98-189d9a611d48</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>f25a3096-4f34-41c2-a163-3d698b081c48</d2p1:Id>
<d2p1:Name>sample string 2</d2p1:Name>
</ParentProgram>
<PresenterName>sample string 8</PresenterName>
<ProgramEndDate>2025-12-18T09:00:53.7715974+00:00</ProgramEndDate>
<ProgramId>sample string 2</ProgramId>
<ProgramStartDate>2025-12-18T09:00:53.7715974+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>f25a3096-4f34-41c2-a163-3d698b081c48</d2p1:Id>
<d2p1:Name>sample string 2</d2p1:Name>
</ProgramType>
<ProgramURL>sample string 6</ProgramURL>
<Receipt>
<InvoiceDate>2025-12-18T09:00:53.7715974+00:00</InvoiceDate>
<InvoiceId>9576f827-182c-413e-892d-78cc71224430</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>efae1593-0a65-40e6-ad9c-974dce854178</WebProductId>
<WebProductName>sample string 20</WebProductName>
</ProviderProgram>