Put Ticket Category Entity

using RestSharp;


var options = new RestClientOptions("http://localhost:56350/api/v1/List/TicketCategory/Items/{id}");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddJsonBody("{\n  \"TicketCategoryId\": 123,\n  \"ParentId\": 123,\n  \"Name\": \"<string>\",\n  \"Fullname\": \"<string>\",\n  \"CategoryMaster\": 123,\n  \"ExternalName\": \"<string>\",\n  \"AssignmentLag\": 123,\n  \"ReplyTemplate\": 123,\n  \"NotificationEmail\": \"<string>\",\n  \"DefaultTicketStatus\": {\n    \"TicketStatusId\": 123,\n    \"Name\": \"<string>\",\n    \"NoEmailReopen\": true,\n    \"IsDefault\": true,\n    \"UsedInQueue\": true,\n    \"TableRight\": {\n      \"Mask\": \"<string>\",\n      \"Reason\": \"<string>\"\n    },\n    \"FieldProperties\": {}\n  },\n  \"DefaultMessageStatus\": {\n    \"TicketStatusId\": 123,\n    \"Name\": \"<string>\",\n    \"NoEmailReopen\": true,\n    \"IsDefault\": true,\n    \"UsedInQueue\": true,\n    \"TableRight\": {\n      \"Mask\": \"<string>\",\n      \"Reason\": \"<string>\"\n    },\n    \"FieldProperties\": {}\n  },\n  \"EffectiveReplyTemplateId\": 123,\n  \"ExtraFields\": {},\n  \"CustomFields\": {},\n  \"TableRight\": {\n    \"Mask\": \"<string>\",\n    \"Reason\": \"<string>\"\n  },\n  \"FieldProperties\": {}\n}", false);
var response = await client.PutAsync(request);

Console.WriteLine("{0}", response.Content);

const options = {
  method: 'PUT',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    TicketCategoryId: 123,
    ParentId: 123,
    Name: '<string>',
    Fullname: '<string>',
    CategoryMaster: 123,
    ExternalName: '<string>',
    AssignmentLag: 123,
    ReplyTemplate: 123,
    NotificationEmail: '<string>',
    DefaultTicketStatus: {
      TicketStatusId: 123,
      Name: '<string>',
      NoEmailReopen: true,
      IsDefault: true,
      UsedInQueue: true,
      TableRight: {Mask: '<string>', Reason: '<string>'},
      FieldProperties: {}
    },
    DefaultMessageStatus: {
      TicketStatusId: 123,
      Name: '<string>',
      NoEmailReopen: true,
      IsDefault: true,
      UsedInQueue: true,
      TableRight: {Mask: '<string>', Reason: '<string>'},
      FieldProperties: {}
    },
    EffectiveReplyTemplateId: 123,
    ExtraFields: {},
    CustomFields: {},
    TableRight: {Mask: '<string>', Reason: '<string>'},
    FieldProperties: {}
  })
};

