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. |
|
state_id | integer |
None. |
|
parent | CodeList |
None. |
|
send_notifications | boolean |
None. |
|
message | string |
None. |
Request Formats
application/json, text/json
Sample:
{ "ids": [ "996162fe-2ba2-4ed7-b82c-23bc5e0b1239", "3e878406-704b-478b-a96a-b297a29f4dcf" ], "state_id": 1, "parent": { "id": "35ccf4be-5c42-4034-b4ce-0a3fb26ee60f", "name": "sample string 2", "deleted": true, "system_information": { "creation": { "user": { "full_name": "sample string 12 sample string 11", "id": "edf5c4ec-034f-43ac-ad68-018e22f9a58a", "image_id": "5dc4b17b-7fec-4ee2-a768-09637ce93195", "id_user_work_position": "65f01849-945f-4e67-8152-c5c16d7cb172", "id_shift": "16f83e66-9880-481d-9a5e-4ee5cf1f0e3e", "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-07-27T03:25:07Z" }, "last_change": { "user": { "full_name": "sample string 12 sample string 11", "id": "edf5c4ec-034f-43ac-ad68-018e22f9a58a", "image_id": "5dc4b17b-7fec-4ee2-a768-09637ce93195", "id_user_work_position": "65f01849-945f-4e67-8152-c5c16d7cb172", "id_shift": "16f83e66-9880-481d-9a5e-4ee5cf1f0e3e", "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-07-27T03:25:07Z" } } }, "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>996162fe-2ba2-4ed7-b82c-23bc5e0b1239</d2p1:guid> <d2p1:guid>3e878406-704b-478b-a96a-b297a29f4dcf</d2p1:guid> </ids> <message>sample string 2</message> <parent> <deleted>true</deleted> <id>35ccf4be-5c42-4034-b4ce-0a3fb26ee60f</id> <name>sample string 2</name> <system_information> <creation> <date>2024-07-27T05:25:07.5503375+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>edf5c4ec-034f-43ac-ad68-018e22f9a58a</id> <id_shift>16f83e66-9880-481d-9a5e-4ee5cf1f0e3e</id_shift> <id_user_work_position>65f01849-945f-4e67-8152-c5c16d7cb172</id_user_work_position> <image_id>5dc4b17b-7fec-4ee2-a768-09637ce93195</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-07-27T05:25:07.5503375+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>edf5c4ec-034f-43ac-ad68-018e22f9a58a</id> <id_shift>16f83e66-9880-481d-9a5e-4ee5cf1f0e3e</id_shift> <id_user_work_position>65f01849-945f-4e67-8152-c5c16d7cb172</id_user_work_position> <image_id>5dc4b17b-7fec-4ee2-a768-09637ce93195</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
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>