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": "8fc259b8-48db-4728-b07a-5e6bd0a50c0f",
"ProgramType": {
"Id": "dec90383-52d2-4501-9bfc-e72e6cd532c3",
"Name": "sample string 2"
},
"ProgramId": "sample string 2",
"ProgramTitle": "sample string 3",
"ProgramStartDate": "2025-11-12T19:17:46.6800235+00:00",
"ProgramEndDate": "2025-11-12T19:17:46.6800235+00:00",
"ProgramURL": "sample string 6",
"LearningObjectives": "sample string 7",
"PresenterName": "sample string 8",
"CreditType": {
"Id": "dec90383-52d2-4501-9bfc-e72e6cd532c3",
"Name": "sample string 2"
},
"EducationalTime": 9.0,
"IsAvailableOnline": true,
"CourseLocations": [
{
"Id": "e560a634-788a-4370-bbb2-83c6c194ac70",
"Country": {
"Id": "dec90383-52d2-4501-9bfc-e72e6cd532c3",
"Name": "sample string 2"
},
"StateProvince": {
"Id": "dec90383-52d2-4501-9bfc-e72e6cd532c3",
"Name": "sample string 2"
},
"StateProvinceString": "sample string 2",
"City": "sample string 3"
},
{
"Id": "e560a634-788a-4370-bbb2-83c6c194ac70",
"Country": {
"Id": "dec90383-52d2-4501-9bfc-e72e6cd532c3",
"Name": "sample string 2"
},
"StateProvince": {
"Id": "dec90383-52d2-4501-9bfc-e72e6cd532c3",
"Name": "sample string 2"
},
"StateProvinceString": "sample string 2",
"City": "sample string 3"
}
],
"IsAttested": true,
"IsRequirementMet": true,
"ParentProgram": {
"Id": "dec90383-52d2-4501-9bfc-e72e6cd532c3",
"Name": "sample string 2"
},
"CreditHours": 13.0,
"IsOngoingProgram": true,
"IsDuplicate": true,
"NonLearningTime": 16.0,
"ProgramStatus": {
"Label": "sample string 1",
"Value": 2
},
"SubmitProgram": true,
"ContactId": "f1499eec-f08f-4e29-9e3f-c3accd376bc1",
"WebProductId": "8d6901dc-8bde-4ee8-af1a-ac21d19bb56e",
"WebProductName": "sample string 20",
"Receipt": {
"InvoiceId": "d950145b-4977-43b7-9ecf-0ff5e0671aec",
"Messages": [
"sample string 1",
"sample string 2"
],
"InvoiceNumber": "sample string 2",
"InvoiceDate": "2025-11-12T19:17:46.6800235+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>f1499eec-f08f-4e29-9e3f-c3accd376bc1</ContactId>
<CourseLocations>
<CourseLocation>
<City>sample string 3</City>
<Country xmlns:d4p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers">
<d4p1:Id>dec90383-52d2-4501-9bfc-e72e6cd532c3</d4p1:Id>
<d4p1:Name>sample string 2</d4p1:Name>
</Country>
<Id>e560a634-788a-4370-bbb2-83c6c194ac70</Id>
<StateProvince xmlns:d4p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers">
<d4p1:Id>dec90383-52d2-4501-9bfc-e72e6cd532c3</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>dec90383-52d2-4501-9bfc-e72e6cd532c3</d4p1:Id>
<d4p1:Name>sample string 2</d4p1:Name>
</Country>
<Id>e560a634-788a-4370-bbb2-83c6c194ac70</Id>
<StateProvince xmlns:d4p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers">
<d4p1:Id>dec90383-52d2-4501-9bfc-e72e6cd532c3</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>dec90383-52d2-4501-9bfc-e72e6cd532c3</d2p1:Id>
<d2p1:Name>sample string 2</d2p1:Name>
</CreditType>
<EducationalTime>9</EducationalTime>
<Id>8fc259b8-48db-4728-b07a-5e6bd0a50c0f</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>dec90383-52d2-4501-9bfc-e72e6cd532c3</d2p1:Id>
<d2p1:Name>sample string 2</d2p1:Name>
</ParentProgram>
<PresenterName>sample string 8</PresenterName>
<ProgramEndDate>2025-11-12T19:17:46.6800235+00:00</ProgramEndDate>
<ProgramId>sample string 2</ProgramId>
<ProgramStartDate>2025-11-12T19:17:46.6800235+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>dec90383-52d2-4501-9bfc-e72e6cd532c3</d2p1:Id>
<d2p1:Name>sample string 2</d2p1:Name>
</ProgramType>
<ProgramURL>sample string 6</ProgramURL>
<Receipt>
<InvoiceDate>2025-11-12T19:17:46.6800235+00:00</InvoiceDate>
<InvoiceId>d950145b-4977-43b7-9ecf-0ff5e0671aec</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>8d6901dc-8bde-4ee8-af1a-ac21d19bb56e</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": "74a543bb-915d-4205-b2b3-eee2408be007",
"ProgramType": {
"Id": "e741535c-42dd-47fd-83b0-596059ef4956",
"Name": "sample string 2"
},
"ProgramId": "sample string 2",
"ProgramTitle": "sample string 3",
"ProgramStartDate": "2025-11-12T19:17:46.6800235+00:00",
"ProgramEndDate": "2025-11-12T19:17:46.6800235+00:00",
"ProgramURL": "sample string 6",
"LearningObjectives": "sample string 7",
"PresenterName": "sample string 8",
"CreditType": {
"Id": "e741535c-42dd-47fd-83b0-596059ef4956",
"Name": "sample string 2"
},
"EducationalTime": 9.0,
"IsAvailableOnline": true,
"CourseLocations": [
{
"Id": "d5d64047-0c4a-448d-a70a-05aa59a3fb35",
"Country": {
"Id": "e741535c-42dd-47fd-83b0-596059ef4956",
"Name": "sample string 2"
},
"StateProvince": {
"Id": "e741535c-42dd-47fd-83b0-596059ef4956",
"Name": "sample string 2"
},
"StateProvinceString": "sample string 2",
"City": "sample string 3"
},
{
"Id": "d5d64047-0c4a-448d-a70a-05aa59a3fb35",
"Country": {
"Id": "e741535c-42dd-47fd-83b0-596059ef4956",
"Name": "sample string 2"
},
"StateProvince": {
"Id": "e741535c-42dd-47fd-83b0-596059ef4956",
"Name": "sample string 2"
},
"StateProvinceString": "sample string 2",
"City": "sample string 3"
}
],
"IsAttested": true,
"IsRequirementMet": true,
"ParentProgram": {
"Id": "e741535c-42dd-47fd-83b0-596059ef4956",
"Name": "sample string 2"
},
"CreditHours": 13.0,
"IsOngoingProgram": true,
"IsDuplicate": true,
"NonLearningTime": 16.0,
"ProgramStatus": {
"Label": "sample string 1",
"Value": 2
},
"SubmitProgram": true,
"ContactId": "80195354-1c0d-4172-9565-288e3b23114c",
"WebProductId": "95432b98-b76e-43fd-8fd9-561e6f4864d7",
"WebProductName": "sample string 20",
"Receipt": {
"InvoiceId": "4f15a7ed-925c-4a28-96ae-1e7368330b54",
"Messages": [
"sample string 1",
"sample string 2"
],
"InvoiceNumber": "sample string 2",
"InvoiceDate": "2025-11-12T19:17:46.6800235+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>80195354-1c0d-4172-9565-288e3b23114c</ContactId>
<CourseLocations>
<CourseLocation>
<City>sample string 3</City>
<Country xmlns:d4p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers">
<d4p1:Id>e741535c-42dd-47fd-83b0-596059ef4956</d4p1:Id>
<d4p1:Name>sample string 2</d4p1:Name>
</Country>
<Id>d5d64047-0c4a-448d-a70a-05aa59a3fb35</Id>
<StateProvince xmlns:d4p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers">
<d4p1:Id>e741535c-42dd-47fd-83b0-596059ef4956</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>e741535c-42dd-47fd-83b0-596059ef4956</d4p1:Id>
<d4p1:Name>sample string 2</d4p1:Name>
</Country>
<Id>d5d64047-0c4a-448d-a70a-05aa59a3fb35</Id>
<StateProvince xmlns:d4p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers">
<d4p1:Id>e741535c-42dd-47fd-83b0-596059ef4956</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>e741535c-42dd-47fd-83b0-596059ef4956</d2p1:Id>
<d2p1:Name>sample string 2</d2p1:Name>
</CreditType>
<EducationalTime>9</EducationalTime>
<Id>74a543bb-915d-4205-b2b3-eee2408be007</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>e741535c-42dd-47fd-83b0-596059ef4956</d2p1:Id>
<d2p1:Name>sample string 2</d2p1:Name>
</ParentProgram>
<PresenterName>sample string 8</PresenterName>
<ProgramEndDate>2025-11-12T19:17:46.6800235+00:00</ProgramEndDate>
<ProgramId>sample string 2</ProgramId>
<ProgramStartDate>2025-11-12T19:17:46.6800235+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>e741535c-42dd-47fd-83b0-596059ef4956</d2p1:Id>
<d2p1:Name>sample string 2</d2p1:Name>
</ProgramType>
<ProgramURL>sample string 6</ProgramURL>
<Receipt>
<InvoiceDate>2025-11-12T19:17:46.6800235+00:00</InvoiceDate>
<InvoiceId>4f15a7ed-925c-4a28-96ae-1e7368330b54</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>95432b98-b76e-43fd-8fd9-561e6f4864d7</WebProductId>
<WebProductName>sample string 20</WebProductName>
</ProviderProgram>