POST api/Client

Request Information

URI Parameters

None.

Body Parameters

Client
NameDescriptionTypeAdditional information
PmsId

string

Required

String length: inclusive between 0 and 50

LastName

string

Required

String length: inclusive between 0 and 50

FirstName

string

Required

String length: inclusive between 0 and 50

SignificantOther

string

String length: inclusive between 0 and 50

EnteredDate

date

None.

Deleted

boolean

None.

Inactive

boolean

None.

SuspendReminders

boolean

None.

EmailReminders

boolean

None.

SiteId

string

String length: inclusive between 0 and 50

ApiCreateDate

date

Required

ApiLastChangeDate

date

None.

CheckSum

integer

None.

RowKey

integer

Required

Id

string

Required

String length: inclusive between 0 and 50

SyncId

string

Required

String length: inclusive between 0 and 50

SubscriberId

string

Required

String length: inclusive between 0 and 50

ClientTypeCode

string

String length: inclusive between 0 and 64

ClientTypeDescription

string

String length: inclusive between 0 and 100

Request Formats

application/json, text/json

Sample:
{
  "PmsId": "sample string 1",
  "LastName": "sample string 2",
  "FirstName": "sample string 3",
  "SignificantOther": "sample string 4",
  "EnteredDate": "2025-12-16T00:52:09.5232456+00:00",
  "Deleted": true,
  "Inactive": true,
  "SuspendReminders": true,
  "EmailReminders": true,
  "SiteId": "sample string 5",
  "ApiCreateDate": "2025-12-16T00:52:09.5232456+00:00",
  "ApiLastChangeDate": "2025-12-16T00:52:09.5232456+00:00",
  "CheckSum": 7,
  "RowKey": 8,
  "Id": "sample string 9",
  "SyncId": "sample string 10",
  "SubscriberId": "sample string 11",
  "ClientTypeCode": "sample string 12",
  "ClientTypeDescription": "sample string 13"
}

application/xml, text/xml

Sample:
<Client xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PVExDataModel">
  <ApiCreateDate>2025-12-16T00:52:09.5232456+00:00</ApiCreateDate>
  <ApiLastChangeDate>2025-12-16T00:52:09.5232456+00:00</ApiLastChangeDate>
  <CheckSum>7</CheckSum>
  <ClientTypeCode>sample string 12</ClientTypeCode>
  <ClientTypeDescription>sample string 13</ClientTypeDescription>
  <Deleted>true</Deleted>
  <EmailReminders>true</EmailReminders>
  <EnteredDate>2025-12-16T00:52:09.5232456+00:00</EnteredDate>
  <FirstName>sample string 3</FirstName>
  <Id>sample string 9</Id>
  <Inactive>true</Inactive>
  <LastName>sample string 2</LastName>
  <PmsId>sample string 1</PmsId>
  <RowKey>8</RowKey>
  <SignificantOther>sample string 4</SignificantOther>
  <SiteId>sample string 5</SiteId>
  <SubscriberId>sample string 11</SubscriberId>
  <SuspendReminders>true</SuspendReminders>
  <SyncId>sample string 10</SyncId>
</Client>

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 'Client'.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.