Cochrane+ App API

<back to all web services

OnTheMoveListRequest

Requires Authentication
The following routes are available for this service:
GET/template-approval/list

export class ApiServiceRequest implements IServiceRequest, IHasApiKey, IHasDeviceInfo
{
    /** @description The API Key required for authentication */
    // @ApiMember(DataType="string", Description="The API Key required for authentication", IsRequired=true)
    public apiKey: string;

    /** @description Latitude of the user making this request */
    // @ApiMember(DataType="double", Description="Latitude of the user making this request")
    public latitude: number;

    /** @description Longitude of the user making this request */
    // @ApiMember(DataType="double", Description="Longitude of the user making this request")
    public longitude: number;

    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 Coordinate
{
    public latitude: number;
    public longitude: number;

    public constructor(init?: Partial<Coordinate>) { (Object as any).assign(this, init); }
}

export class OnTheMoveListItem
{
    public id: number;
    public name: string;
    public clockedInTime: string;
    public lastSeen: string;
    public lastKnownLocation: string;
    public coordinate: Coordinate;

    public constructor(init?: Partial<OnTheMoveListItem>) { (Object as any).assign(this, init); }
}

export class OnTheMoveListResponse extends ApiServiceResponse
{
    public listItems: OnTheMoveListItem[];

    public constructor(init?: Partial<OnTheMoveListResponse>) { super(init); (Object as any).assign(this, init); }
}

export class OnTheMoveListRequest extends ApiServiceRequest
{

    public constructor(init?: Partial<OnTheMoveListRequest>) { super(init); (Object as any).assign(this, init); }
}

TypeScript OnTheMoveListRequest 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.

GET /template-approval/list HTTP/1.1 
Host: cochraneplus-api-dev.happen.zone 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<OnTheMoveListResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebService.ServiceModel">
  <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>
  <ListItems>
    <OnTheMoveListItem>
      <ClockedInTime>String</ClockedInTime>
      <Coordinate>
        <Latitude>0</Latitude>
        <Longitude>0</Longitude>
      </Coordinate>
      <Id>0</Id>
      <LastKnownLocation>String</LastKnownLocation>
      <LastSeen>String</LastSeen>
      <Name>String</Name>
    </OnTheMoveListItem>
  </ListItems>
</OnTheMoveListResponse>