fetch('http://localhost:56350/api/v1/List/TicketCategory/Items/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "56350",
  CURLOPT_URL => "http://localhost:56350/api/v1/List/TicketCategory/Items/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'TicketCategoryId' => 123,
    'ParentId' => 123,
    'Name' => '<string>',
    'Fullname' => '<string>',
    'CategoryMaster' => 123,
    'ExternalName' => '<string>',
    'AssignmentLag' => 123,
    'ReplyTemplate' => 123,
    'NotificationEmail' => '<string>',
    'DefaultTicketStatus' => [
        'TicketStatusId' => 123,
        'Name' => '<string>',
        'NoEmailReopen' => true,
        'IsDefault' => true,
        'UsedInQueue' => true,
        'TableRight' => [
                'Mask' => '<string>',
                'Reason' => '<string>'
        ],
        'FieldProperties' => [
                
        ]
    ],
    'DefaultMessageStatus' => [
        'TicketStatusId' => 123,
        'Name' => '<string>',
        'NoEmailReopen' => true,
        'IsDefault' => true,
        'UsedInQueue' => true,
        'TableRight' => [
                'Mask' => '<string>',
                'Reason' => '<string>'
        ],
        'FieldProperties' => [
                
        ]
    ],
    'EffectiveReplyTemplateId' => 123,
    'ExtraFields' => [
        
    ],
    'CustomFields' => [
        
    ],
    'TableRight' => [
        'Mask' => '<string>',
        'Reason' => '<string>'
    ],
    'FieldProperties' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

import requests

url = "http://localhost:56350/api/v1/List/TicketCategory/Items/{id}"

payload = {
    "TicketCategoryId": 123,
    "ParentId": 123,
    "Name": "<string>",
    "Fullname": "<string>",
    "CategoryMaster": 123,
    "ExternalName": "<string>",
    "AssignmentLag": 123,
    "ReplyTemplate": 123,
    "NotificationEmail": "<string>",
    "DefaultTicketStatus": {
        "TicketStatusId": 123,
        "Name": "<string>",
        "NoEmailReopen": True,
        "IsDefault": True,
        "UsedInQueue": True,
        "TableRight": {
            "Mask": "<string>",
            "Reason": "<string>"
        },
        "FieldProperties": {}
    },
    "DefaultMessageStatus": {
        "TicketStatusId": 123,
        "Name": "<string>",
        "NoEmailReopen": True,
        "IsDefault": True,
        "UsedInQueue": True,
        "TableRight": {
            "Mask": "<string>",
            "Reason": "<string>"
        },
        "FieldProperties": {}
    },
    "EffectiveReplyTemplateId": 123,
    "ExtraFields": {},
    "CustomFields": {},
    "TableRight": {
        "Mask": "<string>",
        "Reason": "<string>"
    },
    "FieldProperties": {}
}
headers = {"Content-Type": "application/json"}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    TicketCategoryId: 123,
    ParentId: 123,
    Name: '<string>',
    Fullname: '<string>',
    CategoryMaster: 123,
    ExternalName: '<string>',
    AssignmentLag: 123,
    ReplyTemplate: 123,
    NotificationEmail: '<string>',
    DefaultTicketStatus: {
      TicketStatusId: 123,
      Name: '<string>',
      NoEmailReopen: true,
      IsDefault: true,
      UsedInQueue: true,
      TableRight: {Mask: '<string>', Reason: '<string>'},
      FieldProperties: {}
    },
    DefaultMessageStatus: {
      TicketStatusId: 123,
      Name: '<string>',
      NoEmailReopen: true,
      IsDefault: true,
      UsedInQueue: true,
      TableRight: {Mask: '<string>', Reason: '<string>'},
      FieldProperties: {}
    },
    EffectiveReplyTemplateId: 123,
    ExtraFields: {},
    CustomFields: {},
    TableRight: {Mask: '<string>', Reason: '<string>'},
    FieldProperties: {}
  })
};

fetch('http://localhost:56350/api/v1/List/TicketCategory/Items/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "TicketCategoryId": 123,
  "ParentId": 123,
  "Name": "<string>",
  "Fullname": "<string>",
  "CategoryMaster": 123,
  "Flags": "Unknown",
  "DelegateMethod": "Unknown",
  "ExternalName": "<string>",
  "ClosingStatus": "UserDefined",
  "MsgClosingStatus": "UserDefined",
  "AssignmentLag": 123,
  "ReplyTemplate": 123,
  "NotificationEmail": "<string>",
  "DefaultTicketStatus": {
    "TicketStatusId": 123,
    "Name": "<string>",
    "Status": "Unknown",
    "TimeCounter": "None",
    "NoEmailReopen": true,
    "IsDefault": true,
    "UsedInQueue": true,
    "TableRight": {
      "Mask": "<string>",
      "Reason": "<string>"
    },
    "FieldProperties": {}
  },
  "DefaultMessageStatus": {
    "TicketStatusId": 123,
    "Name": "<string>",
    "Status": "Unknown",
    "TimeCounter": "None",
    "NoEmailReopen": true,
    "IsDefault": true,
    "UsedInQueue": true,
    "TableRight": {
      "Mask": "<string>",
      "Reason": "<string>"
    },
    "FieldProperties": {}
  },
  "EffectiveReplyTemplateId": 123,
  "ExtraFields": {},
  "CustomFields": {},
  "TableRight": {
    "Mask": "<string>",
    "Reason": "<string>"
  },
  "FieldProperties": {}
}

Put Ticket Category Entity

using RestSharp;


