POST Api/WebUtilities/SendMail

Request Information

URI Parameters

None.

Body Parameters

WebUtilityDTO
NameDescriptionTypeAdditional information
_IncomingUser

UserDTO

None.

EmailBody

string

None.

EmailSubject

string

None.

EmailAddress

string

None.

EmailAddressList

Collection of string

None.

AdditionalParams

Dictionary of string [key] and Object [value]

None.

ClientPublicKey

string

None.

SecurityToken

string

None.

CurrentUserId

globally unique identifier

None.

Request Formats

application/json, text/json

Sample:
{
  "_IncomingUser": {
    "id": "37380e5b-4488-4e46-a145-ba1fa7096bc5",
    "username": "sample string 2",
    "password": "sample string 3",
    "email": "sample string 4",
    "accountId": "d042bd97-532b-4f98-8094-480645f0ba30",
    "userType": {
      "id": 1,
      "name": "sample string 2",
      "description": "sample string 3"
    },
    "products": [
      {
        "id": 1,
        "portal": {
          "id": 1,
          "name": "sample string 2",
          "description": "sample string 3",
          "clientPublicKey": "sample string 4",
          "securityToken": "sample string 5",
          "currentUserId": "a32be23c-76d6-43c5-adc9-7c66b4d69ff3"
        },
        "tool": {
          "id": 1,
          "name": "sample string 2",
          "shortName": "sample string 3",
          "logoUrl": "sample string 4",
          "order": 5,
          "description": "sample string 6",
          "author": "sample string 7",
          "ageRange": "sample string 8",
          "clientPublicKey": "sample string 9",
          "securityToken": "sample string 10",
          "currentUserId": "55a4d15a-58ca-44b5-99d7-5ea9d4ec2689"
        },
        "clientPublicKey": "sample string 2",
        "securityToken": "sample string 3",
        "currentUserId": "34de1228-7e27-4f97-b152-8bceca073266"
      },
      {
        "id": 1,
        "portal": {
          "id": 1,
          "name": "sample string 2",
          "description": "sample string 3",
          "clientPublicKey": "sample string 4",
          "securityToken": "sample string 5",
          "currentUserId": "a32be23c-76d6-43c5-adc9-7c66b4d69ff3"
        },
        "tool": {
          "id": 1,
          "name": "sample string 2",
          "shortName": "sample string 3",
          "logoUrl": "sample string 4",
          "order": 5,
          "description": "sample string 6",
          "author": "sample string 7",
          "ageRange": "sample string 8",
          "clientPublicKey": "sample string 9",
          "securityToken": "sample string 10",
          "currentUserId": "55a4d15a-58ca-44b5-99d7-5ea9d4ec2689"
        },
        "clientPublicKey": "sample string 2",
        "securityToken": "sample string 3",
        "currentUserId": "34de1228-7e27-4f97-b152-8bceca073266"
      }
    ],
    "firstName": "sample string 6",
    "lastName": "sample string 7",
    "oneId": "37d853f3-210f-435f-b5fb-41ff0824d830",
    "verificationDate": "2024-09-29T20:33:56.3517235-04:00",
    "verificationCode": "sample string 9",
    "clientPublicKey": "sample string 10",
    "securityToken": "sample string 11",
    "currentUserId": "77f86256-c7e2-4d46-8998-c1358f5f269e"
  },
  "emailBody": "sample string 1",
  "emailSubject": "sample string 2",
  "emailAddress": "sample string 3",
  "emailAddressList": [
    "sample string 1",
    "sample string 2"
  ],
  "additionalParams": {
    "sample string 1": {},
    "sample string 3": {}
  },
  "clientPublicKey": "sample string 4",
  "securityToken": "sample string 5",
  "currentUserId": "5957453c-a442-4232-8101-cf8a91655370"
}

application/xml, text/xml

