GET Requests/RequestsByRoute

Gets routes with request details.

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Collection of HomepageRouteDetailDTO
NameDescriptionTypeAdditional information
RequestDataMartID

Gets or Sets the Identifier of the RequestDatamart.

globally unique identifier

None.

DataMart

Gets or Sets the Name of the Datamart.

string

None.

DataMartID

Gets or Sets the Identifier of the Datamart.

globally unique identifier

None.

RoutingType

Gets or Sets the Type of Routing this Route is

RoutingType

None.

RequestID

Gets or sets the Identifier of the Request.

globally unique identifier

None.

Name

Gets or sets the name of the Request.

string

None.

Identifier

Gets or sets the Identifier (System Number) of the Request.

integer

None.

SubmittedOn

Gets or sets the date the Request was submitted on.

date

None.

SubmittedByName

Gets or sets the username of the user that submitted the Request.

string

None.

ResponseID

Gets or Sets the Identifier of the Current Response.

globally unique identifier

None.

ResponseSubmittedOn

Gets or Sets the Date when the Current Response was submitted on.

date

None.

ResponseSubmittedByID

Gets or Sets the Identifier if the User who Submitted the Current Response.

globally unique identifier

None.

ResponseSubmittedBy

Gets or Sets the UserName of the user who submitted the Current Response.

string

None.

ResponseTime

Gets or Sets the Time the Current Response was Responded To.

date

None.

RespondedByID

Gets or Sets the Identifier of the User who Responded to the Route.

globally unique identifier

None.

RespondedBy

Gets or Sets the Username of the User who Responded to the Route.

string

None.

ResponseGroupID

Gets or Sets the Identifier of the Response Group of the Current Response.

globally unique identifier

None.

ResponseGroup

Gets or Sets the name of the Response Group of the Current Response.

string

None.

ResponseMessage

Gets or Sets the Message for the Current Reponse.

string

None.

StatusText

Gets or sets the display text for the status of the Request.

string

None.

RequestStatus

Gets or sets the status of the Request.

RequestStatuses

None.

RoutingStatus

Gets or Sets The status of the routing.

RoutingStatus

None.

RoutingStatusText

Gets or Sets The display text for the status of the routing.

string

None.

RequestType

Gets or sets the name of the RequestType.

string

None.

Project

Gets or sets the name of the Project.

string

None.

Priority

Gets or sets the Priority of the Request.

Priorities

None.

DueDate

Gets or sets the Due Date of the Request.

date

None.

MSRequestID

Gets or sets the Mini-Sentiel Request ID for the Request.

string

None.

IsWorkflowRequest

Gets or sets if the Request uses workflow.

boolean

None.

CanEditMetadata

Gets or sets if the user can edit the request's metadata.

boolean

None.

Response Formats

application/json, text/json

Sample:
{
  "results": [
    {
      "RequestDataMartID": "db3bbd81-b59a-4b11-91f1-74aaf9d5341d",
      "DataMart": "sample string 2",
      "DataMartID": "1273cb5d-1c11-4708-984b-dda3f6c735eb",
      "RoutingType": 0,
      "RequestID": "fbc5144c-be2a-4ae9-a3a4-4e680f2c619d",
      "Name": "sample string 5",
      "Identifier": 6,
      "SubmittedOn": "2024-05-13T19:12:57Z",
      "SubmittedByName": "sample string 7",
      "ResponseID": "620ac9ef-9ac0-4edf-87c6-22e70c273dbb",
      "ResponseSubmittedOn": "2024-05-13T19:12:57Z",
      "ResponseSubmittedByID": "f4fadd16-82af-45c3-896a-4a5ec63f853b",
      "ResponseSubmittedBy": "sample string 9",
      "ResponseTime": "2024-05-13T19:12:57Z",
      "RespondedByID": "05781bb8-9234-4163-b813-b3421e2139dd",
      "RespondedBy": "sample string 10",
      "ResponseGroupID": "cff3da0c-ef15-454a-9144-c8788a05bcc0",
      "ResponseGroup": "sample string 11",
      "ResponseMessage": "sample string 12",
      "StatusText": "sample string 13",
      "RequestStatus": 100,
      "RoutingStatus": 1,
      "RoutingStatusText": "sample string 14",
      "RequestType": "sample string 15",
      "Project": "sample string 16",
      "Priority": 0,
      "DueDate": "2024-05-13T19:12:57Z",
      "MSRequestID": "sample string 17",
      "IsWorkflowRequest": true,
      "CanEditMetadata": true
    },
    {
      "RequestDataMartID": "db3bbd81-b59a-4b11-91f1-74aaf9d5341d",
      "DataMart": "sample string 2",
      "DataMartID": "1273cb5d-1c11-4708-984b-dda3f6c735eb",
      "RoutingType": 0,
      "RequestID": "fbc5144c-be2a-4ae9-a3a4-4e680f2c619d",
      "Name": "sample string 5",
      "Identifier": 6,
      "SubmittedOn": "2024-05-13T19:12:57Z",
      "SubmittedByName": "sample string 7",
      "ResponseID": "620ac9ef-9ac0-4edf-87c6-22e70c273dbb",
      "ResponseSubmittedOn": "2024-05-13T19:12:57Z",
      "ResponseSubmittedByID": "f4fadd16-82af-45c3-896a-4a5ec63f853b",
      "ResponseSubmittedBy": "sample string 9",
      "ResponseTime": "2024-05-13T19:12:57Z",
      "RespondedByID": "05781bb8-9234-4163-b813-b3421e2139dd",
      "RespondedBy": "sample string 10",
      "ResponseGroupID": "cff3da0c-ef15-454a-9144-c8788a05bcc0",
      "ResponseGroup": "sample string 11",
      "ResponseMessage": "sample string 12",
      "StatusText": "sample string 13",
      "RequestStatus": 100,
      "RoutingStatus": 1,
      "RoutingStatusText": "sample string 14",
      "RequestType": "sample string 15",
      "Project": "sample string 16",
      "Priority": 0,
      "DueDate": "2024-05-13T19:12:57Z",
      "MSRequestID": "sample string 17",
      "IsWorkflowRequest": true,
      "CanEditMetadata": true
    }
  ]
}

