eQuipAPI

<back to all web services

eQuipLogin

The following routes are available for this service:
All Verbs/eQuipLogin/{username}/{password}
All Verbs/eQuipLogin/{username}
All Verbs/eQuipLogin/{username}/{password}/{encodecount}
eQuipLogin Parameters:
NameParameterData TypeRequiredDescription
usernamepathstringNo
passwordpathstringNo
encodecountpathint?No
Time Parameters:
NameParameterData TypeRequiredDescription
ServerTimebodyDateTimeNo
UserIDbodystringNo
RoleIDbodyintNo
DefaultSitebodyList<Site>No
MobileSitesbodyList<Site>No
AllowDuplicateBarcodebodyboolNo
PermissionsbodyPermissionsNo
FrameworkbodystringNo
eQuipVersionbodystringNo
RequiredFieldsbodyList<string>No
PropertyPassbodyboolNo
DisableAssetCreationOnScanbodyboolNo
IdleTimeoutbodyintNo
Site Parameters:
NameParameterData TypeRequiredDescription
SiteCodebodystringNo
SiteDescriptionbodystringNo
SiteIDInternalbodystringNo
SiteNamebodystringNo
CreatedBybodyint?No
CreatedDatebodyDateTime?No
UpdatedBybodyint?No
UpdatedDatebodyDateTime?No
Permissions Parameters:
NameParameterData TypeRequiredDescription
DeleteAssetbodyboolNo
AddEditAssetsbodyboolNo
AddEditDeleteFloorsbodyboolNo
RelocateAssetsbodyboolNo
AddEditDeletePermissionsbodyboolNo
AddEditDeleteReportsbodyboolNo
FromDesignbodyboolNo
EditFloorplanImagesbodyboolNo
ChangeOptionsbodyboolNo
ChangePerferencesbodyboolNo
ModifyValueListsbodyboolNo
AddEditDeleteCategoriesbodyboolNo
OpenProjectsbodyboolNo
CreateProjectsbodyboolNo
WorkstationAuditEmployeeImportbodyboolNo
BarcodeScanningPrintingbodyboolNo
AssetCheckOutbodyboolNo
ScannerAdminbodyboolNo
MoveLocationsbodyboolNo
AddEditLocationsbodyboolNo
DeleteLocationsbodyboolNo
AddEditPeoplebodyboolNo
DeletePeoplebodyboolNo
ImportDatabodyboolNo
CreateWorkOrderbodyboolNo
ApproveWorkOrderbodyboolNo
DeleteWorkOrderbodyboolNo
ExportWorkOrderbodyboolNo
CreateMessagebodyboolNo
ViewAllSitesReadOnlybodyboolNo
ViewAdminMenubodyboolNo
ProhibitchangeofassetsbyotherusersbodyboolNo
ViewUnApprovedAssetsbodyboolNo
ViewRemoteSitesbodyboolNo
ViewReportsMenubodyboolNo
ViewAssetReservationbodyboolNo

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

HTTP + CSV

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

POST /csv/reply/eQuipLogin HTTP/1.1 
Host: equipstage3.e-isg.com 
Content-Type: text/csv
Content-Length: length

{"username":"String","password":"String","encodecount":0}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"ServerTime":"\/Date(-62135596800000-0000)\/","UserID":"String","RoleID":0,"DefaultSite":[{"SiteCode":"String","SiteDescription":"String","SiteIDInternal":"String","SiteName":"String","CreatedBy":0,"CreatedDate":"\/Date(-62135596800000-0000)\/","UpdatedBy":0,"UpdatedDate":"\/Date(-62135596800000-0000)\/"}],"MobileSites":[{"SiteCode":"String","SiteDescription":"String","SiteIDInternal":"String","SiteName":"String","CreatedBy":0,"CreatedDate":"\/Date(-62135596800000-0000)\/","UpdatedBy":0,"UpdatedDate":"\/Date(-62135596800000-0000)\/"}],"AllowDuplicateBarcode":false,"Permissions":{"DeleteAsset":false,"AddEditAssets":false,"AddEditDeleteFloors":false,"RelocateAssets":false,"AddEditDeletePermissions":false,"AddEditDeleteReports":false,"FromDesign":false,"EditFloorplanImages":false,"ChangeOptions":false,"ChangePerferences":false,"ModifyValueLists":false,"AddEditDeleteCategories":false,"OpenProjects":false,"CreateProjects":false,"WorkstationAuditEmployeeImport":false,"BarcodeScanningPrinting":false,"AssetCheckOut":false,"ScannerAdmin":false,"MoveLocations":false,"AddEditLocations":false,"DeleteLocations":false,"AddEditPeople":false,"DeletePeople":false,"ImportData":false,"CreateWorkOrder":false,"ApproveWorkOrder":false,"DeleteWorkOrder":false,"ExportWorkOrder":false,"CreateMessage":false,"ViewAllSitesReadOnly":false,"ViewAdminMenu":false,"Prohibitchangeofassetsbyotherusers":false,"ViewUnApprovedAssets":false,"ViewRemoteSites":false,"ViewReportsMenu":false,"ViewAssetReservation":false},"Framework":"String","eQuipVersion":"String","RequiredFields":["String"],"PropertyPass":false,"DisableAssetCreationOnScan":false,"IdleTimeout":0}