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

Request Information

URI Parameters

NameDescriptionTypeAdditional information
siteId

globally unique identifier

None.

Body Parameters

ContractViewModel
NameDescriptionTypeAdditional 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": "5cc189f6-0981-4947-bf96-bbc9a60bf442",
  "selected_sticker_id": "d05e7487-d5c6-4656-bfec-3b3419b5c167",
  "washing_processes": [
    {
      "descriptions": {
        "sample string 1": "sample string 2",
        "sample string 3": "sample string 4"
      },
      "active": true,
      "code": "sample string 2",
      "id": "23728528-312f-4789-acaf-71ece38847a2",
      "site_id": "11e610f9-d1f5-4e95-8bb3-75ae3ac961ec"
    },
    {
      "descriptions": {
        "sample string 1": "sample string 2",
        "sample string 3": "sample string 4"
      },
      "active": true,
      "code": "sample string 2",
      "id": "23728528-312f-4789-acaf-71ece38847a2",
      "site_id": "11e610f9-d1f5-4e95-8bb3-75ae3ac961ec"
    }
  ],
  "active": true,
  "certificate_type_id": "31b65612-b121-43ef-89fd-ff15b88ef1f7",
  "code": 1,
  "delay_between_scans": 1,
  "id": "38aebfd1-60bc-4944-a7e8-e9f43725fe72",
  "internal_reference": "sample string 4",
  "item_wash_max": 1,
  "language_code": "sample string 5",
  "name": "sample string 6",
  "packaging_type_id": "8079eb55-8afd-4a30-97c7-72b18d6e103e",
  "packing_type_id": "6dec2dd3-217a-453d-a1d8-f5ad4ae6d4d7",
  "particles_control": true,
  "peremption_month": 1,
  "peremption_print_cleanroom": true,
  "peremption_print_date": true,
  "peremption_print_expedition": true,
  "permanent_management": true,
  "pool_id": "d4677313-9a4c-4dfd-b77f-bc022f4a65e4",
  "remark": "sample string 14",
  "site_customer_id": "b3f5f123-2623-419f-b325-78aaf87ec0af",
  "sorting_type_id": "f7359e65-c4cd-40bb-8f4a-54628a4ea855",
  "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>31b65612-b121-43ef-89fd-ff15b88ef1f7</certificate_type_id>
  <code>1</code>
  <delay_between_scans>1</delay_between_scans>
  <id>38aebfd1-60bc-4944-a7e8-e9f43725fe72</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>8079eb55-8afd-4a30-97c7-72b18d6e103e</packaging_type_id>
  <packing_type_id>6dec2dd3-217a-453d-a1d8-f5ad4ae6d4d7</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>d4677313-9a4c-4dfd-b77f-bc022f4a65e4</pool_id>
  <remark>sample string 14</remark>
  <site_customer_id>b3f5f123-2623-419f-b325-78aaf87ec0af</site_customer_id>
  <sorting_type_id>f7359e65-c4cd-40bb-8f4a-54628a4ea855</sorting_type_id>
  <type>sample string 17</type>
  <selected_nameplate_id>5cc189f6-0981-4947-bf96-bbc9a60bf442</selected_nameplate_id>
  <selected_sticker_id>d05e7487-d5c6-4656-bfec-3b3419b5c167</selected_sticker_id>
  <washing_processes>
    <washing_process>
      <active>true</active>
      <code>sample string 2</code>
      <id>23728528-312f-4789-acaf-71ece38847a2</id>
      <site_id>11e610f9-d1f5-4e95-8bb3-75ae3ac961ec</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>23728528-312f-4789-acaf-71ece38847a2</id>
      <site_id>11e610f9-d1f5-4e95-8bb3-75ae3ac961ec</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 identifier

Response Formats

application/json, text/json

Sample:
"5ec20d14-560c-4b5f-a795-b3dcfc2aa6b0"

application/xml, text/xml

Sample:
<guid xmlns="http://schemas.microsoft.com/2003/10/Serialization/">5ec20d14-560c-4b5f-a795-b3dcfc2aa6b0</guid>