| POST | /journey/start |
|---|
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 StartJourneyResponse extends ApiServiceResponse
{
public journeyId: number;
public constructor(init?: Partial<StartJourneyResponse>) { super(init); (Object as any).assign(this, init); }
}
export class StartJourney extends ApiServiceRequest
{
public title: string;
public crmMeetingId: string;
public meetingCompany: string;
public meetingContact: string;
public meetingSubject: string;
public constructor(init?: Partial<StartJourney>) { super(init); (Object as any).assign(this, init); }
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /journey/start HTTP/1.1
Host: cochraneplus-api-dev.happen.zone
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length
{"title":"String","crmMeetingId":"00000000-0000-0000-0000-000000000000","meetingCompany":"String","meetingContact":"String","meetingSubject":"String","apiKey":"String","latitude":0,"longitude":0}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length
{"journeyId":0,"description":"String","heading":"String","wasSuccessful":false,"modelState":{}}