POST Api/Tool/GetChildTools?portalId={portalId}&username={username}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
portalId

integer

Required

username

string

Required

Body Parameters

UserDTO
NameDescriptionTypeAdditional information
Id

globally unique identifier

None.

Username

string

None.

Password

string

None.

Email

string

None.

AccountId

globally unique identifier

None.

UserType

UserTypeDTO

None.

Products

Collection of ProductDTO

None.

FirstName

string

None.

LastName

string

None.

OneId

globally unique identifier

None.

VerificationDate

date

None.

VerificationCode

string

None.

ClientPublicKey

string

None.

SecurityToken

string

None.

CurrentUserId

globally unique identifier

None.

Request Formats

application/json, text/json

Sample:
{
  "id": "3a5e5a7d-613a-495e-8782-33ed431f92c2",
  "username": "sample string 2",
  "password": "sample string 3",
  "email": "sample string 4",
  "accountId": "43531884-e080-498a-801a-b42442d6824f",
  "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": "93db3eda-85a1-4952-9073-1abecba7fbd6"
      },
      "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": "404450b9-728f-4214-83e3-78b4a2457615"
      },
      "clientPublicKey": "sample string 2",
      "securityToken": "sample string 3",
      "currentUserId": "5e6c27f2-9aa9-4f24-a91b-58501f5202cd"
    },
    {
      "id": 1,
      "portal": {
        "id": 1,
        "name": "sample string 2",
        "description": "sample string 3",
        "clientPublicKey": "sample string 4",
        "securityToken": "sample string 5",
        "currentUserId": "93db3eda-85a1-4952-9073-1abecba7fbd6"
      },
      "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": "404450b9-728f-4214-83e3-78b4a2457615"
      },
      "clientPublicKey": "sample string 2",
      "securityToken": "sample string 3",
      "currentUserId": "5e6c27f2-9aa9-4f24-a91b-58501f5202cd"
    }
  ],
  "firstName": "sample string 6",
  "lastName": "sample string 7",
  "oneId": "2eb1bc32-7c3d-4c98-9b3e-2725e73217fd",
  "verificationDate": "2024-09-29T20:31:25.82172-04:00",
  "verificationCode": "sample string 9",
  "clientPublicKey": "sample string 10",
  "securityToken": "sample string 11",
  "currentUserId": "8f2e8d2c-4dbd-4c29-9f50-976e96fd5c17"
}

application/xml, text/xml

Sample:
<UserDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AccessManager.DTO">
  <ClientPublicKey>sample string 10</ClientPublicKey>
  <CurrentUserId>8f2e8d2c-4dbd-4c29-9f50-976e96fd5c17</CurrentUserId>
  <SecurityToken>sample string 11</SecurityToken>
  <AccountId>43531884-e080-498a-801a-b42442d6824f</AccountId>
  <Email>sample string 4</Email>
  <FirstName>sample string 6</FirstName>
  <Id>3a5e5a7d-613a-495e-8782-33ed431f92c2</Id>
  <LastName>sample string 7</LastName>
  <OneId>2eb1bc32-7c3d-4c98-9b3e-2725e73217fd</OneId>
  <Password>sample string 3</Password>
  <Products>
    <ProductDTO>
      <ClientPublicKey>sample string 2</ClientPublicKey>
      <CurrentUserId>5e6c27f2-9aa9-4f24-a91b-58501f5202cd</CurrentUserId>
      <SecurityToken>sample string 3</SecurityToken>
      <Id>1</Id>
      <Portal>
        <ClientPublicKey>sample string 4</ClientPublicKey>
        <CurrentUserId>93db3eda-85a1-4952-9073-1abecba7fbd6</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>404450b9-728f-4214-83e3-78b4a2457615</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>5e6c27f2-9aa9-4f24-a91b-58501f5202cd</CurrentUserId>
      <SecurityToken>sample string 3</SecurityToken>
      <Id>1</Id>
      <Portal>
        <ClientPublicKey>sample string 4</ClientPublicKey>
        <CurrentUserId>93db3eda-85a1-4952-9073-1abecba7fbd6</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>404450b9-728f-4214-83e3-78b4a2457615</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:31:25.82172-04:00</VerificationDate>
</UserDTO>

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

Response Information

Resource Description

Collection of ToolDTO
NameDescriptionTypeAdditional information
Id

integer

None.

Name

string

None.

ShortName

string

None.

LogoUrl

string

None.

Order

integer

None.

Description

string

None.

Author

string

None.

AgeRange

string

None.

ClientPublicKey

string

None.

SecurityToken

string

None.

CurrentUserId

globally unique identifier

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "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": "c42656da-a041-4585-b11b-c17599ec79b8"
  },
  {
    "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": "c42656da-a041-4585-b11b-c17599ec79b8"
  }
]

application/xml, text/xml

Sample:
<ArrayOfToolDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AccessManager.DTO">
  <ToolDTO>
    <ClientPublicKey>sample string 9</ClientPublicKey>
    <CurrentUserId>c42656da-a041-4585-b11b-c17599ec79b8</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>
  </ToolDTO>
  <ToolDTO>
    <ClientPublicKey>sample string 9</ClientPublicKey>
    <CurrentUserId>c42656da-a041-4585-b11b-c17599ec79b8</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>
  </ToolDTO>
</ArrayOfToolDTO>