POST api/v1/code-list/{entity}

Request Information

URI Parameters

Name	Description	Type	Additional information
entity		string	Required

Body Parameters

SearchBody

Name	Type	Additional information
fulltext	string	None.
filter	string	None.
password	string	None.
fields	Collection of string	None.
page	integer	None.
id	integer	None.
deleted	boolean	None.
per_page	integer	None.
view_mode	integer	None.
sort_fields	string	None.
stop_top	boolean	None.
tmp	boolean	None.
columns	Collection of TitleName	None.
sort_fields_desc	string	None.
disable_count	boolean	None.
date_from	date	None.
date_to	date	None.
view_name	string	None.

Request Formats

application/json, text/json

Sample:

{
  "fulltext": "sample string 1",
  "filter": "sample string 2",
  "password": "sample string 3",
  "fields": [
    "sample string 1",
    "sample string 2"
  ],
  "page": 1,
  "id": 4,
  "deleted": true,
  "per_page": 1,
  "view_mode": 1,
  "sort_fields": "sample string 5",
  "stop_top": true,
  "tmp": true,
  "columns": [
    {
      "title": "sample string 1",
      "name": "sample string 2",
      "width": 1
    },
    {
      "title": "sample string 1",
      "name": "sample string 2",
      "width": 1
    }
  ],
  "sort_fields_desc": "sample string 8",
  "disable_count": true,
  "date_from": "2024-11-21T09:48:41Z",
  "date_to": "2024-11-21T09:48:41Z",
  "view_name": "sample string 10"
}

application/xml, text/xml

Sample:

<SearchBody xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Up.Core.Data">
  <columns>
    <TitleName>
      <name>sample string 2</name>
      <title>sample string 1</title>
      <width>1</width>
    </TitleName>
    <TitleName>
      <name>sample string 2</name>
      <title>sample string 1</title>
      <width>1</width>
    </TitleName>
  </columns>
  <date_from>2024-11-21T10:48:41.277324+01:00</date_from>
  <date_to>2024-11-21T10:48:41.277324+01:00</date_to>
  <deleted>true</deleted>
  <disable_count>true</disable_count>
  <fields xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </fields>
  <filter>sample string 2</filter>
  <fulltext>sample string 1</fulltext>
  <id>4</id>
  <page>1</page>
  <password>sample string 3</password>
  <per_page>1</per_page>
  <sort_fields>sample string 5</sort_fields>
  <sort_fields_desc>sample string 8</sort_fields_desc>
  <stop_top>true</stop_top>
  <tmp>true</tmp>
  <view_mode>1</view_mode>
  <view_name>sample string 10</view_name>
</SearchBody>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

PaginationResponseOfCodeList

Name	Type	Additional information
data	Collection of CodeList	Required
pagination	Pagination	Required
structure	Collection of StructureItem	Required
format_conditions	Collection of Object	Required
message	string	Required

Response Formats

application/json, text/json

Sample:

