POST api/v1/residencies/bulk/change_state
Request Information
URI Parameters
None.
Body Parameters
ChangeStateName | 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": [ "0edb2c58-27eb-4289-be34-f3367ec9ec65", "5241e4f5-ef60-411b-b67d-d744ba8bf73a" ], "user_id": "6d0c7e5a-d9e5-49b6-b163-3b7b2563eef2", "state_id": 1, "parent": { "id": "e4d29c11-b556-4f41-9494-a06e0604a5c1", "name": "sample string 2", "deleted": true, "system_information": { "creation": { "user": { "full_name": "sample string 12 sample string 11", "id": "94bd636d-ecc6-4f63-a369-00f49a871611", "image_id": "3d3e97a8-0504-45c2-a4cb-1b542f92d4be", "id_user_work_position": "305b81d5-2738-4225-a48f-2d4b61dc7815", "id_shift": "d6f230c7-9256-4256-8c64-c8c4a3e59b79", "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-07-19T08:37:10Z" }, "last_change": { "user": { "full_name": "sample string 12 sample string 11", "id": "94bd636d-ecc6-4f63-a369-00f49a871611", "image_id": "3d3e97a8-0504-45c2-a4cb-1b542f92d4be", "id_user_work_position": "305b81d5-2738-4225-a48f-2d4b61dc7815", "id_shift": "d6f230c7-9256-4256-8c64-c8c4a3e59b79", "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-07-19T08:37:10Z" } } }, "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>0edb2c58-27eb-4289-be34-f3367ec9ec65</d2p1:guid> <d2p1:guid>5241e4f5-ef60-411b-b67d-d744ba8bf73a</d2p1:guid> </ids> <message>sample string 2</message> <parent> <deleted>true</deleted> <id>e4d29c11-b556-4f41-9494-a06e0604a5c1</id> <name>sample string 2</name> <system_information> <creation> <date>2025-07-19T10:37:10.9565108+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>94bd636d-ecc6-4f63-a369-00f49a871611</id> <id_shift>d6f230c7-9256-4256-8c64-c8c4a3e59b79</id_shift> <id_user_work_position>305b81d5-2738-4225-a48f-2d4b61dc7815</id_user_work_position> <image_id>3d3e97a8-0504-45c2-a4cb-1b542f92d4be</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-07-19T10:37:10.9565108+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>94bd636d-ecc6-4f63-a369-00f49a871611</id> <id_shift>d6f230c7-9256-4256-8c64-c8c4a3e59b79</id_shift> <id_user_work_position>305b81d5-2738-4225-a48f-2d4b61dc7815</id_user_work_position> <image_id>3d3e97a8-0504-45c2-a4cb-1b542f92d4be</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>6d0c7e5a-d9e5-49b6-b163-3b7b2563eef2</user_id> </ChangeState>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
ResultName | 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>