Service Call Search
post
https://server:port/rest/apis/asset/work/serviceCalls/search
This operation is used to find service calls matching specific input filters.
Request
Query Parameters
Supported Media Types
- application/xml
- application/json
Root Schema : schema
Type:
Show Source
object
-
activeOnly: boolean
Indicates whether to limit the search to active service calls only.Example:
false
-
address: string
Maximum Length:
254
The first line of the service call address.Example:800 Rosewood Ave
-
city: string
Maximum Length:
90
The city of the service call address.Example:North Canton
-
creationFromDateTime: string
(date-time)
The start of the 'creation date time' search filter. Service calls created within the given start and end date times are returned.Example:
2022-06-01T01:01:07.033Z
-
creationToDateTime: string
(date-time)
The end of the 'creation date time' search filter. Service calls created within the given start and end date times are returned.Example:
2022-06-20T20:10:30.652Z
-
description: string
Maximum Length:
100
Short description about the service call.Example:New Electric Service
-
firstName: string
Maximum Length:
254
The first name of the contact person.Example:Robert
-
lastName: string
Maximum Length:
254
The last name of the contact person.Example:Brown
-
locations: array
locations
-
phoneNumber: string
Maximum Length:
24
The phone number (either primary, home or mobile) of the contact person.Example:330-532-9834
-
postal: string
Maximum Length:
12
The zip code of the service call address.Example:61520
-
serviceCallExternalId: string
Maximum Length:
60
The external system's unique identifier for the service call.Example:SR202200001
-
serviceCallId: string
Maximum Length:
14
The system-generated unique identifier for the service call.Example:20124908366206
-
serviceCallNumber: string
Maximum Length:
14
The alternative unique identifier for the service call.Example:20220000001209
-
serviceCategory: string
Maximum Length:
30
Service category represents a broad grouping of services provided by the company.Example:CM_ElectricService
-
serviceCode: string
Maximum Length:
30
Service code is used to assign actions corresponding to the service call received.Example:CM_MeterRead
Nested Schema : items
Type:
Show Source
object
-
locationExternalId: string
Maximum Length:
60
The external system's unique identifier for the asset location.Example:300000354678942
-
locationId: string
Maximum Length:
12
The system-generated unique identifier for the asset location associated to the service call.Example:958486684159
Root Schema : schema
Type:
Show Source
object
-
activeOnly: boolean
Indicates whether to limit the search to active service calls only.Example:
false
-
address: string
Maximum Length:
254
The first line of the service call address.Example:800 Rosewood Ave
-
city: string
Maximum Length:
90
The city of the service call address.Example:North Canton
-
creationFromDateTime: string
(date-time)
The start of the 'creation date time' search filter. Service calls created within the given start and end date times are returned.Example:
2022-06-01T01:01:07.033Z
-
creationToDateTime: string
(date-time)
The end of the 'creation date time' search filter. Service calls created within the given start and end date times are returned.Example:
2022-06-20T20:10:30.652Z
-
description: string
Maximum Length:
100
Short description about the service call.Example:New Electric Service
-
firstName: string
Maximum Length:
254
The first name of the contact person.Example:Robert
-
lastName: string
Maximum Length:
254
The last name of the contact person.Example:Brown
-
locations: array
locations
-
phoneNumber: string
Maximum Length:
24
The phone number (either primary, home or mobile) of the contact person.Example:330-532-9834
-
postal: string
Maximum Length:
12
The zip code of the service call address.Example:61520
-
serviceCallExternalId: string
Maximum Length:
60
The external system's unique identifier for the service call.Example:SR202200001
-
serviceCallId: string
Maximum Length:
14
The system-generated unique identifier for the service call.Example:20124908366206
-
serviceCallNumber: string
Maximum Length:
14
The alternative unique identifier for the service call.Example:20220000001209
-
serviceCategory: string
Maximum Length:
30
Service category represents a broad grouping of services provided by the company.Example:CM_ElectricService
-
serviceCode: string
Maximum Length:
30
Service code is used to assign actions corresponding to the service call received.Example:CM_MeterRead
Nested Schema : items
Type:
Show Source
object
-
locationExternalId: string
Maximum Length:
60
The external system's unique identifier for the asset location.Example:300000354678942
-
locationId: string
Maximum Length:
12
The system-generated unique identifier for the asset location associated to the service call.Example:958486684159
Response
Supported Media Types
- application/xml
- application/json
200 Response
Success response
Root Schema : W1RETSVCCALL
Type:
Show Source
object
-
count: number
Minimum Value:
0
Maximum Value:99999
The number of service calls returned by the search.Example:1
-
serviceCalls: array
serviceCalls
Nested Schema : items
Type:
Show Source
object
-
address1: string
Maximum Length:
254
The first line of the service call address.Example:800 Rosewood Ave
-
address2: string
Maximum Length:
254
The second line of the service call address.Example:Suite 101
-
address3: string
Maximum Length:
254
The third line of the service call address. -
address4: string
Maximum Length:
254
The fourth line of the service call address. -
callbackRequired: string
Maximum Length:
4
Indicates if the customer expects a callback from the utility.Example:W1YS
-
city: string
Maximum Length:
90
The city of the service call address.Example:North Canton
-
country: string
Maximum Length:
3
The country of the service call address.Example:USA
-
county: string
Maximum Length:
90
The county of the service call address.Example:Fulton
-
creationDateTime: string
(date-time)
The creation date and time of the service call.Example:
2022-06-05T10:30:49-07:00
-
crossStreet: string
Maximum Length:
64
The major intersection of the service call address.Example:Rosewood and Main
-
description: string
Maximum Length:
100
Short description about the service call.Example:New Electric Service
-
firstName: string
Maximum Length:
254
The first name of the contact person.Example:Robert
-
geographicCode: string
Maximum Length:
11
The geographic code of the service call address. -
homePhone: string
Maximum Length:
24
The home phone number of the contact person.Example:330-532-9834
-
houseType: string
Allowed Values:
[ "AP ", "CM " ]
The property type of the service call address. * `AP ` - Apartment, * `CM ` - CondominiumExample:AP
-
inCityLimit: boolean
Indicates if the service call address is within the city boundary.
-
isActive: boolean
Indicates whether the service call is active or not.Example:
true
-
lastName: string
Maximum Length:
254
The last name of the contact person.Example:Brown
-
latitude: number
Minimum Value:
0
Maximum Value:9.99999999999999E8
The latitude coordinate of the service call address.Example:40.558270
-
longitude: number
Minimum Value:
-9.99999999999999E8
Maximum Value:9.99999999999999E8
The longitude coordinate of the service call address.Example:-90.035090
-
mobilePhone: string
Maximum Length:
24
The mobile phone number of the contact person.Example:330-532-9834
-
number1: string
Maximum Length:
6
Address number 1 of the service call address. -
number2: string
Maximum Length:
4
Address number 2 of the service call address. -
postal: string
Maximum Length:
12
The zip code of the service call address.Example:61520
-
primaryPhone: string
Maximum Length:
24
The primary phone number of the contact person.Example:330-532-9834
-
requiredByDate: string
(date)
The date when the work needs to be completed.Example:
2022-06-10
-
serviceCall: object
serviceCall
-
serviceCallExternalId: string
Maximum Length:
60
The external system's unique identifier for the service call.Example:SR202200001
-
serviceCallNumber: string
Maximum Length:
14
The alternative unique identifier for the service call.Example:20220000001209
-
serviceCategory: object
serviceCategory
Service category represents a broad grouping of services provided by the company.
-
serviceCode: object
serviceCode
Service code is used to assign actions corresponding to the service call received.
-
state: string
Maximum Length:
6
The state of the service call address.Example:IL
-
status: string
Maximum Length:
60
The current status of the service call.Example:Processed
-
suburb: string
Maximum Length:
64
The suburb of the service call address.Example:Peoria Metropolitan
Nested Schema : serviceCall
Type:
Show Source
object
-
_link: string
_link
-
serviceCallId: string
Maximum Length:
14
The system-generated unique identifier for the service call.Example:20124908366206
Nested Schema : serviceCategory
Type:
object
Service category represents a broad grouping of services provided by the company.
Show Source
-
_link: string
_link
-
serviceCategory: string
Maximum Length:
30
Service category represents a broad grouping of services provided by the company.Example:CM_ElectricService
Nested Schema : serviceCode
Type:
object
Service code is used to assign actions corresponding to the service call received.
Show Source
-
_link: string
_link
-
serviceCode: string
Maximum Length:
30
Service code is used to assign actions corresponding to the service call received.Example:CM_MeterRead
400 Response
Bad Request
Root Schema : problemDetailDocument
Type:
Show Source
object
-
detail: string
Maximum Length:
60
The long message description from the Oracle Utilities Application Framework in CDATA format. -
httpStatus: number
Minimum Value:
0
Maximum Value:9999
The HTTP Status code for the error. -
problemInstance: string
Maximum Length:
60
Fully qualified URL consisting of the Base URI Timestamp of error in ISO format, the User used for the transaction, the Message Category within Oracle Utilities Application Framework, the Message Number within Oracle Utilities Application Framework, the Request URL and the HTTP method used for the transaction. -
problemType: string
Maximum Length:
60
URL of the format "A/message/X/Y" where A is the base URI, X is the Message Category and Y is the Message Number within Oracle Utilities Application Framework. -
serverMessage: object
serverMessage
-
stackTrace: string
Maximum Length:
60
The stack trace shows where the error occurs during the execution of a program. -
title: string
Maximum Length:
60
Fully qualified error message from Oracle Utilities Application Framework in CDATA format.
Nested Schema : serverMessage
Type:
Show Source
object
-
callSequence: string
Maximum Length:
60
Delimited sequence of programs called. -
longDescription: string
Maximum Length:
60
The long message description from the Oracle Utilities Application Framework in CDATA format. -
messageCategory: number
Minimum Value:
0
Maximum Value:0
Message Category within Oracle Utilities Application Framework. -
messageNbr: number
Minimum Value:
-99999
Maximum Value:99999
Message Number within Oracle Utilities Application Framework. -
messageText: string
Maximum Length:
60
Fully qualified error message from Oracle Utilities Application Framework in CDATA format. -
programName: string
Maximum Length:
60
Name of the program that encountered the error.
500 Response
Internal Server Error
Root Schema : problemDetailDocument
Type:
Show Source
object
-
detail: string
Maximum Length:
60
The long message description from the Oracle Utilities Application Framework in CDATA format. -
httpStatus: number
Minimum Value:
0
Maximum Value:9999
The HTTP Status code for the error. -
problemInstance: string
Maximum Length:
60
Fully qualified URL consisting of the Base URI Timestamp of error in ISO format, the User used for the transaction, the Message Category within Oracle Utilities Application Framework, the Message Number within Oracle Utilities Application Framework, the Request URL and the HTTP method used for the transaction. -
problemType: string
Maximum Length:
60
URL of the format "A/message/X/Y" where A is the base URI, X is the Message Category and Y is the Message Number within Oracle Utilities Application Framework. -
serverMessage: object
serverMessage
-
stackTrace: string
Maximum Length:
60
The stack trace shows where the error occurs during the execution of a program. -
title: string
Maximum Length:
60
Fully qualified error message from Oracle Utilities Application Framework in CDATA format.
Nested Schema : serverMessage
Type:
Show Source
object
-
callSequence: string
Maximum Length:
60
Delimited sequence of programs called. -
longDescription: string
Maximum Length:
60
The long message description from the Oracle Utilities Application Framework in CDATA format. -
messageCategory: number
Minimum Value:
0
Maximum Value:0
Message Category within Oracle Utilities Application Framework. -
messageNbr: number
Minimum Value:
-99999
Maximum Value:99999
Message Number within Oracle Utilities Application Framework. -
messageText: string
Maximum Length:
60
Fully qualified error message from Oracle Utilities Application Framework in CDATA format. -
programName: string
Maximum Length:
60
Name of the program that encountered the error.