Learn how to write robust queries to optimize your solution
QueryExpressions provide a simple mechanism to return one or more entities based on combination of properties, operators and values.
POST {Host Name}/api/v1/query/{EntityType}
where {Host Name} is derived from GetCompanyWsdkUrlCommand.Url, and
{EntityType} is a class listed in Entities namespace, and
{Request body} which contains a valid QueryExpression.
The Response JSON stream includes a standard outer structure with Entities collection and Data element. Within the Data element, entity-specific content is rendered, as shown below.
{
"Entities" : [
{
"Data" :
{
//**ENTITY SPECIFIC CONTENT HERE**//
}
}
]
}
Response limits apply
No query may return more than 4000 entities in a single operation. Use QueryExpression.Count and multiple operations to optimize your queries that are expected to return more than 4000 entities.
Contact by Email Address
Fields that are commonly shared with other integrated systems, like email address, are prime examples of how to use simple queries to return entities in Corrigo Enterprise, the HTTP POST below shall demonstrate.
POST <<AM Host Name>>/api/v1/query/Contact HTTP/1.1
Accept-Encoding: gzip,deflate
CompanyName: <<Sample Company>>
Content-Type: application/json
Authorization: Bearer eyJBdXRoZW50aWNhdGlvblR5cGUiOiJCZWFyZXIiLCJOYW1lQ2xhaW1UeXBlIjoiaHR0cDovL3NjaGVtYXMueG1sc29hcC5vcmcvd3MvMjAwNS8wNS9pZGVudGl0eS9jbGFpbXMvbmFtZSIsIlJvbGVDbGFpbVR5cGUiOiJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9uYW1lIiwiQ2xhaW1zIjpbeyJUeXBlIjoiaHR0cDovL3NjaGVtYXMueG1sc29hcC5vcmcvd3MvMjAwNS8wNS9pZGVudGl0eS9jbGFpbXMvbmFtZSIsIlZhbHVlIjoiY2VhcGljbGllbnQuMS4xODY4LjY5ZjgiLCJWYWx1ZVR5cGUiOiJodHRwOi8vd3d3LnczLm9yZy8yMDAxL1hNTFNjaGVtYSNzdHJpbmciLCJJc3N1ZXIiOiJMT0NBTCBBVVRIT1JJVFkiLCJPcmlnaW5hbElzc3VlciI6IkxPQ0FMIEFVVEhPUklUWSJ9LHsiVHlwZSI6InVybjpvYXV0aDpzY29wZSIsIlZhbHVlIjoiIiwiVmFsdWVUeXBlIjoiaHR0cDovL3d3dy53My5vcmcvMjAwMS9YTUxTY2hlbWEjc3RyaW5nIiwiSXNzdWVyIjoiTE9DQUwgQVVUSE9SSVRZIiwiT3JpZ2luYWxJc3N1ZXIiOiJMT0NBTCBBVVRIT1JJVFkifSx7IlR5cGUiOiJBdWQiLCJWYWx1ZSI6IjE4NjgiLCJWYWx1ZVR5cGUiOiJodHRwOi8vd3d3LnczLm9yZy8yMDAxL1hNTFNjaGVtYSNzdHJpbmciLCJJc3N1ZXIiOiJMT0NBTCBBVVRIT1JJVFkiLCJPcmlnaW5hbElzc3VlciI6IkxPQ0FMIEFVVEhPUklUWSJ9XSwiUHJvcGVydGllcyI6eyJEaWN0aW9uYXJ5Ijp7Ii5pc3N1ZWQiOiJNb24sIDEzIERlYyAyMDIxIDA1OjE0OjUyIEdNVCIsIi5leHBpcmVzIjoiTW9uLCAxMyBEZWMgMjAyMSAwNTozNDo1MiBHTVQifX19<---->HItqqW2V3km1vRqeob13Jw7agZG0UFsfiMtB5S8rr6bxaxoxz9VwywdfX9QszGlxSxx-30m1KTLeD3zaZxdiauWwAW6nFewOQrkbBOEiXEyy9gK5VlNf4MPXdw1y0XFDOdm8rZ9NVEbUOB4axFsBzK_pezYcyGuJGsiDooVIgx8AYu54cpkQgc82JXuaAj1cUjfDy6vjqeA8D3--9-0OsPIqnIzp494I0VbhTBq5rpMUrg5GqVhu_zEODbSYLgLeGXz7WIAG8nN-Zz5FKChnyVN_taX41KKsO3OJC_fHOU76YXSNC1VfHAfjFQKarUs6W8InVKeFyP3zU-HjIW0Yww
Content-Length: 386
Connection: Keep-Alive
User-Agent: Apache-HttpClient/4.5.2 (Java/16.0.1)
{
"QueryExpression":
{
"Criteria": {
"Conditions": [
{
"PropertyName": "ContactAddresses.Address",
"Operator": "Equal",
"Values": ["[email protected]"]
}
],
"FilterOperator": "And"
},
"Distinct": true,
"PropertySet": { "Properties" : ["*", "ContactAddresses.*"]},
"Count": 1,
"FirstResultIndex": 0
}
}
{
"Entities" : [
{
"Data" : {
"DisplayAs" : "Divyesh 15313",
"FirstName" : "Divyesh",
"LastName" : "15313",
"TypeId" : "Alternate",
"CustomerId" : 0,
"CanViewAnyRequest" : false,
"CanCreateRequest" : true,
"PriorityThreshold" : 255,
"CustomFields" : [ ],
"ContactAddresses" : [
{
"ActorTypeId" : "LeaseUser",
"ActorId" : 15313,
"AddrTypeId" : "PrimEmail",
"Address" : "[email protected]",
"IsAlert" : false,
"IsReport" : false,
"ConcurrencyId" : 182,
"Id" : 174803,
"PerformDeletion" : false,
"IsNew" : false
}
],
"GroupsBridge" : [ ],
"Username" : "[email protected]",
"Number" : "",
"MustResetPassword" : false,
"NoAlertEmails" : false,
"Comment" : "",
"UnlimitedRequest" : true,
"UnlimitedAuthorization" : true,
"SupervisorId" : 0,
"LanguageId" : 0,
"CustomerNoteAccessId" : "View",
"NoPwdExpirationAlert" : false,
"Currencies" : [ ],
"IsRemoved" : false,
"ConcurrencyId" : 183,
"Id" : 15313,
"PerformDeletion" : false,
"IsNew" : false
}
}
]
}
Customer by TenantCode
TenantCode is designed for use by integrated systems. Values are guaranteed unique across the entire Company.
POST <<AM Host Name>>/api/v1/query/Customer HTTP/1.1
CompanyName: <<Sample Company>>
Authorization: Bearer eyJBdXRoZW50aWNhdGlvblR5cGUiOiJCZWFyZXIiLCJOYW1lQ2xhaW1UeXBlIjoiaHR0cDovL3NjaGVtYXMueG1sc29hcC5vcmcvd3MvMjAwNS8wNS9pZGVudGl0eS9jbGFpbXMvbmFtZSIsIlJvbGVDbGFpbVR5cGUiOiJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9uYW1lIiwiQ2xhaW1zIjpbeyJUeXBlIjoiaHR0cDovL3NjaGVtYXMueG1sc29hcC5vcmcvd3MvMjAwNS8wNS9pZGVudGl0eS9jbGFpbXMvbmFtZSIsIlZhbHVlIjoiY2VhcGljbGllbnQuMS4xODY4LmI5ZmUiLCJWYWx1ZVR5cGUiOiJodHRwOi8vd3d3LnczLm9yZy8yMDAxL1hNTFNjaGVtYSNzdHJpbmciLCJJc3N1ZXIiOiJMT0NBTCBBVVRIT1JJVFkiLCJPcmlnaW5hbElzc3VlciI6IkxPQ0FMIEFVVEhPUklUWSJ9LHsiVHlwZSI6InVybjpvYXV0aDpzY29wZSIsIlZhbHVlIjoiIiwiVmFsdWVUeXBlIjoiaHR0cDovL3d3dy53My5vcmcvMjAwMS9YTUxTY2hlbWEjc3RyaW5nIiwiSXNzdWVyIjoiTE9DQUwgQVVUSE9SSVRZIiwiT3JpZ2luYWxJc3N1ZXIiOiJMT0NBTCBBVVRIT1JJVFkifSx7IlR5cGUiOiJBdWQiLCJWYWx1ZSI6IjE4NjgiLCJWYWx1ZVR5cGUiOiJodHRwOi8vd3d3LnczLm9yZy8yMDAxL1hNTFNjaGVtYSNzdHJpbmciLCJJc3N1ZXIiOiJMT0NBTCBBVVRIT1JJVFkiLCJPcmlnaW5hbElzc3VlciI6IkxPQ0FMIEFVVEhPUklUWSJ9XSwiUHJvcGVydGllcyI6eyJEaWN0aW9uYXJ5Ijp7Ii5pc3N1ZWQiOiJXZWQsIDI5IERlYyAyMDIxIDA5OjAyOjIwIEdNVCIsIi5leHBpcmVzIjoiV2VkLCAyOSBEZWMgMjAyMSAwOToyMjoyMCBHTVQifX19<---->TxSDK0QdlxOyK92DhqU2gw_2pHi8v6uOdfx0n_Y4E2Gq0a6OkWMW-JwFfiftf7mOvsAod2boSydc74tl41kIyC0Tpj0u7_-d60YcEF8q8RGZvM3UTbBIa3Otbb-zfNjoucaZN08ROn9ej0WPDh823B_VS8VAS9MHSjwP7eYi0E8Irp5J6b1B4c2eeH8SRr3KX-Digx5gE9ZdkqkM6_az4xjZmTsSWD8krmtrsFxDw2dJ3CLFs-gE3xAhQjEbqR3QaGBu6_pOY1TXe8gPotDwYasx726BApvD62U81iv02VX1ScRB3GlsLtS_iBk5QqAdplwg7BInebkG2Coj6U71GQ
Content-Type: application/json
Content-Length: 393
{
"QueryExpression":
{
"Criteria": {
"Conditions": [
{
"PropertyName": "TenantCode",
"Operator": "Equal",
"Values": ["000-12345"]
}
],
"FilterOperator": "And"
},
"Distinct": true,
"PropertySet": { "Properties" : ["*"]},
"Count": 1,
"FirstResultIndex": 0
}
}
{
"Entities": [
{
"Data": {
"DisplayAs": "113update Store XXXX",
"Name": "113update Store XXXX",
"WorkZone": {
"DisplayAs": "",
"TimeZone": 0,
"LanguageId": 0,
"WoNumberPrefix": "",
"Entity": "",
"SchedulingWindow": 0,
"NoIncompleteProcedure": false,
"AccessOptionsMask": 0,
"Number": "",
"AdvanceNotice": 0,
"WoNumberDigits": 0,
"RoundApptTimeTo": 0,
"WorkPlanAutoCancel": false,
"WorkPlanChildResolution": false,
"WorkPlanAutoDependency": false,
"CpThemeId": 0,
"DefaultAccess": "Unknown",
"AutoAssignEnabled": false,
"BackupRoutingId": "Unassigned",
"NoIncompleteItem": false,
"UiShowProvidersFirst": false,
"CurrencyTypeId": "Unknown",
"IsOffline": false,
"ContactAddresses": [],
"CustomFields": [],
"Portfolios": [],
"SlaValues": [],
"Teams": [],
"BizHours": [],
"EscalationRules": [],
"SpecDispatchRules": [],
"OnCallRules": [],
"Responsibilities": [],
"UseBizHours": false,
"UseHolidays": false,
"UseOnCall": false,
"UseEscalation": false,
"DefaultBillToLogic": 0,
"TurnKickOffAuto": false,
"TurnKickOffLagDays": 0,
"TurnKickOffOnDays": 0,
"EarliestSlot": 0,
"LatestSlot": 0,
"SlotsCount": 0,
"IsPrecalculatedSchedule": false,
"AllowTimePreference": false,
"TurnTemplateId": 0,
"IsmSpecGroupId": 0,
"IsmUrl": "",
"ExcludeNonCompliantProviders": "InheritGlobalSettings",
"IsNteAuto": true,
"IsRemoved": false,
"ConcurrencyId": 0,
"Id": 1,
"PerformDeletion": false,
"IsNew": false
},
"Dba": "2021-04-28 07-04-31",
"Instructions": "",
"TenantCode": "12345",
"TaxExempt": false,
"Spaces": [],
"Contacts": [],
"CustomFields": [],
"Notes": [],
"Addresses": [],
"Contract": {
"Id": 3,
"PerformDeletion": false,
"IsNew": false
},
"GroupsBridge": [],
"ApprovalScopes": [],
"IsRemoved": false,
"ConcurrencyId": 275,
"Id": 3,
"PerformDeletion": false,
"IsNew": false
}
}
]
}
WorkOrders by LastAction
LastAction is a special collection of data designed so that external applications can 'detect' activity in Corrigo Enterprise through regular event polling.
POST <<AM Host Name>>/api/v1/query/WorkOrder?= HTTP/1.1
CompanyName:<<Sample Company>>
Authorization: Bearer eyJBdXRoZW50aWNhdGlvblR5cGUiOiJCZWFyZXIiLCJOYW1lQ2xhaW1UeXBlIjoiaHR0cDovL3NjaGVtYXMueG1sc29hcC5vcmcvd3MvMjAwNS8wNS9pZGVudGl0eS9jbGFpbXMvbmFtZSIsIlJvbGVDbGFpbVR5cGUiOiJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9uYW1lIiwiQ2xhaW1zIjpbeyJUeXBlIjoiaHR0cDovL3NjaGVtYXMueG1sc29hcC5vcmcvd3MvMjAwNS8wNS9pZGVudGl0eS9jbGFpbXMvbmFtZSIsIlZhbHVlIjoiY2VhcGljbGllbnQuMS4xODY4LjE3Y2MiLCJWYWx1ZVR5cGUiOiJodHRwOi8vd3d3LnczLm9yZy8yMDAxL1hNTFNjaGVtYSNzdHJpbmciLCJJc3N1ZXIiOiJMT0NBTCBBVVRIT1JJVFkiLCJPcmlnaW5hbElzc3VlciI6IkxPQ0FMIEFVVEhPUklUWSJ9LHsiVHlwZSI6InVybjpvYXV0aDpzY29wZSIsIlZhbHVlIjoiIiwiVmFsdWVUeXBlIjoiaHR0cDovL3d3dy53My5vcmcvMjAwMS9YTUxTY2hlbWEjc3RyaW5nIiwiSXNzdWVyIjoiTE9DQUwgQVVUSE9SSVRZIiwiT3JpZ2luYWxJc3N1ZXIiOiJMT0NBTCBBVVRIT1JJVFkifSx7IlR5cGUiOiJBdWQiLCJWYWx1ZSI6IjE4NjgiLCJWYWx1ZVR5cGUiOiJodHRwOi8vd3d3LnczLm9yZy8yMDAxL1hNTFNjaGVtYSNzdHJpbmciLCJJc3N1ZXIiOiJMT0NBTCBBVVRIT1JJVFkiLCJPcmlnaW5hbElzc3VlciI6IkxPQ0FMIEFVVEhPUklUWSJ9XSwiUHJvcGVydGllcyI6eyJEaWN0aW9uYXJ5Ijp7Ii5pc3N1ZWQiOiJUdWUsIDAxIEZlYiAyMDIyIDE1OjE3OjEzIEdNVCIsIi5leHBpcmVzIjoiVHVlLCAwMSBGZWIgMjAyMiAxNTozNzoxMyBHTVQifX19<---->HPCu6_TzZy_e-J3pVsg_1xu5q5sDmXW-ZkzBNoPrDGA023XWV57NKaJKJs-XJvgMcPWlsswGlsEbLwy_vgLg0EH-K0hNF4yN1RyWFSKVPcI1qvy81Msq8o8tdSJPp02mRoZvU7lsJB5hGefSOmpJ8AvRY9JopzntUXvktR7iWz3dfw4D35s3oroRyfcpINfeYnrZKebDDUjWO3RDj6vp-LO89wP1DKc3VDxsMSTcnr42vRTzRY2zoLCNXiUXhhWt3MKcDCStVizclNisgSZ-QygIiPrG0XPFRTNvX6RuBIsDCbqlQKPhj4ZfeEQG5DIrFrYTtFwW3-13N92mf4oYBw
Content-Type: application/json
Content-Length: 423
{
"QueryExpression":
{
"Criteria": {
"Conditions": [
{
"PropertyName": "LastActionDateUtc",
"Operator": "GreaterOrEqual",
"Values": ["2021-11-04T17:30:00"]
}
],
"FilterOperator": "And"
},
"Distinct": true,
"PropertySet": { "Properties" : ["*"]},
"Count": 0,
"FirstResultIndex": 0
}
}
{
"Entities": [
{
"Data": {
"Number": "ZAUS0003.14",
"TypeCategory": "PMRM",
"WorkOrderCost": {
"Id": 49935,
"CurrencyTypeId": "Unknown",
"BillToType": "None",
"CostsTotal": {
"CurrencyTypeId": "Unknown",
"Value": 0.0
},
"ApStateId": "None",
"ApStatusId": 1,
"JobCode": "",
"AuthorizationCode": "",
"CheckNumber": "",
"PaymentAmount": {
"CurrencyTypeId": "Unknown",
"Value": 0.0
},
"PaymentNotes": "",
"GlAccount": "",
"Number": "",
"VendorInvoiceTotal": {
"CurrencyTypeId": "Unknown",
"Value": 0.0
},
"IsPreBilled": false,
"ExpensesTotal": {
"CurrencyTypeId": "Unknown",
"Value": 0.0
},
"BillingRule": "Unknown",
"TaxStatus": "Unknown",
"CustomerNte": {
"CurrencyTypeId": "Unknown",
"Value": 0.0
},
"Items": [],
"ServiceFeesTotal": {
"CurrencyTypeId": "Unknown",
"Value": 0.0
},
"CostStatusId": 1,
"CostState": "Pending",
"ExternalId": "",
"ConcurrencyId": 0,
"PerformDeletion": false,
"IsNew": false
},
"Priority": {
"IsEmergency": false,
"AcknowledgeInMinutes": 0,
"RespondInMinutes": 0,
"DueInMinutes": 0,
"Id": 2,
"PerformDeletion": false,
"IsNew": false
},
"StatusId": "Cancelled",
"Access": "PTE",
"MainAsset": {
"Name": "",
"ModelId": 0,
"Orphan": false,
"TypeId": "Unknown",
"ParentId": 0,
"RootId": 0,
"IsTemplate": false,
"Documents": [],
"IsOffline": false,
"IsLocked": false,
"Attributes": [],
"Id": 73568,
"PerformDeletion": false,
"IsNew": false
},
"ShortLocation": "Sydney AM Location",
"TaskRefinement": "Doors:Frame rusted",
"WorkZone": {
"DisplayAs": "",
"TimeZone": 0,
"LanguageId": 0,
"WoNumberPrefix": "",
"Entity": "",
"SchedulingWindow": 0,
"NoIncompleteProcedure": false,
"AccessOptionsMask": 0,
"Number": "",
"AdvanceNotice": 0,
"WoNumberDigits": 0,
"RoundApptTimeTo": 0,
"WorkPlanAutoCancel": false,
"WorkPlanChildResolution": false,
"WorkPlanAutoDependency": false,
"CpThemeId": 0,
"DefaultAccess": "Unknown",
"AutoAssignEnabled": false,
"BackupRoutingId": "Unassigned",
"NoIncompleteItem": false,
"UiShowProvidersFirst": false,
"CurrencyTypeId": "Unknown",
"IsOffline": false,
"ContactAddresses": [],
"CustomFields": [],
"Portfolios": [],
"SlaValues": [],
"Teams": [],
"BizHours": [],
"EscalationRules": [],
"SpecDispatchRules": [],
"OnCallRules": [],
"Responsibilities": [],
"UseBizHours": false,
"UseHolidays": false,
"UseOnCall": false,
"UseEscalation": false,
"DefaultBillToLogic": 0,
"TurnKickOffAuto": false,
"TurnKickOffLagDays": 0,
"TurnKickOffOnDays": 0,
"EarliestSlot": 0,
"LatestSlot": 0,
"SlotsCount": 0,
"IsPrecalculatedSchedule": false,
"AllowTimePreference": false,
"TurnTemplateId": 0,
"IsmSpecGroupId": 0,
"IsmUrl": "",
"ExcludeNonCompliantProviders": "InheritGlobalSettings",
"IsNteAuto": true,
"IsRemoved": false,
"ConcurrencyId": 0,
"Id": 400,
"PerformDeletion": false,
"IsNew": false
},
"Employee": {
"FirstName": "",
"LastName": "",
"DisplayAs": "",
"AccessToAllWorkZones": false,
"LanguageId": 0,
"ActorTypeId": "Unknown",
"Username": "",
"DtPwdChange": "0001-01-01T00:00:00",
"Instructions": "",
"WonMemberId": 0,
"WonLocationId": 0,
"WonServiceRadius": 0,
"IsElectronicPayment": false,
"ProviderStatusId": "NA",
"LabelId": 0,
"FreeTextAllowed": false,
"RadiusUnit": "Unknown",
"Password": "",
"Number": "",
"JobTitle": "",
"FederalId": "",
"ExternalId": "",
"ForcePasswordReset": false,
"TaxWarnOnly": false,
"PriceLists": [],
"CustomFields": [],
"BillAtZero": false,
"IsSupplier": false,
"ProviderTypeId": "Regular",
"ContactAddresses": [],
"Teams": [],
"WorkZones": [],
"Portfolios": [],
"CustomerGroups": [],
"Specialties": [],
"PayRates": [],
"StockLocations": [],
"Services": [],
"AlertSubscriptions": [],
"TaxExempt": false,
"LimitAssignmentByPortfolioId": 0,
"IsRemoved": false,
"ConcurrencyId": 0,
"Id": 2102,
"PerformDeletion": false,
"IsNew": false
},
"Duration": 0,
"VendorNte": {
"CurrencyTypeId": "AUD",
"Value": 1096.7900
},
"Specialty": {
"DisplayAs": "",
"WONServiceId": 0,
"Instructions": "",
"Currencies": [],
"IsNteAuto": true,
"IsRemoved": false,
"ConcurrencyId": 0,
"Id": 10043,
"PerformDeletion": false,
"IsNew": false
},
"PoNumber": "",
"SubType": {
"TypeId": "Unknown",
"IsDefSR": false,
"IsDefBasic": false,
"IsRemoved": false,
"ConcurrencyId": 0,
"Id": 257,
"PerformDeletion": false,
"IsNew": false
},
"Customer": {
"DisplayAs": "",
"Name": "",
"Dba": "",
"Instructions": "",
"TenantCode": "",
"TaxExempt": false,
"Spaces": [],
"Contacts": [],
"CustomFields": [],
"Notes": [],
"Addresses": [],
"GroupsBridge": [],
"ApprovalScopes": [],
"IsRemoved": false,
"ConcurrencyId": 0,
"Id": 493,
"PerformDeletion": false,
"IsNew": false
},
"ContactName": "Sydney AM Contact",
"WonId": 0,
"IsWarranty": false,
"FlagId": 0,
"TimeZone": 255,
"CurrencyTypeId": "AUD",
"LastActionDate": "2022-01-25T20:14:15.95",
"DtCreated": "2021-06-23T12:23:22",
"DtDue": "2021-06-24T12:30:00",
"DtAcknowledgeBy": "2021-06-24T00:30:00",
"AcknowledgeByUtc": "2021-06-23T14:30:00",
"LastActionDateUtc": "2022-01-25T09:14:15.95",
"CreatedDateUtc": "2021-06-23T02:23:22",
"DueDateUtc": "2021-06-24T02:30:00",
"DtOnSiteBy": "2021-06-24T00:30:00",
"DtUtcOnSiteBy": "2021-06-23T14:30:00",
"LastAction": {
"Id": 49935,
"WorkOrderId": 0,
"BillStatus": "NotBilled",
"PerformDeletion": false,
"IsNew": false
},
"Items": [],
"EquipmentWorkedOn": [],
"Notes": [],
"Assignments": [],
"Procedures": [],
"Documents": [],
"CustomFields": [],
"Verifications": [],
"CheckInOuts": [],
"ActionLogRecords": [],
"InductionAndSafetyStatusID": "NotApplicable",
"Flags": [],
"ConcurrencyId": 3,
"Id": 49935,
"PerformDeletion": false,
"IsNew": false
}
}
]
}
Employee by Number
Number is designed for use by integrated systems. Values are guaranteed unique across entire Company, Number is often populated by EIN / Badge# or other shared key.
POST <<AM Host Name>>/api/v1/query/Employee HTTP/1.1
CompanyName: <<Sample Company>>
Authorization: Bearer eyJBdXRoZW50aWNhdGlvblR5cGUiOiJCZWFyZXIiLCJOYW1lQ2xhaW1UeXBlIjoiaHR0cDovL3NjaGVtYXMueG1sc29hcC5vcmcvd3MvMjAwNS8wNS9pZGVudGl0eS9jbGFpbXMvbmFtZSIsIlJvbGVDbGFpbVR5cGUiOiJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9uYW1lIiwiQ2xhaW1zIjpbeyJUeXBlIjoiaHR0cDovL3NjaGVtYXMueG1sc29hcC5vcmcvd3MvMjAwNS8wNS9pZGVudGl0eS9jbGFpbXMvbmFtZSIsIlZhbHVlIjoiY2VhcGljbGllbnQuMS4xODY4LmNjMTYiLCJWYWx1ZVR5cGUiOiJodHRwOi8vd3d3LnczLm9yZy8yMDAxL1hNTFNjaGVtYSNzdHJpbmciLCJJc3N1ZXIiOiJMT0NBTCBBVVRIT1JJVFkiLCJPcmlnaW5hbElzc3VlciI6IkxPQ0FMIEFVVEhPUklUWSJ9LHsiVHlwZSI6InVybjpvYXV0aDpzY29wZSIsIlZhbHVlIjoiIiwiVmFsdWVUeXBlIjoiaHR0cDovL3d3dy53My5vcmcvMjAwMS9YTUxTY2hlbWEjc3RyaW5nIiwiSXNzdWVyIjoiTE9DQUwgQVVUSE9SSVRZIiwiT3JpZ2luYWxJc3N1ZXIiOiJMT0NBTCBBVVRIT1JJVFkifSx7IlR5cGUiOiJBdWQiLCJWYWx1ZSI6IjE4NjgiLCJWYWx1ZVR5cGUiOiJodHRwOi8vd3d3LnczLm9yZy8yMDAxL1hNTFNjaGVtYSNzdHJpbmciLCJJc3N1ZXIiOiJMT0NBTCBBVVRIT1JJVFkiLCJPcmlnaW5hbElzc3VlciI6IkxPQ0FMIEFVVEhPUklUWSJ9XSwiUHJvcGVydGllcyI6eyJEaWN0aW9uYXJ5Ijp7Ii5pc3N1ZWQiOiJUaHUsIDIzIERlYyAyMDIxIDE0OjMzOjQ2IEdNVCIsIi5leHBpcmVzIjoiVGh1LCAyMyBEZWMgMjAyMSAxNDo1Mzo0NiBHTVQifX19<---->KcfRu_iJKtxBRDsZwEX8sKmDwzjqWPWy_T8ZExJ6uSEWFMXiC816nQJh6vhNH7Ph7YncHvT0jBC5jfrStDC51XhCG4LUhTRv4mEk8R9J7MT02KCN72BWf498AfJu0Nrd1HqNndScYPxBEtLn-x3szzzqwpf2zknHn_YHcjw-2Z7862n4bhPQ7WKpxVjnEnS6qnaxeQGlRGuvDClIDumdq8pWZcWOaSkEnnHHPCtMT8NQVQflx9M1p2npkpawu9qjgjzNlAdNSLUKpWiy2heL-LJjviVh_76aObNJln_MWBImruD1Drrhp5UHJ9JX_Vqaec6QqgP6ZMhBeMFW11VEVw
Content-Type: application/json
Content-Length: 381
{
"QueryExpression":
{
"Criteria": {
"Conditions": [
{
"PropertyName": "Number",
"Operator": "Equal",
"Values": ["00-343221"]
}
],
"FilterOperator": "And"
},
"Distinct": true,
"PropertySet": { "Properties" : ["*"]},
"Count": 0,
"FirstResultIndex": 0
}
}
{
"Entities": [
{
"Data": {
"FirstName": "System",
"LastName": "Administrator",
"DisplayAs": "System Administrator",
"Role": {
"DisplayAs": "",
"Rank": 0,
"UnlimitedNte": false,
"SsoLoginOnly": false,
"Currencies": [],
"IsIsmRequired": false,
"ConcurrencyId": 0,
"Id": 1,
"PerformDeletion": false,
"IsNew": false
},
"AccessToAllWorkZones": true,
"LanguageId": 1033,
"ActorTypeId": "Employee",
"Username": "SysAdmin",
"DtPwdChange": "2021-11-28T00:00:00",
"Instructions": "",
"WonMemberId": 0,
"WonLocationId": 0,
"WonServiceRadius": 0,
"IsElectronicPayment": false,
"ProviderStatusId": "NA",
"LabelId": 0,
"FreeTextAllowed": true,
"RadiusUnit": "Mile",
"Password": "",
"Number": "",
"JobTitle": "",
"FederalId": "",
"ExternalId": "",
"ForcePasswordReset": false,
"TaxWarnOnly": false,
"PriceLists": [],
"CustomFields": [],
"BillAtZero": false,
"IsSupplier": false,
"ProviderTypeId": "Regular",
"ContactAddresses": [],
"Teams": [],
"WorkZones": [],
"Portfolios": [],
"CustomerGroups": [],
"Specialties": [],
"PayRates": [],
"StockLocations": [],
"Services": [],
"AlertSubscriptions": [],
"TaxExempt": false,
"LimitAssignmentByPortfolioId": 0,
"IsRemoved": false,
"ConcurrencyId": 38,
"Id": 1,
"PerformDeletion": false,
"IsNew": false
}
}
]
}