var options = new RestClientOptions("http://localhost:56350/api/v1/List/TicketCategory/Items/{id}");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddJsonBody("{\n  \"TicketCategoryId\": 123,\n  \"ParentId\": 123,\n  \"Name\": \"<string>\",\n  \"Fullname\": \"<string>\",\n  \"CategoryMaster\": 123,\n  \"ExternalName\": \"<string>\",\n  \"AssignmentLag\": 123,\n  \"ReplyTemplate\": 123,\n  \"NotificationEmail\": \"<string>\",\n  \"DefaultTicketStatus\": {\n    \"TicketStatusId\": 123,\n    \"Name\": \"<string>\",\n    \"NoEmailReopen\": true,\n    \"IsDefault\": true,\n    \"UsedInQueue\": true,\n    \"TableRight\": {\n      \"Mask\": \"<string>\",\n      \"Reason\": \"<string>\"\n    },\n    \"FieldProperties\": {}\n  },\n  \"DefaultMessageStatus\": {\n    \"TicketStatusId\": 123,\n    \"Name\": \"<string>\",\n    \"NoEmailReopen\": true,\n    \"IsDefault\": true,\n    \"UsedInQueue\": true,\n    \"TableRight\": {\n      \"Mask\": \"<string>\",\n      \"Reason\": \"<string>\"\n    },\n    \"FieldProperties\": {}\n  },\n  \"EffectiveReplyTemplateId\": 123,\n  \"ExtraFields\": {},\n  \"CustomFields\": {},\n  \"TableRight\": {\n    \"Mask\": \"<string>\",\n    \"Reason\": \"<string>\"\n  },\n  \"FieldProperties\": {}\n}", false);
var response = await client.PutAsync(request);

Console.WriteLine("{0}", response.Content);

const options = {
  method: 'PUT',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    TicketCategoryId: 123,
    ParentId: 123,
    Name: '<string>',
    Fullname: '<string>',
    CategoryMaster: 123,
    ExternalName: '<string>',
    AssignmentLag: 123,
    ReplyTemplate: 123,
    NotificationEmail: '<string>',
    DefaultTicketStatus: {
      TicketStatusId: 123,
      Name: '<string>',
      NoEmailReopen: true,
      IsDefault: true,
      UsedInQueue: true,
      TableRight: {Mask: '<string>', Reason: '<string>'},
      FieldProperties: {}
    },
    DefaultMessageStatus: {
      TicketStatusId: 123,
      Name: '<string>',
      NoEmailReopen: true,
      IsDefault: true,
      UsedInQueue: true,
      TableRight: {Mask: '<string>', Reason: '<string>'},
      FieldProperties: {}
    },
    EffectiveReplyTemplateId: 123,
    ExtraFields: {},
    CustomFields: {},
    TableRight: {Mask: '<string>', Reason: '<string>'},
    FieldProperties: {}
  })
};

fetch('http://localhost:56350/api/v1/List/TicketCategory/Items/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "56350",
  CURLOPT_URL => "http://localhost:56350/api/v1/List/TicketCategory/Items/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'TicketCategoryId' => 123,
    'ParentId' => 123,
    'Name' => '<string>',
    'Fullname' => '<string>',
    'CategoryMaster' => 123,
    'ExternalName' => '<string>',
    'AssignmentLag' => 123,
    'ReplyTemplate' => 123,
    'NotificationEmail' => '<string>',
    'DefaultTicketStatus' => [
        'TicketStatusId' => 123,
        'Name' => '<string>',
        'NoEmailReopen' => true,
        'IsDefault' => true,
        'UsedInQueue' => true,
        'TableRight' => [
                'Mask' => '<string>',
                'Reason' => '<string>'
        ],
        'FieldProperties' => [
                
        ]
    ],
    'DefaultMessageStatus' => [
        'TicketStatusId' => 123,
        'Name' => '<string>',
        'NoEmailReopen' => true,
        'IsDefault' => true,
        'UsedInQueue' => true,
        'TableRight' => [
                'Mask' => '<string>',
                'Reason' => '<string>'
        ],
        'FieldProperties' => [
                
        ]
    ],
    'EffectiveReplyTemplateId' => 123,
    'ExtraFields' => [
        
    ],
    'CustomFields' => [
        
    ],
    'TableRight' => [
        'Mask' => '<string>',
        'Reason' => '<string>'
    ],
    'FieldProperties' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

import requests

url = "http://localhost:56350/api/v1/List/TicketCategory/Items/{id}"

payload = {
    "TicketCategoryId": 123,
    "ParentId": 123,
    "Name": "<string>",
    "Fullname": "<string>",
    "CategoryMaster": 123,
    "ExternalName": "<string>",
    "AssignmentLag": 123,
    "ReplyTemplate": 123,
    "NotificationEmail": "<string>",
    "DefaultTicketStatus": {
        "TicketStatusId": 123,
        "Name": "<string>",
        "NoEmailReopen": True,
        "IsDefault": True,
        "UsedInQueue": True,
        "TableRight": {
            "Mask": "<string>",
            "Reason": "<string>"
        },
        "FieldProperties": {}
    },
    "DefaultMessageStatus": {
        "TicketStatusId": 123,
        "Name": "<string>",
        "NoEmailReopen": True,
        "IsDefault": True,
        "UsedInQueue": True,
        "TableRight": {
            "Mask": "<string>",
            "Reason": "<string>"
        },
        "FieldProperties": {}
    },
    "EffectiveReplyTemplateId": 123,
    "ExtraFields": {},
    "CustomFields": {},
    "TableRight": {
        "Mask": "<string>",
        "Reason": "<string>"
    },
    "FieldProperties": {}
}
headers = {"Content-Type": "application/json"}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    TicketCategoryId: 123,
    ParentId: 123,
    Name: '<string>',
    Fullname: '<string>',
    CategoryMaster: 123,
    ExternalName: '<string>',
    AssignmentLag: 123,
    ReplyTemplate: 123,
    NotificationEmail: '<string>',
    DefaultTicketStatus: {
      TicketStatusId: 123,
      Name: '<string>',
      NoEmailReopen: true,
      IsDefault: true,
      UsedInQueue: true,
      TableRight: {Mask: '<string>', Reason: '<string>'},
      FieldProperties: {}
    },
    DefaultMessageStatus: {
      TicketStatusId: 123,
      Name: '<string>',
      NoEmailReopen: true,
      IsDefault: true,
      UsedInQueue: true,
      TableRight: {Mask: '<string>', Reason: '<string>'},
      FieldProperties: {}
    },
    EffectiveReplyTemplateId: 123,
    ExtraFields: {},
    CustomFields: {},
    TableRight: {Mask: '<string>', Reason: '<string>'},
    FieldProperties: {}
  })
};

