POST api/TrueTalentServices/ReportScore

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
ClientId	TrueTalent Client Details.	Client	None.
PackageId	TrueTalent Package Details.	Package	None.
ComparisonGroupId	TrueTalent ComparisonGroup. Identifies any grouping (demographic, norm, etc...) needed for scoring the assessment. Max Length: String (64)	string	None.
ClientOrderId	TrueTalent ClientOrder	ClientOrder	None.
AssessmentSubject	TrueTalent AssessmentSubject	AssessmentSubject	None.
UserArea	Used for redirection and Interoperability	UserArea	None.

Request Formats

application/json, text/json

Sample:

{
  "ClientId": {
    "CustomerId": "sample string 1",
    "Username": "sample string 2",
    "Password": "sample string 3"
  },
  "PackageId": {
    "AssessmentId": "sample string 1",
    "ReportId": "sample string 2"
  },
  "ComparisonGroupId": "sample string 1",
  "ClientOrderId": {
    "OrderId": "sample string 1",
    "RequestTypeId": "sample string 2"
  },
  "AssessmentSubject": {
    "SubjectId": {
      "AccountId": "sample string 1",
      "Username": "sample string 2"
    },
    "PersonName": {
      "GivenName": "sample string 1",
      "MiddleName": "sample string 2",
      "FamilyName": "sample string 3"
    },
    "ContactMethod": {
      "InternetEmailAddress": "sample string 1"
    },
    "AssessmentPersonDescriptors": {
      "BiologicalDescriptors": {
        "GenderCode": "0",
        "DisabilityInfo": {
          "Percentage": 1,
          "Type": "sample string 2",
          "AccommodationsNeeded": true
        }
      }
    }
  },
  "UserArea": {
    "LaunchOptions": {
      "RedirectionUrl": "http://webapihelppage1.com"
    }
  }
}

application/xml, text/xml

Sample:

<AssessmentOrderRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ManagementServicesApi.Models.TT">
  <AssessmentSubject>
    <AssessmentPersonDescriptors>
      <BiologicalDemographics>
        <DisabilityInfo>
          <IsAccommodationNeeded>true</IsAccommodationNeeded>
          <Percentage>1</Percentage>
          <Type>sample string 2</Type>
        </DisabilityInfo>
        <GenderCode>NotKnown</GenderCode>
      </BiologicalDemographics>
    </AssessmentPersonDescriptors>
    <ContactMethod>
      <InternetEmailAddress>sample string 1</InternetEmailAddress>
    </ContactMethod>
    <PersonName>
      <FamilyName>sample string 3</FamilyName>
      <GivenName>sample string 1</GivenName>
      <MiddleName>sample string 2</MiddleName>
    </PersonName>
    <SubjectId>
      <AccountId>sample string 1</AccountId>
      <Username>sample string 2</Username>
    </SubjectId>
  </AssessmentSubject>
  <ClientId>
    <CustomerId>sample string 1</CustomerId>
    <Password>sample string 3</Password>
    <Username>sample string 2</Username>
  </ClientId>
  <ClientOrder>
    <OrderId>sample string 1</OrderId>
    <RequestType>sample string 2</RequestType>
  </ClientOrder>
  <ComparisonGroup>sample string 1</ComparisonGroup>
  <PackageId>
    <AssessmentId>sample string 1</AssessmentId>
    <ReportId>sample string 2</ReportId>
  </PackageId>
  <UserArea>
    <LaunchOptions>
      <RedirectionUrl>http://webapihelppage1.com/</RedirectionUrl>
    </LaunchOptions>
  </UserArea>
</AssessmentOrderRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

AssessmentResult

Name	Description	Type	Additional information
ClientId	TrueTalent Client Details	Client	None.
ProviderId	Provider (i.e. GMetrix)	Provider	None.
ClientOrderId	The Order Id that was provided in the AssessmentOrderRequest.	ClientOrder	None.
Results	Result Details	Results	None.
AssessmentStatus	Status of the Assessment	AssessmentStatus	None.
UserArea	Used for redirection and Interoperability	UserArea	None.

Response Formats

application/json

Sample:

Sample not available.

text/json

Sample:

Sample not available.

application/xml, text/xml

Sample:

<AssessmentResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ManagementServicesApi.Models.TT">
  <AssessmentStatus>
    <Details>sample string 2</Details>
    <Status>sample string 1</Status>
    <StatusDate xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>2025-05-07T15:20:48.8438788Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>-420</d3p1:OffsetMinutes>
    </StatusDate>
  </AssessmentStatus>
  <Client>
    <CustomerId>sample string 1</CustomerId>
    <Password>sample string 3</Password>
    <Username>sample string 2</Username>
  </Client>
  <ClientOrder>
    <OrderId>sample string 1</OrderId>
    <RequestType>sample string 2</RequestType>
  </ClientOrder>
  <ProviderId>
    <IdValue>sample string 1</IdValue>
  </ProviderId>
  <Results>
    <DetailResults>
      <DetailResultList>
        <DetailResult>
          <Comments>sample string 2</Comments>
          <Description>sample string 1</Description>
          <Score>
            <ScoreName>sample string 1</ScoreName>
            <ScoreValue>sample string 2</ScoreValue>
          </Score>
        </DetailResult>
        <DetailResult>
          <Comments>sample string 2</Comments>
          <Description>sample string 1</Description>
          <Score>
            <ScoreName>sample string 1</ScoreName>
            <ScoreValue>sample string 2</ScoreValue>
          </Score>
        </DetailResult>
      </DetailResultList>
    </DetailResults>
    <Profile>sample string 1</Profile>
    <SupportingMaterials>
      <EmbeddedData>
        <EncodedContent>sample string 1</EncodedContent>
      </EmbeddedData>
      <ReferenceInfo>
        <ReportUrl>sample string 1</ReportUrl>
      </ReferenceInfo>
      <SupportingMaterialsId>
        <MimeType>sample string 2</MimeType>
        <ReportId>sample string 1</ReportId>
      </SupportingMaterialsId>
    </SupportingMaterials>
  </Results>
  <UserArea>
    <LaunchOptions>
      <RedirectionUrl>http://webapihelppage1.com/</RedirectionUrl>
    </LaunchOptions>
  </UserArea>
</AssessmentResult>