Sample:
<WebUtilityDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AccessManager.DTO">
  <ClientPublicKey>sample string 4</ClientPublicKey>
  <CurrentUserId>5957453c-a442-4232-8101-cf8a91655370</CurrentUserId>
  <SecurityToken>sample string 5</SecurityToken>
  <AdditionalParams xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringanyType>
      <d2p1:Key>sample string 1</d2p1:Key>
      <d2p1:Value />
    </d2p1:KeyValueOfstringanyType>
    <d2p1:KeyValueOfstringanyType>
      <d2p1:Key>sample string 3</d2p1:Key>
      <d2p1:Value />
    </d2p1:KeyValueOfstringanyType>
  </AdditionalParams>
  <EmailAddress>sample string 3</EmailAddress>
  <EmailAddressList xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </EmailAddressList>
  <EmailBody>sample string 1</EmailBody>
  <EmailSubject>sample string 2</EmailSubject>
  <_IncomingUser>
    <ClientPublicKey>sample string 10</ClientPublicKey>
    <CurrentUserId>77f86256-c7e2-4d46-8998-c1358f5f269e</CurrentUserId>
    <SecurityToken>sample string 11</SecurityToken>
    <AccountId>d042bd97-532b-4f98-8094-480645f0ba30</AccountId>
    <Email>sample string 4</Email>
    <FirstName>sample string 6</FirstName>
    <Id>37380e5b-4488-4e46-a145-ba1fa7096bc5</Id>
    <LastName>sample string 7</LastName>
    <OneId>37d853f3-210f-435f-b5fb-41ff0824d830</OneId>
    <Password>sample string 3</Password>
    <Products>
      <ProductDTO>
        <ClientPublicKey>sample string 2</ClientPublicKey>
        <CurrentUserId>34de1228-7e27-4f97-b152-8bceca073266</CurrentUserId>
        <SecurityToken>sample string 3</SecurityToken>
        <Id>1</Id>
        <Portal>
          <ClientPublicKey>sample string 4</ClientPublicKey>
          <CurrentUserId>a32be23c-76d6-43c5-adc9-7c66b4d69ff3</CurrentUserId>
          <SecurityToken>sample string 5</SecurityToken>
          <Description>sample string 3</Description>
          <Id>1</Id>
          <Name>sample string 2</Name>
        </Portal>
        <Tool>
          <ClientPublicKey>sample string 9</ClientPublicKey>
          <CurrentUserId>55a4d15a-58ca-44b5-99d7-5ea9d4ec2689</CurrentUserId>
          <SecurityToken>sample string 10</SecurityToken>
          <AgeRange>sample string 8</AgeRange>
          <Author>sample string 7</Author>
          <Description>sample string 6</Description>
          <Id>1</Id>
          <LogoUrl>sample string 4</LogoUrl>
          <Name>sample string 2</Name>
          <Order>5</Order>
          <ShortName>sample string 3</ShortName>
        </Tool>
      </ProductDTO>
      <ProductDTO>
        <ClientPublicKey>sample string 2</ClientPublicKey>
        <CurrentUserId>34de1228-7e27-4f97-b152-8bceca073266</CurrentUserId>
        <SecurityToken>sample string 3</SecurityToken>
        <Id>1</Id>
        <Portal>
          <ClientPublicKey>sample string 4</ClientPublicKey>
          <CurrentUserId>a32be23c-76d6-43c5-adc9-7c66b4d69ff3</CurrentUserId>
          <SecurityToken>sample string 5</SecurityToken>
          <Description>sample string 3</Description>
          <Id>1</Id>
          <Name>sample string 2</Name>
        </Portal>
        <Tool>
          <ClientPublicKey>sample string 9</ClientPublicKey>
          <CurrentUserId>55a4d15a-58ca-44b5-99d7-5ea9d4ec2689</CurrentUserId>
          <SecurityToken>sample string 10</SecurityToken>
          <AgeRange>sample string 8</AgeRange>
          <Author>sample string 7</Author>
          <Description>sample string 6</Description>
          <Id>1</Id>
          <LogoUrl>sample string 4</LogoUrl>
          <Name>sample string 2</Name>
          <Order>5</Order>
          <ShortName>sample string 3</ShortName>
        </Tool>
      </ProductDTO>
    </Products>
    <UserType>
      <Description>sample string 3</Description>
      <Id>1</Id>
      <Name>sample string 2</Name>
    </UserType>
    <Username>sample string 2</Username>
    <VerificationCode>sample string 9</VerificationCode>
    <VerificationDate>2024-09-29T20:33:56.3517235-04:00</VerificationDate>
  </_IncomingUser>
</WebUtilityDTO>

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

Response Information

Resource Description

boolean

Response Formats

application/json, text/json

Sample:
true

application/xml, text/xml

Sample:
<boolean xmlns="http://schemas.microsoft.com/2003/10/Serialization/">true</boolean>