fetch('http://localhost:56350/api/v1/List/TicketCategory/Items/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "TicketCategoryId": 123,
  "ParentId": 123,
  "Name": "<string>",
  "Fullname": "<string>",
  "CategoryMaster": 123,
  "Flags": "Unknown",
  "DelegateMethod": "Unknown",
  "ExternalName": "<string>",
  "ClosingStatus": "UserDefined",
  "MsgClosingStatus": "UserDefined",
  "AssignmentLag": 123,
  "ReplyTemplate": 123,
  "NotificationEmail": "<string>",
  "DefaultTicketStatus": {
    "TicketStatusId": 123,
    "Name": "<string>",
    "Status": "Unknown",
    "TimeCounter": "None",
    "NoEmailReopen": true,
    "IsDefault": true,
    "UsedInQueue": true,
    "TableRight": {
      "Mask": "<string>",
      "Reason": "<string>"
    },
    "FieldProperties": {}
  },
  "DefaultMessageStatus": {
    "TicketStatusId": 123,
    "Name": "<string>",
    "Status": "Unknown",
    "TimeCounter": "None",
    "NoEmailReopen": true,
    "IsDefault": true,
    "UsedInQueue": true,
    "TableRight": {
      "Mask": "<string>",
      "Reason": "<string>"
    },
    "FieldProperties": {}
  },
  "EffectiveReplyTemplateId": 123,
  "ExtraFields": {},
  "CustomFields": {},
  "TableRight": {
    "Mask": "<string>",
    "Reason": "<string>"
  },
  "FieldProperties": {}
}

Headers

Accept-Language

string

Convert string references and multi-language values into a specified language (iso2) code.

SO-Language

string

Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value.

SO-Culture

string

Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set.

SO-TimeZone

string

Specify the timezone code that you would like date/time responses converted to.

SO-AppToken

string

The application token that identifies the partner app. Used when calling Online WebAPI from a server.

Path Parameters

integer<int32>

required

The id of TicketCategoryEntity to be saved.

Body

The details of TicketCategoryEntity to be saved.

This entity describes the meta data for a ticket category, and provides special operations on it. Carrier object for TicketCategoryEntity. Services for the TicketCategoryEntity Carrier is available from the List Agent.

TicketCategoryId

integer<int32>

The id of the ticket category. (primary key)

ParentId

integer<int32>

The parent category for this category. -1 if this is a toplevel category.

Name

string

The (short) name of this category. E.g. 'support'.

Fullname

string

