POST Agents/Project/GetProjectEvent

• 5 minutes to read
 • 5 minutes to read 
POST /api/v1/Agents/Project/GetProjectEvent

Gets a ProjectEvent object.

NsApiSlow threshold: 2000 ms.

Query String Parameters

Parameter Name Type Description
projectEventId int32 Required The identifier of the ProjectEvent object
$select string Optional comma separated list of properties to include in the result. Other fields are then nulled out to reduce payload size: "Name,department,category". Default = show all fields. 
POST /api/v1/Agents/Project/GetProjectEvent?projectEventId=23
POST /api/v1/Agents/Project/GetProjectEvent?$select=name,department,category/id

Request Headers

Parameter Name Description
Authorization Supports 'Basic', 'SoTicket' and 'Bearer' schemes, depending on installation type.
X-XSRF-TOKEN If not using Authorization header, you must provide XSRF value from cookie or hidden input field
Accept Content-type(s) you would like the response in: application/json, text/json, application/xml, text/xml, application/json-patch+json, application/merge-patch+json
Accept-Language Convert string references and multi-language values into a specified language (iso2) code.
SO-Language Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value.
SO-Culture Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set.
SO-TimeZone Specify the timezone code that you would like date/time responses converted to.
SO-AppToken The application token that identifies the partner app. Used when calling Online WebAPI from a server.

Response:

OK

Response Description
200 OK

Response body: ProjectEvent

Property Name Type Description
AssociateFullName string Name of the person that ows the event (i.e. project)
Description string The event description (i.e. the project text)
ProjectId int32 Id of the project that represents the event
EventName string The name of the event (i.e. the project name)
AssociateId int32 Id of the person that ows the event (i.e. project)
IsSignedOn bool True if the current user is signed on to the event (i.e. is project member)
SignOffConfirmationText string Text shown as confirmation text before accepting sign off.
SignOffText string Default text for the activity created when signing off.
SignOnConfirmationText string Text shown as confirmation text before accepting sign on.
SignOnText string Default text for the activity created when signing on.
EventDate date-time Date of the event. Event is not visible after this date.
Enabled bool If true the event is enabled (visible)
SignOff bool If true, it is possible to sign off the event.
SignOffTaskEnable bool If true, a task should be created when the external user signs off an event
SignOnTaskEnable bool If true, a task should be created when the external user signs on an event
SignOn bool If true, it is possible to sign on the event.
SignOffTaskId int32 If not 0, sign off should cause an Activity of this type to be registered
SignOnTaskId int32 If not 0, sign on should cause an Activity of this type to be registered
SignOffTriggersAssign bool If true, the sign off task should be created as an Assigned task, triggering the invitation dialog
SignOnTriggersAssign bool If true, the sign on task should be created as an Assigned task, triggering the invitation dialog
SignOnPersonId int32 If 0, the signOn Activity should go into the persons Our Contact; if not 0, this is the Person whose diary should get the activity
SignOffPersonId int32 If 0, the signOn Activity should go into the persons Our Contact; if not 0, this is the Person whose diary should get the activity
TableRight TableRight The carrier's table right
FieldProperties object Field property dictionary mapping field names to field access rights.

Sample request

POST /api/v1/Agents/Project/GetProjectEvent
Authorization: Basic dGplMDpUamUw
Accept: application/json; charset=utf-8
Accept-Language: en

Sample response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "AssociateFullName": "Elroy Ada King DVM",
  "Description": "Profound cohesive software",
  "ProjectId": 434,
  "EventName": "Stehr, Ritchie and Blanda",
  "AssociateId": 608,
  "IsSignedOn": false,
  "SignOffConfirmationText": "dolores",
  "SignOffText": "cumque",
  "SignOnConfirmationText": "eius",
  "SignOnText": "omnis",
  "EventDate": "2000-10-08T02:30:47.6788214+02:00",
  "Enabled": false,
  "SignOff": true,
  "SignOffTaskEnable": false,
  "SignOnTaskEnable": true,
  "SignOn": true,
  "SignOffTaskId": 1000,
  "SignOnTaskId": 833,
  "SignOffTriggersAssign": true,
  "SignOnTriggersAssign": true,
  "SignOnPersonId": 19,
  "SignOffPersonId": 427,
  "TableRight": null,
  "FieldProperties": {
    "fieldName": {
      "FieldRight": null,
      "FieldType": "System.Int32",
      "FieldLength": 603
    }
  }
}