PUT api/v1/code-list/{entity}?id={id}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
entity

string

Required

id

globally unique identifier

None.

Body Parameters

CodeList
NameDescriptionTypeAdditional information
id

globally unique identifier

Required

name

string

None.

deleted

boolean

Required

system_information

SystemInformation

None.

Request Formats

application/json, text/json

Sample:
{
  "id": "9ffc2b01-ded6-4bad-a21d-04a3b895ec2b",
  "name": "sample string 2",
  "deleted": true,
  "system_information": {
    "creation": {
      "user": {
        "full_name": "sample string 12 sample string 11",
        "id": "7a435a6f-9c6c-4f62-bc97-e6f38d95219f",
        "image_id": "4219629b-2f2b-446e-9b3a-1ccfaf1d33f0",
        "id_user_work_position": "13661c01-c37a-4bf4-8470-28f7012fc7d3",
        "id_shift": "5c7b1019-ccc0-469a-8e44-fbec66a1f7c0",
        "code": "sample string 5",
        "code2": "sample string 6",
        "title": "sample string 9",
        "introduction": "sample string 10",
        "first_name": "sample string 11",
        "last_name": "sample string 12"
      },
      "date": "2024-02-24T09:32:17Z"
    },
    "last_change": {
      "user": {
        "full_name": "sample string 12 sample string 11",
        "id": "7a435a6f-9c6c-4f62-bc97-e6f38d95219f",
        "image_id": "4219629b-2f2b-446e-9b3a-1ccfaf1d33f0",
        "id_user_work_position": "13661c01-c37a-4bf4-8470-28f7012fc7d3",
        "id_shift": "5c7b1019-ccc0-469a-8e44-fbec66a1f7c0",
        "code": "sample string 5",
        "code2": "sample string 6",
        "title": "sample string 9",
        "introduction": "sample string 10",
        "first_name": "sample string 11",
        "last_name": "sample string 12"
      },
      "date": "2024-02-24T09:32:17Z"
    }
  }
}

application/xml, text/xml

Sample:
<CodeList xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IO.Swagger.Models">
  <deleted>true</deleted>
  <id>9ffc2b01-ded6-4bad-a21d-04a3b895ec2b</id>
  <name>sample string 2</name>
  <system_information>
    <creation>
      <date>2024-02-24T10:32:17.3929462+01:00</date>
      <user>
        <code>sample string 5</code>
        <code2>sample string 6</code2>
        <first_name>sample string 11</first_name>
        <full_name>sample string 12 sample string 11</full_name>
        <id>7a435a6f-9c6c-4f62-bc97-e6f38d95219f</id>
        <id_shift>5c7b1019-ccc0-469a-8e44-fbec66a1f7c0</id_shift>
        <id_user_work_position>13661c01-c37a-4bf4-8470-28f7012fc7d3</id_user_work_position>
        <image_id>4219629b-2f2b-446e-9b3a-1ccfaf1d33f0</image_id>
        <introduction>sample string 10</introduction>
        <last_name>sample string 12</last_name>
        <title>sample string 9</title>
      </user>
    </creation>
    <last_change>
      <date>2024-02-24T10:32:17.3929462+01:00</date>
      <user>
        <code>sample string 5</code>
        <code2>sample string 6</code2>
        <first_name>sample string 11</first_name>
        <full_name>sample string 12 sample string 11</full_name>
        <id>7a435a6f-9c6c-4f62-bc97-e6f38d95219f</id>
        <id_shift>5c7b1019-ccc0-469a-8e44-fbec66a1f7c0</id_shift>
        <id_user_work_position>13661c01-c37a-4bf4-8470-28f7012fc7d3</id_user_work_position>
        <image_id>4219629b-2f2b-446e-9b3a-1ccfaf1d33f0</image_id>
        <introduction>sample string 10</introduction>
        <last_name>sample string 12</last_name>
        <title>sample string 9</title>
      </user>
    </last_change>
  </system_information>
</CodeList>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Result
NameDescriptionTypeAdditional information
messages

Collection of ResultMessage

None.

count_of_errors

integer

None.

id

Object

None.

name

string

None.

data

Object

None.

url

string

None.

text

string

None.

inner_exception

string

None.

Response Formats

application/json, text/json

Sample:
{
  "messages": [
    {
      "type": 1,
      "code": 1,
      "message": "sample string 1",
      "field": "sample string 2"
    },
    {
      "type": 1,
      "code": 1,
      "message": "sample string 1",
      "field": "sample string 2"
    }
  ],
  "count_of_errors": 1,
  "id": {},
  "name": "sample string 3",
  "data": {},
  "url": "sample string 5",
  "text": "sample string 6",
  "inner_exception": "sample string 7"
}

application/xml, text/xml

Sample:
<Result xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/UP.Core.Data">
  <count_of_errors>1</count_of_errors>
  <data />
  <id />
  <inner_exception>sample string 7</inner_exception>
  <messages>
    <ResultMessage>
      <code>1</code>
      <field>sample string 2</field>
      <message>sample string 1</message>
      <type>1</type>
    </ResultMessage>
    <ResultMessage>
      <code>1</code>
      <field>sample string 2</field>
      <message>sample string 1</message>
      <type>1</type>
    </ResultMessage>
  </messages>
  <name>sample string 3</name>
  <text>sample string 6</text>
  <url>sample string 5</url>
</Result>