PUT api/Consumer

Request Information

URI Parameters

None.

Body Parameters

ConsumerDTO
NameDescriptionTypeAdditional information
Identifier

string

None.

Name

string

None.

Email

string

None.

Mobile

string

None.

Address

string

None.

EmergencyContact

string

None.

EmergencyMobile

string

None.

HasSystemAccess

boolean

None.

ParentEmail

string

None.

DateOfBirth

date

None.

ParentConsumerID

integer

None.

Roles

Collection of string

None.

SystemConsumerMemberStatusID

integer

None.

IsUpfrontPayment

boolean

None.

IsVatExempted

boolean

None.

ConsumerGroupConsumerMappings

Collection of ConsumerGroupConsumerMappingDTO

None.

ID

integer

None.

GUID

globally unique identifier

None.

CreatedBy

integer

None.

CreatedDate

date

None.

ModifiedBy

integer

None.

ModifiedDate

date

None.

DeletedBy

integer

None.

DeletedDate

date

None.

IsActive

boolean

None.

IsDeleted

boolean

None.

Remarks

string

None.

Request Formats

application/json, text/json

Sample:
{
  "Identifier": "sample string 1",
  "Name": "sample string 3",
  "Email": "sample string 4",
  "Mobile": "sample string 5",
  "Address": "sample string 6",
  "EmergencyContact": "sample string 7",
  "EmergencyMobile": "sample string 8",
  "HasSystemAccess": true,
  "ParentEmail": "sample string 9",
  "DateOfBirth": "2026-11-05T12:27:33.2973516+00:00",
  "ParentConsumerID": 1,
  "Roles": [
    "sample string 1",
    "sample string 2"
  ],
  "SystemConsumerMemberStatusID": 1,
  "IsUpfrontPayment": true,
  "IsVatExempted": true,
  "ConsumerGroupConsumerMappings": [
    {
      "ConsumerGroupID": 1,
      "ConsumerID": 2,
      "LicenceID": 1,
      "ConsumerGroup_Description": "sample string 3",
      "ConsumerGroup_SortOrder": 64,
      "Consumer_Identifier": "sample string 5",
      "Consumer_Name": "sample string 6",
      "ID": 7,
      "GUID": "c9e47b47-50b7-4681-b339-555f2cdde301",
      "CreatedBy": 9,
      "CreatedDate": "2026-11-05T12:27:33.2973516+00:00",
      "ModifiedBy": 11,
      "ModifiedDate": "2026-11-05T12:27:33.2973516+00:00",
      "DeletedBy": 12,
      "DeletedDate": "2026-11-05T12:27:33.2973516+00:00",
      "IsActive": true,
      "IsDeleted": true,
      "Remarks": "sample string 15"
    },
    {
      "ConsumerGroupID": 1,
      "ConsumerID": 2,
      "LicenceID": 1,
      "ConsumerGroup_Description": "sample string 3",
      "ConsumerGroup_SortOrder": 64,
      "Consumer_Identifier": "sample string 5",
      "Consumer_Name": "sample string 6",
      "ID": 7,
      "GUID": "c9e47b47-50b7-4681-b339-555f2cdde301",
      "CreatedBy": 9,
      "CreatedDate": "2026-11-05T12:27:33.2973516+00:00",
      "ModifiedBy": 11,
      "ModifiedDate": "2026-11-05T12:27:33.2973516+00:00",
      "DeletedBy": 12,
      "DeletedDate": "2026-11-05T12:27:33.2973516+00:00",
      "IsActive": true,
      "IsDeleted": true,
      "Remarks": "sample string 15"
    }
  ],
  "ID": 10,
  "GUID": "2e206449-d4c4-45c1-bed4-1f85f1167994",
  "CreatedBy": 12,
  "CreatedDate": "2026-11-05T12:27:33.2973516+00:00",
  "ModifiedBy": 14,
  "ModifiedDate": "2026-11-05T12:27:33.2973516+00:00",
  "DeletedBy": 15,
  "DeletedDate": "2026-11-05T12:27:33.2973516+00:00",
  "IsActive": true,
  "IsDeleted": true,
  "Remarks": "sample string 18"
}

text/xml

