eQuipAPI

<back to all web services

GetLocationData

The following routes are available for this service:
All Verbs/GetLocationData
GetLocationData Parameters:
NameParameterData TypeRequiredDescription
UserIDquerystringNo
SearchParamCollectionqueryList<SearchParam>No
ForAttachmentquerystringNo
SearchParam Parameters:
NameParameterData TypeRequiredDescription
FieldIDbodystringNo
FieldNamebodystringNo
FieldValuebodyObjectNo
OperatorbodystringNo
FieldTypebodyshortNo
UseMultiSelectbodyboolNo
IsSearchAsTextboxbodyboolNo
IsTransactionDetailSearchbodyboolNo
IsSubTransactionDetailSearchbodyboolNo
SecondDateRangeValuebodystringNo
GetLocationDataResponse Parameters:
NameParameterData TypeRequiredDescription
LocationDatabodyList<Dictionary>No
ColumnCollectionbodyList<Column>No
Column Parameters:
NameParameterData TypeRequiredDescription
fieldbodystringNo
commandbodystringNo
selectablebodyboolNo
titlebodystringNo
templatebodystringNo
formatbodystringNo
decimalsbodyintNo
headerTemplatebodystringNo
lockedbodyboolNo
lockablebodyboolNo
sortablebodyboolNo
IsInlineEditWFbodyboolNo
filterablebodyboolNo
valueListbodyboolNo
UseMultiSelectbodyboolNo
DisablebodyboolNo
RequiredbodyboolNo
editorbodystringNo
typebodystringNo
TableTypebodystringNo
widthbodyintNo
FieldDataSourcebodyList<Dictionary>No
expandablebodyboolNo
FieldIdbodyintNo
ValueListTypebodyintNo
IsEditablebodyboolNo
AssetMappedFieldIDbodyintNo
IsMaxLengthbodyboolNo
MaxLengthCountbodyintNo
TextLengthbodyintNo

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/GetLocationData HTTP/1.1 
Host: equipstage3.e-isg.com 
Content-Type: text/jsv
Content-Length: length

{
	UserID: String,
	SearchParamCollection: 
	[
		{
			FieldID: String,
			FieldName: String,
			FieldValue: {},
			Operator: String,
			FieldType: 0,
			UseMultiSelect: False,
			IsSearchAsTextbox: False,
			IsTransactionDetailSearch: False,
			IsSubTransactionDetailSearch: False,
			SecondDateRangeValue: String
		}
	],
	ForAttachment: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	LocationData: 
	[
		{
			String: {}
		}
	],
	ColumnCollection: 
	[
		{
			field: String,
			command: String,
			selectable: False,
			title: String,
			template: String,
			format: String,
			decimals: 0,
			headerTemplate: String,
			locked: False,
			lockable: False,
			sortable: False,
			IsInlineEditWF: False,
			filterable: False,
			valueList: False,
			UseMultiSelect: False,
			Disable: False,
			Required: False,
			editor: String,
			type: String,
			TableType: String,
			width: 200,
			FieldDataSource: 
			[
				{
					String: {}
				}
			],
			expandable: False,
			FieldId: 0,
			ValueListType: 0,
			IsEditable: False,
			AssetMappedFieldID: 0,
			IsMaxLength: False,
			MaxLengthCount: 0,
			TextLength: 0
		}
	]
}