GET api/provider/course?courseId={courseId}

Request Information

URI Parameters

Name	Description	Type	Additional information
courseId		globally unique identifier	Required

Body Parameters

None.

Response Information

Resource Description

ProviderCourse

Name	Type	Additional information
Id	globally unique identifier	None.
ProgramId	string	None.
PreviousProgramId	string	None.
ProgramType	ProgramType	None.
ProgramTypeString	string	None.
ProgramTitle	string	None.
ProgramStartDate	date	None.
ProgramEndDate	date	None.
SubmissionDate	date	None.
ProgramWebsite	string	None.
ProgramDescription	string	None.
CreditType	IdNamePair	None.
CreditTypeString	string	None.
RelevantFunctionalAreas	Collection of IdNamePair	None.
RelevantFunctionalAreaResponsibilities	Collection of RelevantFunctionalAreaResponsibility	None.
AttendanceMonitoredBy	Collection of Object	None.
CourseLocations	Collection of ProviderCourseLocation	None.
OtherAttendanceMonitors	string	None.
Attestation	boolean	None.
PresenterNames	string	None.
ScheduledProgramTime	string	None.
ScheduledNonLearningTime	string	None.
TotalCreditHoursRequested	string	None.
IsActivityOngoing	boolean	None.
ProgramOccurrence	OptionSetValueModel	None.
ProgramStatus	ProgramStatus	None.
ProgramStatusString	string	None.
Provider	IdNamePair	None.
CreditHours	string	None.
HRCIComments	string	None.
UserComments	string	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.
SessionGridFile	string	None.
PresenterBioFile	string	None.
ProgramAgendaFile	string	None.
IsDuplicateAllowed	boolean	None.
IsDuplicated	boolean	None.
ParentProgramCreatedOn	Object	None.

Response Formats

application/json, text/json

Sample:

{
  "Id": "a1d8e9db-d516-4e7e-8ed8-dcb5717a378a",
  "ProgramId": "sample string 2",
  "PreviousProgramId": "sample string 3",
  "ProgramType": {
    "Description": "sample string 1",
    "Id": "907df5aa-adfe-4160-be33-5cacaf3968ca",
    "Name": "sample string 3"
  },
  "ProgramTypeString": "sample string 4",
  "ProgramTitle": "sample string 5",
  "ProgramStartDate": "2024-11-21T08:57:00.6627168+00:00",
  "ProgramEndDate": "2024-11-21T08:57:00.6627168+00:00",
  "SubmissionDate": "2024-11-21T08:57:00.6627168+00:00",
  "ProgramWebsite": "sample string 9",
  "ProgramDescription": "sample string 10",
  "CreditType": {
    "Id": "dffc6a86-9784-4d10-891c-daa63078e311",
    "Name": "sample string 2"
  },
  "CreditTypeString": "sample string 11",
  "RelevantFunctionalAreas": [
    {
      "Id": "dffc6a86-9784-4d10-891c-daa63078e311",
      "Name": "sample string 2"
    },
    {
      "Id": "dffc6a86-9784-4d10-891c-daa63078e311",
      "Name": "sample string 2"
    }
  ],
  "RelevantFunctionalAreaResponsibilities": [
    {
      "Id": "1bd277d2-dd2c-4d22-8ce4-6ed2b3f287c9",
      "FunctionalAreaId": "333b796a-4f31-4e4c-a1d6-4d851a8b1100",
      "Name": "sample string 3"
    },
    {
      "Id": "1bd277d2-dd2c-4d22-8ce4-6ed2b3f287c9",
      "FunctionalAreaId": "333b796a-4f31-4e4c-a1d6-4d851a8b1100",
      "Name": "sample string 3"
    }
  ],
  "AttendanceMonitoredBy": null,
  "CourseLocations": [
    {
      "Id": "bf0aadee-8e1d-4bed-8b61-4bdbd7735a0a",
      "Country": {
        "Code": "sample string 1",
        "Id": "sample string 2",
        "Name": "sample string 3",
        "EmbargoCountry": true,
        "APPresScreen": true,
        "hasStates": true
      },
      "StateProvince": {
        "Code": "sample string 1",
        "Country": {
          "Code": "sample string 1",
          "Id": "sample string 2",
          "Name": "sample string 3",
          "EmbargoCountry": true,
          "APPresScreen": true,
          "hasStates": true
        },
        "Id": "sample string 2",
        "Name": "sample string 3"
      },
      "StateProvinceString": "sample string 2",
      "City": "sample string 3"
    },
    {
      "Id": "bf0aadee-8e1d-4bed-8b61-4bdbd7735a0a",
      "Country": {
        "Code": "sample string 1",
        "Id": "sample string 2",
        "Name": "sample string 3",
        "EmbargoCountry": true,
        "APPresScreen": true,
        "hasStates": true
      },
      "StateProvince": {
        "Code": "sample string 1",
        "Country": {
          "Code": "sample string 1",
          "Id": "sample string 2",
          "Name": "sample string 3",
          "EmbargoCountry": true,
          "APPresScreen": true,
          "hasStates": true
        },
        "Id": "sample string 2",
        "Name": "sample string 3"
      },
      "StateProvinceString": "sample string 2",
      "City": "sample string 3"
    }
  ],
  "OtherAttendanceMonitors": "sample string 12",
  "Attestation": true,
  "PresenterNames": "sample string 14",
  "ScheduledProgramTime": "sample string 15",
  "ScheduledNonLearningTime": "sample string 16",
  "TotalCreditHoursRequested": "sample string 17",
  "IsActivityOngoing": true,
  "ProgramOccurrence": {
    "Label": "sample string 1",
    "Value": 2
  },
  "ProgramStatus": {
    "Id": 1,
    "Name": "sample string 2"
  },
  "ProgramStatusString": "sample string 18",
  "Provider": {
    "Id": "dffc6a86-9784-4d10-891c-daa63078e311",
    "Name": "sample string 2"
  },
  "CreditHours": "sample string 19",
  "HRCIComments": "sample string 20",
  "UserComments": "sample string 21",
  "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,
  "SessionGridFile": "sample string 41",
  "PresenterBioFile": "sample string 42",
  "ProgramAgendaFile": "sample string 43",
  "IsDuplicateAllowed": true,
  "IsDuplicated": true,
  "ParentProgramCreatedOn": {}
}

