POST 17.0/database/types

Description

Create Types

URI Parameters

None.

Name Description Type Additional information
ID

integer

None.

Description

string

String length: inclusive between 0 and 30

TypeID

byte

None.

Exclude

byte

None.

ShowAsReminder

byte

None.

ForeColor

integer

None.

BackColor

integer

None.

MailingList

byte

None.

RenewalPeriod

integer

None.

AutoArchivePeriod

integer

None.

AutoArchiveStatus

integer

None.

PropertyCategory

byte

None.

BulkAnonymise

byte

None.

InActive

byte

None.

application/json, text/json

Sample:
{
  "id": 1,
  "description": "sample string 1",
  "typeID": 64,
  "exclude": 64,
  "showAsReminder": 64,
  "foreColor": 1,
  "backColor": 1,
  "mailingList": 64,
  "renewalPeriod": 1,
  "autoArchivePeriod": 1,
  "autoArchiveStatus": 1,
  "propertyCategory": 64,
  "bulkAnonymise": 64,
  "inActive": 64
}

application/xml, text/xml

Sample:
<TypesUpdate xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <ID>1</ID>
  <Description>sample string 1</Description>
  <TypeID>64</TypeID>
  <Exclude>64</Exclude>
  <ShowAsReminder>64</ShowAsReminder>
  <ForeColor>1</ForeColor>
  <BackColor>1</BackColor>
  <MailingList>64</MailingList>
  <RenewalPeriod>1</RenewalPeriod>
  <AutoArchivePeriod>1</AutoArchivePeriod>
  <AutoArchiveStatus>1</AutoArchiveStatus>
  <PropertyCategory>64</PropertyCategory>
  <BulkAnonymise>64</BulkAnonymise>
  <InActive>64</InActive>
</TypesUpdate>

application/x-www-form-urlencoded

Sample:

Sample not available.

Name Description Type Additional information
ID

integer

None.

Description

string

String length: inclusive between 0 and 30

TypeID

byte

None.

Exclude

byte

None.

ShowAsReminder

byte

None.

ForeColor

integer

None.

BackColor

integer

None.

MailingList

byte

None.

RenewalPeriod

integer

None.

AutoArchivePeriod

integer

None.

AutoArchiveStatus

integer

None.

PropertyCategory

byte

None.

BulkAnonymise

byte

None.

InActive

byte

None.

application/json, text/json

Sample:
{
  "id": 1,
  "description": "sample string 2",
  "typeID": 64,
  "exclude": 64,
  "showAsReminder": 64,
  "foreColor": 6,
  "backColor": 7,
  "mailingList": 64,
  "renewalPeriod": 9,
  "autoArchivePeriod": 10,
  "autoArchiveStatus": 11,
  "propertyCategory": 64,
  "bulkAnonymise": 64,
  "inActive": 64
}

application/xml, text/xml

Sample:
<Types xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <ID>1</ID>
  <Description>sample string 2</Description>
  <TypeID>64</TypeID>
  <Exclude>64</Exclude>
  <ShowAsReminder>64</ShowAsReminder>
  <ForeColor>6</ForeColor>
  <BackColor>7</BackColor>
  <MailingList>64</MailingList>
  <RenewalPeriod>9</RenewalPeriod>
  <AutoArchivePeriod>10</AutoArchivePeriod>
  <AutoArchiveStatus>11</AutoArchiveStatus>
  <PropertyCategory>64</PropertyCategory>
  <BulkAnonymise>64</BulkAnonymise>
  <InActive>64</InActive>
</Types>