{
  "data": [
    {
      "id": "1b1c698f-b817-437c-b736-f42e79d4be29",
      "name": "sample string 2",
      "deleted": true,
      "system_information": {
        "creation": {
          "user": {
            "full_name": "sample string 12 sample string 11",
            "id": "0f819590-d682-4c4f-af67-cadae08b09ac",
            "image_id": "962d5253-d9ce-446e-83da-0d3c9f0773a1",
            "id_user_work_position": "5bd25e4c-d948-4c3b-8eb2-7f63be54661a",
            "id_shift": "c79e52c4-7448-4275-a767-90ddb8c7ce88",
            "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-11-21T09:48:41Z"
        },
        "last_change": {
          "user": {
            "full_name": "sample string 12 sample string 11",
            "id": "0f819590-d682-4c4f-af67-cadae08b09ac",
            "image_id": "962d5253-d9ce-446e-83da-0d3c9f0773a1",
            "id_user_work_position": "5bd25e4c-d948-4c3b-8eb2-7f63be54661a",
            "id_shift": "c79e52c4-7448-4275-a767-90ddb8c7ce88",
            "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-11-21T09:48:41Z"
        }
      }
    },
    {
      "id": "1b1c698f-b817-437c-b736-f42e79d4be29",
      "name": "sample string 2",
      "deleted": true,
      "system_information": {
        "creation": {
          "user": {
            "full_name": "sample string 12 sample string 11",
            "id": "0f819590-d682-4c4f-af67-cadae08b09ac",
            "image_id": "962d5253-d9ce-446e-83da-0d3c9f0773a1",
            "id_user_work_position": "5bd25e4c-d948-4c3b-8eb2-7f63be54661a",
            "id_shift": "c79e52c4-7448-4275-a767-90ddb8c7ce88",
            "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-11-21T09:48:41Z"
        },
        "last_change": {
          "user": {
            "full_name": "sample string 12 sample string 11",
            "id": "0f819590-d682-4c4f-af67-cadae08b09ac",
            "image_id": "962d5253-d9ce-446e-83da-0d3c9f0773a1",
            "id_user_work_position": "5bd25e4c-d948-4c3b-8eb2-7f63be54661a",
            "id_shift": "c79e52c4-7448-4275-a767-90ddb8c7ce88",
            "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-11-21T09:48:41Z"
        }
      }
    }
  ],
  "pagination": {
    "object_count": 1,
    "page": 1,
    "per_page": 1
  },
  "structure": [
    {
      "name": "sample string 1",
      "title": "sample string 2",
      "width": 3,
      "show": true,
      "format": "sample string 5",
      "text_align": 6,
      "items": [
        {},
        {}
      ],
      "filter": "sample string 7",
      "type": "sample string 8",
      "order_number": 9
    },
    {
      "name": "sample string 1",
      "title": "sample string 2",
      "width": 3,
      "show": true,
      "format": "sample string 5",
      "text_align": 6,
      "items": [
        {},
        {}
      ],
      "filter": "sample string 7",
      "type": "sample string 8",
      "order_number": 9
    }
  ],
  "format_conditions": [
    {},
    {}
  ],
  "message": "sample string 1"
}

application/xml, text/xml

Sample:

<PaginationResponseOfCodeListFBCW68op xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/UP.Core.Data">
  <data xmlns:d2p1="http://schemas.datacontract.org/2004/07/IO.Swagger.Models">
    <d2p1:CodeList>
      <d2p1:deleted>true</d2p1:deleted>
      <d2p1:id>1b1c698f-b817-437c-b736-f42e79d4be29</d2p1:id>
      <d2p1:name>sample string 2</d2p1:name>
      <d2p1:system_information>
        <d2p1:creation>
          <d2p1:date>2024-11-21T10:48:41.277324+01:00</d2p1:date>
          <d2p1:user>
            <d2p1:code>sample string 5</d2p1:code>
            <d2p1:code2>sample string 6</d2p1:code2>
            <d2p1:first_name>sample string 11</d2p1:first_name>
            <d2p1:full_name>sample string 12 sample string 11</d2p1:full_name>
            <d2p1:id>0f819590-d682-4c4f-af67-cadae08b09ac</d2p1:id>
            <d2p1:id_shift>c79e52c4-7448-4275-a767-90ddb8c7ce88</d2p1:id_shift>
            <d2p1:id_user_work_position>5bd25e4c-d948-4c3b-8eb2-7f63be54661a</d2p1:id_user_work_position>
            <d2p1:image_id>962d5253-d9ce-446e-83da-0d3c9f0773a1</d2p1:image_id>
            <d2p1:introduction>sample string 10</d2p1:introduction>
            <d2p1:last_name>sample string 12</d2p1:last_name>
            <d2p1:title>sample string 9</d2p1:title>
          </d2p1:user>
        </d2p1:creation>
        <d2p1:last_change>
          <d2p1:date>2024-11-21T10:48:41.277324+01:00</d2p1:date>
          <d2p1:user>
            <d2p1:code>sample string 5</d2p1:code>
            <d2p1:code2>sample string 6</d2p1:code2>
            <d2p1:first_name>sample string 11</d2p1:first_name>
            <d2p1:full_name>sample string 12 sample string 11</d2p1:full_name>
            <d2p1:id>0f819590-d682-4c4f-af67-cadae08b09ac</d2p1:id>
            <d2p1:id_shift>c79e52c4-7448-4275-a767-90ddb8c7ce88</d2p1:id_shift>
            <d2p1:id_user_work_position>5bd25e4c-d948-4c3b-8eb2-7f63be54661a</d2p1:id_user_work_position>
            <d2p1:image_id>962d5253-d9ce-446e-83da-0d3c9f0773a1</d2p1:image_id>
            <d2p1:introduction>sample string 10</d2p1:introduction>
            <d2p1:last_name>sample string 12</d2p1:last_name>
            <d2p1:title>sample string 9</d2p1:title>
          </d2p1:user>
        </d2p1:last_change>
      </d2p1:system_information>
    </d2p1:CodeList>
    <d2p1:CodeList>
      <d2p1:deleted>true</d2p1:deleted>
      <d2p1:id>1b1c698f-b817-437c-b736-f42e79d4be29</d2p1:id>
      <d2p1:name>sample string 2</d2p1:name>
      <d2p1:system_information>
        <d2p1:creation>
          <d2p1:date>2024-11-21T10:48:41.277324+01:00</d2p1:date>
          <d2p1:user>
            <d2p1:code>sample string 5</d2p1:code>
            <d2p1:code2>sample string 6</d2p1:code2>
            <d2p1:first_name>sample string 11</d2p1:first_name>
            <d2p1:full_name>sample string 12 sample string 11</d2p1:full_name>
            <d2p1:id>0f819590-d682-4c4f-af67-cadae08b09ac</d2p1:id>
            <d2p1:id_shift>c79e52c4-7448-4275-a767-90ddb8c7ce88</d2p1:id_shift>
            <d2p1:id_user_work_position>5bd25e4c-d948-4c3b-8eb2-7f63be54661a</d2p1:id_user_work_position>
            <d2p1:image_id>962d5253-d9ce-446e-83da-0d3c9f0773a1</d2p1:image_id>
            <d2p1:introduction>sample string 10</d2p1:introduction>
            <d2p1:last_name>sample string 12</d2p1:last_name>
            <d2p1:title>sample string 9</d2p1:title>
          </d2p1:user>
        </d2p1:creation>
        <d2p1:last_change>
          <d2p1:date>2024-11-21T10:48:41.277324+01:00</d2p1:date>
          <d2p1:user>
            <d2p1:code>sample string 5</d2p1:code>
            <d2p1:code2>sample string 6</d2p1:code2>
            <d2p1:first_name>sample string 11</d2p1:first_name>
            <d2p1:full_name>sample string 12 sample string 11</d2p1:full_name>
            <d2p1:id>0f819590-d682-4c4f-af67-cadae08b09ac</d2p1:id>
            <d2p1:id_shift>c79e52c4-7448-4275-a767-90ddb8c7ce88</d2p1:id_shift>
            <d2p1:id_user_work_position>5bd25e4c-d948-4c3b-8eb2-7f63be54661a</d2p1:id_user_work_position>
            <d2p1:image_id>962d5253-d9ce-446e-83da-0d3c9f0773a1</d2p1:image_id>
            <d2p1:introduction>sample string 10</d2p1:introduction>
            <d2p1:last_name>sample string 12</d2p1:last_name>
            <d2p1:title>sample string 9</d2p1:title>
          </d2p1:user>
        </d2p1:last_change>
      </d2p1:system_information>
    </d2p1:CodeList>
  </data>
  <format_conditions xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:anyType />
    <d2p1:anyType />
  </format_conditions>
  <message>sample string 1</message>
  <pagination>
    <object_count>1</object_count>
    <page>1</page>
    <per_page>1</per_page>
  </pagination>
  <structure>
    <StructureItem>
      <filter>sample string 7</filter>
      <format>sample string 5</format>
      <items xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:anyType />
        <d4p1:anyType />
      </items>
      <name>sample string 1</name>
      <order_number>9</order_number>
      <show>true</show>
      <text_align>6</text_align>
      <title>sample string 2</title>
      <type>sample string 8</type>
      <width>3</width>
    </StructureItem>
    <StructureItem>
      <filter>sample string 7</filter>
      <format>sample string 5</format>
      <items xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:anyType />
        <d4p1:anyType />
      </items>
      <name>sample string 1</name>
      <order_number>9</order_number>
      <show>true</show>
      <text_align>6</text_align>
      <title>sample string 2</title>
      <type>sample string 8</type>
      <width>3</width>
    </StructureItem>
  </structure>
</PaginationResponseOfCodeListFBCW68op>