GET api/provider/program/list?accountId={accountId}&isHistoric={isHistoric}
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
accountId | globally unique identifier |
Required |
|
isHistoric | boolean |
Required |
Body Parameters
None.
Response Information
Resource Description
ProviderProgramsListName | Description | Type | Additional information |
---|---|---|---|
Records | Collection of ProviderProgram |
None. |
|
TotalRecords | integer |
None. |
Response Formats
application/json, text/json
Sample:
{ "Records": [ { "Id": "c1e845e6-4dee-4741-a0cd-c7133534ea4b", "ProgramType": { "Id": "2f682b3d-e132-4503-a7cc-55e8450c2faf", "Name": "sample string 2" }, "ProgramId": "sample string 2", "ProgramTitle": "sample string 3", "ProgramStartDate": "2025-07-19T16:59:58.9247482+00:00", "ProgramEndDate": "2025-07-19T16:59:58.9466251+00:00", "ProgramURL": "sample string 6", "LearningObjectives": "sample string 7", "PresenterName": "sample string 8", "CreditType": { "Id": "2f682b3d-e132-4503-a7cc-55e8450c2faf", "Name": "sample string 2" }, "EducationalTime": 9.0, "IsAvailableOnline": true, "CourseLocations": [ { "Id": "3bf5d340-ba1e-4d16-b077-e873840bb654", "Country": { "Id": "2f682b3d-e132-4503-a7cc-55e8450c2faf", "Name": "sample string 2" }, "StateProvince": { "Id": "2f682b3d-e132-4503-a7cc-55e8450c2faf", "Name": "sample string 2" }, "StateProvinceString": "sample string 2", "City": "sample string 3" }, { "Id": "3bf5d340-ba1e-4d16-b077-e873840bb654", "Country": { "Id": "2f682b3d-e132-4503-a7cc-55e8450c2faf", "Name": "sample string 2" }, "StateProvince": { "Id": "2f682b3d-e132-4503-a7cc-55e8450c2faf", "Name": "sample string 2" }, "StateProvinceString": "sample string 2", "City": "sample string 3" } ], "IsAttested": true, "IsRequirementMet": true, "ParentProgram": { "Id": "2f682b3d-e132-4503-a7cc-55e8450c2faf", "Name": "sample string 2" }, "CreditHours": 13.0, "IsOngoingProgram": true, "IsDuplicate": true, "NonLearningTime": 16.0, "ProgramStatus": { "Label": "sample string 1", "Value": 2 }, "SubmitProgram": true, "ContactId": "a78665dd-fd4f-414c-ba77-ad42ba4fbd82", "WebProductId": "ea631ba6-a3b6-4afd-9dba-534d3eb855a0", "WebProductName": "sample string 20", "Receipt": { "InvoiceId": "6feef348-99f2-4197-bf67-17d5de4abb35", "Messages": [ "sample string 1", "sample string 2" ], "InvoiceNumber": "sample string 2", "InvoiceDate": "2025-07-19T16:59:58.9466251+00:00", "TotalAmountPaid": 4.0, "PaymentAuthorizationNumber": "sample string 5" }, "IsDuplicateAllowed": true, "IsRosterUploadAllowed": true, "SubmissionDate": "sample string 23" }, { "Id": "c1e845e6-4dee-4741-a0cd-c7133534ea4b", "ProgramType": { "Id": "2f682b3d-e132-4503-a7cc-55e8450c2faf", "Name": "sample string 2" }, "ProgramId": "sample string 2", "ProgramTitle": "sample string 3", "ProgramStartDate": "2025-07-19T16:59:58.9247482+00:00", "ProgramEndDate": "2025-07-19T16:59:58.9466251+00:00", "ProgramURL": "sample string 6", "LearningObjectives": "sample string 7", "PresenterName": "sample string 8", "CreditType": { "Id": "2f682b3d-e132-4503-a7cc-55e8450c2faf", "Name": "sample string 2" }, "EducationalTime": 9.0, "IsAvailableOnline": true, "CourseLocations": [ { "Id": "3bf5d340-ba1e-4d16-b077-e873840bb654", "Country": { "Id": "2f682b3d-e132-4503-a7cc-55e8450c2faf", "Name": "sample string 2" }, "StateProvince": { "Id": "2f682b3d-e132-4503-a7cc-55e8450c2faf", "Name": "sample string 2" }, "StateProvinceString": "sample string 2", "City": "sample string 3" }, { "Id": "3bf5d340-ba1e-4d16-b077-e873840bb654", "Country": { "Id": "2f682b3d-e132-4503-a7cc-55e8450c2faf", "Name": "sample string 2" }, "StateProvince": { "Id": "2f682b3d-e132-4503-a7cc-55e8450c2faf", "Name": "sample string 2" }, "StateProvinceString": "sample string 2", "City": "sample string 3" } ], "IsAttested": true, "IsRequirementMet": true, "ParentProgram": { "Id": "2f682b3d-e132-4503-a7cc-55e8450c2faf", "Name": "sample string 2" }, "CreditHours": 13.0, "IsOngoingProgram": true, "IsDuplicate": true, "NonLearningTime": 16.0, "ProgramStatus": { "Label": "sample string 1", "Value": 2 }, "SubmitProgram": true, "ContactId": "a78665dd-fd4f-414c-ba77-ad42ba4fbd82", "WebProductId": "ea631ba6-a3b6-4afd-9dba-534d3eb855a0", "WebProductName": "sample string 20", "Receipt": { "InvoiceId": "6feef348-99f2-4197-bf67-17d5de4abb35", "Messages": [ "sample string 1", "sample string 2" ], "InvoiceNumber": "sample string 2", "InvoiceDate": "2025-07-19T16:59:58.9466251+00:00", "TotalAmountPaid": 4.0, "PaymentAuthorizationNumber": "sample string 5" }, "IsDuplicateAllowed": true, "IsRosterUploadAllowed": true, "SubmissionDate": "sample string 23" } ], "TotalRecords": 1 }
application/xml, text/xml
Sample:
<ProviderProgramsList xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models"> <Records> <ProviderProgram> <ContactId>a78665dd-fd4f-414c-ba77-ad42ba4fbd82</ContactId> <CourseLocations> <CourseLocation> <City>sample string 3</City> <Country xmlns:d6p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers"> <d6p1:Id>2f682b3d-e132-4503-a7cc-55e8450c2faf</d6p1:Id> <d6p1:Name>sample string 2</d6p1:Name> </Country> <Id>3bf5d340-ba1e-4d16-b077-e873840bb654</Id> <StateProvince xmlns:d6p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers"> <d6p1:Id>2f682b3d-e132-4503-a7cc-55e8450c2faf</d6p1:Id> <d6p1:Name>sample string 2</d6p1:Name> </StateProvince> <StateProvinceString>sample string 2</StateProvinceString> </CourseLocation> <CourseLocation> <City>sample string 3</City> <Country xmlns:d6p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers"> <d6p1:Id>2f682b3d-e132-4503-a7cc-55e8450c2faf</d6p1:Id> <d6p1:Name>sample string 2</d6p1:Name> </Country> <Id>3bf5d340-ba1e-4d16-b077-e873840bb654</Id> <StateProvince xmlns:d6p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers"> <d6p1:Id>2f682b3d-e132-4503-a7cc-55e8450c2faf</d6p1:Id> <d6p1:Name>sample string 2</d6p1:Name> </StateProvince> <StateProvinceString>sample string 2</StateProvinceString> </CourseLocation> </CourseLocations> <CreditHours>13</CreditHours> <CreditType xmlns:d4p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers"> <d4p1:Id>2f682b3d-e132-4503-a7cc-55e8450c2faf</d4p1:Id> <d4p1:Name>sample string 2</d4p1:Name> </CreditType> <EducationalTime>9</EducationalTime> <Id>c1e845e6-4dee-4741-a0cd-c7133534ea4b</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:d4p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers"> <d4p1:Id>2f682b3d-e132-4503-a7cc-55e8450c2faf</d4p1:Id> <d4p1:Name>sample string 2</d4p1:Name> </ParentProgram> <PresenterName>sample string 8</PresenterName> <ProgramEndDate>2025-07-19T16:59:58.9466251+00:00</ProgramEndDate> <ProgramId>sample string 2</ProgramId> <ProgramStartDate>2025-07-19T16:59:58.9247482+00:00</ProgramStartDate> <ProgramStatus 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> </ProgramStatus> <ProgramTitle>sample string 3</ProgramTitle> <ProgramType xmlns:d4p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers"> <d4p1:Id>2f682b3d-e132-4503-a7cc-55e8450c2faf</d4p1:Id> <d4p1:Name>sample string 2</d4p1:Name> </ProgramType> <ProgramURL>sample string 6</ProgramURL> <Receipt> <InvoiceDate>2025-07-19T16:59:58.9466251+00:00</InvoiceDate> <InvoiceId>6feef348-99f2-4197-bf67-17d5de4abb35</InvoiceId> <InvoiceNumber>sample string 2</InvoiceNumber> <Messages xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d5p1:string>sample string 1</d5p1:string> <d5p1:string>sample string 2</d5p1:string> </Messages> <PaymentAuthorizationNumber>sample string 5</PaymentAuthorizationNumber> <TotalAmountPaid>4</TotalAmountPaid> </Receipt> <SubmissionDate>sample string 23</SubmissionDate> <SubmitProgram>true</SubmitProgram> <WebProductId>ea631ba6-a3b6-4afd-9dba-534d3eb855a0</WebProductId> <WebProductName>sample string 20</WebProductName> </ProviderProgram> <ProviderProgram> <ContactId>a78665dd-fd4f-414c-ba77-ad42ba4fbd82</ContactId> <CourseLocations> <CourseLocation> <City>sample string 3</City> <Country xmlns:d6p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers"> <d6p1:Id>2f682b3d-e132-4503-a7cc-55e8450c2faf</d6p1:Id> <d6p1:Name>sample string 2</d6p1:Name> </Country> <Id>3bf5d340-ba1e-4d16-b077-e873840bb654</Id> <StateProvince xmlns:d6p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers"> <d6p1:Id>2f682b3d-e132-4503-a7cc-55e8450c2faf</d6p1:Id> <d6p1:Name>sample string 2</d6p1:Name> </StateProvince> <StateProvinceString>sample string 2</StateProvinceString> </CourseLocation> <CourseLocation> <City>sample string 3</City> <Country xmlns:d6p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers"> <d6p1:Id>2f682b3d-e132-4503-a7cc-55e8450c2faf</d6p1:Id> <d6p1:Name>sample string 2</d6p1:Name> </Country> <Id>3bf5d340-ba1e-4d16-b077-e873840bb654</Id> <StateProvince xmlns:d6p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers"> <d6p1:Id>2f682b3d-e132-4503-a7cc-55e8450c2faf</d6p1:Id> <d6p1:Name>sample string 2</d6p1:Name> </StateProvince> <StateProvinceString>sample string 2</StateProvinceString> </CourseLocation> </CourseLocations> <CreditHours>13</CreditHours> <CreditType xmlns:d4p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers"> <d4p1:Id>2f682b3d-e132-4503-a7cc-55e8450c2faf</d4p1:Id> <d4p1:Name>sample string 2</d4p1:Name> </CreditType> <EducationalTime>9</EducationalTime> <Id>c1e845e6-4dee-4741-a0cd-c7133534ea4b</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:d4p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers"> <d4p1:Id>2f682b3d-e132-4503-a7cc-55e8450c2faf</d4p1:Id> <d4p1:Name>sample string 2</d4p1:Name> </ParentProgram> <PresenterName>sample string 8</PresenterName> <ProgramEndDate>2025-07-19T16:59:58.9466251+00:00</ProgramEndDate> <ProgramId>sample string 2</ProgramId> <ProgramStartDate>2025-07-19T16:59:58.9247482+00:00</ProgramStartDate> <ProgramStatus 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> </ProgramStatus> <ProgramTitle>sample string 3</ProgramTitle> <ProgramType xmlns:d4p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers"> <d4p1:Id>2f682b3d-e132-4503-a7cc-55e8450c2faf</d4p1:Id> <d4p1:Name>sample string 2</d4p1:Name> </ProgramType> <ProgramURL>sample string 6</ProgramURL> <Receipt> <InvoiceDate>2025-07-19T16:59:58.9466251+00:00</InvoiceDate> <InvoiceId>6feef348-99f2-4197-bf67-17d5de4abb35</InvoiceId> <InvoiceNumber>sample string 2</InvoiceNumber> <Messages xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d5p1:string>sample string 1</d5p1:string> <d5p1:string>sample string 2</d5p1:string> </Messages> <PaymentAuthorizationNumber>sample string 5</PaymentAuthorizationNumber> <TotalAmountPaid>4</TotalAmountPaid> </Receipt> <SubmissionDate>sample string 23</SubmissionDate> <SubmitProgram>true</SubmitProgram> <WebProductId>ea631ba6-a3b6-4afd-9dba-534d3eb855a0</WebProductId> <WebProductName>sample string 20</WebProductName> </ProviderProgram> </Records> <TotalRecords>1</TotalRecords> </ProviderProgramsList>