| POST | /cmd/locations |
|---|
export class Ref
{
public id: string;
public val: string;
public constructor(init?: Partial<Ref>) { (Object as any).assign(this, init); }
}
export class RefEx extends Ref
{
public data: RecordDictionary<string, string>;
public constructor(init?: Partial<RefEx>) { super(init); (Object as any).assign(this, init); }
}
export class GPSCoordinates
{
public lat: number;
public lng: number;
public constructor(init?: Partial<GPSCoordinates>) { (Object as any).assign(this, init); }
}
export class Address
{
public street: string;
public city: string;
public state: string;
public postalCode: string;
public country: Ref;
public gps: GPSCoordinates;
public data: RecordDictionary<string, string>;
public constructor(init?: Partial<Address>) { (Object as any).assign(this, init); }
}
export enum DeviceType
{
ClerkServicedKiosk = 0,
PersonalOnline = 1,
SelfServiceKiosk = 2,
Unknown = -1,
}
export class Device
{
public id: string;
public name: string;
public isActive: boolean;
public type: DeviceType;
public integrationsData: RecordDictionary<string, string>;
public constructor(init?: Partial<Device>) { (Object as any).assign(this, init); }
}
export class ProductReference
{
public id: string;
public value: string;
public category: string;
public productProvider: Ref;
public constructor(init?: Partial<ProductReference>) { (Object as any).assign(this, init); }
}
export class ProductInstanceRef
{
public id: string;
public name: string;
public title: string;
public product: ProductReference;
public constructor(init?: Partial<ProductInstanceRef>) { (Object as any).assign(this, init); }
}
export class Locale
{
public timeZone: Ref;
public currency: Ref;
public language: Ref;
public constructor(init?: Partial<Locale>) { (Object as any).assign(this, init); }
}
export class OpenLocation
{
public id: string;
public name: string;
public organization: RefEx;
public region: Ref;
public group: Ref;
public address: Address;
public devices: Device[];
public productInstances: ProductInstanceRef[];
public locale: Locale;
public integrationsData: { [index:string]: string; };
public constructor(init?: Partial<OpenLocation>) { (Object as any).assign(this, init); }
}
export class Dictionary<T> { [Key: string]: T; }
export class RecordDictionary<TKey, TVal> extends Dictionary<TVal>
{
public constructor(init?: Partial<RecordDictionary<TKey, TVal>>) { super(); (Object as any).assign(this, init); }
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /cmd/locations HTTP/1.1
Host: api.sbbet.ath.cx
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
id: String,
name: String,
organization:
{
data:
{
String: String
},
id: String,
val: String
},
region:
{
id: String,
val: String
},
group:
{
id: String,
val: String
},
address:
{
street: String,
city: String,
state: String,
postalCode: String,
country:
{
id: String,
val: String
},
gps:
{
lat: 0,
lng: 0
},
data:
{
String: String
}
},
devices:
[
{
id: String,
name: String,
isActive: False,
type: 0,
integrationsData:
{
String: String
}
}
],
productInstances:
[
{
id: String,
name: String,
title: String,
product:
{
id: String,
value: String,
category: String,
productProvider:
{
id: String,
val: String
}
}
}
],
locale:
{
timeZone:
{
id: String,
val: String
},
currency:
{
id: String,
val: String
},
language:
{
id: String,
val: String
}
},
integrationsData:
{
String: String
}
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
errorCode: String,
message: String,
stackTrace: String,
errors:
[
{
errorCode: String,
fieldName: String,
message: String,
meta:
{
String: String
}
}
],
meta:
{
String: String
}
}