POST api/event/recordenquiry

Records an event on the role representing a neg being in contact with a person Processes this event API request. The parameter and response sections describe the data exchanged with the API.

Request Information

URI Parameters

None.

Body Parameters

The role record enquiry data contract supplied with the request.

RoleRecordEnquiryDataContract

Name	Description	Type	Additional information
GroupId	The unique identifier of the related group resource.	integer	None.
PersonId	The unique identifier of the related person resource.	integer	None.
RoleIds	The unique identifiers of the related role resources.	Collection of integer	None.
MethodOfContact	The method of contact value.	EnumDataContract	None.
Origin	The origin value.	EnumDataContract	None.
NatureOfEnquiry	The nature of enquiry value.	EnumDataContract	None.
AdditionalInfo	The additional info value.	string	None.
NegotiatorIds	The unique identifiers of the related negotiator resources.	Collection of integer	None.
UnableToContact	Indicates whether unable to contact is true.	boolean	None.

Request Formats

application/x-www-form-urlencoded

Sample:

Sample not available.

application/json, text/json

Sample:

{
  "GroupId": 1,
  "PersonId": 2,
  "RoleIds": [
    1,
    2
  ],
  "MethodOfContact": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "Origin": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "NatureOfEnquiry": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "AdditionalInfo": "sample string 3",
  "NegotiatorIds": [
    1,
    2
  ],
  "UnableToContact": true
}

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.