POST api/role/createreferralevent
Creates a referral event on the role Processes this role API request. The parameter and response sections describe the data exchanged with the API.
Request Information
URI Parameters
None.
Body Parameters
The legal referral command data contract supplied with the request.
LegalReferralCommandDataContract| Name | Description | Type | Additional information |
|---|---|---|---|
| Details |
The details value. |
string |
None. |
| Roleids |
The collection of roleids. |
Collection of integer |
None. |
Request Formats
application/x-www-form-urlencoded
Sample not available.
application/json, text/json
{
"Details": "sample string 1",
"Roleids": [
1,
2
]
}
Response Information
Resource Description
The response returned after the operation completes.
Collection of TaskDataContract| Name | Description | Type | Additional information |
|---|---|---|---|
| Team |
The team value. |
EventTeamDataContract |
None. |
| Notes |
The collection of notes. |
Collection of EventNoteCommandDataContract |
None. |
| Documents |
The collection of documents. |
Collection of DocumentDataContract |
None. |
| Name |
The name value. |
string |
None. |
| Description |
The description value. |
string |
None. |
| DateTime |
The date time, expressed as a date and time. |
date |
None. |
| EventCategory |
The event category value. |
EnumDataContract |
None. |
| EventType |
The event type value. |
EnumDataContract |
None. |
| EventStatus |
The event status value. |
EnumDataContract |
None. |
| Negotiators |
The collection of negotiators. |
Collection of ListNegotiatorDataContract |
None. |
| BranchId |
The unique identifier of the related branch resource. |
integer |
None. |
| OwningTeamId |
The unique identifier of the related owning team resource. |
integer |
None. |
| TeamAccessType |
The team access type value. |
string |
None. |
| CustomFields |
The collection of custom fields. |
Collection of CustomFieldGroupWithValuesDataContract |
None. |
| CreatedDate |
The created date, expressed as a date and time. |
date |
None. |
| CreatedBy |
The created by value. |
CreatedByDataContract |
None. |
| Id |
The unique identifier of this resource. |
integer |
None. |
Response Formats
application/json
Sample not available.
text/json
Sample not available.