POST api/Route/Status

Request Information

URI Parameters

None.

Body Parameters

RouteStatusRequest
NameDescriptionTypeAdditional information
RunningJobCount

integer

None.

Jobs

Collection of RouteJob

None.

Result

integer

None.

Message

string

None.

DurationMs

integer

None.

Request Formats

application/json, text/json

Sample:
{
  "RunningJobCount": 1,
  "Jobs": [
    {
      "JobId": "sample string 1",
      "Status": "sample string 2"
    },
    {
      "JobId": "sample string 1",
      "Status": "sample string 2"
    }
  ],
  "Result": 2,
  "Message": "sample string 3",
  "DurationMs": 4
}

application/xml, text/xml

Sample:
<RouteStatusRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ServiceMinder.Geo.Api">
  <DurationMs>4</DurationMs>
  <Message>sample string 3</Message>
  <Result>2</Result>
  <Jobs>
    <RouteJob>
      <JobId>sample string 1</JobId>
      <Status>sample string 2</Status>
    </RouteJob>
    <RouteJob>
      <JobId>sample string 1</JobId>
      <Status>sample string 2</Status>
    </RouteJob>
  </Jobs>
  <RunningJobCount>1</RunningJobCount>
</RouteStatusRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

RouteStatusResponse
NameDescriptionTypeAdditional information
RunningJobCount

integer

None.

Jobs

Collection of RouteJob

None.

Result

integer

None.

Message

string

None.

DurationMs

integer

None.

Response Formats

application/json, text/json

Sample:
{
  "RunningJobCount": 1,
  "Jobs": [
    {
      "JobId": "sample string 1",
      "Status": "sample string 2"
    },
    {
      "JobId": "sample string 1",
      "Status": "sample string 2"
    }
  ],
  "Result": 2,
  "Message": "sample string 3",
  "DurationMs": 4
}

application/xml, text/xml

Sample:
<RouteStatusResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ServiceMinder.Geo.Api">
  <DurationMs>4</DurationMs>
  <Message>sample string 3</Message>
  <Result>2</Result>
  <Jobs>
    <RouteJob>
      <JobId>sample string 1</JobId>
      <Status>sample string 2</Status>
    </RouteJob>
    <RouteJob>
      <JobId>sample string 1</JobId>
      <Status>sample string 2</Status>
    </RouteJob>
  </Jobs>
  <RunningJobCount>1</RunningJobCount>
</RouteStatusResponse>