GET api/provider/program/list?accountId={accountId}&isHistoric={isHistoric}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
accountId

globally unique identifier

Required

isHistoric

boolean

Required

Body Parameters

None.

Response Information

Resource Description

ProviderProgramsList
NameDescriptionTypeAdditional information
Records

Collection of ProviderProgram

None.

TotalRecords

integer

None.

Response Formats

application/json, text/json

Sample:
{
  "Records": [
    {
      "Id": "c8f21d0d-efc7-447d-bcba-36e154f296f9",
      "ProgramType": {
        "Id": "083e92bf-d85e-4604-9147-8a0601c5b1af",
        "Name": "sample string 2"
      },
      "ProgramId": "sample string 2",
      "ProgramTitle": "sample string 3",
      "ProgramStartDate": "2025-01-22T08:11:15.4338357+00:00",
      "ProgramEndDate": "2025-01-22T08:11:15.4338357+00:00",
      "ProgramURL": "sample string 6",
      "LearningObjectives": "sample string 7",
      "PresenterName": "sample string 8",
      "CreditType": {
        "Id": "083e92bf-d85e-4604-9147-8a0601c5b1af",
        "Name": "sample string 2"
      },
      "EducationalTime": 9.0,
      "IsAvailableOnline": true,
      "CourseLocations": [
        {
          "Id": "373ccf14-bcfe-4a84-8de0-996c227f9922",
          "Country": {
            "Id": "083e92bf-d85e-4604-9147-8a0601c5b1af",
            "Name": "sample string 2"
          },
          "StateProvince": {
            "Id": "083e92bf-d85e-4604-9147-8a0601c5b1af",
            "Name": "sample string 2"
          },
          "StateProvinceString": "sample string 2",
          "City": "sample string 3"
        },
        {
          "Id": "373ccf14-bcfe-4a84-8de0-996c227f9922",
          "Country": {
            "Id": "083e92bf-d85e-4604-9147-8a0601c5b1af",
            "Name": "sample string 2"
          },
          "StateProvince": {
            "Id": "083e92bf-d85e-4604-9147-8a0601c5b1af",
            "Name": "sample string 2"
          },
          "StateProvinceString": "sample string 2",
          "City": "sample string 3"
        }
      ],
      "IsAttested": true,
      "IsRequirementMet": true,
      "ParentProgram": {
        "Id": "083e92bf-d85e-4604-9147-8a0601c5b1af",
        "Name": "sample string 2"
      },
      "CreditHours": 13.0,
      "IsOngoingProgram": true,
      "IsDuplicate": true,
      "NonLearningTime": 16.0,
      "ProgramStatus": {
        "Label": "sample string 1",
        "Value": 2
      },
      "SubmitProgram": true,
      "ContactId": "8174de0f-ba14-4faf-900a-61f27a53322e",
      "WebProductId": "19513b51-a83c-4690-aece-996344207c7e",
      "WebProductName": "sample string 20",
      "Receipt": {
        "InvoiceId": "e9868cdb-7586-4209-bd0b-6941e468a529",
        "Messages": [
          "sample string 1",
          "sample string 2"
        ],
        "InvoiceNumber": "sample string 2",
        "InvoiceDate": "2025-01-22T08:11:15.4338357+00:00",
        "TotalAmountPaid": 4.0,
        "PaymentAuthorizationNumber": "sample string 5"
      },
      "IsDuplicateAllowed": true,
      "IsRosterUploadAllowed": true
    },
    {
      "Id": "c8f21d0d-efc7-447d-bcba-36e154f296f9",
      "ProgramType": {
        "Id": "083e92bf-d85e-4604-9147-8a0601c5b1af",
        "Name": "sample string 2"
      },
      "ProgramId": "sample string 2",
      "ProgramTitle": "sample string 3",
      "ProgramStartDate": "2025-01-22T08:11:15.4338357+00:00",
      "ProgramEndDate": "2025-01-22T08:11:15.4338357+00:00",
      "ProgramURL": "sample string 6",
      "LearningObjectives": "sample string 7",
      "PresenterName": "sample string 8",
      "CreditType": {
        "Id": "083e92bf-d85e-4604-9147-8a0601c5b1af",
        "Name": "sample string 2"
      },
      "EducationalTime": 9.0,
      "IsAvailableOnline": true,
      "CourseLocations": [
        {
          "Id": "373ccf14-bcfe-4a84-8de0-996c227f9922",
          "Country": {
            "Id": "083e92bf-d85e-4604-9147-8a0601c5b1af",
            "Name": "sample string 2"
          },
          "StateProvince": {
            "Id": "083e92bf-d85e-4604-9147-8a0601c5b1af",
            "Name": "sample string 2"
          },
          "StateProvinceString": "sample string 2",
          "City": "sample string 3"
        },
        {
          "Id": "373ccf14-bcfe-4a84-8de0-996c227f9922",
          "Country": {
            "Id": "083e92bf-d85e-4604-9147-8a0601c5b1af",
            "Name": "sample string 2"
          },
          "StateProvince": {
            "Id": "083e92bf-d85e-4604-9147-8a0601c5b1af",
            "Name": "sample string 2"
          },
          "StateProvinceString": "sample string 2",
          "City": "sample string 3"
        }
      ],
      "IsAttested": true,
      "IsRequirementMet": true,
      "ParentProgram": {
        "Id": "083e92bf-d85e-4604-9147-8a0601c5b1af",
        "Name": "sample string 2"
      },
      "CreditHours": 13.0,
      "IsOngoingProgram": true,
      "IsDuplicate": true,
      "NonLearningTime": 16.0,
      "ProgramStatus": {
        "Label": "sample string 1",
        "Value": 2
      },
      "SubmitProgram": true,
      "ContactId": "8174de0f-ba14-4faf-900a-61f27a53322e",
      "WebProductId": "19513b51-a83c-4690-aece-996344207c7e",
      "WebProductName": "sample string 20",
      "Receipt": {
        "InvoiceId": "e9868cdb-7586-4209-bd0b-6941e468a529",
        "Messages": [
          "sample string 1",
          "sample string 2"
        ],
        "InvoiceNumber": "sample string 2",
        "InvoiceDate": "2025-01-22T08:11:15.4338357+00:00",
        "TotalAmountPaid": 4.0,
        "PaymentAuthorizationNumber": "sample string 5"
      },
      "IsDuplicateAllowed": true,
      "IsRosterUploadAllowed": true
    }
  ],
  "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>8174de0f-ba14-4faf-900a-61f27a53322e</ContactId>
      <CourseLocations>
        <CourseLocation>
          <City>sample string 3</City>
          <Country xmlns:d6p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers">
            <d6p1:Id>083e92bf-d85e-4604-9147-8a0601c5b1af</d6p1:Id>
            <d6p1:Name>sample string 2</d6p1:Name>
          </Country>
          <Id>373ccf14-bcfe-4a84-8de0-996c227f9922</Id>
          <StateProvince xmlns:d6p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers">
            <d6p1:Id>083e92bf-d85e-4604-9147-8a0601c5b1af</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>083e92bf-d85e-4604-9147-8a0601c5b1af</d6p1:Id>
            <d6p1:Name>sample string 2</d6p1:Name>
          </Country>
          <Id>373ccf14-bcfe-4a84-8de0-996c227f9922</Id>
          <StateProvince xmlns:d6p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers">
            <d6p1:Id>083e92bf-d85e-4604-9147-8a0601c5b1af</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>083e92bf-d85e-4604-9147-8a0601c5b1af</d4p1:Id>
        <d4p1:Name>sample string 2</d4p1:Name>
      </CreditType>
      <EducationalTime>9</EducationalTime>
      <Id>c8f21d0d-efc7-447d-bcba-36e154f296f9</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>083e92bf-d85e-4604-9147-8a0601c5b1af</d4p1:Id>
        <d4p1:Name>sample string 2</d4p1:Name>
      </ParentProgram>
      <PresenterName>sample string 8</PresenterName>
      <ProgramEndDate>2025-01-22T08:11:15.4338357+00:00</ProgramEndDate>
      <ProgramId>sample string 2</ProgramId>
      <ProgramStartDate>2025-01-22T08:11:15.4338357+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>083e92bf-d85e-4604-9147-8a0601c5b1af</d4p1:Id>
        <d4p1:Name>sample string 2</d4p1:Name>
      </ProgramType>
      <ProgramURL>sample string 6</ProgramURL>
      <Receipt>
        <InvoiceDate>2025-01-22T08:11:15.4338357+00:00</InvoiceDate>
        <InvoiceId>e9868cdb-7586-4209-bd0b-6941e468a529</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>
      <SubmitProgram>true</SubmitProgram>
      <WebProductId>19513b51-a83c-4690-aece-996344207c7e</WebProductId>
      <WebProductName>sample string 20</WebProductName>
    </ProviderProgram>
    <ProviderProgram>
      <ContactId>8174de0f-ba14-4faf-900a-61f27a53322e</ContactId>
      <CourseLocations>
        <CourseLocation>
          <City>sample string 3</City>
          <Country xmlns:d6p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers">
            <d6p1:Id>083e92bf-d85e-4604-9147-8a0601c5b1af</d6p1:Id>
            <d6p1:Name>sample string 2</d6p1:Name>
          </Country>
          <Id>373ccf14-bcfe-4a84-8de0-996c227f9922</Id>
          <StateProvince xmlns:d6p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers">
            <d6p1:Id>083e92bf-d85e-4604-9147-8a0601c5b1af</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>083e92bf-d85e-4604-9147-8a0601c5b1af</d6p1:Id>
            <d6p1:Name>sample string 2</d6p1:Name>
          </Country>
          <Id>373ccf14-bcfe-4a84-8de0-996c227f9922</Id>
          <StateProvince xmlns:d6p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers">
            <d6p1:Id>083e92bf-d85e-4604-9147-8a0601c5b1af</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>083e92bf-d85e-4604-9147-8a0601c5b1af</d4p1:Id>
        <d4p1:Name>sample string 2</d4p1:Name>
      </CreditType>
      <EducationalTime>9</EducationalTime>
      <Id>c8f21d0d-efc7-447d-bcba-36e154f296f9</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>083e92bf-d85e-4604-9147-8a0601c5b1af</d4p1:Id>
        <d4p1:Name>sample string 2</d4p1:Name>
      </ParentProgram>
      <PresenterName>sample string 8</PresenterName>
      <ProgramEndDate>2025-01-22T08:11:15.4338357+00:00</ProgramEndDate>
      <ProgramId>sample string 2</ProgramId>
      <ProgramStartDate>2025-01-22T08:11:15.4338357+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>083e92bf-d85e-4604-9147-8a0601c5b1af</d4p1:Id>
        <d4p1:Name>sample string 2</d4p1:Name>
      </ProgramType>
      <ProgramURL>sample string 6</ProgramURL>
      <Receipt>
        <InvoiceDate>2025-01-22T08:11:15.4338357+00:00</InvoiceDate>
        <InvoiceId>e9868cdb-7586-4209-bd0b-6941e468a529</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>
      <SubmitProgram>true</SubmitProgram>
      <WebProductId>19513b51-a83c-4690-aece-996344207c7e</WebProductId>
      <WebProductName>sample string 20</WebProductName>
    </ProviderProgram>
  </Records>
  <TotalRecords>1</TotalRecords>
</ProviderProgramsList>