eQuipAPI

CreateLocation

Creates a new Location. Requires a valid user to complete this request. Returns LocationDto.

The following routes are available for this service:
POST	/sites/locations	Creates a new Location.

**CreateLocation** Parameters:
Name	Parameter	Data Type	Required	Description
UserID	query	Guid	Yes	The UserID that authorizes the caller to complete the request. Contact your eQuip admin.
LocationID	body	int	No	Location ID
LocationCategoryID	body	int	Yes	Location Category ID
UL_LocationID	body	int	No	UL Location ID
SiteID	body	int	Yes	Site ID
PlanID	body	int	No	Plan ID
ZoneID	body	int	No	Zone ID
LocationBarcode	body	string	No	Location Barcode
LocationName	body	string	Yes	The name of location
LocationDescription	body	string	No	Location Description
LocationX	body	int	No	LocationX
LocationY	body	int	No	LocationY
Width	body	int	No	Width
Height	body	int	No	Height
SizeType	body	string	No	Size Type
Opacity	body	string	No	Opacity
Color	body	string	No	Color
DisplayOnScanner	body	boolean	No	Display On Scanner
FileLocatorCode	body	string	No	File Locator Code
DateCreated	body	datetime	No	Created date
DateModified	body	datetime	No	Modified date
UseMap	body	boolean	No	Use Map?
CustomFields	body	List<CustomElement>	No	Custom Fields collection

**CustomElement** Parameters:
Name	Parameter	Data Type	Required	Description
FieldName	body	string	Yes	The name of the field
FieldValue	body	object	No	The value of the field

**LocationDto** Parameters:
Name	Parameter	Data Type	Required	Description
LocationID	body	string	No	Location ID
LocationCategoryID	body	string	No	Location Category ID
UL_LocationID	body	string	No	UL Location ID
SiteID	body	string	No	Site ID
PlanID	body	string	No	Plan ID
ZoneID	body	string	No	Zone ID
LocationBarcode	body	string	No	Location Barcode
LocationName	body	string	No	Location Name
LocationDescription	body	string	No	Location Description
LocationX	body	string	No	LocationX
LocationY	body	string	No	LocationY
Width	body	string	No	Width
Height	body	string	No	Height
SizeType	body	string	No	Size Type
Opacity	body	string	No	Opacity
Color	body	string	No	Color
DisplayOnScanner	body	string	No	Display On Scanner
FileLocatorCode	body	string	No	File Locator Code
DateCreated	body	string	No	Date Created
DateModified	body	string	No	Date Modified
UseMap	body	string	No	Use Map?
CustomFields	body	List<CustomKeyPair>	No	Custom Fields

**CustomKeyPair** Parameters:
Name	Parameter	Data Type	Required	Description
FieldName	body	string	No	The name of field
FieldValue	body	object	No	The value of field

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /jsv/reply/CreateLocation HTTP/1.1 
Host: equipstage2.e-isg.com 
Content-Type: text/jsv
Content-Length: length

{
	UserID: String,
	LocationID: 0,
	LocationCategoryID: 0,
	UL_LocationID: 0,
	SiteID: 0,
	PlanID: 0,
	ZoneID: 0,
	LocationBarcode: String,
	LocationName: String,
	LocationDescription: String,
	LocationX: 0,
	LocationY: 0,
	Width: 0,
	Height: 0,
	SizeType: String,
	Opacity: String,
	Color: String,
	DisplayOnScanner: False,
	FileLocatorCode: String,
	DateCreated: 0001-01-01,
	DateModified: 0001-01-01,
	UseMap: False,
	CustomFields: 
	[
		{
			FieldName: String,
			FieldValue: {}
		}
	]
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	LocationID: 0,
	LocationCategoryID: 0,
	UL_LocationID: 0,
	SiteID: 0,
	PlanID: 0,
	ZoneID: 0,
	LocationBarcode: String,
	LocationName: String,
	LocationDescription: String,
	LocationX: 0,
	LocationY: 0,
	Width: 0,
	Height: 0,
	SizeType: String,
	Opacity: String,
	Color: String,
	DisplayOnScanner: False,
	FileLocatorCode: String,
	DateCreated: 0001-01-01,
	DateModified: 0001-01-01,
	UseMap: False,
	CustomFields: 
	[
		{
			FieldName: String,
			FieldValue: {}
		}
	]
}