POST api/role/{id}/boardrequest
To send an board request email to a external provider Processes this role API request. The parameter and response sections describe the data exchanged with the API.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
The unique identifier of the requested resource. |
integer |
Required |
Body Parameters
Details of the sms to send
UpdateBoardRequestDataContract| Name | Description | Type | Additional information |
|---|---|---|---|
| GroupId |
The unique identifier of the related group resource. |
integer |
None. |
| BoardStatus |
The board status value. |
EnumDataContract |
None. |
| BoardSlipType |
The board slip type value. |
EnumDataContract |
None. |
| BoardEventStatus |
The board event status value. |
EnumDataContract |
None. |
| AdditionalInfo |
The additional info value. |
string |
None. |
| NegotiatorIds |
The unique identifiers of the related negotiator resources. |
Collection of integer |
None. |
Request Formats
application/x-www-form-urlencoded
Sample not available.
application/json, text/json
{
"GroupId": 1,
"BoardStatus": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"BoardSlipType": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"BoardEventStatus": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"AdditionalInfo": "sample string 2",
"NegotiatorIds": [
1,
2
]
}
Response Information
Resource Description
The response returned after the operation completes.
HttpResponseMessage| Name | Description | Type | Additional information |
|---|---|---|---|
| Version |
The version value. |
Version |
None. |
| Content |
The content value. |
HttpContent |
None. |
| StatusCode |
The status code classification. |
HttpStatusCode |
None. |
| ReasonPhrase |
The reason phrase value. |
string |
None. |
| Headers |
The collection of headers. |
Collection of Object |
None. |
| RequestMessage |
The request message value. |
HttpRequestMessage |
None. |
| IsSuccessStatusCode |
Indicates whether this item is success status code. |
boolean |
None. |