POST api/RcAdminInvitation/PostPersonInvitation
Creates new invitation and send an email to the invited person. Upon registration, the person will receive the role specified in the invitation. If the person with the email was already invited, then returns an error.
Request Information
URI Parameters
None.
Body Parameters
PostPersonInvitationDtoName | Description | Type | Additional information |
---|---|---|---|
RcId | integer |
Required |
|
FirstName | string |
Required |
|
LastName | string |
Required |
|
string |
Required |
||
PostStudentInvitationDto | PostStudentInvitationDto |
None. |
|
PostTutorInvitationDto | PostTutorInvitationDto |
None. |
|
PostRcAdminInvitationDto | PostRcAdminInvitationDto |
None. |
|
PostSiLeaderInvitationDto | PostSiLeaderInvitationDto |
None. |
|
PostInstructorInvitationDto | PostInstructorInvitationDto |
None. |
|
PostUniversityAdminInvitationDto | PostUniversityAdminInvitationDto |
None. |
Request Formats
application/json, text/json
Sample:
{ "RcId": 1, "FirstName": "sample string 2", "LastName": "sample string 3", "Email": "sample string 4", "PostStudentInvitationDto": { "SectionIds": [ 1, 2 ] }, "PostTutorInvitationDto": { "CourseIds": [ 1, 2 ] }, "PostRcAdminInvitationDto": { "ResourceCenterIds": [ 1, 2 ] }, "PostSiLeaderInvitationDto": {}, "PostInstructorInvitationDto": {}, "PostUniversityAdminInvitationDto": {} }
application/xml, text/xml
Sample:
<PostPersonInvitationDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/StudyTree.Core.Dtos.PersonNs.InvitationNs"> <Email>sample string 4</Email> <FirstName>sample string 2</FirstName> <LastName>sample string 3</LastName> <PostInstructorInvitationDto /> <PostRcAdminInvitationDto> <ResourceCenterIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:int>1</d3p1:int> <d3p1:int>2</d3p1:int> </ResourceCenterIds> </PostRcAdminInvitationDto> <PostSiLeaderInvitationDto /> <PostStudentInvitationDto> <SectionIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:long>1</d3p1:long> <d3p1:long>2</d3p1:long> </SectionIds> </PostStudentInvitationDto> <PostTutorInvitationDto> <CourseIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:long>1</d3p1:long> <d3p1:long>2</d3p1:long> </CourseIds> </PostTutorInvitationDto> <PostUniversityAdminInvitationDto /> <RcId>1</RcId> </PostPersonInvitationDto>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
HttpResponseMessageName | Description | Type | Additional information |
---|---|---|---|
Version | Version |
None. |
|
Content | HttpContent |
None. |
|
StatusCode | HttpStatusCode |
None. |
|
ReasonPhrase | string |
None. |
|
Headers | Collection of Object |
None. |
|
RequestMessage | HttpRequestMessage |
None. |
|
IsSuccessStatusCode | boolean |
None. |