Get Assignment

GET /v1/get-assignment

See original API description on Amazon Mechanical Turk.

Headers

Content-Type string Required

Default value is application/json.

Body

AssignmentId string Required

Responses

200

OK
Hide response attributes Show response attributes object
- Assignment object Required
  
  Hide Assignment attributes Show Assignment attributes object
  
  AssignmentId string
  
  WorkerId string
  
  HITId string
  
  AssignmentStatus string
  
  Values are Submitted, Approved, or Rejected.
  
  AutoApprovalTime number
  
  AcceptTime number
  
  SubmitTime number
  
  ApprovalTime number
  
  RejectionTime number
  
  Deadline number
  
  Answer string
  
  RequesterFeedback string
- HIT object Required
  
  Hide HIT attributes Show HIT attributes object
  
  HITId string
  
  HITTypeId string
  
  HITGroupId string
  
  HITLayoutId string
  
  CreationTime string(date-time)
  
  Title string
  
  Description string
  
  Keywords string
  
  HITStatus string
  
  Values are Assignable, Unassignable, Reviewable, Reviewing, or Disposed.
  
  Reward string Required
  
  LifetimeInSeconds integer
  
  AssignmentDurationInSeconds integer
  
  MaxAssignments integer
  
  Default value is 1.
  
  AutoApprovalDelayInSeconds integer
  
  Expiration string(date-time)
  
  QualificationRequirements array[object]
  
  Hide QualificationRequirements attributes Show QualificationRequirements attributes array[object]
  
  QualificationTypeId string Required
  
  Comparator string Required
  
  IntegerValues array[integer]
  
  LocaleValues array[object]
  
  Hide LocaleValues attributes Show LocaleValues attributes array[object]
  
  Country string Required
  
  Subdivision string
  
  RequiredToPreview boolean Deprecated
  
  ActionsGuarded string
  
  Question string
  
  RequesterAnnotation string
  
  HITReviewStatus string
  
  Values are NotReviewed, MarkedForReview, ReviewedAppropriate, or ReviewedInappropriate.
  
  NumberOfAssignmentsPending integer
  
  Minimum value is 0.
  
  NumberOfAssignmentsAvailable integer
  
  Minimum value is 0.
  
  NumberOfAssignmentsCompleted integer
  
  Minimum value is 0.
400

Bad request
404

Resource not found

GET /v1/get-assignment

curl \
 -X GET https://yourcrowd.ai.moda/api/v1/get-assignment \
 -H "Content-Type: application/json" \
 -d '{"AssignmentId":"123RVWYBAZW00EXAMPLE444RVWYBAZW01EXAMPLE"}'

Request example

# Headers
Content-Type: application/json

# Payload
{
  "AssignmentId": "123RVWYBAZW00EXAMPLE444RVWYBAZW01EXAMPLE"
}

Request examples

# Headers
Content-Type: application/json

# Payload
{
  "AssignmentId": "123RVWYBAZW00EXAMPLE444RVWYBAZW01EXAMPLE"
}

Response examples (200)

{
  "Assignment": {
    "AssignmentId": "123RVWYBAZW00EXAMPLE444RVWYBAZW01EXAMPLE",
    "WorkerId": "AZ2256EXAM",
    "HITId": "123RVWYBAZW00EXAMPLE444RVWYBAZW01EXAMPLE",
    "AssignmentStatus": "Submitted",
    "AutoApprovalTime": 1683142622654,
    "AcceptTime": 1683142622654,
    "SubmitTime": 1683142622654,
    "ApprovalTime": 1683142622654,
    "RejectionTime": 1683142622654,
    "Deadline": 1683142622654,
    "Answer": "string",
    "RequesterFeedback": "Example HIT"
  },
  "HIT": {
    "HITId": "123RVWYBAZW00EXAMPLE444RVWYBAZW01EXAMPLE",
    "HITTypeId": "AZ2256EXAM",
    "HITGroupId": "AZ2256EXAM",
    "HITLayoutId": "AZ2256EXAM",
    "CreationTime": "2012-01-31T23:59:59Z",
    "Title": "Example HIT",
    "Description": "Example HIT",
    "Keywords": "Example HIT",
    "HITStatus": "Assignable",
    "Reward": "25.01",
    "LifetimeInSeconds": 3600,
    "AssignmentDurationInSeconds": 3600,
    "MaxAssignments": 1,
    "AutoApprovalDelayInSeconds": 3600,
    "Expiration": "2012-01-31T23:59:59Z",
    "QualificationRequirements": [
      {
        "QualificationTypeId": "QualificationTypeId example",
        "Comparator": "Comparator example",
        "IntegerValues": [
          1
        ],
        "LocaleValues": [
          {
            "Country": "Country example",
            "Subdivision": "Subdivision example"
          }
        ],
        "RequiredToPreview": true,
        "ActionsGuarded": "ActionsGuarded example"
      }
    ],
    "Question": "string",
    "RequesterAnnotation": "Example HIT",
    "HITReviewStatus": "NotReviewed",
    "NumberOfAssignmentsPending": 1,
    "NumberOfAssignmentsAvailable": 1,
    "NumberOfAssignmentsCompleted": 1
  }
}

Response examples (200)

{
  "Assignment": {
    "AssignmentId": "123RVWYBAZW00EXAMPLE444RVWYBAZW01EXAMPLE",
    "WorkerId": "AZ2256EXAM",
    "HITId": "123RVWYBAZW00EXAMPLE444RVWYBAZW01EXAMPLE",
    "AssignmentStatus": "Submitted",
    "AutoApprovalTime": 1683142622654,
    "AcceptTime": 1683142622654,
    "SubmitTime": 1683142622654,
    "ApprovalTime": 1683142622654,
    "RejectionTime": 1683142622654,
    "Deadline": 1683142622654,
    "Answer": "string",
    "RequesterFeedback": "Example HIT"
  },
  "HIT": {
    "HITId": "123RVWYBAZW00EXAMPLE444RVWYBAZW01EXAMPLE",
    "HITTypeId": "AZ2256EXAM",
    "HITGroupId": "AZ2256EXAM",
    "HITLayoutId": "AZ2256EXAM",
    "CreationTime": "2012-01-31T23:59:59Z",
    "Title": "Example HIT",
    "Description": "Example HIT",
    "Keywords": "Example HIT",
    "HITStatus": "Assignable",
    "Reward": "25.01",
    "LifetimeInSeconds": 3600,
    "AssignmentDurationInSeconds": 3600,
    "MaxAssignments": 1,
    "AutoApprovalDelayInSeconds": 3600,
    "Expiration": "2012-01-31T23:59:59Z",
    "QualificationRequirements": [
      {
        "QualificationTypeId": "QualificationTypeId example",
        "Comparator": "Comparator example",
        "IntegerValues": [
          1
        ],
        "LocaleValues": [
          {
            "Country": "Country example",
            "Subdivision": "Subdivision example"
          }
        ],
        "RequiredToPreview": true,
        "ActionsGuarded": "ActionsGuarded example"
      }
    ],
    "Question": "string",
    "RequesterAnnotation": "Example HIT",
    "HITReviewStatus": "NotReviewed",
    "NumberOfAssignmentsPending": 1,
    "NumberOfAssignmentsAvailable": 1,
    "NumberOfAssignmentsCompleted": 1
  }
}