GET api/Satellites

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Collection of Satellite

Name	Type	Additional information
SatelliteId	integer	None.
ClientId	integer	None.
URL	string	Required
Name	string	Required String length: inclusive between 0 and 100
IPAddress	string	None.
Protocol	string	Required
PortNumber	string	Required
ServiceContract	string	Required
StarshipId	integer	Required
UniqueId	globally unique identifier	None.
SerialNumber	string	None.
MacAddress	string	None.
WindowsKey	string	None.
Active	boolean	None.
Latitude	decimal number	None.
Longitude	decimal number	None.
IsOnline	boolean	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "SatelliteId": 1,
    "ClientId": 1,
    "URL": "sample string 2",
    "Name": "sample string 3",
    "IPAddress": "sample string 4",
    "Protocol": "sample string 5",
    "PortNumber": "sample string 6",
    "ServiceContract": "sample string 7",
    "StarshipId": 8,
    "UniqueId": "f71ce591-f748-4ec8-b59f-fd1faea53ac4",
    "SerialNumber": "sample string 10",
    "MacAddress": "sample string 11",
    "WindowsKey": "sample string 12",
    "Active": true,
    "Latitude": 14.0,
    "Longitude": 15.0,
    "IsOnline": true
  },
  {
    "SatelliteId": 1,
    "ClientId": 1,
    "URL": "sample string 2",
    "Name": "sample string 3",
    "IPAddress": "sample string 4",
    "Protocol": "sample string 5",
    "PortNumber": "sample string 6",
    "ServiceContract": "sample string 7",
    "StarshipId": 8,
    "UniqueId": "f71ce591-f748-4ec8-b59f-fd1faea53ac4",
    "SerialNumber": "sample string 10",
    "MacAddress": "sample string 11",
    "WindowsKey": "sample string 12",
    "Active": true,
    "Latitude": 14.0,
    "Longitude": 15.0,
    "IsOnline": true
  }
]

application/xml, text/xml

Sample:

<ArrayOfSatellite xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Starship.WebAPI.Models">
  <Satellite>
    <Active>true</Active>
    <ClientId>1</ClientId>
    <IPAddress>sample string 4</IPAddress>
    <IsOnline>true</IsOnline>
    <Latitude>14</Latitude>
    <Longitude>15</Longitude>
    <MacAddress>sample string 11</MacAddress>
    <Name>sample string 3</Name>
    <PortNumber>sample string 6</PortNumber>
    <Protocol>sample string 5</Protocol>
    <SatelliteId>1</SatelliteId>
    <SerialNumber>sample string 10</SerialNumber>
    <ServiceContract>sample string 7</ServiceContract>
    <StarshipId>8</StarshipId>
    <URL>sample string 2</URL>
    <UniqueId>f71ce591-f748-4ec8-b59f-fd1faea53ac4</UniqueId>
    <WindowsKey>sample string 12</WindowsKey>
  </Satellite>
  <Satellite>
    <Active>true</Active>
    <ClientId>1</ClientId>
    <IPAddress>sample string 4</IPAddress>
    <IsOnline>true</IsOnline>
    <Latitude>14</Latitude>
    <Longitude>15</Longitude>
    <MacAddress>sample string 11</MacAddress>
    <Name>sample string 3</Name>
    <PortNumber>sample string 6</PortNumber>
    <Protocol>sample string 5</Protocol>
    <SatelliteId>1</SatelliteId>
    <SerialNumber>sample string 10</SerialNumber>
    <ServiceContract>sample string 7</ServiceContract>
    <StarshipId>8</StarshipId>
    <URL>sample string 2</URL>
    <UniqueId>f71ce591-f748-4ec8-b59f-fd1faea53ac4</UniqueId>
    <WindowsKey>sample string 12</WindowsKey>
  </Satellite>
</ArrayOfSatellite>