POST api/recertapp/activity?contactId={contactId}&applicationId={applicationId}
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
contactId | globally unique identifier |
Required |
|
applicationId | globally unique identifier |
Required |
Body Parameters
RecertActivityName | Description | Type | Additional information |
---|---|---|---|
Id | globally unique identifier |
None. |
|
Name | string |
None. |
|
Category | IdNamePair |
None. |
|
CategoryName | string |
None. |
|
CeuType | IdNamePair |
None. |
|
CeuTypeName | string |
None. |
|
CeusEarnedHours | decimal number |
None. |
|
CeusRequestedHours | decimal number |
None. |
|
CourseEndDate | date |
None. |
|
CourseStartDate | date |
None. |
|
CourseId | globally unique identifier |
None. |
|
CourseNumber | string |
None. |
|
CourseType | IdNamePair |
None. |
|
CourseTypeName | string |
None. |
|
StartDate | date |
None. |
|
EndDate | date |
None. |
|
ReviewFlags | CEUActivityReviewFlags |
None. |
|
Status | OptionSetValueModel |
None. |
|
StatusName | string |
None. |
|
SupportingDocument | OptionSetValueModel |
None. |
|
Url | string |
None. |
|
SubmittedOn | date |
None. |
|
Description | string |
None. |
|
AttestationConfirmation | boolean |
None. |
|
EthicsRequirement | boolean |
None. |
|
Organization | string |
None. |
|
Comments | Collection of Comment |
None. |
|
UserComment | string |
None. |
|
CourseData | CourseData |
None. |
Request Formats
application/json, text/json
Sample:
{ "Id": "327136b3-a07f-48a6-aa6e-69d7502d3884", "Name": "sample string 2", "Category": { "Id": "61f6226a-a234-4d70-9544-a8c44192d888", "Name": "sample string 2" }, "CategoryName": "sample string 3", "CeuType": { "Id": "61f6226a-a234-4d70-9544-a8c44192d888", "Name": "sample string 2" }, "CeuTypeName": "sample string 4", "CeusEarnedHours": 5.0, "CeusRequestedHours": 6.0, "CourseEndDate": "2025-07-18T23:52:36.5577366+00:00", "CourseStartDate": "2025-07-18T23:52:36.5577366+00:00", "CourseId": "20082edb-df11-42a5-a9a5-d435be8bfc63", "CourseNumber": "sample string 7", "CourseType": { "Id": "61f6226a-a234-4d70-9544-a8c44192d888", "Name": "sample string 2" }, "CourseTypeName": "sample string 8", "StartDate": "2025-07-18T23:52:36.5577366+00:00", "EndDate": "2025-07-18T23:52:36.5577366+00:00", "ReviewFlags": { "ActivityCategory": true, "ActivityDescription": true, "ActivityType": true, "CeuName": true, "CeusRequested": true, "CreditType": true, "EndDate": true, "StartDate": true, "Url": true }, "Status": { "Label": "sample string 1", "Value": 2 }, "StatusName": "sample string 9", "SupportingDocument": { "Label": "sample string 1", "Value": 2 }, "Url": "sample string 10", "SubmittedOn": "2025-07-18T23:52:36.5733589+00:00", "Description": "sample string 12", "AttestationConfirmation": true, "EthicsRequirement": true, "Organization": "sample string 15", "Comments": [ { "Id": "602b13d4-1a2c-46cc-a54c-5becb8fdb778", "NoteType": { "Label": "sample string 1", "Value": 2 }, "CommentFrom": { "Label": "sample string 1", "Value": 2 }, "Text": "sample string 2", "CreatedOn": "2025-07-18T23:52:36.5733589+00:00" }, { "Id": "602b13d4-1a2c-46cc-a54c-5becb8fdb778", "NoteType": { "Label": "sample string 1", "Value": 2 }, "CommentFrom": { "Label": "sample string 1", "Value": 2 }, "Text": "sample string 2", "CreatedOn": "2025-07-18T23:52:36.5733589+00:00" } ], "UserComment": "sample string 16", "CourseData": { "StartDate": "2025-07-18T23:52:36.5733589+00:00", "EndDate": "2025-07-18T23:52:36.5733589+00:00", "AuditFailedDate": "2025-07-18T23:52:36.5733589+00:00", "ProgramStatus": 1, "OnGoingActivity": true } }
application/xml, text/xml
Sample:
<RecertActivity xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models"> <AttestationConfirmation>true</AttestationConfirmation> <Category xmlns:d2p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers"> <d2p1:Id>61f6226a-a234-4d70-9544-a8c44192d888</d2p1:Id> <d2p1:Name>sample string 2</d2p1:Name> </Category> <CategoryName>sample string 3</CategoryName> <CeuType xmlns:d2p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers"> <d2p1:Id>61f6226a-a234-4d70-9544-a8c44192d888</d2p1:Id> <d2p1:Name>sample string 2</d2p1:Name> </CeuType> <CeuTypeName>sample string 4</CeuTypeName> <CeusEarnedHours>5</CeusEarnedHours> <CeusRequestedHours>6</CeusRequestedHours> <Comments> <Comment> <CommentFrom 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> </CommentFrom> <CreatedOn>2025-07-18T23:52:36.5733589+00:00</CreatedOn> <Id>602b13d4-1a2c-46cc-a54c-5becb8fdb778</Id> <NoteType 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> </NoteType> <Text>sample string 2</Text> </Comment> <Comment> <CommentFrom 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> </CommentFrom> <CreatedOn>2025-07-18T23:52:36.5733589+00:00</CreatedOn> <Id>602b13d4-1a2c-46cc-a54c-5becb8fdb778</Id> <NoteType 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> </NoteType> <Text>sample string 2</Text> </Comment> </Comments> <CourseData> <AuditFailedDate>2025-07-18T23:52:36.5733589+00:00</AuditFailedDate> <EndDate>2025-07-18T23:52:36.5733589+00:00</EndDate> <OnGoingActivity>true</OnGoingActivity> <ProgramStatus>1</ProgramStatus> <StartDate>2025-07-18T23:52:36.5733589+00:00</StartDate> </CourseData> <CourseEndDate>2025-07-18T23:52:36.5577366+00:00</CourseEndDate> <CourseId>20082edb-df11-42a5-a9a5-d435be8bfc63</CourseId> <CourseNumber>sample string 7</CourseNumber> <CourseStartDate>2025-07-18T23:52:36.5577366+00:00</CourseStartDate> <CourseType xmlns:d2p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers"> <d2p1:Id>61f6226a-a234-4d70-9544-a8c44192d888</d2p1:Id> <d2p1:Name>sample string 2</d2p1:Name> </CourseType> <CourseTypeName>sample string 8</CourseTypeName> <Description>sample string 12</Description> <EndDate>2025-07-18T23:52:36.5577366+00:00</EndDate> <EthicsRequirement>true</EthicsRequirement> <Id>327136b3-a07f-48a6-aa6e-69d7502d3884</Id> <Name>sample string 2</Name> <Organization>sample string 15</Organization> <ReviewFlags> <ActivityCategory>true</ActivityCategory> <ActivityDescription>true</ActivityDescription> <ActivityType>true</ActivityType> <CeuName>true</CeuName> <CeusRequested>true</CeusRequested> <CreditType>true</CreditType> <EndDate>true</EndDate> <StartDate>true</StartDate> <Url>true</Url> </ReviewFlags> <StartDate>2025-07-18T23:52:36.5577366+00:00</StartDate> <Status 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> </Status> <StatusName>sample string 9</StatusName> <SubmittedOn>2025-07-18T23:52:36.5733589+00:00</SubmittedOn> <SupportingDocument 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> </SupportingDocument> <Url>sample string 10</Url> <UserComment>sample string 16</UserComment> </RecertActivity>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
RecertActivityName | Description | Type | Additional information |
---|---|---|---|
Id | globally unique identifier |
None. |
|
Name | string |
None. |
|
Category | IdNamePair |
None. |
|
CategoryName | string |
None. |
|
CeuType | IdNamePair |
None. |
|
CeuTypeName | string |
None. |
|
CeusEarnedHours | decimal number |
None. |
|
CeusRequestedHours | decimal number |
None. |
|
CourseEndDate | date |
None. |
|
CourseStartDate | date |
None. |
|
CourseId | globally unique identifier |
None. |
|
CourseNumber | string |
None. |
|
CourseType | IdNamePair |
None. |
|
CourseTypeName | string |
None. |
|
StartDate | date |
None. |
|
EndDate | date |
None. |
|
ReviewFlags | CEUActivityReviewFlags |
None. |
|
Status | OptionSetValueModel |
None. |
|
StatusName | string |
None. |
|
SupportingDocument | OptionSetValueModel |
None. |
|
Url | string |
None. |
|
SubmittedOn | date |
None. |
|
Description | string |
None. |
|
AttestationConfirmation | boolean |
None. |
|
EthicsRequirement | boolean |
None. |
|
Organization | string |
None. |
|
Comments | Collection of Comment |
None. |
|
UserComment | string |
None. |
|
CourseData | CourseData |
None. |
Response Formats
application/json, text/json
Sample:
{ "Id": "9cd452e0-582b-447b-89c6-7c08e106ea3f", "Name": "sample string 2", "Category": { "Id": "31776809-cc64-46d3-af69-3c802c71b0b2", "Name": "sample string 2" }, "CategoryName": "sample string 3", "CeuType": { "Id": "31776809-cc64-46d3-af69-3c802c71b0b2", "Name": "sample string 2" }, "CeuTypeName": "sample string 4", "CeusEarnedHours": 5.0, "CeusRequestedHours": 6.0, "CourseEndDate": "2025-07-18T23:52:36.7458638+00:00", "CourseStartDate": "2025-07-18T23:52:36.7458638+00:00", "CourseId": "ea75493f-e33f-4542-99dd-36459faa37a2", "CourseNumber": "sample string 7", "CourseType": { "Id": "31776809-cc64-46d3-af69-3c802c71b0b2", "Name": "sample string 2" }, "CourseTypeName": "sample string 8", "StartDate": "2025-07-18T23:52:36.7458638+00:00", "EndDate": "2025-07-18T23:52:36.7458638+00:00", "ReviewFlags": { "ActivityCategory": true, "ActivityDescription": true, "ActivityType": true, "CeuName": true, "CeusRequested": true, "CreditType": true, "EndDate": true, "StartDate": true, "Url": true }, "Status": { "Label": "sample string 1", "Value": 2 }, "StatusName": "sample string 9", "SupportingDocument": { "Label": "sample string 1", "Value": 2 }, "Url": "sample string 10", "SubmittedOn": "2025-07-18T23:52:36.7458638+00:00", "Description": "sample string 12", "AttestationConfirmation": true, "EthicsRequirement": true, "Organization": "sample string 15", "Comments": [ { "Id": "f3ddba9f-9afe-4d2f-80dd-89b3ea732d25", "NoteType": { "Label": "sample string 1", "Value": 2 }, "CommentFrom": { "Label": "sample string 1", "Value": 2 }, "Text": "sample string 2", "CreatedOn": "2025-07-18T23:52:36.7458638+00:00" }, { "Id": "f3ddba9f-9afe-4d2f-80dd-89b3ea732d25", "NoteType": { "Label": "sample string 1", "Value": 2 }, "CommentFrom": { "Label": "sample string 1", "Value": 2 }, "Text": "sample string 2", "CreatedOn": "2025-07-18T23:52:36.7458638+00:00" } ], "UserComment": "sample string 16", "CourseData": { "StartDate": "2025-07-18T23:52:36.7458638+00:00", "EndDate": "2025-07-18T23:52:36.7458638+00:00", "AuditFailedDate": "2025-07-18T23:52:36.7458638+00:00", "ProgramStatus": 1, "OnGoingActivity": true } }
application/xml, text/xml
Sample:
<RecertActivity xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models"> <AttestationConfirmation>true</AttestationConfirmation> <Category xmlns:d2p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers"> <d2p1:Id>31776809-cc64-46d3-af69-3c802c71b0b2</d2p1:Id> <d2p1:Name>sample string 2</d2p1:Name> </Category> <CategoryName>sample string 3</CategoryName> <CeuType xmlns:d2p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers"> <d2p1:Id>31776809-cc64-46d3-af69-3c802c71b0b2</d2p1:Id> <d2p1:Name>sample string 2</d2p1:Name> </CeuType> <CeuTypeName>sample string 4</CeuTypeName> <CeusEarnedHours>5</CeusEarnedHours> <CeusRequestedHours>6</CeusRequestedHours> <Comments> <Comment> <CommentFrom 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> </CommentFrom> <CreatedOn>2025-07-18T23:52:36.7458638+00:00</CreatedOn> <Id>f3ddba9f-9afe-4d2f-80dd-89b3ea732d25</Id> <NoteType 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> </NoteType> <Text>sample string 2</Text> </Comment> <Comment> <CommentFrom 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> </CommentFrom> <CreatedOn>2025-07-18T23:52:36.7458638+00:00</CreatedOn> <Id>f3ddba9f-9afe-4d2f-80dd-89b3ea732d25</Id> <NoteType 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> </NoteType> <Text>sample string 2</Text> </Comment> </Comments> <CourseData> <AuditFailedDate>2025-07-18T23:52:36.7458638+00:00</AuditFailedDate> <EndDate>2025-07-18T23:52:36.7458638+00:00</EndDate> <OnGoingActivity>true</OnGoingActivity> <ProgramStatus>1</ProgramStatus> <StartDate>2025-07-18T23:52:36.7458638+00:00</StartDate> </CourseData> <CourseEndDate>2025-07-18T23:52:36.7458638+00:00</CourseEndDate> <CourseId>ea75493f-e33f-4542-99dd-36459faa37a2</CourseId> <CourseNumber>sample string 7</CourseNumber> <CourseStartDate>2025-07-18T23:52:36.7458638+00:00</CourseStartDate> <CourseType xmlns:d2p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers"> <d2p1:Id>31776809-cc64-46d3-af69-3c802c71b0b2</d2p1:Id> <d2p1:Name>sample string 2</d2p1:Name> </CourseType> <CourseTypeName>sample string 8</CourseTypeName> <Description>sample string 12</Description> <EndDate>2025-07-18T23:52:36.7458638+00:00</EndDate> <EthicsRequirement>true</EthicsRequirement> <Id>9cd452e0-582b-447b-89c6-7c08e106ea3f</Id> <Name>sample string 2</Name> <Organization>sample string 15</Organization> <ReviewFlags> <ActivityCategory>true</ActivityCategory> <ActivityDescription>true</ActivityDescription> <ActivityType>true</ActivityType> <CeuName>true</CeuName> <CeusRequested>true</CeusRequested> <CreditType>true</CreditType> <EndDate>true</EndDate> <StartDate>true</StartDate> <Url>true</Url> </ReviewFlags> <StartDate>2025-07-18T23:52:36.7458638+00:00</StartDate> <Status 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> </Status> <StatusName>sample string 9</StatusName> <SubmittedOn>2025-07-18T23:52:36.7458638+00:00</SubmittedOn> <SupportingDocument 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> </SupportingDocument> <Url>sample string 10</Url> <UserComment>sample string 16</UserComment> </RecertActivity>