GET api/provider/program?accountId={accountId}&programId={programId}

Get Provider Program

Request Information

URI Parameters

NameDescriptionTypeAdditional information
accountId

globally unique identifier

Required

programId

globally unique identifier

Required

Body Parameters

None.

Response Information

Resource Description

ProviderProgram
NameDescriptionTypeAdditional 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.

Response Formats

application/json, text/json

Sample:
{
  "Id": "2f1d04fe-9685-4271-9c1e-a3c2e7514860",
  "ProgramType": {
    "Id": "22b0e964-48d9-44db-b7b6-d6fbdbbadf5f",
    "Name": "sample string 2"
  },
  "ProgramId": "sample string 2",
  "ProgramTitle": "sample string 3",
  "ProgramStartDate": "2024-06-18T17:35:27.4151321+00:00",
  "ProgramEndDate": "2024-06-18T17:35:27.4151321+00:00",
  "ProgramURL": "sample string 6",
  "LearningObjectives": "sample string 7",
  "PresenterName": "sample string 8",
  "CreditType": {
    "Id": "22b0e964-48d9-44db-b7b6-d6fbdbbadf5f",
    "Name": "sample string 2"
  },
  "EducationalTime": 9.0,
  "IsAvailableOnline": true,
  "CourseLocations": [
    {
      "Id": "506853b5-8278-4757-b3bd-df5fc5ea4af5",
      "Country": {
        "Id": "22b0e964-48d9-44db-b7b6-d6fbdbbadf5f",
        "Name": "sample string 2"
      },
      "StateProvince": {
        "Id": "22b0e964-48d9-44db-b7b6-d6fbdbbadf5f",
        "Name": "sample string 2"
      },
      "StateProvinceString": "sample string 2",
      "City": "sample string 3"
    },
    {
      "Id": "506853b5-8278-4757-b3bd-df5fc5ea4af5",
      "Country": {
        "Id": "22b0e964-48d9-44db-b7b6-d6fbdbbadf5f",
        "Name": "sample string 2"
      },
      "StateProvince": {
        "Id": "22b0e964-48d9-44db-b7b6-d6fbdbbadf5f",
        "Name": "sample string 2"
      },
      "StateProvinceString": "sample string 2",
      "City": "sample string 3"
    }
  ],
  "IsAttested": true,
  "IsRequirementMet": true,
  "ParentProgram": {
    "Id": "22b0e964-48d9-44db-b7b6-d6fbdbbadf5f",
    "Name": "sample string 2"
  },
  "CreditHours": 13.0,
  "IsOngoingProgram": true,
  "IsDuplicate": true,
  "NonLearningTime": 16.0,
  "ProgramStatus": {
    "Label": "sample string 1",
    "Value": 2
  }
}

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">
  <CourseLocations>
    <CourseLocation>
      <City>sample string 3</City>
      <Country xmlns:d4p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers">
        <d4p1:Id>22b0e964-48d9-44db-b7b6-d6fbdbbadf5f</d4p1:Id>
        <d4p1:Name>sample string 2</d4p1:Name>
      </Country>
      <Id>506853b5-8278-4757-b3bd-df5fc5ea4af5</Id>
      <StateProvince xmlns:d4p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers">
        <d4p1:Id>22b0e964-48d9-44db-b7b6-d6fbdbbadf5f</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>22b0e964-48d9-44db-b7b6-d6fbdbbadf5f</d4p1:Id>
        <d4p1:Name>sample string 2</d4p1:Name>
      </Country>
      <Id>506853b5-8278-4757-b3bd-df5fc5ea4af5</Id>
      <StateProvince xmlns:d4p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers">
        <d4p1:Id>22b0e964-48d9-44db-b7b6-d6fbdbbadf5f</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>22b0e964-48d9-44db-b7b6-d6fbdbbadf5f</d2p1:Id>
    <d2p1:Name>sample string 2</d2p1:Name>
  </CreditType>
  <EducationalTime>9</EducationalTime>
  <Id>2f1d04fe-9685-4271-9c1e-a3c2e7514860</Id>
  <IsAttested>true</IsAttested>
  <IsAvailableOnline>true</IsAvailableOnline>
  <IsDuplicate>true</IsDuplicate>
  <IsOngoingProgram>true</IsOngoingProgram>
  <IsRequirementMet>true</IsRequirementMet>
  <LearningObjectives>sample string 7</LearningObjectives>
  <NonLearningTime>16</NonLearningTime>
  <ParentProgram xmlns:d2p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers">
    <d2p1:Id>22b0e964-48d9-44db-b7b6-d6fbdbbadf5f</d2p1:Id>
    <d2p1:Name>sample string 2</d2p1:Name>
  </ParentProgram>
  <PresenterName>sample string 8</PresenterName>
  <ProgramEndDate>2024-06-18T17:35:27.4151321+00:00</ProgramEndDate>
  <ProgramId>sample string 2</ProgramId>
  <ProgramStartDate>2024-06-18T17:35:27.4151321+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>22b0e964-48d9-44db-b7b6-d6fbdbbadf5f</d2p1:Id>
    <d2p1:Name>sample string 2</d2p1:Name>
  </ProgramType>
  <ProgramURL>sample string 6</ProgramURL>
</ProviderProgram>