POST api/v1/subjects

Request Information

URI Parameters

None.

Body Parameters

SearchBody
NameDescriptionTypeAdditional 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:33:59Z",
  "date_to": "2024-11-21T09:33:59Z",
  "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:33:59.446177+01:00</date_from>
  <date_to>2024-11-21T10:33:59.446177+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

PaginationResponseOfSubject
NameDescriptionTypeAdditional information
data

Collection of Subject

Required
pagination

Pagination

Required
structure

Collection of StructureItem

Required
format_conditions

Collection of Object

Required
message

string

Required
show_message

boolean

None.

Response Formats

application/json, text/json

Sample: 
{
  "data": [
    {
      "id": "40ea67ff-5f46-4f83-adc9-0db351621d17",
      "name": "sample string 2",
      "subject_type": {
        "id": 1,
        "name": "sample string 2",
        "name_en": "sample string 3",
        "code": "sample string 4"
      },
      "address": {
        "custom_location": true,
        "region": "sample string 2",
        "district": "sample string 3",
        "city": "sample string 4",
        "country": "sample string 5",
        "street": "sample string 6",
        "description_number": "sample string 7",
        "house_number": "sample string 8",
        "county": "sample string 9",
        "postcode": "sample string 10",
        "location": {
          "lat": "sample string 1",
          "lng": "sample string 2"
        }
      },
      "contact": {
        "email": "sample string 1",
        "phone": "sample string 2",
        "person_first_name": "sample string 3",
        "person_last_name": "sample string 4"
      },
      "registration_number": "sample string 3",
      "vat_number": "sample string 4",
      "account": "sample string 5",
      "bank_code": "sample string 6",
      "agreement": true,
      "broker": true,
      "deleted": true,
      "system_information": {
        "creation": {
          "user": {
            "full_name": "sample string 12 sample string 11",
            "id": "e05bfc94-2d3d-4bef-9f5c-fee462fecf10",
            "image_id": "66299fb3-8476-4839-9ac7-e63971e17bc0",
            "id_user_work_position": "c74039fc-86a2-4326-aa0b-7df594998b63",
            "id_shift": "d7853ab3-b61a-44ea-9ca8-762ea0279a2d",
            "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:33:59Z"
        },
        "last_change": {
          "user": {
            "full_name": "sample string 12 sample string 11",
            "id": "e05bfc94-2d3d-4bef-9f5c-fee462fecf10",
            "image_id": "66299fb3-8476-4839-9ac7-e63971e17bc0",
            "id_user_work_position": "c74039fc-86a2-4326-aa0b-7df594998b63",
            "id_shift": "d7853ab3-b61a-44ea-9ca8-762ea0279a2d",
            "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:33:59Z"
        }
      }
    },
    {
      "id": "40ea67ff-5f46-4f83-adc9-0db351621d17",
      "name": "sample string 2",
      "subject_type": {
        "id": 1,
        "name": "sample string 2",
        "name_en": "sample string 3",
        "code": "sample string 4"
      },
      "address": {
        "custom_location": true,
        "region": "sample string 2",
        "district": "sample string 3",
        "city": "sample string 4",
        "country": "sample string 5",
        "street": "sample string 6",
        "description_number": "sample string 7",
        "house_number": "sample string 8",
        "county": "sample string 9",
        "postcode": "sample string 10",
        "location": {
          "lat": "sample string 1",
          "lng": "sample string 2"
        }
      },
      "contact": {
        "email": "sample string 1",
        "phone": "sample string 2",
        "person_first_name": "sample string 3",
        "person_last_name": "sample string 4"
      },
      "registration_number": "sample string 3",
      "vat_number": "sample string 4",
      "account": "sample string 5",
      "bank_code": "sample string 6",
      "agreement": true,
      "broker": true,
      "deleted": true,
      "system_information": {
        "creation": {
          "user": {
            "full_name": "sample string 12 sample string 11",
            "id": "e05bfc94-2d3d-4bef-9f5c-fee462fecf10",
            "image_id": "66299fb3-8476-4839-9ac7-e63971e17bc0",
            "id_user_work_position": "c74039fc-86a2-4326-aa0b-7df594998b63",
            "id_shift": "d7853ab3-b61a-44ea-9ca8-762ea0279a2d",
            "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:33:59Z"
        },
        "last_change": {
          "user": {
            "full_name": "sample string 12 sample string 11",
            "id": "e05bfc94-2d3d-4bef-9f5c-fee462fecf10",
            "image_id": "66299fb3-8476-4839-9ac7-e63971e17bc0",
            "id_user_work_position": "c74039fc-86a2-4326-aa0b-7df594998b63",
            "id_shift": "d7853ab3-b61a-44ea-9ca8-762ea0279a2d",
            "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:33:59Z"
        }
      }
    }
  ],
  "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",
  "show_message": true
}

application/xml, text/xml

Sample: 
<PaginationResponseOfSubjectFBCW68op 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:Subject>
      <d2p1:account>sample string 5</d2p1:account>
      <d2p1:address>
        <d2p1:city>sample string 4</d2p1:city>
        <d2p1:country>sample string 5</d2p1:country>
        <d2p1:county>sample string 9</d2p1:county>
        <d2p1:custom_location>true</d2p1:custom_location>
        <d2p1:description_number>sample string 7</d2p1:description_number>
        <d2p1:district>sample string 3</d2p1:district>
        <d2p1:house_number>sample string 8</d2p1:house_number>
        <d2p1:location>
          <d2p1:lat>sample string 1</d2p1:lat>
          <d2p1:lng>sample string 2</d2p1:lng>
        </d2p1:location>
        <d2p1:postcode>sample string 10</d2p1:postcode>
        <d2p1:region>sample string 2</d2p1:region>
        <d2p1:street>sample string 6</d2p1:street>
      </d2p1:address>
      <d2p1:agreement>true</d2p1:agreement>
      <d2p1:bank_code>sample string 6</d2p1:bank_code>
      <d2p1:broker>true</d2p1:broker>
      <d2p1:contact>
        <d2p1:email>sample string 1</d2p1:email>
        <d2p1:person_first_name>sample string 3</d2p1:person_first_name>
        <d2p1:person_last_name>sample string 4</d2p1:person_last_name>
        <d2p1:phone>sample string 2</d2p1:phone>
      </d2p1:contact>
      <d2p1:deleted>true</d2p1:deleted>
      <d2p1:id>40ea67ff-5f46-4f83-adc9-0db351621d17</d2p1:id>
      <d2p1:name>sample string 2</d2p1:name>
      <d2p1:registration_number>sample string 3</d2p1:registration_number>
      <d2p1:subject_type>
        <d2p1:code>sample string 4</d2p1:code>
        <d2p1:id>1</d2p1:id>
        <d2p1:name>sample string 2</d2p1:name>
        <d2p1:name_en>sample string 3</d2p1:name_en>
      </d2p1:subject_type>
      <d2p1:system_information>
        <d2p1:creation>
          <d2p1:date>2024-11-21T10:33:59.446177+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>e05bfc94-2d3d-4bef-9f5c-fee462fecf10</d2p1:id>
            <d2p1:id_shift>d7853ab3-b61a-44ea-9ca8-762ea0279a2d</d2p1:id_shift>
            <d2p1:id_user_work_position>c74039fc-86a2-4326-aa0b-7df594998b63</d2p1:id_user_work_position>
            <d2p1:image_id>66299fb3-8476-4839-9ac7-e63971e17bc0</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:33:59.446177+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>e05bfc94-2d3d-4bef-9f5c-fee462fecf10</d2p1:id>
            <d2p1:id_shift>d7853ab3-b61a-44ea-9ca8-762ea0279a2d</d2p1:id_shift>
            <d2p1:id_user_work_position>c74039fc-86a2-4326-aa0b-7df594998b63</d2p1:id_user_work_position>
            <d2p1:image_id>66299fb3-8476-4839-9ac7-e63971e17bc0</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:vat_number>sample string 4</d2p1:vat_number>
    </d2p1:Subject>
    <d2p1:Subject>
      <d2p1:account>sample string 5</d2p1:account>
      <d2p1:address>
        <d2p1:city>sample string 4</d2p1:city>
        <d2p1:country>sample string 5</d2p1:country>
        <d2p1:county>sample string 9</d2p1:county>
        <d2p1:custom_location>true</d2p1:custom_location>
        <d2p1:description_number>sample string 7</d2p1:description_number>
        <d2p1:district>sample string 3</d2p1:district>
        <d2p1:house_number>sample string 8</d2p1:house_number>
        <d2p1:location>
          <d2p1:lat>sample string 1</d2p1:lat>
          <d2p1:lng>sample string 2</d2p1:lng>
        </d2p1:location>
        <d2p1:postcode>sample string 10</d2p1:postcode>
        <d2p1:region>sample string 2</d2p1:region>
        <d2p1:street>sample string 6</d2p1:street>
      </d2p1:address>
      <d2p1:agreement>true</d2p1:agreement>
      <d2p1:bank_code>sample string 6</d2p1:bank_code>
      <d2p1:broker>true</d2p1:broker>
      <d2p1:contact>
        <d2p1:email>sample string 1</d2p1:email>
        <d2p1:person_first_name>sample string 3</d2p1:person_first_name>
        <d2p1:person_last_name>sample string 4</d2p1:person_last_name>
        <d2p1:phone>sample string 2</d2p1:phone>
      </d2p1:contact>
      <d2p1:deleted>true</d2p1:deleted>
      <d2p1:id>40ea67ff-5f46-4f83-adc9-0db351621d17</d2p1:id>
      <d2p1:name>sample string 2</d2p1:name>
      <d2p1:registration_number>sample string 3</d2p1:registration_number>
      <d2p1:subject_type>
        <d2p1:code>sample string 4</d2p1:code>
        <d2p1:id>1</d2p1:id>
        <d2p1:name>sample string 2</d2p1:name>
        <d2p1:name_en>sample string 3</d2p1:name_en>
      </d2p1:subject_type>
      <d2p1:system_information>
        <d2p1:creation>
          <d2p1:date>2024-11-21T10:33:59.446177+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>e05bfc94-2d3d-4bef-9f5c-fee462fecf10</d2p1:id>
            <d2p1:id_shift>d7853ab3-b61a-44ea-9ca8-762ea0279a2d</d2p1:id_shift>
            <d2p1:id_user_work_position>c74039fc-86a2-4326-aa0b-7df594998b63</d2p1:id_user_work_position>
            <d2p1:image_id>66299fb3-8476-4839-9ac7-e63971e17bc0</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:33:59.446177+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>e05bfc94-2d3d-4bef-9f5c-fee462fecf10</d2p1:id>
            <d2p1:id_shift>d7853ab3-b61a-44ea-9ca8-762ea0279a2d</d2p1:id_shift>
            <d2p1:id_user_work_position>c74039fc-86a2-4326-aa0b-7df594998b63</d2p1:id_user_work_position>
            <d2p1:image_id>66299fb3-8476-4839-9ac7-e63971e17bc0</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:vat_number>sample string 4</d2p1:vat_number>
    </d2p1:Subject>
  </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>
  <show_message>true</show_message>
  <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>
</PaginationResponseOfSubjectFBCW68op>