POST 17.0/database/types/list

Description

Retrieve a list of Types

URI Parameters

None.

ListOptions
Name Description Type Additional information
Fields

Collection of string

None.
Filters

Collection of DatabaseFilter

None.
Order

string

None.

application/json, text/json
Sample: 
{
  "fields": [
    "sample string 1",
    "sample string 2"
  ],
  "filters": [
    {
      "fieldName": "sample string 1",
      "value": "sample string 2",
      "operator": "sample string 3",
      "valueType": "sample string 4"
    },
    {
      "fieldName": "sample string 1",
      "value": "sample string 2",
      "operator": "sample string 3",
      "valueType": "sample string 4"
    }
  ],
  "order": "sample string 1"
}

application/xml, text/xml
Sample: 
<ListOptions xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Fields>
    <string>sample string 1</string>
    <string>sample string 2</string>
  </Fields>
  <Filters>
    <DatabaseFilter>
      <FieldName>sample string 1</FieldName>
      <Value>sample string 2</Value>
      <Operator>sample string 3</Operator>
      <ValueType>sample string 4</ValueType>
    </DatabaseFilter>
    <DatabaseFilter>
      <FieldName>sample string 1</FieldName>
      <Value>sample string 2</Value>
      <Operator>sample string 3</Operator>
      <ValueType>sample string 4</ValueType>
    </DatabaseFilter>
  </Filters>
  <Order>sample string 1</Order>
</ListOptions>

application/x-www-form-urlencoded
Sample:

Sample not available.

Collection of TypesUpdate
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
  },
  {
    "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: 
<ArrayOfTypesUpdate xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <TypesUpdate>
    <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>
  <TypesUpdate>
    <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>
</ArrayOfTypesUpdate>