| POST | /protectme/activate | Register a Protect Me panic request. |
|---|
export class ApiServiceRequest implements IServiceRequest, IHasApiKey
{
/** @description The API Key required for authentication */
// @ApiMember(DataType="string", Description="The API Key required for authentication", IsRequired=true)
public ApiKey: string;
public constructor(init?: Partial<ApiServiceRequest>) { (Object as any).assign(this, init); }
}
export class ApiServiceResponse implements IServiceResponse
{
public Description: string;
public Heading: string;
public WasSuccessful: boolean;
public ModelState: Object;
public constructor(init?: Partial<ApiServiceResponse>) { (Object as any).assign(this, init); }
}
export class ProtectMeActivationResponse extends ApiServiceResponse
{
/** @description Is the requested product set up and enabled on Galaxy. */
// @ApiMember(Description="Is the requested product set up and enabled on Galaxy.")
public ProductAvailable: boolean;
/** @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.")
public UserHasAccess: boolean;
/** @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.")
public PanicId: number;
public constructor(init?: Partial<ProtectMeActivationResponse>) { super(init); (Object as any).assign(this, init); }
}
export class ProtectMeActivationRequest extends ApiServiceRequest
{
/** @description ID Number of the user making this request. */
// @ApiMember(Description="ID Number of the user making this request.", IsRequired=true)
public IdNumber: string;
/** @description Latitude of the panic location. */
// @ApiMember(Description="Latitude of the panic location.", IsRequired=true)
public Latitude: number;
/** @description Longitude of the panic location. */
// @ApiMember(Description="Longitude of the panic location.", IsRequired=true)
public Longitude: number;
public constructor(init?: Partial<ProtectMeActivationRequest>) { super(init); (Object as any).assign(this, init); }
}
TypeScript ProtectMeActivationRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=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>