POST api/contractapi/add?siteId={siteId}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| siteId | globally unique identifier |
None. |
Body Parameters
ContractViewModel| Name | Description | Type | Additional information |
|---|---|---|---|
| selected_nameplate_id | globally unique identifier |
None. |
|
| selected_sticker_id | globally unique identifier |
None. |
|
| washing_processes | Collection of WashingProcessViewModel |
None. |
|
| active | boolean |
Required |
|
| certificate_type_id | globally unique identifier |
Required |
|
| code | integer |
None. |
|
| delay_between_scans | integer |
None. |
|
| id | globally unique identifier |
None. |
|
| internal_reference | string |
String length: inclusive between 0 and 50 |
|
| item_wash_max | integer |
None. |
|
| language_code | string |
Required String length: inclusive between 0 and 10 |
|
| name | string |
Required String length: inclusive between 0 and 100 |
|
| packaging_type_id | globally unique identifier |
Required |
|
| packing_type_id | globally unique identifier |
Required |
|
| particles_control | boolean |
Required |
|
| peremption_month | integer |
None. |
|
| peremption_print_cleanroom | boolean |
Required |
|
| peremption_print_date | boolean |
Required |
|
| peremption_print_expedition | boolean |
Required |
|
| permanent_management | boolean |
Required |
|
| pool_id | globally unique identifier |
None. |
|
| remark | string |
None. |
|
| site_customer_id | globally unique identifier |
Required |
|
| sorting_type_id | globally unique identifier |
Required |
|
| type | string |
Required String length: inclusive between 0 and 1 |
Request Formats
application/json, text/json
Sample:
{
"selected_nameplate_id": "7880ada4-fd02-471a-ac1a-ac21df57329a",
"selected_sticker_id": "6a48fdc1-33b2-45ee-bb34-5602f8e73e0c",
"washing_processes": [
{
"descriptions": {
"sample string 1": "sample string 2",
"sample string 3": "sample string 4"
},
"active": true,
"code": "sample string 2",
"id": "1ba9ef5b-d68a-47b7-ba58-6faf1d36a290",
"site_id": "189d2b77-43d5-4eb4-9fed-0a9d62f6107e"
},
{
"descriptions": {
"sample string 1": "sample string 2",
"sample string 3": "sample string 4"
},
"active": true,
"code": "sample string 2",
"id": "1ba9ef5b-d68a-47b7-ba58-6faf1d36a290",
"site_id": "189d2b77-43d5-4eb4-9fed-0a9d62f6107e"
}
],
"active": true,
"certificate_type_id": "1e879b45-3c4d-4267-a91a-e229cb117de3",
"code": 1,
"delay_between_scans": 1,
"id": "5ef1cd54-7ed6-4ab4-8e95-0c556a0b5e16",
"internal_reference": "sample string 4",
"item_wash_max": 1,
"language_code": "sample string 5",
"name": "sample string 6",
"packaging_type_id": "c5888c06-d728-4802-b10b-d8e16e513e57",
"packing_type_id": "7072411f-2a74-4e27-9f79-274232cb8e13",
"particles_control": true,
"peremption_month": 1,
"peremption_print_cleanroom": true,
"peremption_print_date": true,
"peremption_print_expedition": true,
"permanent_management": true,
"pool_id": "5bb66a03-b912-42b2-91b2-07bbc75816d1",
"remark": "sample string 14",
"site_customer_id": "3a49f067-b872-4f80-b33f-05dc50a4b10d",
"sorting_type_id": "a86ed7ab-815f-4b61-b883-240eff16d218",
"type": "sample string 17"
}
application/xml, text/xml
Sample:
<contract xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EntityModel">
<active>true</active>
<certificate_type_id>1e879b45-3c4d-4267-a91a-e229cb117de3</certificate_type_id>
<code>1</code>
<delay_between_scans>1</delay_between_scans>
<id>5ef1cd54-7ed6-4ab4-8e95-0c556a0b5e16</id>
<internal_reference>sample string 4</internal_reference>
<item_wash_max>1</item_wash_max>
<language_code>sample string 5</language_code>
<name>sample string 6</name>
<packaging_type_id>c5888c06-d728-4802-b10b-d8e16e513e57</packaging_type_id>
<packing_type_id>7072411f-2a74-4e27-9f79-274232cb8e13</packing_type_id>
<particles_control>true</particles_control>
<peremption_month>1</peremption_month>
<peremption_print_cleanroom>true</peremption_print_cleanroom>
<peremption_print_date>true</peremption_print_date>
<peremption_print_expedition>true</peremption_print_expedition>
<permanent_management>true</permanent_management>
<pool_id>5bb66a03-b912-42b2-91b2-07bbc75816d1</pool_id>
<remark>sample string 14</remark>
<site_customer_id>3a49f067-b872-4f80-b33f-05dc50a4b10d</site_customer_id>
<sorting_type_id>a86ed7ab-815f-4b61-b883-240eff16d218</sorting_type_id>
<type>sample string 17</type>
<selected_nameplate_id>7880ada4-fd02-471a-ac1a-ac21df57329a</selected_nameplate_id>
<selected_sticker_id>6a48fdc1-33b2-45ee-bb34-5602f8e73e0c</selected_sticker_id>
<washing_processes>
<washing_process>
<active>true</active>
<code>sample string 2</code>
<id>1ba9ef5b-d68a-47b7-ba58-6faf1d36a290</id>
<site_id>189d2b77-43d5-4eb4-9fed-0a9d62f6107e</site_id>
<descriptions xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:KeyValueOfstringstring>
<d4p1:Key>sample string 1</d4p1:Key>
<d4p1:Value>sample string 2</d4p1:Value>
</d4p1:KeyValueOfstringstring>
<d4p1:KeyValueOfstringstring>
<d4p1:Key>sample string 3</d4p1:Key>
<d4p1:Value>sample string 4</d4p1:Value>
</d4p1:KeyValueOfstringstring>
</descriptions>
</washing_process>
<washing_process>
<active>true</active>
<code>sample string 2</code>
<id>1ba9ef5b-d68a-47b7-ba58-6faf1d36a290</id>
<site_id>189d2b77-43d5-4eb4-9fed-0a9d62f6107e</site_id>
<descriptions xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:KeyValueOfstringstring>
<d4p1:Key>sample string 1</d4p1:Key>
<d4p1:Value>sample string 2</d4p1:Value>
</d4p1:KeyValueOfstringstring>
<d4p1:KeyValueOfstringstring>
<d4p1:Key>sample string 3</d4p1:Key>
<d4p1:Value>sample string 4</d4p1:Value>
</d4p1:KeyValueOfstringstring>
</descriptions>
</washing_process>
</washing_processes>
</contract>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
globally unique identifierResponse Formats
application/json, text/json
Sample:
"a7a68d80-94df-4d03-bb46-6e7555a4c009"
application/xml, text/xml
Sample:
<guid xmlns="http://schemas.microsoft.com/2003/10/Serialization/">a7a68d80-94df-4d03-bb46-6e7555a4c009</guid>