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

Request Information

URI Parameters

NameDescriptionTypeAdditional information
siteId

globally unique identifier

None.

Body Parameters

PoolEventTypeViewModel
NameDescriptionTypeAdditional information
descriptions

Dictionary of string [key] and string [value]

None.

id

globally unique identifier

None.

code

integer

Required

short_name

string

Required

String length: inclusive between 0 and 10

technical_description

string

Required

String length: inclusive between 0 and 100

active

boolean

Required

Request Formats

application/json, text/json

Sample:
{
  "descriptions": {
    "sample string 1": "sample string 2",
    "sample string 3": "sample string 4"
  },
  "id": "197ff9fe-323b-4d7b-8043-15c0b5634275",
  "code": 2,
  "short_name": "sample string 3",
  "technical_description": "sample string 4",
  "active": true
}

application/xml, text/xml

Sample:
<pool_event_type xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EntityModel">
  <active>true</active>
  <code>2</code>
  <id>197ff9fe-323b-4d7b-8043-15c0b5634275</id>
  <short_name>sample string 3</short_name>
  <technical_description>sample string 4</technical_description>
  <descriptions xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>sample string 1</d2p1:Key>
      <d2p1:Value>sample string 2</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>sample string 3</d2p1:Key>
      <d2p1:Value>sample string 4</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </descriptions>
</pool_event_type>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

globally unique identifier

Response Formats

application/json, text/json

Sample:
"6d3ba537-3e32-4330-bd0f-7ce8c1b85fb6"

application/xml, text/xml

Sample:
<guid xmlns="http://schemas.microsoft.com/2003/10/Serialization/">6d3ba537-3e32-4330-bd0f-7ce8c1b85fb6</guid>