POST api/provider/program/create?accountId={accountId}
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
accountId | globally unique identifier |
Required |
Body Parameters
ProviderProgramName | Description | 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. |
|
IsDuplicateAllowed | boolean |
None. |
|
IsRosterUploadAllowed | boolean |
None. |
|
SubmissionDate | string |
None. |
Request Formats
application/json, text/json
Sample:
{ "Id": "b53d6ae7-4de7-4501-9fc6-f09de3ab322a", "ProgramType": { "Id": "f39cd243-8c25-415c-b2b2-ad14f45d2121", "Name": "sample string 2" }, "ProgramId": "sample string 2", "ProgramTitle": "sample string 3", "ProgramStartDate": "2025-09-01T06:55:17.1707942-04:00", "ProgramEndDate": "2025-09-01T06:55:17.1707942-04:00", "ProgramURL": "sample string 6", "LearningObjectives": "sample string 7", "PresenterName": "sample string 8", "CreditType": { "Id": "f39cd243-8c25-415c-b2b2-ad14f45d2121", "Name": "sample string 2" }, "EducationalTime": 9.0, "IsAvailableOnline": true, "CourseLocations": [ { "Id": "f83d60e7-84c8-4775-ba93-04c1798f75e8", "Country": { "Id": "f39cd243-8c25-415c-b2b2-ad14f45d2121", "Name": "sample string 2" }, "StateProvince": { "Id": "f39cd243-8c25-415c-b2b2-ad14f45d2121", "Name": "sample string 2" }, "StateProvinceString": "sample string 2", "City": "sample string 3" }, { "Id": "f83d60e7-84c8-4775-ba93-04c1798f75e8", "Country": { "Id": "f39cd243-8c25-415c-b2b2-ad14f45d2121", "Name": "sample string 2" }, "StateProvince": { "Id": "f39cd243-8c25-415c-b2b2-ad14f45d2121", "Name": "sample string 2" }, "StateProvinceString": "sample string 2", "City": "sample string 3" } ], "IsAttested": true, "IsRequirementMet": true, "ParentProgram": { "Id": "f39cd243-8c25-415c-b2b2-ad14f45d2121", "Name": "sample string 2" }, "CreditHours": 13.0, "IsOngoingProgram": true, "IsDuplicate": true, "NonLearningTime": 16.0, "ProgramStatus": { "Label": "sample string 1", "Value": 2 }, "SubmitProgram": true, "ContactId": "7b46f5d0-0c1f-48fa-a36a-db7ba1efba25", "WebProductId": "d234d00f-12c7-437e-9726-1c94bd8553ba", "WebProductName": "sample string 20", "Receipt": { "InvoiceId": "8fa65563-3274-4453-9c47-6f21c0ad0606", "Messages": [ "sample string 1", "sample string 2" ], "InvoiceNumber": "sample string 2", "InvoiceDate": "2025-09-01T06:55:17.1707942-04:00", "TotalAmountPaid": 4.0, "PaymentAuthorizationNumber": "sample string 5" }, "IsDuplicateAllowed": true, "IsRosterUploadAllowed": true, "SubmissionDate": "sample string 23" }
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>7b46f5d0-0c1f-48fa-a36a-db7ba1efba25</ContactId> <CourseLocations> <CourseLocation> <City>sample string 3</City> <Country xmlns:d4p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers"> <d4p1:Id>f39cd243-8c25-415c-b2b2-ad14f45d2121</d4p1:Id> <d4p1:Name>sample string 2</d4p1:Name> </Country> <Id>f83d60e7-84c8-4775-ba93-04c1798f75e8</Id> <StateProvince xmlns:d4p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers"> <d4p1:Id>f39cd243-8c25-415c-b2b2-ad14f45d2121</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>f39cd243-8c25-415c-b2b2-ad14f45d2121</d4p1:Id> <d4p1:Name>sample string 2</d4p1:Name> </Country> <Id>f83d60e7-84c8-4775-ba93-04c1798f75e8</Id> <StateProvince xmlns:d4p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers"> <d4p1:Id>f39cd243-8c25-415c-b2b2-ad14f45d2121</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>f39cd243-8c25-415c-b2b2-ad14f45d2121</d2p1:Id> <d2p1:Name>sample string 2</d2p1:Name> </CreditType> <EducationalTime>9</EducationalTime> <Id>b53d6ae7-4de7-4501-9fc6-f09de3ab322a</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:d2p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers"> <d2p1:Id>f39cd243-8c25-415c-b2b2-ad14f45d2121</d2p1:Id> <d2p1:Name>sample string 2</d2p1:Name> </ParentProgram> <PresenterName>sample string 8</PresenterName> <ProgramEndDate>2025-09-01T06:55:17.1707942-04:00</ProgramEndDate> <ProgramId>sample string 2</ProgramId> <ProgramStartDate>2025-09-01T06:55:17.1707942-04: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>f39cd243-8c25-415c-b2b2-ad14f45d2121</d2p1:Id> <d2p1:Name>sample string 2</d2p1:Name> </ProgramType> <ProgramURL>sample string 6</ProgramURL> <Receipt> <InvoiceDate>2025-09-01T06:55:17.1707942-04:00</InvoiceDate> <InvoiceId>8fa65563-3274-4453-9c47-6f21c0ad0606</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> <SubmissionDate>sample string 23</SubmissionDate> <SubmitProgram>true</SubmitProgram> <WebProductId>d234d00f-12c7-437e-9726-1c94bd8553ba</WebProductId> <WebProductName>sample string 20</WebProductName> </ProviderProgram>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
ProviderProgramName | Description | 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. |
|
IsDuplicateAllowed | boolean |
None. |
|
IsRosterUploadAllowed | boolean |
None. |
|
SubmissionDate | string |
None. |
Response Formats
application/json, text/json
Sample:
{ "Id": "b8f4ccb8-d972-4fb3-9b1a-189c4e920abc", "ProgramType": { "Id": "49b22208-1e75-4843-9913-fa347756e455", "Name": "sample string 2" }, "ProgramId": "sample string 2", "ProgramTitle": "sample string 3", "ProgramStartDate": "2025-09-01T06:55:17.1864031-04:00", "ProgramEndDate": "2025-09-01T06:55:17.1864031-04:00", "ProgramURL": "sample string 6", "LearningObjectives": "sample string 7", "PresenterName": "sample string 8", "CreditType": { "Id": "49b22208-1e75-4843-9913-fa347756e455", "Name": "sample string 2" }, "EducationalTime": 9.0, "IsAvailableOnline": true, "CourseLocations": [ { "Id": "45f1b0b1-36ee-48cc-bda3-01874feee9a0", "Country": { "Id": "49b22208-1e75-4843-9913-fa347756e455", "Name": "sample string 2" }, "StateProvince": { "Id": "49b22208-1e75-4843-9913-fa347756e455", "Name": "sample string 2" }, "StateProvinceString": "sample string 2", "City": "sample string 3" }, { "Id": "45f1b0b1-36ee-48cc-bda3-01874feee9a0", "Country": { "Id": "49b22208-1e75-4843-9913-fa347756e455", "Name": "sample string 2" }, "StateProvince": { "Id": "49b22208-1e75-4843-9913-fa347756e455", "Name": "sample string 2" }, "StateProvinceString": "sample string 2", "City": "sample string 3" } ], "IsAttested": true, "IsRequirementMet": true, "ParentProgram": { "Id": "49b22208-1e75-4843-9913-fa347756e455", "Name": "sample string 2" }, "CreditHours": 13.0, "IsOngoingProgram": true, "IsDuplicate": true, "NonLearningTime": 16.0, "ProgramStatus": { "Label": "sample string 1", "Value": 2 }, "SubmitProgram": true, "ContactId": "38fb0c5d-8feb-46ec-8465-a209def3c9c2", "WebProductId": "f4d623c2-a40e-48a7-af9a-e039f9797127", "WebProductName": "sample string 20", "Receipt": { "InvoiceId": "c3c32bcb-da9e-4038-a0aa-0b1b4a50c922", "Messages": [ "sample string 1", "sample string 2" ], "InvoiceNumber": "sample string 2", "InvoiceDate": "2025-09-01T06:55:17.1864031-04:00", "TotalAmountPaid": 4.0, "PaymentAuthorizationNumber": "sample string 5" }, "IsDuplicateAllowed": true, "IsRosterUploadAllowed": true, "SubmissionDate": "sample string 23" }
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>38fb0c5d-8feb-46ec-8465-a209def3c9c2</ContactId> <CourseLocations> <CourseLocation> <City>sample string 3</City> <Country xmlns:d4p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers"> <d4p1:Id>49b22208-1e75-4843-9913-fa347756e455</d4p1:Id> <d4p1:Name>sample string 2</d4p1:Name> </Country> <Id>45f1b0b1-36ee-48cc-bda3-01874feee9a0</Id> <StateProvince xmlns:d4p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers"> <d4p1:Id>49b22208-1e75-4843-9913-fa347756e455</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>49b22208-1e75-4843-9913-fa347756e455</d4p1:Id> <d4p1:Name>sample string 2</d4p1:Name> </Country> <Id>45f1b0b1-36ee-48cc-bda3-01874feee9a0</Id> <StateProvince xmlns:d4p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers"> <d4p1:Id>49b22208-1e75-4843-9913-fa347756e455</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>49b22208-1e75-4843-9913-fa347756e455</d2p1:Id> <d2p1:Name>sample string 2</d2p1:Name> </CreditType> <EducationalTime>9</EducationalTime> <Id>b8f4ccb8-d972-4fb3-9b1a-189c4e920abc</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:d2p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers"> <d2p1:Id>49b22208-1e75-4843-9913-fa347756e455</d2p1:Id> <d2p1:Name>sample string 2</d2p1:Name> </ParentProgram> <PresenterName>sample string 8</PresenterName> <ProgramEndDate>2025-09-01T06:55:17.1864031-04:00</ProgramEndDate> <ProgramId>sample string 2</ProgramId> <ProgramStartDate>2025-09-01T06:55:17.1864031-04: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>49b22208-1e75-4843-9913-fa347756e455</d2p1:Id> <d2p1:Name>sample string 2</d2p1:Name> </ProgramType> <ProgramURL>sample string 6</ProgramURL> <Receipt> <InvoiceDate>2025-09-01T06:55:17.1864031-04:00</InvoiceDate> <InvoiceId>c3c32bcb-da9e-4038-a0aa-0b1b4a50c922</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> <SubmissionDate>sample string 23</SubmissionDate> <SubmitProgram>true</SubmitProgram> <WebProductId>f4d623c2-a40e-48a7-af9a-e039f9797127</WebProductId> <WebProductName>sample string 20</WebProductName> </ProviderProgram>