POST api/v1/lpa/vehicles/status

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
vehicles	VehicleNumbers	None.
includeDetails	string	None.
documents	DocumentNumbers	None.

Request Formats

application/json, text/json

Sample:

{
  "vehicles": {
    "vehicleNumber": [
      "sample string 1",
      "sample string 2"
    ]
  },
  "includeDetails": "sample string 1",
  "documents": {
    "documentNumber": [
      "sample string 1",
      "sample string 2"
    ]
  }
}

application/xml, text/xml

Sample:

<VehiclesStatusReqMDL xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FTSMDLClassLibrary.WebAPIMDL.LPA">
  <documents>
    <documentNumber xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </documentNumber>
  </documents>
  <includeDetails>sample string 1</includeDetails>
  <vehicles>
    <vehicleNumber xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </vehicleNumber>
  </vehicles>
</VehiclesStatusReqMDL>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

VehicleStatusRespMDL

Name	Type	Additional information
response	integer	None.
message	string	None.
data	FetchVehicleMDL	None.

Response Formats

application/json, text/json

Sample:

{
  "response": 1,
  "message": "sample string 2",
  "data": {
    "vehicles": [
      {
        "vehicleNumber": "sample string 1",
        "message": "sample string 2",
        "process": "sample string 3",
        "documentBindings": {
          "sample string 1": {},
          "sample string 3": {}
        },
        "workflow": [
          {
            "stage": "sample string 1",
            "startTime": "sample string 2",
            "endTime": "sample string 3",
            "stageTATMinutes": "sample string 4",
            "tasks": [
              {
                "taskName": "sample string 1",
                "status": "sample string 2",
                "details": "sample string 3"
              },
              {
                "taskName": "sample string 1",
                "status": "sample string 2",
                "details": "sample string 3"
              }
            ]
          },
          {
            "stage": "sample string 1",
            "startTime": "sample string 2",
            "endTime": "sample string 3",
            "stageTATMinutes": "sample string 4",
            "tasks": [
              {
                "taskName": "sample string 1",
                "status": "sample string 2",
                "details": "sample string 3"
              },
              {
                "taskName": "sample string 1",
                "status": "sample string 2",
                "details": "sample string 3"
              }
            ]
          }
        ],
        "overallTATMinutes": "sample string 4",
        "lastUpdated": "sample string 5",
        "pendingStages": [
          {
            "stage": "sample string 1"
          },
          {
            "stage": "sample string 1"
          }
        ]
      },
      {
        "vehicleNumber": "sample string 1",
        "message": "sample string 2",
        "process": "sample string 3",
        "documentBindings": {
          "sample string 1": {},
          "sample string 3": {}
        },
        "workflow": [
          {
            "stage": "sample string 1",
            "startTime": "sample string 2",
            "endTime": "sample string 3",
            "stageTATMinutes": "sample string 4",
            "tasks": [
              {
                "taskName": "sample string 1",
                "status": "sample string 2",
                "details": "sample string 3"
              },
              {
                "taskName": "sample string 1",
                "status": "sample string 2",
                "details": "sample string 3"
              }
            ]
          },
          {
            "stage": "sample string 1",
            "startTime": "sample string 2",
            "endTime": "sample string 3",
            "stageTATMinutes": "sample string 4",
            "tasks": [
              {
                "taskName": "sample string 1",
                "status": "sample string 2",
                "details": "sample string 3"
              },
              {
                "taskName": "sample string 1",
                "status": "sample string 2",
                "details": "sample string 3"
              }
            ]
          }
        ],
        "overallTATMinutes": "sample string 4",
        "lastUpdated": "sample string 5",
        "pendingStages": [
          {
            "stage": "sample string 1"
          },
          {
            "stage": "sample string 1"
          }
        ]
      }
    ]
  }
}

application/xml, text/xml

Sample:

