POST api/Invitations
Add user invitations for a subproject/family
Request Information
URI Parameters
None.
Body Parameters
invitation
UserInvitationModel| Name | Description | Type | Additional information |
|---|---|---|---|
| EmailAddress | string |
None. |
|
| Phone | string |
None. |
|
| InvitedTimeStamp | date |
None. |
|
| ProjectID | integer |
None. |
|
| SpaceID | integer |
None. |
|
| PPMAccountTypeID | integer |
None. |
|
| ReqAccountTypeID | integer |
None. |
|
| DevAccountTypeID | integer |
None. |
|
| LibAccountTypeID | integer |
None. |
|
| RunAccountTypeID | integer |
None. |
|
| KWAccountTypeID | integer |
None. |
|
| DefectAccountTypeID | integer |
None. |
|
| ServerPath | string |
None. |
Request Formats
application/json, text/json
Sample:
{
"EmailAddress": "sample string 1",
"Phone": "sample string 2",
"InvitedTimeStamp": "2025-11-04 13:12:09",
"ProjectID": 3,
"SpaceID": 4,
"PPMAccountTypeID": 1,
"ReqAccountTypeID": 1,
"DevAccountTypeID": 1,
"LibAccountTypeID": 1,
"RunAccountTypeID": 1,
"KWAccountTypeID": 1,
"DefectAccountTypeID": 1,
"ServerPath": "sample string 5"
}
application/xml, text/xml
Sample:
<UserInvitationModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TechExcel.DTKService.Model.Entities"> <DefectAccountTypeID>1</DefectAccountTypeID> <DevAccountTypeID>1</DevAccountTypeID> <EmailAddress>sample string 1</EmailAddress> <InvitedTimeStamp>2025-11-04T17:12:09.4711784-08:00</InvitedTimeStamp> <KWAccountTypeID>1</KWAccountTypeID> <LibAccountTypeID>1</LibAccountTypeID> <PPMAccountTypeID>1</PPMAccountTypeID> <Phone>sample string 2</Phone> <ProjectID>3</ProjectID> <ReqAccountTypeID>1</ReqAccountTypeID> <RunAccountTypeID>1</RunAccountTypeID> <ServerPath>sample string 5</ServerPath> <SpaceID>4</SpaceID> </UserInvitationModel>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
Add user invitations for a subproject/family
ApiReturn| Name | Description | Type | Additional information |
|---|---|---|---|
| Success | boolean |
None. |
|
| Error | ErrorInfo |
None. |
Response Formats
application/json, text/json
Sample:
{
"Success": true,
"Error": {
"ErrorCode": 1,
"ErrorMessage": "sample string 1"
}
}
application/xml, text/xml
Sample:
<ApiReturn xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TechExcel.DTKService.Model.Common">
<Error>
<ErrorCode>1</ErrorCode>
<ErrorMessage>sample string 1</ErrorMessage>
</Error>
<Success>true</Success>
</ApiReturn>