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. |
Request Formats
application/json, text/json
Sample:
{ "Id": "32be03a7-0d0e-4f66-85d1-556c54cd79b1", "Name": "sample string 2", "Category": { "Id": "202596e1-0f3f-4545-b31d-8182eabc8a3a", "Name": "sample string 2" }, "CategoryName": "sample string 3", "CeuType": { "Id": "202596e1-0f3f-4545-b31d-8182eabc8a3a", "Name": "sample string 2" }, "CeuTypeName": "sample string 4", "CeusEarnedHours": 5.0, "CeusRequestedHours": 6.0, "CourseEndDate": "2024-12-26T19:33:31.2266118+00:00", "CourseStartDate": "2024-12-26T19:33:31.2266118+00:00", "CourseId": "e0e48b7e-854c-4df6-956c-80efb3138914", "CourseNumber": "sample string 10", "CourseType": { "Id": "202596e1-0f3f-4545-b31d-8182eabc8a3a", "Name": "sample string 2" }, "CourseTypeName": "sample string 11", "StartDate": "2024-12-26T19:33:31.2266118+00:00", "EndDate": "2024-12-26T19:33:31.2266118+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 14", "SupportingDocument": { "Label": "sample string 1", "Value": 2 }, "Url": "sample string 15", "SubmittedOn": "2024-12-26T19:33:31.2266118+00:00", "Description": "sample string 17", "AttestationConfirmation": true, "EthicsRequirement": true, "Organization": "sample string 20", "Comments": [ { "Id": "012342ea-a5a8-4aac-b913-eb796c31d8bf", "NoteType": { "Label": "sample string 1", "Value": 2 }, "CommentFrom": { "Label": "sample string 1", "Value": 2 }, "Text": "sample string 2", "CreatedOn": "2024-12-26T19:33:31.2422277+00:00" }, { "Id": "012342ea-a5a8-4aac-b913-eb796c31d8bf", "NoteType": { "Label": "sample string 1", "Value": 2 }, "CommentFrom": { "Label": "sample string 1", "Value": 2 }, "Text": "sample string 2", "CreatedOn": "2024-12-26T19:33:31.2422277+00:00" } ], "UserComment": "sample string 21" }
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>202596e1-0f3f-4545-b31d-8182eabc8a3a</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>202596e1-0f3f-4545-b31d-8182eabc8a3a</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>2024-12-26T19:33:31.2422277+00:00</CreatedOn> <Id>012342ea-a5a8-4aac-b913-eb796c31d8bf</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>2024-12-26T19:33:31.2422277+00:00</CreatedOn> <Id>012342ea-a5a8-4aac-b913-eb796c31d8bf</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> <CourseEndDate>2024-12-26T19:33:31.2266118+00:00</CourseEndDate> <CourseId>e0e48b7e-854c-4df6-956c-80efb3138914</CourseId> <CourseNumber>sample string 10</CourseNumber> <CourseStartDate>2024-12-26T19:33:31.2266118+00:00</CourseStartDate> <CourseType xmlns:d2p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers"> <d2p1:Id>202596e1-0f3f-4545-b31d-8182eabc8a3a</d2p1:Id> <d2p1:Name>sample string 2</d2p1:Name> </CourseType> <CourseTypeName>sample string 11</CourseTypeName> <Description>sample string 17</Description> <EndDate>2024-12-26T19:33:31.2266118+00:00</EndDate> <EthicsRequirement>true</EthicsRequirement> <Id>32be03a7-0d0e-4f66-85d1-556c54cd79b1</Id> <Name>sample string 2</Name> <Organization>sample string 20</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>2024-12-26T19:33:31.2266118+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 14</StatusName> <SubmittedOn>2024-12-26T19:33:31.2266118+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 15</Url> <UserComment>sample string 21</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. |
Response Formats
application/json, text/json
Sample:
{ "Id": "275f4708-438f-4d67-a96b-1045220f4793", "Name": "sample string 2", "Category": { "Id": "82ddbc8d-31ca-4d94-82cd-595f048f6b50", "Name": "sample string 2" }, "CategoryName": "sample string 3", "CeuType": { "Id": "82ddbc8d-31ca-4d94-82cd-595f048f6b50", "Name": "sample string 2" }, "CeuTypeName": "sample string 4", "CeusEarnedHours": 5.0, "CeusRequestedHours": 6.0, "CourseEndDate": "2024-12-26T19:33:31.2903614+00:00", "CourseStartDate": "2024-12-26T19:33:31.2903614+00:00", "CourseId": "ba4012c5-93fd-476d-bac1-997c6dcd2fe7", "CourseNumber": "sample string 10", "CourseType": { "Id": "82ddbc8d-31ca-4d94-82cd-595f048f6b50", "Name": "sample string 2" }, "CourseTypeName": "sample string 11", "StartDate": "2024-12-26T19:33:31.2903614+00:00", "EndDate": "2024-12-26T19:33:31.2903614+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 14", "SupportingDocument": { "Label": "sample string 1", "Value": 2 }, "Url": "sample string 15", "SubmittedOn": "2024-12-26T19:33:31.2903614+00:00", "Description": "sample string 17", "AttestationConfirmation": true, "EthicsRequirement": true, "Organization": "sample string 20", "Comments": [ { "Id": "84e6354f-6b3f-4ad4-92ea-fa77906b8460", "NoteType": { "Label": "sample string 1", "Value": 2 }, "CommentFrom": { "Label": "sample string 1", "Value": 2 }, "Text": "sample string 2", "CreatedOn": "2024-12-26T19:33:31.2903614+00:00" }, { "Id": "84e6354f-6b3f-4ad4-92ea-fa77906b8460", "NoteType": { "Label": "sample string 1", "Value": 2 }, "CommentFrom": { "Label": "sample string 1", "Value": 2 }, "Text": "sample string 2", "CreatedOn": "2024-12-26T19:33:31.2903614+00:00" } ], "UserComment": "sample string 21" }
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>82ddbc8d-31ca-4d94-82cd-595f048f6b50</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>82ddbc8d-31ca-4d94-82cd-595f048f6b50</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>2024-12-26T19:33:31.2903614+00:00</CreatedOn> <Id>84e6354f-6b3f-4ad4-92ea-fa77906b8460</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>2024-12-26T19:33:31.2903614+00:00</CreatedOn> <Id>84e6354f-6b3f-4ad4-92ea-fa77906b8460</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> <CourseEndDate>2024-12-26T19:33:31.2903614+00:00</CourseEndDate> <CourseId>ba4012c5-93fd-476d-bac1-997c6dcd2fe7</CourseId> <CourseNumber>sample string 10</CourseNumber> <CourseStartDate>2024-12-26T19:33:31.2903614+00:00</CourseStartDate> <CourseType xmlns:d2p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers"> <d2p1:Id>82ddbc8d-31ca-4d94-82cd-595f048f6b50</d2p1:Id> <d2p1:Name>sample string 2</d2p1:Name> </CourseType> <CourseTypeName>sample string 11</CourseTypeName> <Description>sample string 17</Description> <EndDate>2024-12-26T19:33:31.2903614+00:00</EndDate> <EthicsRequirement>true</EthicsRequirement> <Id>275f4708-438f-4d67-a96b-1045220f4793</Id> <Name>sample string 2</Name> <Organization>sample string 20</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>2024-12-26T19:33:31.2903614+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 14</StatusName> <SubmittedOn>2024-12-26T19:33:31.2903614+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 15</Url> <UserComment>sample string 21</UserComment> </RecertActivity>