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": "803c2026-918b-4211-b01d-012101db21db",
"ProgramType": {
"Id": "850b27a7-b155-48bd-8a2b-80ee7e589ef3",
"Name": "sample string 2"
},
"ProgramId": "sample string 2",
"ProgramTitle": "sample string 3",
"ProgramStartDate": "2026-01-25T05:18:54.2277589+00:00",
"ProgramEndDate": "2026-01-25T05:18:54.2277589+00:00",
"ProgramURL": "sample string 6",
"LearningObjectives": "sample string 7",
"PresenterName": "sample string 8",
"CreditType": {
"Id": "850b27a7-b155-48bd-8a2b-80ee7e589ef3",
"Name": "sample string 2"
},
"EducationalTime": 9.0,
"IsAvailableOnline": true,
"CourseLocations": [
{
"Id": "fe85a62d-85d9-49fd-b735-6de4ca75c00e",
"Country": {
"Id": "850b27a7-b155-48bd-8a2b-80ee7e589ef3",
"Name": "sample string 2"
},
"StateProvince": {
"Id": "850b27a7-b155-48bd-8a2b-80ee7e589ef3",
"Name": "sample string 2"
},
"StateProvinceString": "sample string 2",
"City": "sample string 3"
},
{
"Id": "fe85a62d-85d9-49fd-b735-6de4ca75c00e",
"Country": {
"Id": "850b27a7-b155-48bd-8a2b-80ee7e589ef3",
"Name": "sample string 2"
},
"StateProvince": {
"Id": "850b27a7-b155-48bd-8a2b-80ee7e589ef3",
"Name": "sample string 2"
},
"StateProvinceString": "sample string 2",
"City": "sample string 3"
}
],
"IsAttested": true,
"IsRequirementMet": true,
"ParentProgram": {
"Id": "850b27a7-b155-48bd-8a2b-80ee7e589ef3",
"Name": "sample string 2"
},
"CreditHours": 13.0,
"IsOngoingProgram": true,
"IsDuplicate": true,
"NonLearningTime": 16.0,
"ProgramStatus": {
"Label": "sample string 1",
"Value": 2
},
"SubmitProgram": true,
"ContactId": "cd813da5-c8cf-4a84-8035-482a1523f11e",
"WebProductId": "0ac0c404-90ac-4735-9ac2-5c6b8f141c37",
"WebProductName": "sample string 20",
"Receipt": {
"InvoiceId": "bcecf646-897f-4142-a35d-1d9f0ee197aa",
"Messages": [
"sample string 1",
"sample string 2"
],
"InvoiceNumber": "sample string 2",
"InvoiceDate": "2026-01-25T05:18:54.2277589+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>cd813da5-c8cf-4a84-8035-482a1523f11e</ContactId>
<CourseLocations>
<CourseLocation>
<City>sample string 3</City>
<Country xmlns:d4p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers">
<d4p1:Id>850b27a7-b155-48bd-8a2b-80ee7e589ef3</d4p1:Id>
<d4p1:Name>sample string 2</d4p1:Name>
</Country>
<Id>fe85a62d-85d9-49fd-b735-6de4ca75c00e</Id>
<StateProvince xmlns:d4p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers">
<d4p1:Id>850b27a7-b155-48bd-8a2b-80ee7e589ef3</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>850b27a7-b155-48bd-8a2b-80ee7e589ef3</d4p1:Id>
<d4p1:Name>sample string 2</d4p1:Name>
</Country>
<Id>fe85a62d-85d9-49fd-b735-6de4ca75c00e</Id>
<StateProvince xmlns:d4p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers">
<d4p1:Id>850b27a7-b155-48bd-8a2b-80ee7e589ef3</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>850b27a7-b155-48bd-8a2b-80ee7e589ef3</d2p1:Id>
<d2p1:Name>sample string 2</d2p1:Name>
</CreditType>
<EducationalTime>9</EducationalTime>
<Id>803c2026-918b-4211-b01d-012101db21db</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>850b27a7-b155-48bd-8a2b-80ee7e589ef3</d2p1:Id>
<d2p1:Name>sample string 2</d2p1:Name>
</ParentProgram>
<PresenterName>sample string 8</PresenterName>
<ProgramEndDate>2026-01-25T05:18:54.2277589+00:00</ProgramEndDate>
<ProgramId>sample string 2</ProgramId>
<ProgramStartDate>2026-01-25T05:18:54.2277589+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>850b27a7-b155-48bd-8a2b-80ee7e589ef3</d2p1:Id>
<d2p1:Name>sample string 2</d2p1:Name>
</ProgramType>
<ProgramURL>sample string 6</ProgramURL>
<Receipt>
<InvoiceDate>2026-01-25T05:18:54.2277589+00:00</InvoiceDate>
<InvoiceId>bcecf646-897f-4142-a35d-1d9f0ee197aa</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>0ac0c404-90ac-4735-9ac2-5c6b8f141c37</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": "845c05d7-d650-4ed4-ba2c-1c09291dc0a4",
"ProgramType": {
"Id": "f7596be9-76e4-460c-ba5a-f7195fa743cc",
"Name": "sample string 2"
},
"ProgramId": "sample string 2",
"ProgramTitle": "sample string 3",
"ProgramStartDate": "2026-01-25T05:18:54.2746325+00:00",
"ProgramEndDate": "2026-01-25T05:18:54.2746325+00:00",
"ProgramURL": "sample string 6",
"LearningObjectives": "sample string 7",
"PresenterName": "sample string 8",
"CreditType": {
"Id": "f7596be9-76e4-460c-ba5a-f7195fa743cc",
"Name": "sample string 2"
},
"EducationalTime": 9.0,
"IsAvailableOnline": true,
"CourseLocations": [
{
"Id": "8fef3f4e-6c0a-476a-bd8e-0241d3d6b5c6",
"Country": {
"Id": "f7596be9-76e4-460c-ba5a-f7195fa743cc",
"Name": "sample string 2"
},
"StateProvince": {
"Id": "f7596be9-76e4-460c-ba5a-f7195fa743cc",
"Name": "sample string 2"
},
"StateProvinceString": "sample string 2",
"City": "sample string 3"
},
{
"Id": "8fef3f4e-6c0a-476a-bd8e-0241d3d6b5c6",
"Country": {
"Id": "f7596be9-76e4-460c-ba5a-f7195fa743cc",
"Name": "sample string 2"
},
"StateProvince": {
"Id": "f7596be9-76e4-460c-ba5a-f7195fa743cc",
"Name": "sample string 2"
},
"StateProvinceString": "sample string 2",
"City": "sample string 3"
}
],
"IsAttested": true,
"IsRequirementMet": true,
"ParentProgram": {
"Id": "f7596be9-76e4-460c-ba5a-f7195fa743cc",
"Name": "sample string 2"
},
"CreditHours": 13.0,
"IsOngoingProgram": true,
"IsDuplicate": true,
"NonLearningTime": 16.0,
"ProgramStatus": {
"Label": "sample string 1",
"Value": 2
},
"SubmitProgram": true,
"ContactId": "dc02caf5-d19f-41ea-b197-23a581df72b2",
"WebProductId": "a5c2cda1-405f-4a4e-b305-4d55fa4d0a8d",
"WebProductName": "sample string 20",
"Receipt": {
"InvoiceId": "ea4b58ad-bbf7-4df3-a979-aec525a71a1a",
"Messages": [
"sample string 1",
"sample string 2"
],
"InvoiceNumber": "sample string 2",
"InvoiceDate": "2026-01-25T05:18:54.2746325+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>dc02caf5-d19f-41ea-b197-23a581df72b2</ContactId>
<CourseLocations>
<CourseLocation>
<City>sample string 3</City>
<Country xmlns:d4p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers">
<d4p1:Id>f7596be9-76e4-460c-ba5a-f7195fa743cc</d4p1:Id>
<d4p1:Name>sample string 2</d4p1:Name>
</Country>
<Id>8fef3f4e-6c0a-476a-bd8e-0241d3d6b5c6</Id>
<StateProvince xmlns:d4p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers">
<d4p1:Id>f7596be9-76e4-460c-ba5a-f7195fa743cc</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>f7596be9-76e4-460c-ba5a-f7195fa743cc</d4p1:Id>
<d4p1:Name>sample string 2</d4p1:Name>
</Country>
<Id>8fef3f4e-6c0a-476a-bd8e-0241d3d6b5c6</Id>
<StateProvince xmlns:d4p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers">
<d4p1:Id>f7596be9-76e4-460c-ba5a-f7195fa743cc</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>f7596be9-76e4-460c-ba5a-f7195fa743cc</d2p1:Id>
<d2p1:Name>sample string 2</d2p1:Name>
</CreditType>
<EducationalTime>9</EducationalTime>
<Id>845c05d7-d650-4ed4-ba2c-1c09291dc0a4</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>f7596be9-76e4-460c-ba5a-f7195fa743cc</d2p1:Id>
<d2p1:Name>sample string 2</d2p1:Name>
</ParentProgram>
<PresenterName>sample string 8</PresenterName>
<ProgramEndDate>2026-01-25T05:18:54.2746325+00:00</ProgramEndDate>
<ProgramId>sample string 2</ProgramId>
<ProgramStartDate>2026-01-25T05:18:54.2746325+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>f7596be9-76e4-460c-ba5a-f7195fa743cc</d2p1:Id>
<d2p1:Name>sample string 2</d2p1:Name>
</ProgramType>
<ProgramURL>sample string 6</ProgramURL>
<Receipt>
<InvoiceDate>2026-01-25T05:18:54.2746325+00:00</InvoiceDate>
<InvoiceId>ea4b58ad-bbf7-4df3-a979-aec525a71a1a</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>a5c2cda1-405f-4a4e-b305-4d55fa4d0a8d</WebProductId>
<WebProductName>sample string 20</WebProductName>
</ProviderProgram>