POST api/v1/family_houses/bulk/change_state

Request Information

URI Parameters

None.

Body Parameters

ChangeState
NameDescriptionTypeAdditional information
ids

Collection of globally unique identifier

None.

state_id

integer

None.

parent

CodeList

None.

send_notifications

boolean

None.

message

string

None.

Request Formats

application/json, text/json

Sample:
{
  "ids": [
    "9167f324-052d-4223-b55a-a7cd72460bfa",
    "ce73ba76-886b-45dc-aa47-01a9a298aa0f"
  ],
  "state_id": 1,
  "parent": {
    "id": "4d6b348c-e319-4e27-b441-93a4afb53495",
    "name": "sample string 2",
    "deleted": true,
    "system_information": {
      "creation": {
        "user": {
          "full_name": "sample string 12 sample string 11",
          "id": "e4dedb32-85f0-43ba-8ffd-cbccebbc4f75",
          "image_id": "c0c5d40d-854a-4d59-920a-31654e172449",
          "id_user_work_position": "b1016a75-e3f3-4db8-a2d0-13e87da63a40",
          "id_shift": "6fdf3e1d-2c3e-441f-a874-83d355ecd579",
          "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-05-23T22:31:35Z"
      },
      "last_change": {
        "user": {
          "full_name": "sample string 12 sample string 11",
          "id": "e4dedb32-85f0-43ba-8ffd-cbccebbc4f75",
          "image_id": "c0c5d40d-854a-4d59-920a-31654e172449",
          "id_user_work_position": "b1016a75-e3f3-4db8-a2d0-13e87da63a40",
          "id_shift": "6fdf3e1d-2c3e-441f-a874-83d355ecd579",
          "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-05-23T22:31:35Z"
      }
    }
  },
  "send_notifications": true,
  "message": "sample string 2"
}

application/xml, text/xml

Sample:
<ChangeState xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IO.Swagger.Models">
  <ids xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:guid>9167f324-052d-4223-b55a-a7cd72460bfa</d2p1:guid>
    <d2p1:guid>ce73ba76-886b-45dc-aa47-01a9a298aa0f</d2p1:guid>
  </ids>
  <message>sample string 2</message>
  <parent>
    <deleted>true</deleted>
    <id>4d6b348c-e319-4e27-b441-93a4afb53495</id>
    <name>sample string 2</name>
    <system_information>
      <creation>
        <date>2024-05-24T00:31:35.6429282+02: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>e4dedb32-85f0-43ba-8ffd-cbccebbc4f75</id>
          <id_shift>6fdf3e1d-2c3e-441f-a874-83d355ecd579</id_shift>
          <id_user_work_position>b1016a75-e3f3-4db8-a2d0-13e87da63a40</id_user_work_position>
          <image_id>c0c5d40d-854a-4d59-920a-31654e172449</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-05-24T00:31:35.6429282+02: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>e4dedb32-85f0-43ba-8ffd-cbccebbc4f75</id>
          <id_shift>6fdf3e1d-2c3e-441f-a874-83d355ecd579</id_shift>
          <id_user_work_position>b1016a75-e3f3-4db8-a2d0-13e87da63a40</id_user_work_position>
          <image_id>c0c5d40d-854a-4d59-920a-31654e172449</image_id>
          <introduction>sample string 10</introduction>
          <last_name>sample string 12</last_name>
          <title>sample string 9</title>
        </user>
      </last_change>
    </system_information>
  </parent>
  <send_notifications>true</send_notifications>
  <state_id>1</state_id>
</ChangeState>

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>