POST Api/Catalog/GetAsync?id={id}

Request Information

URI Parameters

Name	Description	Type	Additional information
id		string	Required

Body Parameters

UserDTO

Name	Type	Additional 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": "414b78ca-6806-44a8-9120-8a0ea00e1f83",
  "username": "sample string 2",
  "password": "sample string 3",
  "email": "sample string 4",
  "accountId": "422ee3fa-9185-4836-98bc-e8b6d58e896c",
  "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": "3d029e59-64a3-4eb7-9b33-6d79a1afc7e3"
      },
      "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": "ebc67343-42aa-4cc8-b314-8429afca1ce4"
      },
      "clientPublicKey": "sample string 2",
      "securityToken": "sample string 3",
      "currentUserId": "fc6af46f-5192-4ca8-8868-814b8b77bcd3"
    },
    {
      "id": 1,
      "portal": {
        "id": 1,
        "name": "sample string 2",
        "description": "sample string 3",
        "clientPublicKey": "sample string 4",
        "securityToken": "sample string 5",
        "currentUserId": "3d029e59-64a3-4eb7-9b33-6d79a1afc7e3"
      },
      "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": "ebc67343-42aa-4cc8-b314-8429afca1ce4"
      },
      "clientPublicKey": "sample string 2",
      "securityToken": "sample string 3",
      "currentUserId": "fc6af46f-5192-4ca8-8868-814b8b77bcd3"
    }
  ],
  "firstName": "sample string 6",
  "lastName": "sample string 7",
  "oneId": "61fb2448-eea7-498d-a78a-955fb8211f80",
  "verificationDate": "2024-11-21T01:24:50.2000134-05:00",
  "verificationCode": "sample string 9",
  "clientPublicKey": "sample string 10",
  "securityToken": "sample string 11",
  "currentUserId": "b60280c0-b379-4d2b-8a89-7a5f1b6ccc55"
}

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>b60280c0-b379-4d2b-8a89-7a5f1b6ccc55</CurrentUserId>
  <SecurityToken>sample string 11</SecurityToken>
  <AccountId>422ee3fa-9185-4836-98bc-e8b6d58e896c</AccountId>
  <Email>sample string 4</Email>
  <FirstName>sample string 6</FirstName>
  <Id>414b78ca-6806-44a8-9120-8a0ea00e1f83</Id>
  <LastName>sample string 7</LastName>
  <OneId>61fb2448-eea7-498d-a78a-955fb8211f80</OneId>
  <Password>sample string 3</Password>
  <Products>
    <ProductDTO>
      <ClientPublicKey>sample string 2</ClientPublicKey>
      <CurrentUserId>fc6af46f-5192-4ca8-8868-814b8b77bcd3</CurrentUserId>
      <SecurityToken>sample string 3</SecurityToken>
      <Id>1</Id>
      <Portal>
        <ClientPublicKey>sample string 4</ClientPublicKey>
        <CurrentUserId>3d029e59-64a3-4eb7-9b33-6d79a1afc7e3</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>ebc67343-42aa-4cc8-b314-8429afca1ce4</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>fc6af46f-5192-4ca8-8868-814b8b77bcd3</CurrentUserId>
      <SecurityToken>sample string 3</SecurityToken>
      <Id>1</Id>
      <Portal>
        <ClientPublicKey>sample string 4</ClientPublicKey>
        <CurrentUserId>3d029e59-64a3-4eb7-9b33-6d79a1afc7e3</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>ebc67343-42aa-4cc8-b314-8429afca1ce4</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-11-21T01:24:50.2000134-05: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

CatalogDTO

Name	Type	Additional information
Id	string	None.
Type	integer	None.
BasePrice	integer	None.
LanguageId	integer	None.
Rater	string	None.
FullName	string	None.
ShortName	string	None.
IconLabelName	string	None.
Description	string	None.
FormUrl	string	None.
SortOrder	integer	None.
Tool	ToolDTO	None.
AdministrationOptions	Collection of AdministrationOptions	None.
ClientPublicKey	string	None.
SecurityToken	string	None.
CurrentUserId	globally unique identifier	None.

Response Formats

application/json, text/json

Sample:

{
  "id": "sample string 1",
  "type": 2,
  "basePrice": 3,
  "languageId": 4,
  "rater": "sample string 5",
  "fullName": "sample string 6",
  "shortName": "sample string 7",
  "iconLabelName": "sample string 8",
  "description": "sample string 9",
  "formUrl": "sample string 10",
  "sortOrder": 11,
  "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": "3100b616-bde9-4e56-9fa3-3607ad07e5e6"
  },
  "administrationOptions": [
    {
      "id": "fa09f208-f7fb-4f36-b75c-d7d07c242a39",
      "name": "sample string 2",
      "sortOrder": 3
    },
    {
      "id": "fa09f208-f7fb-4f36-b75c-d7d07c242a39",
      "name": "sample string 2",
      "sortOrder": 3
    }
  ],
  "clientPublicKey": "sample string 12",
  "securityToken": "sample string 13",
  "currentUserId": "c845515c-f655-4f65-8b57-58b2900c2858"
}

application/xml

Sample:

An exception has occurred while using the formatter 'XmlMediaTypeFormatter' to generate sample for media type 'application/xml'. Exception message: Object graph for type 'System.Collections.Generic.List`1[[MHS.Portal.Data.Assessment, MHS.Portal.Data, Version=2024.1112.1.24299, Culture=neutral, PublicKeyToken=null]]' contains cycles and cannot be serialized if reference tracking is disabled.

text/xml

Sample:

An exception has occurred while using the formatter 'XmlMediaTypeFormatter' to generate sample for media type 'text/xml'. Exception message: Object graph for type 'System.Collections.Generic.List`1[[MHS.Portal.Data.Assessment, MHS.Portal.Data, Version=2024.1112.1.24299, Culture=neutral, PublicKeyToken=null]]' contains cycles and cannot be serialized if reference tracking is disabled.