application/xml, text/xml

Sample:

<ProviderCourse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models">
  <AttendanceMonitoredBy xmlns:d2p1="http://schemas.microsoft.com/xrm/9.0/Contracts" i:nil="true" />
  <Attestation>true</Attestation>
  <CourseLocations>
    <ProviderCourseLocation>
      <City>sample string 3</City>
      <Country>
        <APPresScreen>true</APPresScreen>
        <Code>sample string 1</Code>
        <EmbargoCountry>true</EmbargoCountry>
        <Id>sample string 2</Id>
        <Name>sample string 3</Name>
        <hasStates>true</hasStates>
      </Country>
      <Id>bf0aadee-8e1d-4bed-8b61-4bdbd7735a0a</Id>
      <StateProvince>
        <Code>sample string 1</Code>
        <Country>
          <APPresScreen>true</APPresScreen>
          <Code>sample string 1</Code>
          <EmbargoCountry>true</EmbargoCountry>
          <Id>sample string 2</Id>
          <Name>sample string 3</Name>
          <hasStates>true</hasStates>
        </Country>
        <Id>sample string 2</Id>
        <Name>sample string 3</Name>
      </StateProvince>
      <StateProvinceString>sample string 2</StateProvinceString>
    </ProviderCourseLocation>
    <ProviderCourseLocation>
      <City>sample string 3</City>
      <Country>
        <APPresScreen>true</APPresScreen>
        <Code>sample string 1</Code>
        <EmbargoCountry>true</EmbargoCountry>
        <Id>sample string 2</Id>
        <Name>sample string 3</Name>
        <hasStates>true</hasStates>
      </Country>
      <Id>bf0aadee-8e1d-4bed-8b61-4bdbd7735a0a</Id>
      <StateProvince>
        <Code>sample string 1</Code>
        <Country>
          <APPresScreen>true</APPresScreen>
          <Code>sample string 1</Code>
          <EmbargoCountry>true</EmbargoCountry>
          <Id>sample string 2</Id>
          <Name>sample string 3</Name>
          <hasStates>true</hasStates>
        </Country>
        <Id>sample string 2</Id>
        <Name>sample string 3</Name>
      </StateProvince>
      <StateProvinceString>sample string 2</StateProvinceString>
    </ProviderCourseLocation>
  </CourseLocations>
  <CreditHours>sample string 19</CreditHours>
  <CreditType xmlns:d2p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers">
    <d2p1:Id>dffc6a86-9784-4d10-891c-daa63078e311</d2p1:Id>
    <d2p1:Name>sample string 2</d2p1:Name>
  </CreditType>
  <CreditTypeString>sample string 11</CreditTypeString>
  <HRCIComments>sample string 20</HRCIComments>
  <Id>a1d8e9db-d516-4e7e-8ed8-dcb5717a378a</Id>
  <IsActivityOngoing>true</IsActivityOngoing>
  <IsDuplicateAllowed>true</IsDuplicateAllowed>
  <IsDuplicated>true</IsDuplicated>
  <OtherAttendanceMonitors>sample string 12</OtherAttendanceMonitors>
  <ParentProgramCreatedOn />
  <PresenterBioFile>sample string 42</PresenterBioFile>
  <PresenterNames>sample string 14</PresenterNames>
  <PreviousProgramId>sample string 3</PreviousProgramId>
  <ProgramAgendaFile>sample string 43</ProgramAgendaFile>
  <ProgramDescription>sample string 10</ProgramDescription>
  <ProgramEndDate>2024-11-21T08:57:00.6627168+00:00</ProgramEndDate>
  <ProgramId>sample string 2</ProgramId>
  <ProgramOccurrence 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>
  </ProgramOccurrence>
  <ProgramStartDate>2024-11-21T08:57:00.6627168+00:00</ProgramStartDate>
  <ProgramStatus>
    <Id>1</Id>
    <Name>sample string 2</Name>
  </ProgramStatus>
  <ProgramStatusString>sample string 18</ProgramStatusString>
  <ProgramTitle>sample string 5</ProgramTitle>
  <ProgramType>
    <Description>sample string 1</Description>
    <Id>907df5aa-adfe-4160-be33-5cacaf3968ca</Id>
    <Name>sample string 3</Name>
  </ProgramType>
  <ProgramTypeString>sample string 4</ProgramTypeString>
  <ProgramWebsite>sample string 9</ProgramWebsite>
  <Provider xmlns:d2p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers">
    <d2p1:Id>dffc6a86-9784-4d10-891c-daa63078e311</d2p1:Id>
    <d2p1:Name>sample string 2</d2p1:Name>
  </Provider>
  <RelevantFunctionalAreaResponsibilities>
    <RelevantFunctionalAreaResponsibility>
      <FunctionalAreaId>333b796a-4f31-4e4c-a1d6-4d851a8b1100</FunctionalAreaId>
      <Id>1bd277d2-dd2c-4d22-8ce4-6ed2b3f287c9</Id>
      <Name>sample string 3</Name>
    </RelevantFunctionalAreaResponsibility>
    <RelevantFunctionalAreaResponsibility>
      <FunctionalAreaId>333b796a-4f31-4e4c-a1d6-4d851a8b1100</FunctionalAreaId>
      <Id>1bd277d2-dd2c-4d22-8ce4-6ed2b3f287c9</Id>
      <Name>sample string 3</Name>
    </RelevantFunctionalAreaResponsibility>
  </RelevantFunctionalAreaResponsibilities>
  <RelevantFunctionalAreas xmlns:d2p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers">
    <d2p1:IdNamePair>
      <d2p1:Id>dffc6a86-9784-4d10-891c-daa63078e311</d2p1:Id>
      <d2p1:Name>sample string 2</d2p1:Name>
    </d2p1:IdNamePair>
    <d2p1:IdNamePair>
      <d2p1:Id>dffc6a86-9784-4d10-891c-daa63078e311</d2p1:Id>
      <d2p1:Name>sample string 2</d2p1:Name>
    </d2p1:IdNamePair>
  </RelevantFunctionalAreas>
  <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>
  <ScheduledNonLearningTime>sample string 16</ScheduledNonLearningTime>
  <ScheduledProgramTime>sample string 15</ScheduledProgramTime>
  <SessionGridFile>sample string 41</SessionGridFile>
  <SubmissionDate>2024-11-21T08:57:00.6627168+00:00</SubmissionDate>
  <TotalCreditHoursRequested>sample string 17</TotalCreditHoursRequested>
  <UserComments>sample string 21</UserComments>
</ProviderCourse>