POST api/Story/BatchGet

Batch get story info based on story item id

Request Information

URI Parameters

None.

Body Parameters

BatchGetBinder
NameDescriptionTypeAdditional information
ProjectId

integer

None.

StoryItemIds

Collection of integer

None.

Request Formats

application/json, text/json

Sample:
{
  "ProjectId": 1,
  "StoryItemIds": [
    1,
    2
  ]
}

application/xml, text/xml

Sample:
<BatchGetBinder xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TechExcel.DTKService.Model.Binding">
  <ProjectId>1</ProjectId>
  <StoryItemIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </StoryItemIds>
</BatchGetBinder>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Batch get story info based on story item id

API_Data_DictionaryOfInt32AndStoryInfoModel
NameDescriptionTypeAdditional information
Success

boolean

None.

Error

ErrorInfo

None.

Data

Dictionary of integer [key] and StoryInfoModel [value]

None.

Response Formats

application/json, text/json

Sample:
{
  "Success": true,
  "Error": {
    "ErrorCode": 1,
    "ErrorMessage": "sample string 1"
  },
  "Data": {
    "1": {
      "StoryItemId": 1,
      "DisplayId": "sample string 2",
      "ParentSubProjectID": 3,
      "ImplementionCopyNo": 4,
      "LinkedSpecItemID": 5,
      "LinkedSpecProjectID": 6,
      "LinkedSpecTitle": "sample string 7",
      "StoryTitle": "sample string 8",
      "StoryPriority": 1,
      "StoryPoints": 1,
      "StoryEstimatedTime": 1,
      "CurrentOwnerID": 1,
      "CurrentOwnerName": "sample string 9",
      "CurrentStatus": 1,
      "CurrentStatusName": "sample string 10",
      "IfCreatedFromSpec": true,
      "IfInBacklogFolder": true,
      "IfStandaloneStory": true,
      "PlanedStartDate": "2020-11-29 11:43:03",
      "PlanedEndDate": "2020-11-29 11:43:03",
      "TaskBoardFolderID": 1,
      "TaskBoardFolderName": "sample string 14",
      "Description": "sample string 15",
      "StoryType": 16,
      "WorkType": 1,
      "ActualStoryPoints": 1,
      "WorkObjective": 1,
      "WorkObjectiveName": "sample string 17"
    },
    "2": {
      "StoryItemId": 1,
      "DisplayId": "sample string 2",
      "ParentSubProjectID": 3,
      "ImplementionCopyNo": 4,
      "LinkedSpecItemID": 5,
      "LinkedSpecProjectID": 6,
      "LinkedSpecTitle": "sample string 7",
      "StoryTitle": "sample string 8",
      "StoryPriority": 1,
      "StoryPoints": 1,
      "StoryEstimatedTime": 1,
      "CurrentOwnerID": 1,
      "CurrentOwnerName": "sample string 9",
      "CurrentStatus": 1,
      "CurrentStatusName": "sample string 10",
      "IfCreatedFromSpec": true,
      "IfInBacklogFolder": true,
      "IfStandaloneStory": true,
      "PlanedStartDate": "2020-11-29 11:43:03",
      "PlanedEndDate": "2020-11-29 11:43:03",
      "TaskBoardFolderID": 1,
      "TaskBoardFolderName": "sample string 14",
      "Description": "sample string 15",
      "StoryType": 16,
      "WorkType": 1,
      "ActualStoryPoints": 1,
      "WorkObjective": 1,
      "WorkObjectiveName": "sample string 17"
    }
  }
}

application/xml, text/xml

