| POST | /user/email/ |
|---|
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 ApiServiceActivityRequest extends ApiServiceRequest
{
/** @description Date that this activitiy took place. ISO 8601 */
// @ApiMember(Description="Date that this activitiy took place. ISO 8601", IsRequired=true)
public activityDate: string;
public constructor(init?: Partial<ApiServiceActivityRequest>) { super(init); (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 UserCheckEmailResponse extends ApiServiceResponse
{
public systemUserId: number;
public constructor(init?: Partial<UserCheckEmailResponse>) { super(init); (Object as any).assign(this, init); }
}
export class UserCheckEmail extends ApiServiceActivityRequest
{
public emailAddress: string;
public constructor(init?: Partial<UserCheckEmail>) { super(init); (Object as any).assign(this, init); }
}
TypeScript UserCheckEmail 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 /user/email/ HTTP/1.1
Host: reservation.api.dev.86degrees.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<UserCheckEmail xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebService.ServiceModel">
<ApiKey xmlns="http://schemas.datacontract.org/2004/07/WebService.ServiceModel.Base">String</ApiKey>
<Latitude xmlns="http://schemas.datacontract.org/2004/07/WebService.ServiceModel.Base">0</Latitude>
<Longitude xmlns="http://schemas.datacontract.org/2004/07/WebService.ServiceModel.Base">0</Longitude>
<ActivityDate xmlns="http://schemas.datacontract.org/2004/07/WebService.ServiceModel.Base">String</ActivityDate>
<EmailAddress>String</EmailAddress>
</UserCheckEmail>
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <UserCheckEmailResponse 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> <SystemUserId>0</SystemUserId> </UserCheckEmailResponse>