Sample:
<ConsumerDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Timepeaker.WebApi.DTO">
  <CreatedBy>12</CreatedBy>
  <CreatedDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>2026-11-05T12:27:33.2973516Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
  </CreatedDate>
  <DeletedBy>15</DeletedBy>
  <DeletedDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>2026-11-05T12:27:33.2973516Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
  </DeletedDate>
  <GUID>2e206449-d4c4-45c1-bed4-1f85f1167994</GUID>
  <ID>10</ID>
  <IsActive>true</IsActive>
  <IsDeleted>true</IsDeleted>
  <ModifiedBy>14</ModifiedBy>
  <ModifiedDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>2026-11-05T12:27:33.2973516Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
  </ModifiedDate>
  <Remarks>sample string 18</Remarks>
  <Address>sample string 6</Address>
  <ConsumerGroupConsumerMappings>
    <ConsumerGroupConsumerMappingDTO>
      <CreatedBy>9</CreatedBy>
      <CreatedDate xmlns:d4p1="http://schemas.datacontract.org/2004/07/System">
        <d4p1:DateTime>2026-11-05T12:27:33.2973516Z</d4p1:DateTime>
        <d4p1:OffsetMinutes>0</d4p1:OffsetMinutes>
      </CreatedDate>
      <DeletedBy>12</DeletedBy>
      <DeletedDate xmlns:d4p1="http://schemas.datacontract.org/2004/07/System">
        <d4p1:DateTime>2026-11-05T12:27:33.2973516Z</d4p1:DateTime>
        <d4p1:OffsetMinutes>0</d4p1:OffsetMinutes>
      </DeletedDate>
      <GUID>c9e47b47-50b7-4681-b339-555f2cdde301</GUID>
      <ID>7</ID>
      <IsActive>true</IsActive>
      <IsDeleted>true</IsDeleted>
      <ModifiedBy>11</ModifiedBy>
      <ModifiedDate xmlns:d4p1="http://schemas.datacontract.org/2004/07/System">
        <d4p1:DateTime>2026-11-05T12:27:33.2973516Z</d4p1:DateTime>
        <d4p1:OffsetMinutes>0</d4p1:OffsetMinutes>
      </ModifiedDate>
      <Remarks>sample string 15</Remarks>
      <ConsumerGroupID>1</ConsumerGroupID>
      <ConsumerGroup_Description>sample string 3</ConsumerGroup_Description>
      <ConsumerGroup_SortOrder>64</ConsumerGroup_SortOrder>
      <ConsumerID>2</ConsumerID>
      <Consumer_Identifier>sample string 5</Consumer_Identifier>
      <Consumer_Name>sample string 6</Consumer_Name>
      <LicenceID>1</LicenceID>
    </ConsumerGroupConsumerMappingDTO>
    <ConsumerGroupConsumerMappingDTO>
      <CreatedBy>9</CreatedBy>
      <CreatedDate xmlns:d4p1="http://schemas.datacontract.org/2004/07/System">
        <d4p1:DateTime>2026-11-05T12:27:33.2973516Z</d4p1:DateTime>
        <d4p1:OffsetMinutes>0</d4p1:OffsetMinutes>
      </CreatedDate>
      <DeletedBy>12</DeletedBy>
      <DeletedDate xmlns:d4p1="http://schemas.datacontract.org/2004/07/System">
        <d4p1:DateTime>2026-11-05T12:27:33.2973516Z</d4p1:DateTime>
        <d4p1:OffsetMinutes>0</d4p1:OffsetMinutes>
      </DeletedDate>
      <GUID>c9e47b47-50b7-4681-b339-555f2cdde301</GUID>
      <ID>7</ID>
      <IsActive>true</IsActive>
      <IsDeleted>true</IsDeleted>
      <ModifiedBy>11</ModifiedBy>
      <ModifiedDate xmlns:d4p1="http://schemas.datacontract.org/2004/07/System">
        <d4p1:DateTime>2026-11-05T12:27:33.2973516Z</d4p1:DateTime>
        <d4p1:OffsetMinutes>0</d4p1:OffsetMinutes>
      </ModifiedDate>
      <Remarks>sample string 15</Remarks>
      <ConsumerGroupID>1</ConsumerGroupID>
      <ConsumerGroup_Description>sample string 3</ConsumerGroup_Description>
      <ConsumerGroup_SortOrder>64</ConsumerGroup_SortOrder>
      <ConsumerID>2</ConsumerID>
      <Consumer_Identifier>sample string 5</Consumer_Identifier>
      <Consumer_Name>sample string 6</Consumer_Name>
      <LicenceID>1</LicenceID>
    </ConsumerGroupConsumerMappingDTO>
  </ConsumerGroupConsumerMappings>
  <DateOfBirth>2026-11-05T12:27:33.2973516+00:00</DateOfBirth>
  <Email>sample string 4</Email>
  <EmergencyContact>sample string 7</EmergencyContact>
  <EmergencyMobile>sample string 8</EmergencyMobile>
  <HasSystemAccess>true</HasSystemAccess>
  <Identifier>sample string 1</Identifier>
  <IsUpfrontPayment>true</IsUpfrontPayment>
  <IsVatExempted>true</IsVatExempted>
  <Mobile>sample string 5</Mobile>
  <Name>sample string 3</Name>
  <ParentConsumerID>1</ParentConsumerID>
  <ParentEmail>sample string 9</ParentEmail>
  <Password>sample string 2</Password>
  <Roles xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Roles>
  <SystemConsumerMemberStatusID>1</SystemConsumerMemberStatusID>
</ConsumerDTO>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, text/xml

Sample:

Sample not available.