Create Service Call
post
https://server:port/rest/apis/asset/work/serviceCalls/
This operation is used to create a new service call based on the information provided in the request. The service call system generated ID can be used to get additional details about the service call and its related work documents and if needed, to request the cancelation of the service call.
Request
There are no request parameters for this operation.
Supported Media Types
- application/xml
- application/json
Root Schema : schema
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
Allowed Values:
[ "W1NO", "W1YS" ]
Indicates if the customer expects a callback from the utility. * `W1NO` - No, * `W1YS` - YesExample: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
-
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
-
detailedDescription: string
Maximum Length:
4000
Additional information about the service call.Example:New electric service - customer requesting a meter read
-
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.
-
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
-
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
-
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
-
serviceCallExternalId: string
Maximum Length:
60
The external system's unique identifier for the service call.Example:SR202200001
-
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
-
state: string
Maximum Length:
6
The state of the service call address.Example:IL
-
suburb: string
Maximum Length:
64
The suburb of the service call address.Example:Peoria Metropolitan
Root Schema : schema
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
Allowed Values:
[ "W1NO", "W1YS" ]
Indicates if the customer expects a callback from the utility. * `W1NO` - No, * `W1YS` - YesExample: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
-
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
-
detailedDescription: string
Maximum Length:
4000
Additional information about the service call.Example:New electric service - customer requesting a meter read
-
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.
-
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
-
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
-
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
-
serviceCallExternalId: string
Maximum Length:
60
The external system's unique identifier for the service call.Example:SR202200001
-
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
-
state: string
Maximum Length:
6
The state of the service call address.Example:IL
-
suburb: string
Maximum Length:
64
The suburb of the service call address.Example:Peoria Metropolitan
Response
Supported Media Types
- application/xml
- application/json
200 Response
Success response
Root Schema : W1CreSvcCall
Type:
Show Source
object
-
_self: string
_self
-
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
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.