<VehicleStatusRespMDL xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FTSMDLClassLibrary.WebAPIMDL.LPA">
  <data>
    <vehicles>
      <VehicleInfo>
        <documentBindings xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringanyType>
            <d5p1:Key>sample string 1</d5p1:Key>
            <d5p1:Value />
          </d5p1:KeyValueOfstringanyType>
          <d5p1:KeyValueOfstringanyType>
            <d5p1:Key>sample string 3</d5p1:Key>
            <d5p1:Value />
          </d5p1:KeyValueOfstringanyType>
        </documentBindings>
        <lastUpdated>sample string 5</lastUpdated>
        <message>sample string 2</message>
        <overallTATMinutes>sample string 4</overallTATMinutes>
        <pendingStages>
          <PendingStage>
            <stage>sample string 1</stage>
          </PendingStage>
          <PendingStage>
            <stage>sample string 1</stage>
          </PendingStage>
        </pendingStages>
        <process>sample string 3</process>
        <vehicleNumber>sample string 1</vehicleNumber>
        <workflow>
          <WorkflowStage>
            <endTime>sample string 3</endTime>
            <stage>sample string 1</stage>
            <stageTATMinutes>sample string 4</stageTATMinutes>
            <startTime>sample string 2</startTime>
            <tasks>
              <TaskInfo>
                <details>sample string 3</details>
                <status>sample string 2</status>
                <taskName>sample string 1</taskName>
              </TaskInfo>
              <TaskInfo>
                <details>sample string 3</details>
                <status>sample string 2</status>
                <taskName>sample string 1</taskName>
              </TaskInfo>
            </tasks>
          </WorkflowStage>
          <WorkflowStage>
            <endTime>sample string 3</endTime>
            <stage>sample string 1</stage>
            <stageTATMinutes>sample string 4</stageTATMinutes>
            <startTime>sample string 2</startTime>
            <tasks>
              <TaskInfo>
                <details>sample string 3</details>
                <status>sample string 2</status>
                <taskName>sample string 1</taskName>
              </TaskInfo>
              <TaskInfo>
                <details>sample string 3</details>
                <status>sample string 2</status>
                <taskName>sample string 1</taskName>
              </TaskInfo>
            </tasks>
          </WorkflowStage>
        </workflow>
      </VehicleInfo>
      <VehicleInfo>
        <documentBindings xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringanyType>
            <d5p1:Key>sample string 1</d5p1:Key>
            <d5p1:Value />
          </d5p1:KeyValueOfstringanyType>
          <d5p1:KeyValueOfstringanyType>
            <d5p1:Key>sample string 3</d5p1:Key>
            <d5p1:Value />
          </d5p1:KeyValueOfstringanyType>
        </documentBindings>
        <lastUpdated>sample string 5</lastUpdated>
        <message>sample string 2</message>
        <overallTATMinutes>sample string 4</overallTATMinutes>
        <pendingStages>
          <PendingStage>
            <stage>sample string 1</stage>
          </PendingStage>
          <PendingStage>
            <stage>sample string 1</stage>
          </PendingStage>
        </pendingStages>
        <process>sample string 3</process>
        <vehicleNumber>sample string 1</vehicleNumber>
        <workflow>
          <WorkflowStage>
            <endTime>sample string 3</endTime>
            <stage>sample string 1</stage>
            <stageTATMinutes>sample string 4</stageTATMinutes>
            <startTime>sample string 2</startTime>
            <tasks>
              <TaskInfo>
                <details>sample string 3</details>
                <status>sample string 2</status>
                <taskName>sample string 1</taskName>
              </TaskInfo>
              <TaskInfo>
                <details>sample string 3</details>
                <status>sample string 2</status>
                <taskName>sample string 1</taskName>
              </TaskInfo>
            </tasks>
          </WorkflowStage>
          <WorkflowStage>
            <endTime>sample string 3</endTime>
            <stage>sample string 1</stage>
            <stageTATMinutes>sample string 4</stageTATMinutes>
            <startTime>sample string 2</startTime>
            <tasks>
              <TaskInfo>
                <details>sample string 3</details>
                <status>sample string 2</status>
                <taskName>sample string 1</taskName>
              </TaskInfo>
              <TaskInfo>
                <details>sample string 3</details>
                <status>sample string 2</status>
                <taskName>sample string 1</taskName>
              </TaskInfo>
            </tasks>
          </WorkflowStage>
        </workflow>
      </VehicleInfo>
    </vehicles>
  </data>
  <message>sample string 2</message>
  <response>1</response>
</VehicleStatusRespMDL>