GET api/provider/program/activity?courseNumber={courseNumber}&contactId={contactId}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| courseNumber | string |
Required |
|
| contactId | globally unique identifier |
Required |
Body Parameters
None.
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. |
|
| ResubmitProgram | boolean |
None. |
|
| IsAudited | boolean |
None. |
|
| ReviewCourseType | boolean |
None. |
|
| ReviewName | boolean |
None. |
|
| ReviewStartDate | boolean |
None. |
|
| ReviewEndDate | boolean |
None. |
|
| ReviewProgramWebsite | boolean |
None. |
|
| ReviewPresenterNames | boolean |
None. |
|
| ReviewDescription | boolean |
None. |
|
| ReviewCreditType | boolean |
None. |
|
| ReviewFunctionalAreas | boolean |
None. |
|
| ReviewFunctionalAreaResponsibilities | boolean |
None. |
|
| ReviewProgramPresentationDoc | boolean |
None. |
|
| ReviewPresenterBioDoc | boolean |
None. |
|
| ReviewAgendaDoc | boolean |
None. |
|
| ReviewSessionGrid | boolean |
None. |
|
| ReviewAttendanceMonitoredBy | boolean |
None. |
|
| ReviewTotalTime | boolean |
None. |
|
| ReviewNonLearningTime | boolean |
None. |
|
| ReviewOngoingActivity | Object |
None. |
|
| ReviewProgramLocation | boolean |
None. |
|
| ProgramComments | Collection of ProgramComment |
None. |
|
| UserComment | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"Id": "6b2aa6ac-72e8-4719-9c5e-294cb02642ab",
"ProgramType": {
"Id": "c93d5485-606c-4ecd-a229-32d1925bc53c",
"Name": "sample string 2"
},
"ProgramId": "sample string 2",
"ProgramTitle": "sample string 3",
"ProgramStartDate": "2026-06-17T11:33:24.3985427+00:00",
"ProgramEndDate": "2026-06-17T11:33:24.3985427+00:00",
"ProgramURL": "sample string 6",
"LearningObjectives": "sample string 7",
"PresenterName": "sample string 8",
"CreditType": {
"Id": "c93d5485-606c-4ecd-a229-32d1925bc53c",
"Name": "sample string 2"
},
"EducationalTime": 9.0,
"IsAvailableOnline": true,
"CourseLocations": [
{
"Id": "df811348-2647-44e9-9bb4-0a7d765e60b5",
"Country": {
"Id": "c93d5485-606c-4ecd-a229-32d1925bc53c",
"Name": "sample string 2"
},
"StateProvince": {
"Id": "c93d5485-606c-4ecd-a229-32d1925bc53c",
"Name": "sample string 2"
},
"StateProvinceString": "sample string 2",
"City": "sample string 3"
},
{
"Id": "df811348-2647-44e9-9bb4-0a7d765e60b5",
"Country": {
"Id": "c93d5485-606c-4ecd-a229-32d1925bc53c",
"Name": "sample string 2"
},
"StateProvince": {
"Id": "c93d5485-606c-4ecd-a229-32d1925bc53c",
"Name": "sample string 2"
},
"StateProvinceString": "sample string 2",
"City": "sample string 3"
}
],
"IsAttested": true,
"IsRequirementMet": true,
"ParentProgram": {
"Id": "c93d5485-606c-4ecd-a229-32d1925bc53c",
"Name": "sample string 2"
},
"CreditHours": 13.0,
"IsOngoingProgram": true,
"IsDuplicate": true,
"NonLearningTime": 16.0,
"ProgramStatus": {
"Label": "sample string 1",
"Value": 2
},
"SubmitProgram": true,
"ContactId": "76e2cee3-1b31-4191-9324-726e16231118",
"WebProductId": "3e5d689d-6217-43a3-9fcc-ea2282d14014",
"WebProductName": "sample string 20",
"Receipt": {
"InvoiceId": "7dc1e1f7-4e21-48aa-ba04-cdfce6be02d4",
"Messages": [
"sample string 1",
"sample string 2"
],
"InvoiceNumber": "sample string 2",
"InvoiceDate": "2026-06-17T11:33:24.4140812+00:00",
"TotalAmountPaid": 4.0,
"PaymentAuthorizationNumber": "sample string 5"
},
"IsDuplicateAllowed": true,
"IsRosterUploadAllowed": true,
"SubmissionDate": "sample string 23",
"ResubmitProgram": true,
"IsAudited": true,
"ReviewCourseType": true,
"ReviewName": true,
"ReviewStartDate": true,
"ReviewEndDate": true,
"ReviewProgramWebsite": true,
"ReviewPresenterNames": true,
"ReviewDescription": true,
"ReviewCreditType": true,
"ReviewFunctionalAreas": true,
"ReviewFunctionalAreaResponsibilities": true,
"ReviewProgramPresentationDoc": true,
"ReviewPresenterBioDoc": true,
"ReviewAgendaDoc": true,
"ReviewSessionGrid": true,
"ReviewAttendanceMonitoredBy": true,
"ReviewTotalTime": true,
"ReviewNonLearningTime": true,
"ReviewOngoingActivity": {},
"ReviewProgramLocation": true,
"ProgramComments": [
{
"IsHistorical": true,
"CreatedOn": "2026-06-17T11:33:24.4140812+00:00",
"NoteType": {
"Label": "sample string 1",
"Value": 2
},
"Comment": "sample string 3"
},
{
"IsHistorical": true,
"CreatedOn": "2026-06-17T11:33:24.4140812+00:00",
"NoteType": {
"Label": "sample string 1",
"Value": 2
},
"Comment": "sample string 3"
}
],
"UserComment": "sample string 45"
}
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>76e2cee3-1b31-4191-9324-726e16231118</ContactId>
<CourseLocations>
<CourseLocation>
<City>sample string 3</City>
<Country xmlns:d4p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers">
<d4p1:Id>c93d5485-606c-4ecd-a229-32d1925bc53c</d4p1:Id>
<d4p1:Name>sample string 2</d4p1:Name>
</Country>
<Id>df811348-2647-44e9-9bb4-0a7d765e60b5</Id>
<StateProvince xmlns:d4p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers">
<d4p1:Id>c93d5485-606c-4ecd-a229-32d1925bc53c</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>c93d5485-606c-4ecd-a229-32d1925bc53c</d4p1:Id>
<d4p1:Name>sample string 2</d4p1:Name>
</Country>
<Id>df811348-2647-44e9-9bb4-0a7d765e60b5</Id>
<StateProvince xmlns:d4p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers">
<d4p1:Id>c93d5485-606c-4ecd-a229-32d1925bc53c</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>c93d5485-606c-4ecd-a229-32d1925bc53c</d2p1:Id>
<d2p1:Name>sample string 2</d2p1:Name>
</CreditType>
<EducationalTime>9</EducationalTime>
<Id>6b2aa6ac-72e8-4719-9c5e-294cb02642ab</Id>
<IsAttested>true</IsAttested>
<IsAudited>true</IsAudited>
<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>c93d5485-606c-4ecd-a229-32d1925bc53c</d2p1:Id>
<d2p1:Name>sample string 2</d2p1:Name>
</ParentProgram>
<PresenterName>sample string 8</PresenterName>
<ProgramComments>
<ProgramComment>
<Comment>sample string 3</Comment>
<CreatedOn>2026-06-17T11:33:24.4140812+00:00</CreatedOn>
<IsHistorical>true</IsHistorical>
<NoteType xmlns:d4p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers">
<d4p1:Label>sample string 1</d4p1:Label>
<d4p1:Value>2</d4p1:Value>
</NoteType>
</ProgramComment>
<ProgramComment>
<Comment>sample string 3</Comment>
<CreatedOn>2026-06-17T11:33:24.4140812+00:00</CreatedOn>
<IsHistorical>true</IsHistorical>
<NoteType xmlns:d4p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers">
<d4p1:Label>sample string 1</d4p1:Label>
<d4p1:Value>2</d4p1:Value>
</NoteType>
</ProgramComment>
</ProgramComments>
<ProgramEndDate>2026-06-17T11:33:24.3985427+00:00</ProgramEndDate>
<ProgramId>sample string 2</ProgramId>
<ProgramStartDate>2026-06-17T11:33:24.3985427+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>c93d5485-606c-4ecd-a229-32d1925bc53c</d2p1:Id>
<d2p1:Name>sample string 2</d2p1:Name>
</ProgramType>
<ProgramURL>sample string 6</ProgramURL>
<Receipt>
<InvoiceDate>2026-06-17T11:33:24.4140812+00:00</InvoiceDate>
<InvoiceId>7dc1e1f7-4e21-48aa-ba04-cdfce6be02d4</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>
<ResubmitProgram>true</ResubmitProgram>
<ReviewAgendaDoc>true</ReviewAgendaDoc>
<ReviewAttendanceMonitoredBy>true</ReviewAttendanceMonitoredBy>
<ReviewCourseType>true</ReviewCourseType>
<ReviewCreditType>true</ReviewCreditType>
<ReviewDescription>true</ReviewDescription>
<ReviewEndDate>true</ReviewEndDate>
<ReviewFunctionalAreaResponsibilities>true</ReviewFunctionalAreaResponsibilities>
<ReviewFunctionalAreas>true</ReviewFunctionalAreas>
<ReviewName>true</ReviewName>
<ReviewNonLearningTime>true</ReviewNonLearningTime>
<ReviewOngoingActivity />
<ReviewPresenterBioDoc>true</ReviewPresenterBioDoc>
<ReviewPresenterNames>true</ReviewPresenterNames>
<ReviewProgramLocation>true</ReviewProgramLocation>
<ReviewProgramPresentationDoc>true</ReviewProgramPresentationDoc>
<ReviewProgramWebsite>true</ReviewProgramWebsite>
<ReviewSessionGrid>true</ReviewSessionGrid>
<ReviewStartDate>true</ReviewStartDate>
<ReviewTotalTime>true</ReviewTotalTime>
<SubmissionDate>sample string 23</SubmissionDate>
<SubmitProgram>true</SubmitProgram>
<UserComment>sample string 45</UserComment>
<WebProductId>3e5d689d-6217-43a3-9fcc-ea2282d14014</WebProductId>
<WebProductName>sample string 20</WebProductName>
</ProviderProgram>