GET api/v3/Units/GetUnitDetail

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Collection of UnitDetailResult
NameDescriptionTypeAdditional information
Id

integer

None.

Name

string

None.

Type

string

None.

GroupId

integer

None.

VIN

string

None.

PlateNumber

string

None.

Offroad

boolean

None.

SpecialPermit

boolean

None.

StatusId

integer

None.

Roles

Collection of UnitDetailRoleResult

None.

Response Formats

application/json

Sample:
[
  {
    "Id": 1,
    "Name": "sample string 2",
    "Type": "sample string 3",
    "GroupId": 4,
    "VIN": "sample string 5",
    "PlateNumber": "sample string 6",
    "Offroad": true,
    "SpecialPermit": true,
    "StatusId": 9,
    "Roles": [
      {
        "RoleId": 1,
        "UnitId": 2,
        "UserId": "sample string 3",
        "RoleName": "sample string 4",
        "Name": "sample string 5"
      },
      {
        "RoleId": 1,
        "UnitId": 2,
        "UserId": "sample string 3",
        "RoleName": "sample string 4",
        "Name": "sample string 5"
      }
    ]
  },
  {
    "Id": 1,
    "Name": "sample string 2",
    "Type": "sample string 3",
    "GroupId": 4,
    "VIN": "sample string 5",
    "PlateNumber": "sample string 6",
    "Offroad": true,
    "SpecialPermit": true,
    "StatusId": 9,
    "Roles": [
      {
        "RoleId": 1,
        "UnitId": 2,
        "UserId": "sample string 3",
        "RoleName": "sample string 4",
        "Name": "sample string 5"
      },
      {
        "RoleId": 1,
        "UnitId": 2,
        "UserId": "sample string 3",
        "RoleName": "sample string 4",
        "Name": "sample string 5"
      }
    ]
  }
]

application/xml, text/xml

Sample:
<ArrayOfUnitDetailResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Resgrid.Web.Services.Controllers.Version3.Models.Units">
  <UnitDetailResult>
    <GroupId>4</GroupId>
    <Id>1</Id>
    <Name>sample string 2</Name>
    <Offroad>true</Offroad>
    <PlateNumber>sample string 6</PlateNumber>
    <Roles>
      <UnitDetailRoleResult>
        <Name>sample string 5</Name>
        <RoleId>1</RoleId>
        <RoleName>sample string 4</RoleName>
        <UnitId>2</UnitId>
        <UserId>sample string 3</UserId>
      </UnitDetailRoleResult>
      <UnitDetailRoleResult>
        <Name>sample string 5</Name>
        <RoleId>1</RoleId>
        <RoleName>sample string 4</RoleName>
        <UnitId>2</UnitId>
        <UserId>sample string 3</UserId>
      </UnitDetailRoleResult>
    </Roles>
    <SpecialPermit>true</SpecialPermit>
    <StatusId>9</StatusId>
    <Type>sample string 3</Type>
    <VIN>sample string 5</VIN>
  </UnitDetailResult>
  <UnitDetailResult>
    <GroupId>4</GroupId>
    <Id>1</Id>
    <Name>sample string 2</Name>
    <Offroad>true</Offroad>
    <PlateNumber>sample string 6</PlateNumber>
    <Roles>
      <UnitDetailRoleResult>
        <Name>sample string 5</Name>
        <RoleId>1</RoleId>
        <RoleName>sample string 4</RoleName>
        <UnitId>2</UnitId>
        <UserId>sample string 3</UserId>
      </UnitDetailRoleResult>
      <UnitDetailRoleResult>
        <Name>sample string 5</Name>
        <RoleId>1</RoleId>
        <RoleName>sample string 4</RoleName>
        <UnitId>2</UnitId>
        <UserId>sample string 3</UserId>
      </UnitDetailRoleResult>
    </Roles>
    <SpecialPermit>true</SpecialPermit>
    <StatusId>9</StatusId>
    <Type>sample string 3</Type>
    <VIN>sample string 5</VIN>
  </UnitDetailResult>
</ArrayOfUnitDetailResult>