text/javascript

Sample:
{"results":[{"RequestDataMartID":"db3bbd81-b59a-4b11-91f1-74aaf9d5341d","DataMart":"sample string 2","DataMartID":"1273cb5d-1c11-4708-984b-dda3f6c735eb","RoutingType":0,"RequestID":"fbc5144c-be2a-4ae9-a3a4-4e680f2c619d","Name":"sample string 5","Identifier":6,"SubmittedOn":"2024-05-13T19:12:57Z","SubmittedByName":"sample string 7","ResponseID":"620ac9ef-9ac0-4edf-87c6-22e70c273dbb","ResponseSubmittedOn":"2024-05-13T19:12:57Z","ResponseSubmittedByID":"f4fadd16-82af-45c3-896a-4a5ec63f853b","ResponseSubmittedBy":"sample string 9","ResponseTime":"2024-05-13T19:12:57Z","RespondedByID":"05781bb8-9234-4163-b813-b3421e2139dd","RespondedBy":"sample string 10","ResponseGroupID":"cff3da0c-ef15-454a-9144-c8788a05bcc0","ResponseGroup":"sample string 11","ResponseMessage":"sample string 12","StatusText":"sample string 13","RequestStatus":100,"RoutingStatus":1,"RoutingStatusText":"sample string 14","RequestType":"sample string 15","Project":"sample string 16","Priority":0,"DueDate":"2024-05-13T19:12:57Z","MSRequestID":"sample string 17","IsWorkflowRequest":true,"CanEditMetadata":true},{"RequestDataMartID":"db3bbd81-b59a-4b11-91f1-74aaf9d5341d","DataMart":"sample string 2","DataMartID":"1273cb5d-1c11-4708-984b-dda3f6c735eb","RoutingType":0,"RequestID":"fbc5144c-be2a-4ae9-a3a4-4e680f2c619d","Name":"sample string 5","Identifier":6,"SubmittedOn":"2024-05-13T19:12:57Z","SubmittedByName":"sample string 7","ResponseID":"620ac9ef-9ac0-4edf-87c6-22e70c273dbb","ResponseSubmittedOn":"2024-05-13T19:12:57Z","ResponseSubmittedByID":"f4fadd16-82af-45c3-896a-4a5ec63f853b","ResponseSubmittedBy":"sample string 9","ResponseTime":"2024-05-13T19:12:57Z","RespondedByID":"05781bb8-9234-4163-b813-b3421e2139dd","RespondedBy":"sample string 10","ResponseGroupID":"cff3da0c-ef15-454a-9144-c8788a05bcc0","ResponseGroup":"sample string 11","ResponseMessage":"sample string 12","StatusText":"sample string 13","RequestStatus":100,"RoutingStatus":1,"RoutingStatusText":"sample string 14","RequestType":"sample string 15","Project":"sample string 16","Priority":0,"DueDate":"2024-05-13T19:12:57Z","MSRequestID":"sample string 17","IsWorkflowRequest":true,"CanEditMetadata":true}]}

application/bson

Sample:
Binary JSON content. See http://bsonspec.org for details.

application/xml, text/xml