Sample:
<API_Data_ArrayOfKeyValueOfintStoryInfoModelhiTVkWLH xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TechExcel.DTKService.Model.Common">
  <Data xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfintStoryInfoModelhiTVkWLH>
      <d2p1:Key>1</d2p1:Key>
      <d2p1:Value xmlns:d4p1="http://schemas.datacontract.org/2004/07/TechExcel.DTKService.Model.Entities">
        <d4p1:ActualStoryPoints>1</d4p1:ActualStoryPoints>
        <d4p1:CurrentOwnerID>1</d4p1:CurrentOwnerID>
        <d4p1:CurrentOwnerName>sample string 9</d4p1:CurrentOwnerName>
        <d4p1:CurrentStatus>1</d4p1:CurrentStatus>
        <d4p1:CurrentStatusName>sample string 10</d4p1:CurrentStatusName>
        <d4p1:Description>sample string 15</d4p1:Description>
        <d4p1:DisplayId>sample string 2</d4p1:DisplayId>
        <d4p1:IfCreatedFromSpec>true</d4p1:IfCreatedFromSpec>
        <d4p1:IfInBacklogFolder>true</d4p1:IfInBacklogFolder>
        <d4p1:IfStandaloneStory>true</d4p1:IfStandaloneStory>
        <d4p1:ImplementionCopyNo>4</d4p1:ImplementionCopyNo>
        <d4p1:LinkedSpecItemID>5</d4p1:LinkedSpecItemID>
        <d4p1:LinkedSpecProjectID>6</d4p1:LinkedSpecProjectID>
        <d4p1:LinkedSpecTitle>sample string 7</d4p1:LinkedSpecTitle>
        <d4p1:ParentSubProjectID>3</d4p1:ParentSubProjectID>
        <d4p1:PlanedEndDate>2020-11-29T11:43:03.9259497-08:00</d4p1:PlanedEndDate>
        <d4p1:PlanedStartDate>2020-11-29T11:43:03.9259497-08:00</d4p1:PlanedStartDate>
        <d4p1:StoryEstimatedTime>1</d4p1:StoryEstimatedTime>
        <d4p1:StoryItemId>1</d4p1:StoryItemId>
        <d4p1:StoryPoints>1</d4p1:StoryPoints>
        <d4p1:StoryPriority>1</d4p1:StoryPriority>
        <d4p1:StoryTitle>sample string 8</d4p1:StoryTitle>
        <d4p1:StoryType>16</d4p1:StoryType>
        <d4p1:TaskBoardFolderID>1</d4p1:TaskBoardFolderID>
        <d4p1:TaskBoardFolderName>sample string 14</d4p1:TaskBoardFolderName>
        <d4p1:WorkObjective>1</d4p1:WorkObjective>
        <d4p1:WorkObjectiveName>sample string 17</d4p1:WorkObjectiveName>
        <d4p1:WorkType>1</d4p1:WorkType>
      </d2p1:Value>
    </d2p1:KeyValueOfintStoryInfoModelhiTVkWLH>
    <d2p1:KeyValueOfintStoryInfoModelhiTVkWLH>
      <d2p1:Key>2</d2p1:Key>
      <d2p1:Value xmlns:d4p1="http://schemas.datacontract.org/2004/07/TechExcel.DTKService.Model.Entities">
        <d4p1:ActualStoryPoints>1</d4p1:ActualStoryPoints>
        <d4p1:CurrentOwnerID>1</d4p1:CurrentOwnerID>
        <d4p1:CurrentOwnerName>sample string 9</d4p1:CurrentOwnerName>
        <d4p1:CurrentStatus>1</d4p1:CurrentStatus>
        <d4p1:CurrentStatusName>sample string 10</d4p1:CurrentStatusName>
        <d4p1:Description>sample string 15</d4p1:Description>
        <d4p1:DisplayId>sample string 2</d4p1:DisplayId>
        <d4p1:IfCreatedFromSpec>true</d4p1:IfCreatedFromSpec>
        <d4p1:IfInBacklogFolder>true</d4p1:IfInBacklogFolder>
        <d4p1:IfStandaloneStory>true</d4p1:IfStandaloneStory>
        <d4p1:ImplementionCopyNo>4</d4p1:ImplementionCopyNo>
        <d4p1:LinkedSpecItemID>5</d4p1:LinkedSpecItemID>
        <d4p1:LinkedSpecProjectID>6</d4p1:LinkedSpecProjectID>
        <d4p1:LinkedSpecTitle>sample string 7</d4p1:LinkedSpecTitle>
        <d4p1:ParentSubProjectID>3</d4p1:ParentSubProjectID>
        <d4p1:PlanedEndDate>2020-11-29T11:43:03.9259497-08:00</d4p1:PlanedEndDate>
        <d4p1:PlanedStartDate>2020-11-29T11:43:03.9259497-08:00</d4p1:PlanedStartDate>
        <d4p1:StoryEstimatedTime>1</d4p1:StoryEstimatedTime>
        <d4p1:StoryItemId>1</d4p1:StoryItemId>
        <d4p1:StoryPoints>1</d4p1:StoryPoints>
        <d4p1:StoryPriority>1</d4p1:StoryPriority>
        <d4p1:StoryTitle>sample string 8</d4p1:StoryTitle>
        <d4p1:StoryType>16</d4p1:StoryType>
        <d4p1:TaskBoardFolderID>1</d4p1:TaskBoardFolderID>
        <d4p1:TaskBoardFolderName>sample string 14</d4p1:TaskBoardFolderName>
        <d4p1:WorkObjective>1</d4p1:WorkObjective>
        <d4p1:WorkObjectiveName>sample string 17</d4p1:WorkObjectiveName>
        <d4p1:WorkType>1</d4p1:WorkType>
      </d2p1:Value>
    </d2p1:KeyValueOfintStoryInfoModelhiTVkWLH>
  </Data>
  <Error>
    <ErrorCode>1</ErrorCode>
    <ErrorMessage>sample string 1</ErrorMessage>
  </Error>
  <Success>true</Success>
</API_Data_ArrayOfKeyValueOfintStoryInfoModelhiTVkWLH>