POST api/v1/family_houses/bulk/change_state
Request Information
URI Parameters
None.
Body Parameters
ChangeState| Name | Description | Type | Additional information |
|---|---|---|---|
| ids | Collection of globally unique identifier |
None. |
|
| user_id | 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": [
"cfbb6e1d-3045-4606-8fb5-7f8038e41585",
"5bef0388-776a-4d3d-83a0-77c74b3cc50e"
],
"user_id": "c3b38f2c-9a52-4980-91c2-4d88a18c9eb0",
"state_id": 1,
"parent": {
"id": "dcc99e84-b6d1-4492-b55c-76c9e8d978a7",
"name": "sample string 2",
"deleted": true,
"system_information": {
"creation": {
"user": {
"full_name": "sample string 12 sample string 11",
"id": "4f3c82ed-d632-4fb4-86f1-697278d28946",
"image_id": "724ffbbc-4c2d-46f8-98d2-f956bcba5931",
"id_user_work_position": "51a3e484-5a68-471d-b3f0-376ba7de14e8",
"id_shift": "4fca4f08-4799-4e8a-a62e-6b9b3c869539",
"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": "2025-11-06T00:24:16Z"
},
"last_change": {
"user": {
"full_name": "sample string 12 sample string 11",
"id": "4f3c82ed-d632-4fb4-86f1-697278d28946",
"image_id": "724ffbbc-4c2d-46f8-98d2-f956bcba5931",
"id_user_work_position": "51a3e484-5a68-471d-b3f0-376ba7de14e8",
"id_shift": "4fca4f08-4799-4e8a-a62e-6b9b3c869539",
"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": "2025-11-06T00:24:16Z"
}
}
},
"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>cfbb6e1d-3045-4606-8fb5-7f8038e41585</d2p1:guid>
<d2p1:guid>5bef0388-776a-4d3d-83a0-77c74b3cc50e</d2p1:guid>
</ids>
<message>sample string 2</message>
<parent>
<deleted>true</deleted>
<id>dcc99e84-b6d1-4492-b55c-76c9e8d978a7</id>
<name>sample string 2</name>
<system_information>
<creation>
<date>2025-11-06T01:24:16.8049643+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>4f3c82ed-d632-4fb4-86f1-697278d28946</id>
<id_shift>4fca4f08-4799-4e8a-a62e-6b9b3c869539</id_shift>
<id_user_work_position>51a3e484-5a68-471d-b3f0-376ba7de14e8</id_user_work_position>
<image_id>724ffbbc-4c2d-46f8-98d2-f956bcba5931</image_id>
<introduction>sample string 10</introduction>
<last_name>sample string 12</last_name>
<title>sample string 9</title>
</user>
</creation>
<last_change>
<date>2025-11-06T01:24:16.8049643+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>4f3c82ed-d632-4fb4-86f1-697278d28946</id>
<id_shift>4fca4f08-4799-4e8a-a62e-6b9b3c869539</id_shift>
<id_user_work_position>51a3e484-5a68-471d-b3f0-376ba7de14e8</id_user_work_position>
<image_id>724ffbbc-4c2d-46f8-98d2-f956bcba5931</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>
<user_id>c3b38f2c-9a52-4980-91c2-4d88a18c9eb0</user_id>
</ChangeState>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
Result| Name | Description | Type | Additional 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>