The fullname (compiled from parents' names) for this category. E.g. 'norway/product A/support'.

CategoryMaster

integer<int32>

The user associated with this category.

Flags

enum<string>

A bitmask representing flags for this category.

Available options:

Unknown,

Internal,

OnlyLoggedInUsers,

DefaultToCategoryMaster,

ListInMain,

RedelegateNewMsg,

DelegateToOurContact,

PropagateReplyTemplate,

MembersOnly,

NotifyMembers,

AcceptWhenReplying

DelegateMethod

enum<string>

An integer indicating the delegation method for this category.

Available options:

Unknown,

Even,

Weighted,

Unfair,

Not

ExternalName

string

The external name for this category, used for the customer frontend.

ClosingStatus

enum<string>

Determines the default status used in the GUI when creating a ticket

Available options:

UserDefined,

Active,

Closed,

Postponed

MsgClosingStatus

enum<string>

Determines the default status used in the GUI when adding a request to a ticket

Available options:

UserDefined,

Active,

Closed,

Postponed

AssignmentLag

integer<int32>

Number of minutes we shall override the assignment if a customer sends consecutive messages to this category

ReplyTemplate

integer<int32>

Reply template to merge with messages posted in this category

NotificationEmail

string

Comma separated list of addresses to notify when requests are redelegated to (unassigned) in this category.

DefaultTicketStatus

object

Entity for a ticket status. This entity describes the meta data for a ticket status, and provides special operations on it. Carrier object for TicketStatusEntity. Services for the TicketStatusEntity Carrier is available from the List Agent.

Show child attributes

DefaultMessageStatus

object

Show child attributes

EffectiveReplyTemplateId

integer<int32>

Id of reply template to merge into messages, whose ticket belongs to this category. Also takes into account 'Apply to subcategories' on parent categories. This is a calculated, readonly field.

ExtraFields

object

Deprecated: Use {SuperOffice.CRM.Services.TicketCategoryEntity.CustomFields} instead. Extra fields added to the carrier. This could be data from Plug-ins, the foreign key system, external applications, etc.

Show child attributes

CustomFields

object

Udef + Extra fields added to the carrier. Extra fields as defined by changes to database schema + user-defined fields as defined by admin. Custom fields combines user defined fields and extra fields into one bucket. The individual {SuperOffice.CRM.Services.TicketCategoryEntity.ExtraFields} and UserDefinedFields properties are deprecated in favor of this combined collection.

Show child attributes

TableRight

object

Wraps a table right together with an explanatory reason. Code can indicate why access is restricted.

Show child attributes

FieldProperties

object

Field property dictionary mapping field names to field access rights.

Show child attributes

Response

TicketCategoryId

integer<int32>

The id of the ticket category. (primary key)

ParentId

integer<int32>

The parent category for this category. -1 if this is a toplevel category.

Name

string

The (short) name of this category. E.g. 'support'.

Fullname

string

The fullname (compiled from parents' names) for this category. E.g. 'norway/product A/support'.

CategoryMaster

integer<int32>

The user associated with this category.

Flags

enum<string>

A bitmask representing flags for this category.

Available options:

Unknown,

Internal,

OnlyLoggedInUsers,

DefaultToCategoryMaster,

ListInMain,

RedelegateNewMsg,

DelegateToOurContact,

PropagateReplyTemplate,

MembersOnly,

NotifyMembers,

AcceptWhenReplying

DelegateMethod

enum<string>

An integer indicating the delegation method for this category.

Available options:

Unknown,

Even,

Weighted,

Unfair,

Not

ExternalName

string

The external name for this category, used for the customer frontend.

ClosingStatus

enum<string>

Determines the default status used in the GUI when creating a ticket

Available options:

UserDefined,

Active,

Closed,

Postponed

MsgClosingStatus

enum<string>

Determines the default status used in the GUI when adding a request to a ticket

Available options:

UserDefined,

Active,

Closed,

Postponed

AssignmentLag

integer<int32>

Number of minutes we shall override the assignment if a customer sends consecutive messages to this category

ReplyTemplate

integer<int32>

Reply template to merge with messages posted in this category

NotificationEmail

string

Comma separated list of addresses to notify when requests are redelegated to (unassigned) in this category.

DefaultTicketStatus

object

Show child attributes

DefaultMessageStatus

object

Show child attributes

EffectiveReplyTemplateId

integer<int32>

Id of reply template to merge into messages, whose ticket belongs to this category. Also takes into account 'Apply to subcategories' on parent categories. This is a calculated, readonly field.

ExtraFields

object

Show child attributes

CustomFields

object

Show child attributes

TableRight

object

Wraps a table right together with an explanatory reason. Code can indicate why access is restricted.

Show child attributes

FieldProperties

object

Field property dictionary mapping field names to field access rights.

Show child attributes