POST api/Sections/{sectionId}/Progress/ImportTmsrProgress/Preview

Gets an imported progress document preview (paged)

Request Information

URI Parameters

NameDescriptionTypeAdditional information
sectionId

integer

Required

Body Parameters

ProgressImportTmsrFilterPreview
NameDescriptionTypeAdditional information
DocumentId

globally unique identifier

None.

SelectedItems

Collection of integer

None.

Page

Page

None.

Orders

Collection of Order

None.

Request Formats

application/json, text/json

Sample:
{
  "documentId": "72f6bf3d-7260-4a96-b8ef-de63bbf41467",
  "selectedItems": [
    1,
    2
  ],
  "page": {
    "number": 1,
    "size": 2,
    "skip": 0
  },
  "orders": [
    {
      "name": "sample string 1",
      "descending": true
    },
    {
      "name": "sample string 1",
      "descending": true
    }
  ]
}

text/html

Sample:
{"documentId":"72f6bf3d-7260-4a96-b8ef-de63bbf41467","selectedItems":[1,2],"page":{"number":1,"size":2,"skip":0},"orders":[{"name":"sample string 1","descending":true},{"name":"sample string 1","descending":true}]}

application/xml, text/xml

Sample:
<ProgressImportTmsrFilterPreview xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TR.eSAM.SubcontractModule.Application.Dtos.Dtos.ProgressAgg">
  <Orders xmlns:d2p1="http://schemas.datacontract.org/2004/07/TR.eSAM.Application.Base.SortAndPage.Entities" xmlns="http://schemas.datacontract.org/2004/07/TR.eSAM.Application.Base.Dtos">
    <d2p1:Order>
      <d2p1:Descending>true</d2p1:Descending>
      <d2p1:Name>sample string 1</d2p1:Name>
    </d2p1:Order>
    <d2p1:Order>
      <d2p1:Descending>true</d2p1:Descending>
      <d2p1:Name>sample string 1</d2p1:Name>
    </d2p1:Order>
  </Orders>
  <Page xmlns:d2p1="http://schemas.datacontract.org/2004/07/TR.eSAM.Application.Base.SortAndPage.Entities" xmlns="http://schemas.datacontract.org/2004/07/TR.eSAM.Application.Base.Dtos">
    <d2p1:Number>1</d2p1:Number>
    <d2p1:Size>2</d2p1:Size>
  </Page>
  <DocumentId>72f6bf3d-7260-4a96-b8ef-de63bbf41467</DocumentId>
  <SelectedItems xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:long>1</d2p1:long>
    <d2p1:long>2</d2p1:long>
  </SelectedItems>
</ProgressImportTmsrFilterPreview>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ProgressImportedTMResultDto
NameDescriptionTypeAdditional information
DocumentId

globally unique identifier

None.

SelectedItems

Collection of integer

None.

Preview

IPagedListOfTimesheetTmsrToAssignProgressDto

None.

Errors

IPagedListOfProgressPositionErrorTMDto

None.

Response Formats

application/json, text/json

Sample:
{
  "documentId": "160b0c2b-7a7a-4c33-962c-cd467394e987",
  "selectedItems": [
    1,
    2
  ],
  "preview": null,
  "errors": null
}

text/html

Sample:
{"documentId":"160b0c2b-7a7a-4c33-962c-cd467394e987","selectedItems":[1,2],"preview":null,"errors":null}

application/xml, text/xml

Sample:
<ProgressImportedTMResultDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TR.eSAM.SubcontractModule.Application.Dtos.Dtos.ProgressAgg">
  <DocumentId>160b0c2b-7a7a-4c33-962c-cd467394e987</DocumentId>
  <Errors i:nil="true" />
  <Preview i:nil="true" />
  <SelectedItems xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:long>1</d2p1:long>
    <d2p1:long>2</d2p1:long>
  </SelectedItems>
</ProgressImportedTMResultDto>