Sample:
<ArrayOfHomepageRouteDetailDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Lpp.Dns.DTO">
  <HomepageRouteDetailDTO>
    <CanEditMetadata>true</CanEditMetadata>
    <DataMart>sample string 2</DataMart>
    <DataMartID>1273cb5d-1c11-4708-984b-dda3f6c735eb</DataMartID>
    <DueDate xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>2024-05-13T23:12:57.1557171Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>-240</d3p1:OffsetMinutes>
    </DueDate>
    <Identifier>6</Identifier>
    <IsWorkflowRequest>true</IsWorkflowRequest>
    <MSRequestID>sample string 17</MSRequestID>
    <Name>sample string 5</Name>
    <Priority>Low</Priority>
    <Project>sample string 16</Project>
    <RequestDataMartID>db3bbd81-b59a-4b11-91f1-74aaf9d5341d</RequestDataMartID>
    <RequestID>fbc5144c-be2a-4ae9-a3a4-4e680f2c619d</RequestID>
    <RequestStatus>ThirdPartySubmittedDraft</RequestStatus>
    <RequestType>sample string 15</RequestType>
    <RespondedBy>sample string 10</RespondedBy>
    <RespondedByID>05781bb8-9234-4163-b813-b3421e2139dd</RespondedByID>
    <ResponseGroup>sample string 11</ResponseGroup>
    <ResponseGroupID>cff3da0c-ef15-454a-9144-c8788a05bcc0</ResponseGroupID>
    <ResponseID>620ac9ef-9ac0-4edf-87c6-22e70c273dbb</ResponseID>
    <ResponseMessage>sample string 12</ResponseMessage>
    <ResponseSubmittedBy>sample string 9</ResponseSubmittedBy>
    <ResponseSubmittedByID>f4fadd16-82af-45c3-896a-4a5ec63f853b</ResponseSubmittedByID>
    <ResponseSubmittedOn xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>2024-05-13T23:12:57.1557171Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>-240</d3p1:OffsetMinutes>
    </ResponseSubmittedOn>
    <ResponseTime>2024-05-13T19:12:57.1557171-04:00</ResponseTime>
    <RoutingStatus>Draft</RoutingStatus>
    <RoutingStatusText>sample string 14</RoutingStatusText>
    <RoutingType>AnalysisCenter</RoutingType>
    <StatusText>sample string 13</StatusText>
    <SubmittedByName>sample string 7</SubmittedByName>
    <SubmittedOn xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>2024-05-13T23:12:57.1506553Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>-240</d3p1:OffsetMinutes>
    </SubmittedOn>
  </HomepageRouteDetailDTO>
  <HomepageRouteDetailDTO>
    <CanEditMetadata>true</CanEditMetadata>
    <DataMart>sample string 2</DataMart>
    <DataMartID>1273cb5d-1c11-4708-984b-dda3f6c735eb</DataMartID>
    <DueDate xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>2024-05-13T23:12:57.1557171Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>-240</d3p1:OffsetMinutes>
    </DueDate>
    <Identifier>6</Identifier>
    <IsWorkflowRequest>true</IsWorkflowRequest>
    <MSRequestID>sample string 17</MSRequestID>
    <Name>sample string 5</Name>
    <Priority>Low</Priority>
    <Project>sample string 16</Project>
    <RequestDataMartID>db3bbd81-b59a-4b11-91f1-74aaf9d5341d</RequestDataMartID>
    <RequestID>fbc5144c-be2a-4ae9-a3a4-4e680f2c619d</RequestID>
    <RequestStatus>ThirdPartySubmittedDraft</RequestStatus>
    <RequestType>sample string 15</RequestType>
    <RespondedBy>sample string 10</RespondedBy>
    <RespondedByID>05781bb8-9234-4163-b813-b3421e2139dd</RespondedByID>
    <ResponseGroup>sample string 11</ResponseGroup>
    <ResponseGroupID>cff3da0c-ef15-454a-9144-c8788a05bcc0</ResponseGroupID>
    <ResponseID>620ac9ef-9ac0-4edf-87c6-22e70c273dbb</ResponseID>
    <ResponseMessage>sample string 12</ResponseMessage>
    <ResponseSubmittedBy>sample string 9</ResponseSubmittedBy>
    <ResponseSubmittedByID>f4fadd16-82af-45c3-896a-4a5ec63f853b</ResponseSubmittedByID>
    <ResponseSubmittedOn xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>2024-05-13T23:12:57.1557171Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>-240</d3p1:OffsetMinutes>
    </ResponseSubmittedOn>
    <ResponseTime>2024-05-13T19:12:57.1557171-04:00</ResponseTime>
    <RoutingStatus>Draft</RoutingStatus>
    <RoutingStatusText>sample string 14</RoutingStatusText>
    <RoutingType>AnalysisCenter</RoutingType>
    <StatusText>sample string 13</StatusText>
    <SubmittedByName>sample string 7</SubmittedByName>
    <SubmittedOn xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>2024-05-13T23:12:57.1506553Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>-240</d3p1:OffsetMinutes>
    </SubmittedOn>
  </HomepageRouteDetailDTO>
</ArrayOfHomepageRouteDetailDTO>