POST api/contractapi/add?siteId={siteId}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
siteId

globally unique identifier

None.

Body Parameters

ContractViewModel
NameDescriptionTypeAdditional information
washing_processes

Collection of WashingProcessViewModel

None.

selected_sticker_id

globally unique identifier

None.

selected_nameplate_id

globally unique identifier

None.

active

boolean

Required

certificate_type_id

globally unique identifier

Required

code

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:
{
  "washing_processes": [
    {
      "descriptions": {
        "sample string 1": "sample string 2",
        "sample string 3": "sample string 4"
      },
      "active": true,
      "code": "sample string 2",
      "id": "e470288b-bd27-491e-9969-c3eac5f3d0a0",
      "site_id": "64c33ad8-3dc8-4cba-a9c1-d4050fa7cb75"
    },
    {
      "descriptions": {
        "sample string 1": "sample string 2",
        "sample string 3": "sample string 4"
      },
      "active": true,
      "code": "sample string 2",
      "id": "e470288b-bd27-491e-9969-c3eac5f3d0a0",
      "site_id": "64c33ad8-3dc8-4cba-a9c1-d4050fa7cb75"
    }
  ],
  "selected_sticker_id": "74be0cce-85d6-477c-b6c9-285c03a133a2",
  "selected_nameplate_id": "f3f67663-4d26-4592-9e6a-2a4b4a4c5fa4",
  "active": true,
  "certificate_type_id": "5e907482-3a05-4421-ba51-8ff4688d864a",
  "code": 1,
  "id": "d946c862-d9a2-40b0-9e85-0e762e4dc232",
  "internal_reference": "sample string 4",
  "item_wash_max": 1,
  "language_code": "sample string 5",
  "name": "sample string 6",
  "packaging_type_id": "e49e802f-b3a6-40e9-98b2-a3e9db44122e",
  "packing_type_id": "dbcbbf23-7bdc-4590-8cda-40c9a72fd970",
  "particles_control": true,
  "peremption_month": 1,
  "peremption_print_cleanroom": true,
  "peremption_print_date": true,
  "peremption_print_expedition": true,
  "permanent_management": true,
  "pool_id": "9f823eb5-d640-4f0a-a644-9ca0cc883df7",
  "remark": "sample string 14",
  "site_customer_id": "ec4afab2-915b-435b-8ebd-8f878f7b5169",
  "sorting_type_id": "43497dda-689a-4f16-9825-af57f9ff9624",
  "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>5e907482-3a05-4421-ba51-8ff4688d864a</certificate_type_id>
  <code>1</code>
  <id>d946c862-d9a2-40b0-9e85-0e762e4dc232</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>e49e802f-b3a6-40e9-98b2-a3e9db44122e</packaging_type_id>
  <packing_type_id>dbcbbf23-7bdc-4590-8cda-40c9a72fd970</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>9f823eb5-d640-4f0a-a644-9ca0cc883df7</pool_id>
  <remark>sample string 14</remark>
  <site_customer_id>ec4afab2-915b-435b-8ebd-8f878f7b5169</site_customer_id>
  <sorting_type_id>43497dda-689a-4f16-9825-af57f9ff9624</sorting_type_id>
  <type>sample string 17</type>
  <selected_nameplate_id>f3f67663-4d26-4592-9e6a-2a4b4a4c5fa4</selected_nameplate_id>
  <selected_sticker_id>74be0cce-85d6-477c-b6c9-285c03a133a2</selected_sticker_id>
  <washing_processes>
    <washing_process>
      <active>true</active>
      <code>sample string 2</code>
      <id>e470288b-bd27-491e-9969-c3eac5f3d0a0</id>
      <site_id>64c33ad8-3dc8-4cba-a9c1-d4050fa7cb75</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>e470288b-bd27-491e-9969-c3eac5f3d0a0</id>
      <site_id>64c33ad8-3dc8-4cba-a9c1-d4050fa7cb75</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:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'ContractViewModel'.

Response Information

Resource Description

globally unique identifier

Response Formats

application/json, text/json

Sample:
"10efeb74-cd6d-4060-8d9d-00a14e7ecc2b"

application/xml, text/xml

Sample:
<guid xmlns="http://schemas.microsoft.com/2003/10/Serialization/">10efeb74-cd6d-4060-8d9d-00a14e7ecc2b</guid>