POST api/TrueTalentServices/AssignOrderRequest

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
AssessmentOrderRequest		AssessmentOrderRequest	None.

Request Formats

application/json, text/json

Sample:

{
  "AssessmentOrderRequest": {
    "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:

<BaseOrderRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ManagementServicesApi.Models.TT">
  <AssessmentOrderRequest>
    <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>
</BaseOrderRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

AssessmentOrderAcknowledgement

Name	Type	Additional information
ClientId	Client	None.
ClientOrderId	ClientOrder	None.
AccessPoint	AccessPoint	None.
AssessmentStatus	AssessmentStatus	None.
UserArea	UserArea	None.

Response Formats

application/json, text/json

Sample:

{
  "ClientId": {
    "CustomerId": "sample string 1",
    "Username": "sample string 2",
    "Password": "sample string 3"
  },
  "ClientOrderId": {
    "OrderId": "sample string 1",
    "RequestTypeId": "sample string 2"
  },
  "AccessPoint": {
    "InternetWebAddress": "http://webapihelppage1.com",
    "Description": "sample string 2"
  },
  "AssessmentStatus": {
    "Status": "sample string 1",
    "Details": "sample string 2",
    "StatusDate": "2025-05-08T22:05:17.8098449-07:00"
  },
  "UserArea": {
    "LaunchOptions": {
      "RedirectionUrl": "http://webapihelppage1.com"
    }
  }
}

application/xml, text/xml

Sample:

<AssessmentOrderAcknowledgement xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ManagementServicesApi.Models.TT">
  <AccessPoint>
    <Description>sample string 2</Description>
    <InternetWebAddress>http://webapihelppage1.com/</InternetWebAddress>
  </AccessPoint>
  <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-09T05:05:17.8098449Z</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>
  <UserArea>
    <LaunchOptions>
      <RedirectionUrl>http://webapihelppage1.com/</RedirectionUrl>
    </LaunchOptions>
  </UserArea>
</AssessmentOrderAcknowledgement>