GalaxyMobile Client API

<back to all web services

ProtectMeActivationRequest

The following routes are available for this service:
POST/protectme/activateRegister a Protect Me panic request.
<?php namespace dtos;

use DateTime;
use Exception;
use DateInterval;
use JsonSerializable;
use ServiceStack\{IReturn,IReturnVoid,IGet,IPost,IPut,IDelete,IPatch,IMeta,IHasSessionId,IHasBearerToken,IHasVersion};
use ServiceStack\{ICrud,ICreateDb,IUpdateDb,IPatchDb,IDeleteDb,ISaveDb,AuditBase,QueryDb,QueryDb2,QueryData,QueryData2,QueryResponse};
use ServiceStack\{ResponseStatus,ResponseError,EmptyResponse,IdResponse,ArrayList,KeyValuePair2,StringResponse,StringsResponse,Tuple2,Tuple3,ByteArray};
use ServiceStack\{JsonConverters,Returns,TypeContext};


class ApiServiceRequest implements IServiceRequest, IHasApiKey, JsonSerializable
{
    public function __construct(
        /** @description The API Key required for authentication */
        // @ApiMember(DataType="string", Description="The API Key required for authentication", IsRequired=true)
        /** @var string */
        public string $ApiKey=''
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['ApiKey'])) $this->ApiKey = $o['ApiKey'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->ApiKey)) $o['ApiKey'] = $this->ApiKey;
        return empty($o) ? new class(){} : $o;
    }
}

class ApiServiceResponse implements IServiceResponse, JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $Description=null,
        /** @var string|null */
        public ?string $Heading=null,
        /** @var bool|null */
        public ?bool $WasSuccessful=null,
        /** @var Object|null */
        public ?Object $ModelState=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['Description'])) $this->Description = $o['Description'];
        if (isset($o['Heading'])) $this->Heading = $o['Heading'];
        if (isset($o['WasSuccessful'])) $this->WasSuccessful = $o['WasSuccessful'];
        if (isset($o['ModelState'])) $this->ModelState = JsonConverters::from('Object', $o['ModelState']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->Description)) $o['Description'] = $this->Description;
        if (isset($this->Heading)) $o['Heading'] = $this->Heading;
        if (isset($this->WasSuccessful)) $o['WasSuccessful'] = $this->WasSuccessful;
        if (isset($this->ModelState)) $o['ModelState'] = JsonConverters::to('Object', $this->ModelState);
        return empty($o) ? new class(){} : $o;
    }
}

class ProtectMeActivationResponse extends ApiServiceResponse implements JsonSerializable
{
    /**
     * @param string|null $Description
     * @param string|null $Heading
     * @param bool|null $WasSuccessful
     * @param Object|null $ModelState
     */
    public function __construct(
        ?string $Description=null,
        ?string $Heading=null,
        ?bool $WasSuccessful=null,
        ?Object $ModelState=null,
        /** @description Is the requested product set up and enabled on Galaxy. */
        // @ApiMember(Description="Is the requested product set up and enabled on Galaxy.")
        /** @var bool|null */
        public ?bool $ProductAvailable=null,

        /** @description Does the user have access to this product, based on their Galaxy profile. */
        // @ApiMember(Description="Does the user have access to this product, based on their Galaxy profile.")
        /** @var bool|null */
        public ?bool $UserHasAccess=null,

        /** @description The ID of the panic log. This is the ID returned by the panic provider. Used to get panic detail later. */
        // @ApiMember(Description="The ID of the panic log. This is the ID returned by the panic provider. Used to get panic detail later.")
        /** @var int */
        public int $PanicId=0
    ) {
        parent::__construct($Description,$Heading,$WasSuccessful,$ModelState);
    }

    /** @throws Exception */
    public function fromMap($o): void {
        parent::fromMap($o);
        if (isset($o['ProductAvailable'])) $this->ProductAvailable = $o['ProductAvailable'];
        if (isset($o['UserHasAccess'])) $this->UserHasAccess = $o['UserHasAccess'];
        if (isset($o['PanicId'])) $this->PanicId = $o['PanicId'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = parent::jsonSerialize();
        if (isset($this->ProductAvailable)) $o['ProductAvailable'] = $this->ProductAvailable;
        if (isset($this->UserHasAccess)) $o['UserHasAccess'] = $this->UserHasAccess;
        if (isset($this->PanicId)) $o['PanicId'] = $this->PanicId;
        return empty($o) ? new class(){} : $o;
    }
}

class ProtectMeActivationRequest extends ApiServiceRequest implements JsonSerializable
{
    /**
     * @param string $ApiKey
     */
    public function __construct(
        string $ApiKey='',
        /** @description ID Number of the user making this request. */
        // @ApiMember(Description="ID Number of the user making this request.", IsRequired=true)
        /** @var string */
        public string $IdNumber='',

        /** @description Latitude of the panic location. */
        // @ApiMember(Description="Latitude of the panic location.", IsRequired=true)
        /** @var float */
        public float $Latitude=0.0,

        /** @description Longitude of the panic location. */
        // @ApiMember(Description="Longitude of the panic location.", IsRequired=true)
        /** @var float */
        public float $Longitude=0.0
    ) {
        parent::__construct($ApiKey);
    }

    /** @throws Exception */
    public function fromMap($o): void {
        parent::fromMap($o);
        if (isset($o['IdNumber'])) $this->IdNumber = $o['IdNumber'];
        if (isset($o['Latitude'])) $this->Latitude = $o['Latitude'];
        if (isset($o['Longitude'])) $this->Longitude = $o['Longitude'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = parent::jsonSerialize();
        if (isset($this->IdNumber)) $o['IdNumber'] = $this->IdNumber;
        if (isset($this->Latitude)) $o['Latitude'] = $this->Latitude;
        if (isset($this->Longitude)) $o['Longitude'] = $this->Longitude;
        return empty($o) ? new class(){} : $o;
    }
}

PHP ProtectMeActivationRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /protectme/activate HTTP/1.1 
Host: galaxymobile.api.client.prod.86degrees.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<ProtectMeActivationRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebService.ClientServiceModel.ProtectMe">
  <ApiKey xmlns="http://schemas.datacontract.org/2004/07/WebService.ClientServiceModel.Base">String</ApiKey>
  <IdNumber>String</IdNumber>
  <Latitude>0</Latitude>
  <Longitude>0</Longitude>
</ProtectMeActivationRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ProtectMeActivationResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebService.ClientServiceModel.ProtectMe">
  <Description xmlns="http://schemas.datacontract.org/2004/07/CommonService.Api.Models.Base">String</Description>
  <Heading xmlns="http://schemas.datacontract.org/2004/07/CommonService.Api.Models.Base">String</Heading>
  <ModelState xmlns="http://schemas.datacontract.org/2004/07/CommonService.Api.Models.Base" />
  <WasSuccessful xmlns="http://schemas.datacontract.org/2004/07/CommonService.Api.Models.Base">false</WasSuccessful>
  <PanicId>0</PanicId>
  <ProductAvailable>false</ProductAvailable>
  <UserHasAccess>false</UserHasAccess>
</ProtectMeActivationResponse>