POST api/v1/residencies/bulk/change_state

Request Information

URI Parameters

None.

Body Parameters

Name	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": [
    "4da7df5d-1eb5-4dbd-b144-938795e405bf",
    "3f2ccd8f-89dc-42ce-adbf-c7e409b0f57c"
  ],
  "user_id": "55e8dc7c-c293-4c60-a906-29ee2177a23f",
  "state_id": 1,
  "parent": {
    "id": "8f438d48-0522-493c-8a11-cd06f77ddf67",
    "name": "sample string 2",
    "deleted": true,
    "system_information": {
      "creation": {
        "user": {
          "full_name": "sample string 12 sample string 11",
          "id": "1141dc9d-de5c-4e3b-8839-ca43d7c01419",
          "image_id": "7562a40f-29b9-46a1-909c-fe925c449efd",
          "id_user_work_position": "7aca97c1-e47c-4df7-a606-28407368c6fc",
          "id_shift": "f0cafcf7-039c-4a00-ab40-9e5cd7dee889",
          "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": "2026-02-03T19:10:46Z"
      },
      "last_change": {
        "user": {
          "full_name": "sample string 12 sample string 11",
          "id": "1141dc9d-de5c-4e3b-8839-ca43d7c01419",
          "image_id": "7562a40f-29b9-46a1-909c-fe925c449efd",
          "id_user_work_position": "7aca97c1-e47c-4df7-a606-28407368c6fc",
          "id_shift": "f0cafcf7-039c-4a00-ab40-9e5cd7dee889",
          "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": "2026-02-03T19:10:46Z"
      }
    }
  },
  "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>4da7df5d-1eb5-4dbd-b144-938795e405bf</d2p1:guid>
    <d2p1:guid>3f2ccd8f-89dc-42ce-adbf-c7e409b0f57c</d2p1:guid>
  </ids>
  <message>sample string 2</message>
  <parent>
    <deleted>true</deleted>
    <id>8f438d48-0522-493c-8a11-cd06f77ddf67</id>
    <name>sample string 2</name>
    <system_information>
      <creation>
        <date>2026-02-03T20:10:46.8373088+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>1141dc9d-de5c-4e3b-8839-ca43d7c01419</id>
          <id_shift>f0cafcf7-039c-4a00-ab40-9e5cd7dee889</id_shift>
          <id_user_work_position>7aca97c1-e47c-4df7-a606-28407368c6fc</id_user_work_position>
          <image_id>7562a40f-29b9-46a1-909c-fe925c449efd</image_id>
          <introduction>sample string 10</introduction>
          <last_name>sample string 12</last_name>
          <title>sample string 9</title>
        </user>
      </creation>
      <last_change>
        <date>2026-02-03T20:10:46.8373088+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>1141dc9d-de5c-4e3b-8839-ca43d7c01419</id>
          <id_shift>f0cafcf7-039c-4a00-ab40-9e5cd7dee889</id_shift>
          <id_user_work_position>7aca97c1-e47c-4df7-a606-28407368c6fc</id_user_work_position>
          <image_id>7562a40f-29b9-46a1-909c-fe925c449efd</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>55e8dc7c-c293-4c60-a906-29ee2177a23f</user_id>
</ChangeState>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Result

Name	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>