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

Request Information

URI Parameters

Name	Description	Type	Additional information
accountId		globally unique identifier	Required
programId		globally unique identifier	Required

Body Parameters

None.

Response Information

Resource Description

ProviderProgram

Name	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.

Response Formats

application/json, text/json

Sample:

{
  "Id": "ca96c9e8-33a8-4c3c-94a7-5233eb6a0201",
  "ProgramType": {
    "Id": "23a35ea8-f8e1-4cd4-a896-361cae99ee5e",
    "Name": "sample string 2"
  },
  "ProgramId": "sample string 2",
  "ProgramTitle": "sample string 3",
  "ProgramStartDate": "2024-11-26T14:21:17.0181553+00:00",
  "ProgramEndDate": "2024-11-26T14:21:17.0181553+00:00",
  "ProgramURL": "sample string 6",
  "LearningObjectives": "sample string 7",
  "PresenterName": "sample string 8",
  "CreditType": {
    "Id": "23a35ea8-f8e1-4cd4-a896-361cae99ee5e",
    "Name": "sample string 2"
  },
  "EducationalTime": 9.0,
  "IsAvailableOnline": true,
  "CourseLocations": [
    {
      "Id": "00b3eb00-53d7-47ba-9d79-5d11a0183341",
      "Country": {
        "Id": "23a35ea8-f8e1-4cd4-a896-361cae99ee5e",
        "Name": "sample string 2"
      },
      "StateProvince": {
        "Id": "23a35ea8-f8e1-4cd4-a896-361cae99ee5e",
        "Name": "sample string 2"
      },
      "StateProvinceString": "sample string 2",
      "City": "sample string 3"
    },
    {
      "Id": "00b3eb00-53d7-47ba-9d79-5d11a0183341",
      "Country": {
        "Id": "23a35ea8-f8e1-4cd4-a896-361cae99ee5e",
        "Name": "sample string 2"
      },
      "StateProvince": {
        "Id": "23a35ea8-f8e1-4cd4-a896-361cae99ee5e",
        "Name": "sample string 2"
      },
      "StateProvinceString": "sample string 2",
      "City": "sample string 3"
    }
  ],
  "IsAttested": true,
  "IsRequirementMet": true,
  "ParentProgram": {
    "Id": "23a35ea8-f8e1-4cd4-a896-361cae99ee5e",
    "Name": "sample string 2"
  },
  "CreditHours": 13.0,
  "IsOngoingProgram": true,
  "IsDuplicate": true,
  "NonLearningTime": 16.0,
  "ProgramStatus": {
    "Label": "sample string 1",
    "Value": 2
  },
  "SubmitProgram": true,
  "ContactId": "0c852e87-91ca-4ec8-8cfc-667144029978",
  "WebProductId": "fd56433a-17e1-4f1c-ad7e-a931c103c86c",
  "WebProductName": "sample string 20",
  "Receipt": {
    "InvoiceId": "b19a2779-03ff-4748-b84e-8d452b4eddfc",
    "Messages": [
      "sample string 1",
      "sample string 2"
    ],
    "InvoiceNumber": "sample string 2",
    "InvoiceDate": "2024-11-26T14:21:17.0181553+00:00",
    "TotalAmountPaid": 4.0,
    "PaymentAuthorizationNumber": "sample string 5"
  }
}

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>0c852e87-91ca-4ec8-8cfc-667144029978</ContactId>
  <CourseLocations>
    <CourseLocation>
      <City>sample string 3</City>
      <Country xmlns:d4p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers">
        <d4p1:Id>23a35ea8-f8e1-4cd4-a896-361cae99ee5e</d4p1:Id>
        <d4p1:Name>sample string 2</d4p1:Name>
      </Country>
      <Id>00b3eb00-53d7-47ba-9d79-5d11a0183341</Id>
      <StateProvince xmlns:d4p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers">
        <d4p1:Id>23a35ea8-f8e1-4cd4-a896-361cae99ee5e</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>23a35ea8-f8e1-4cd4-a896-361cae99ee5e</d4p1:Id>
        <d4p1:Name>sample string 2</d4p1:Name>
      </Country>
      <Id>00b3eb00-53d7-47ba-9d79-5d11a0183341</Id>
      <StateProvince xmlns:d4p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers">
        <d4p1:Id>23a35ea8-f8e1-4cd4-a896-361cae99ee5e</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>23a35ea8-f8e1-4cd4-a896-361cae99ee5e</d2p1:Id>
    <d2p1:Name>sample string 2</d2p1:Name>
  </CreditType>
  <EducationalTime>9</EducationalTime>
  <Id>ca96c9e8-33a8-4c3c-94a7-5233eb6a0201</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>23a35ea8-f8e1-4cd4-a896-361cae99ee5e</d2p1:Id>
    <d2p1:Name>sample string 2</d2p1:Name>
  </ParentProgram>
  <PresenterName>sample string 8</PresenterName>
  <ProgramEndDate>2024-11-26T14:21:17.0181553+00:00</ProgramEndDate>
  <ProgramId>sample string 2</ProgramId>
  <ProgramStartDate>2024-11-26T14:21:17.0181553+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>23a35ea8-f8e1-4cd4-a896-361cae99ee5e</d2p1:Id>
    <d2p1:Name>sample string 2</d2p1:Name>
  </ProgramType>
  <ProgramURL>sample string 6</ProgramURL>
  <Receipt>
    <InvoiceDate>2024-11-26T14:21:17.0181553+00:00</InvoiceDate>
    <InvoiceId>b19a2779-03ff-4748-b84e-8d452b4eddfc</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>
  <SubmitProgram>true</SubmitProgram>
  <WebProductId>fd56433a-17e1-4f1c-ad7e-a931c103c86c</WebProductId>
  <WebProductName>sample string 20</WebProductName>
</ProviderProgram>