Oracle Utilities REST API for Work and Asset

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

limit: number

Supported Media Types

application/xml
application/json

Root Schema : schema

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "serviceCallNumber":{
            "type":"string",
            "maxLength":14,
            "description":"The alternative unique identifier for the service call.",
            "example":"20220000001209"
        },
        "serviceCallId":{
            "type":"string",
            "maxLength":14,
            "description":"The system-generated unique identifier for the service call.",
            "example":"20124908366206"
        },
        "serviceCallExternalId":{
            "type":"string",
            "maxLength":60,
            "description":"The external system's unique identifier for the service call.",
            "example":"SR202200001"
        },
        "description":{
            "type":"string",
            "maxLength":100,
            "description":"Short description about the service call.",
            "example":"New Electric Service"
        },
        "serviceCategory":{
            "type":"string",
            "maxLength":30,
            "description":"Service category represents a broad grouping of services provided by the company.",
            "example":"CM_ElectricService"
        },
        "serviceCode":{
            "type":"string",
            "maxLength":30,
            "description":"Service code is used to assign actions corresponding to the service call received.",
            "example":"CM_MeterRead"
        },
        "firstName":{
            "type":"string",
            "maxLength":254,
            "description":"The first name of the contact person.",
            "example":"Robert"
        },
        "lastName":{
            "type":"string",
            "maxLength":254,
            "description":"The last name of the contact person.",
            "example":"Brown"
        },
        "phoneNumber":{
            "type":"string",
            "maxLength":24,
            "description":"The phone number (either primary, home or mobile) of the contact person.",
            "example":"330-532-9834"
        },
        "locations":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "locationId":{
                        "type":"string",
                        "maxLength":12,
                        "description":"The system-generated unique identifier for the asset location associated to the service call.",
                        "example":"958486684159"
                    },
                    "locationExternalId":{
                        "type":"string",
                        "maxLength":60,
                        "description":"The external system's unique identifier for the asset location.",
                        "example":"300000354678942"
                    }
                }
            }
        },
        "address":{
            "type":"string",
            "maxLength":254,
            "description":"The first line of the service call address.",
            "example":"800 Rosewood Ave"
        },
        "city":{
            "type":"string",
            "maxLength":90,
            "description":"The city of the service call address.",
            "example":"North Canton"
        },
        "postal":{
            "type":"string",
            "maxLength":12,
            "description":"The zip code of the service call address.",
            "example":"61520"
        },
        "creationFromDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"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":{
            "type":"string",
            "format":"date-time",
            "description":"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"
        },
        "activeOnly":{
            "type":"boolean",
            "description":"Indicates whether to limit the search to active service calls only.",
            "example":"false"
        }
    },
    "xml":{
        "name":"W1RETSVCCALL"
    }
}

Nested Schema : locations

Type: array

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "locationId":{
                "type":"string",
                "maxLength":12,
                "description":"The system-generated unique identifier for the asset location associated to the service call.",
                "example":"958486684159"
            },
            "locationExternalId":{
                "type":"string",
                "maxLength":60,
                "description":"The external system's unique identifier for the asset location.",
                "example":"300000354678942"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "locationId":{
            "type":"string",
            "maxLength":12,
            "description":"The system-generated unique identifier for the asset location associated to the service call.",
            "example":"958486684159"
        },
        "locationExternalId":{
            "type":"string",
            "maxLength":60,
            "description":"The external system's unique identifier for the asset location.",
            "example":"300000354678942"
        }
    }
}

Root Schema : schema

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "serviceCallNumber":{
            "type":"string",
            "maxLength":14,
            "description":"The alternative unique identifier for the service call.",
            "example":"20220000001209"
        },
        "serviceCallId":{
            "type":"string",
            "maxLength":14,
            "description":"The system-generated unique identifier for the service call.",
            "example":"20124908366206"
        },
        "serviceCallExternalId":{
            "type":"string",
            "maxLength":60,
            "description":"The external system's unique identifier for the service call.",
            "example":"SR202200001"
        },
        "description":{
            "type":"string",
            "maxLength":100,
            "description":"Short description about the service call.",
            "example":"New Electric Service"
        },
        "serviceCategory":{
            "type":"string",
            "maxLength":30,
            "description":"Service category represents a broad grouping of services provided by the company.",
            "example":"CM_ElectricService"
        },
        "serviceCode":{
            "type":"string",
            "maxLength":30,
            "description":"Service code is used to assign actions corresponding to the service call received.",
            "example":"CM_MeterRead"
        },
        "firstName":{
            "type":"string",
            "maxLength":254,
            "description":"The first name of the contact person.",
            "example":"Robert"
        },
        "lastName":{
            "type":"string",
            "maxLength":254,
            "description":"The last name of the contact person.",
            "example":"Brown"
        },
        "phoneNumber":{
            "type":"string",
            "maxLength":24,
            "description":"The phone number (either primary, home or mobile) of the contact person.",
            "example":"330-532-9834"
        },
        "locations":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "locationId":{
                        "type":"string",
                        "maxLength":12,
                        "description":"The system-generated unique identifier for the asset location associated to the service call.",
                        "example":"958486684159"
                    },
                    "locationExternalId":{
                        "type":"string",
                        "maxLength":60,
                        "description":"The external system's unique identifier for the asset location.",
                        "example":"300000354678942"
                    }
                }
            }
        },
        "address":{
            "type":"string",
            "maxLength":254,
            "description":"The first line of the service call address.",
            "example":"800 Rosewood Ave"
        },
        "city":{
            "type":"string",
            "maxLength":90,
            "description":"The city of the service call address.",
            "example":"North Canton"
        },
        "postal":{
            "type":"string",
            "maxLength":12,
            "description":"The zip code of the service call address.",
            "example":"61520"
        },
        "creationFromDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"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":{
            "type":"string",
            "format":"date-time",
            "description":"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"
        },
        "activeOnly":{
            "type":"boolean",
            "description":"Indicates whether to limit the search to active service calls only.",
            "example":"false"
        }
    },
    "xml":{
        "name":"W1RETSVCCALL"
    }
}

Nested Schema : locations

Type: array

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "locationId":{
                "type":"string",
                "maxLength":12,
                "description":"The system-generated unique identifier for the asset location associated to the service call.",
                "example":"958486684159"
            },
            "locationExternalId":{
                "type":"string",
                "maxLength":60,
                "description":"The external system's unique identifier for the asset location.",
                "example":"300000354678942"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "locationId":{
            "type":"string",
            "maxLength":12,
            "description":"The system-generated unique identifier for the asset location associated to the service call.",
            "example":"958486684159"
        },
        "locationExternalId":{
            "type":"string",
            "maxLength":60,
            "description":"The external system's unique identifier for the asset location.",
            "example":"300000354678942"
        }
    }
}

Response

Supported Media Types

application/xml
application/json

200 Response

Success response

Root Schema : W1RETSVCCALL

Type: object

Show Source

count: number

Minimum Value: 0

Maximum Value: 99999

The number of service calls returned by the search.

Example: 1
serviceCalls: array serviceCalls

{
    "type":"object",
    "properties":{
        "count":{
            "type":"number",
            "maximum":99999,
            "minimum":0,
            "description":"The number of service calls returned by the search.",
            "example":"1"
        },
        "serviceCalls":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "serviceCallNumber":{
                        "type":"string",
                        "maxLength":14,
                        "description":"The alternative unique identifier for the service call.",
                        "example":"20220000001209"
                    },
                    "serviceCall":{
                        "type":"object",
                        "properties":{
                            "_link":{
                                "type":"string",
                                "description":"_link"
                            },
                            "serviceCallId":{
                                "type":"string",
                                "maxLength":14,
                                "description":"The system-generated unique identifier for the service call.",
                                "example":"20124908366206"
                            }
                        }
                    },
                    "serviceCallExternalId":{
                        "type":"string",
                        "maxLength":60,
                        "description":"The external system's unique identifier for the service call.",
                        "example":"SR202200001"
                    },
                    "creationDateTime":{
                        "type":"string",
                        "format":"date-time",
                        "description":"The creation date and time of the service call.",
                        "example":"2022-06-05T10:30:49-07:00"
                    },
                    "description":{
                        "type":"string",
                        "maxLength":100,
                        "description":"Short description about the service call.",
                        "example":"New Electric Service"
                    },
                    "serviceCategory":{
                        "type":"object",
                        "description":"Service category represents a broad grouping of services provided by the company.",
                        "properties":{
                            "_link":{
                                "type":"string",
                                "description":"_link"
                            },
                            "serviceCategory":{
                                "type":"string",
                                "maxLength":30,
                                "description":"Service category represents a broad grouping of services provided by the company.",
                                "example":"CM_ElectricService"
                            }
                        }
                    },
                    "serviceCode":{
                        "type":"object",
                        "description":"Service code is used to assign actions corresponding to the service call received.",
                        "properties":{
                            "_link":{
                                "type":"string",
                                "description":"_link"
                            },
                            "serviceCode":{
                                "type":"string",
                                "maxLength":30,
                                "description":"Service code is used to assign actions corresponding to the service call received.",
                                "example":"CM_MeterRead"
                            }
                        }
                    },
                    "status":{
                        "type":"string",
                        "maxLength":60,
                        "description":"The current status of the service call.",
                        "example":"Processed"
                    },
                    "firstName":{
                        "type":"string",
                        "maxLength":254,
                        "description":"The first name of the contact person.",
                        "example":"Robert"
                    },
                    "lastName":{
                        "type":"string",
                        "maxLength":254,
                        "description":"The last name of the contact person.",
                        "example":"Brown"
                    },
                    "primaryPhone":{
                        "type":"string",
                        "maxLength":24,
                        "description":"The primary phone number of the contact person.",
                        "example":"330-532-9834"
                    },
                    "homePhone":{
                        "type":"string",
                        "maxLength":24,
                        "description":"The home phone number of the contact person.",
                        "example":"330-532-9834"
                    },
                    "mobilePhone":{
                        "type":"string",
                        "maxLength":24,
                        "description":"The mobile phone number of the contact person.",
                        "example":"330-532-9834"
                    },
                    "requiredByDate":{
                        "type":"string",
                        "format":"date",
                        "description":"The date when the work needs to be completed.",
                        "example":"2022-06-10"
                    },
                    "callbackRequired":{
                        "type":"string",
                        "maxLength":4,
                        "description":"Indicates if the customer expects a callback from the utility.",
                        "example":"W1YS"
                    },
                    "address1":{
                        "type":"string",
                        "maxLength":254,
                        "description":"The first line of the service call address.",
                        "example":"800 Rosewood Ave"
                    },
                    "address2":{
                        "type":"string",
                        "maxLength":254,
                        "description":"The second line of the service call address.",
                        "example":"Suite 101"
                    },
                    "address3":{
                        "type":"string",
                        "maxLength":254,
                        "description":"The third line of the service call address."
                    },
                    "address4":{
                        "type":"string",
                        "maxLength":254,
                        "description":"The fourth line of the service call address."
                    },
                    "crossStreet":{
                        "type":"string",
                        "maxLength":64,
                        "description":"The major intersection of the service call address.",
                        "example":"Rosewood and Main"
                    },
                    "houseType":{
                        "type":"string",
                        "enum":[
                            "AP  ",
                            "CM  "
                        ],
                        "description":"The property type of the service call address.\n* `AP  ` - Apartment,\n* `CM  ` - Condominium",
                        "example":"AP"
                    },
                    "number1":{
                        "type":"string",
                        "maxLength":6,
                        "description":"Address number 1 of the service call address."
                    },
                    "number2":{
                        "type":"string",
                        "maxLength":4,
                        "description":"Address number 2 of the service call address."
                    },
                    "geographicCode":{
                        "type":"string",
                        "maxLength":11,
                        "description":"The geographic code of the service call address."
                    },
                    "inCityLimit":{
                        "type":"boolean",
                        "description":"Indicates if the service call address is within the city boundary."
                    },
                    "city":{
                        "type":"string",
                        "maxLength":90,
                        "description":"The city of the service call address.",
                        "example":"North Canton"
                    },
                    "suburb":{
                        "type":"string",
                        "maxLength":64,
                        "description":"The suburb of the service call address.",
                        "example":"Peoria Metropolitan"
                    },
                    "county":{
                        "type":"string",
                        "maxLength":90,
                        "description":"The county of the service call address.",
                        "example":"Fulton"
                    },
                    "state":{
                        "type":"string",
                        "maxLength":6,
                        "description":"The state of the service call address.",
                        "example":"IL"
                    },
                    "postal":{
                        "type":"string",
                        "maxLength":12,
                        "description":"The zip code of the service call address.",
                        "example":"61520"
                    },
                    "country":{
                        "type":"string",
                        "maxLength":3,
                        "description":"The country of the service call address.",
                        "example":"USA"
                    },
                    "latitude":{
                        "type":"number",
                        "maximum":9.99999999999999E8,
                        "minimum":0,
                        "description":"The latitude coordinate of the service call address.",
                        "example":"40.558270"
                    },
                    "longitude":{
                        "type":"number",
                        "maximum":9.99999999999999E8,
                        "minimum":-9.99999999999999E8,
                        "description":"The longitude coordinate of the service call address.",
                        "example":"-90.035090"
                    },
                    "isActive":{
                        "type":"boolean",
                        "description":"Indicates whether the service call is active or not.",
                        "example":"true"
                    }
                }
            }
        }
    },
    "xml":{
        "name":"W1RETSVCCALL"
    }
}

Nested Schema : serviceCalls

Type: array

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "serviceCallNumber":{
                "type":"string",
                "maxLength":14,
                "description":"The alternative unique identifier for the service call.",
                "example":"20220000001209"
            },
            "serviceCall":{
                "type":"object",
                "properties":{
                    "_link":{
                        "type":"string",
                        "description":"_link"
                    },
                    "serviceCallId":{
                        "type":"string",
                        "maxLength":14,
                        "description":"The system-generated unique identifier for the service call.",
                        "example":"20124908366206"
                    }
                }
            },
            "serviceCallExternalId":{
                "type":"string",
                "maxLength":60,
                "description":"The external system's unique identifier for the service call.",
                "example":"SR202200001"
            },
            "creationDateTime":{
                "type":"string",
                "format":"date-time",
                "description":"The creation date and time of the service call.",
                "example":"2022-06-05T10:30:49-07:00"
            },
            "description":{
                "type":"string",
                "maxLength":100,
                "description":"Short description about the service call.",
                "example":"New Electric Service"
            },
            "serviceCategory":{
                "type":"object",
                "description":"Service category represents a broad grouping of services provided by the company.",
                "properties":{
                    "_link":{
                        "type":"string",
                        "description":"_link"
                    },
                    "serviceCategory":{
                        "type":"string",
                        "maxLength":30,
                        "description":"Service category represents a broad grouping of services provided by the company.",
                        "example":"CM_ElectricService"
                    }
                }
            },
            "serviceCode":{
                "type":"object",
                "description":"Service code is used to assign actions corresponding to the service call received.",
                "properties":{
                    "_link":{
                        "type":"string",
                        "description":"_link"
                    },
                    "serviceCode":{
                        "type":"string",
                        "maxLength":30,
                        "description":"Service code is used to assign actions corresponding to the service call received.",
                        "example":"CM_MeterRead"
                    }
                }
            },
            "status":{
                "type":"string",
                "maxLength":60,
                "description":"The current status of the service call.",
                "example":"Processed"
            },
            "firstName":{
                "type":"string",
                "maxLength":254,
                "description":"The first name of the contact person.",
                "example":"Robert"
            },
            "lastName":{
                "type":"string",
                "maxLength":254,
                "description":"The last name of the contact person.",
                "example":"Brown"
            },
            "primaryPhone":{
                "type":"string",
                "maxLength":24,
                "description":"The primary phone number of the contact person.",
                "example":"330-532-9834"
            },
            "homePhone":{
                "type":"string",
                "maxLength":24,
                "description":"The home phone number of the contact person.",
                "example":"330-532-9834"
            },
            "mobilePhone":{
                "type":"string",
                "maxLength":24,
                "description":"The mobile phone number of the contact person.",
                "example":"330-532-9834"
            },
            "requiredByDate":{
                "type":"string",
                "format":"date",
                "description":"The date when the work needs to be completed.",
                "example":"2022-06-10"
            },
            "callbackRequired":{
                "type":"string",
                "maxLength":4,
                "description":"Indicates if the customer expects a callback from the utility.",
                "example":"W1YS"
            },
            "address1":{
                "type":"string",
                "maxLength":254,
                "description":"The first line of the service call address.",
                "example":"800 Rosewood Ave"
            },
            "address2":{
                "type":"string",
                "maxLength":254,
                "description":"The second line of the service call address.",
                "example":"Suite 101"
            },
            "address3":{
                "type":"string",
                "maxLength":254,
                "description":"The third line of the service call address."
            },
            "address4":{
                "type":"string",
                "maxLength":254,
                "description":"The fourth line of the service call address."
            },
            "crossStreet":{
                "type":"string",
                "maxLength":64,
                "description":"The major intersection of the service call address.",
                "example":"Rosewood and Main"
            },
            "houseType":{
                "type":"string",
                "enum":[
                    "AP  ",
                    "CM  "
                ],
                "description":"The property type of the service call address.\n* `AP  ` - Apartment,\n* `CM  ` - Condominium",
                "example":"AP"
            },
            "number1":{
                "type":"string",
                "maxLength":6,
                "description":"Address number 1 of the service call address."
            },
            "number2":{
                "type":"string",
                "maxLength":4,
                "description":"Address number 2 of the service call address."
            },
            "geographicCode":{
                "type":"string",
                "maxLength":11,
                "description":"The geographic code of the service call address."
            },
            "inCityLimit":{
                "type":"boolean",
                "description":"Indicates if the service call address is within the city boundary."
            },
            "city":{
                "type":"string",
                "maxLength":90,
                "description":"The city of the service call address.",
                "example":"North Canton"
            },
            "suburb":{
                "type":"string",
                "maxLength":64,
                "description":"The suburb of the service call address.",
                "example":"Peoria Metropolitan"
            },
            "county":{
                "type":"string",
                "maxLength":90,
                "description":"The county of the service call address.",
                "example":"Fulton"
            },
            "state":{
                "type":"string",
                "maxLength":6,
                "description":"The state of the service call address.",
                "example":"IL"
            },
            "postal":{
                "type":"string",
                "maxLength":12,
                "description":"The zip code of the service call address.",
                "example":"61520"
            },
            "country":{
                "type":"string",
                "maxLength":3,
                "description":"The country of the service call address.",
                "example":"USA"
            },
            "latitude":{
                "type":"number",
                "maximum":9.99999999999999E8,
                "minimum":0,
                "description":"The latitude coordinate of the service call address.",
                "example":"40.558270"
            },
            "longitude":{
                "type":"number",
                "maximum":9.99999999999999E8,
                "minimum":-9.99999999999999E8,
                "description":"The longitude coordinate of the service call address.",
                "example":"-90.035090"
            },
            "isActive":{
                "type":"boolean",
                "description":"Indicates whether the service call is active or not.",
                "example":"true"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

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 ` - Condominium

Example: 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

{
    "type":"object",
    "properties":{
        "serviceCallNumber":{
            "type":"string",
            "maxLength":14,
            "description":"The alternative unique identifier for the service call.",
            "example":"20220000001209"
        },
        "serviceCall":{
            "type":"object",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "serviceCallId":{
                    "type":"string",
                    "maxLength":14,
                    "description":"The system-generated unique identifier for the service call.",
                    "example":"20124908366206"
                }
            }
        },
        "serviceCallExternalId":{
            "type":"string",
            "maxLength":60,
            "description":"The external system's unique identifier for the service call.",
            "example":"SR202200001"
        },
        "creationDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"The creation date and time of the service call.",
            "example":"2022-06-05T10:30:49-07:00"
        },
        "description":{
            "type":"string",
            "maxLength":100,
            "description":"Short description about the service call.",
            "example":"New Electric Service"
        },
        "serviceCategory":{
            "type":"object",
            "description":"Service category represents a broad grouping of services provided by the company.",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "serviceCategory":{
                    "type":"string",
                    "maxLength":30,
                    "description":"Service category represents a broad grouping of services provided by the company.",
                    "example":"CM_ElectricService"
                }
            }
        },
        "serviceCode":{
            "type":"object",
            "description":"Service code is used to assign actions corresponding to the service call received.",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "serviceCode":{
                    "type":"string",
                    "maxLength":30,
                    "description":"Service code is used to assign actions corresponding to the service call received.",
                    "example":"CM_MeterRead"
                }
            }
        },
        "status":{
            "type":"string",
            "maxLength":60,
            "description":"The current status of the service call.",
            "example":"Processed"
        },
        "firstName":{
            "type":"string",
            "maxLength":254,
            "description":"The first name of the contact person.",
            "example":"Robert"
        },
        "lastName":{
            "type":"string",
            "maxLength":254,
            "description":"The last name of the contact person.",
            "example":"Brown"
        },
        "primaryPhone":{
            "type":"string",
            "maxLength":24,
            "description":"The primary phone number of the contact person.",
            "example":"330-532-9834"
        },
        "homePhone":{
            "type":"string",
            "maxLength":24,
            "description":"The home phone number of the contact person.",
            "example":"330-532-9834"
        },
        "mobilePhone":{
            "type":"string",
            "maxLength":24,
            "description":"The mobile phone number of the contact person.",
            "example":"330-532-9834"
        },
        "requiredByDate":{
            "type":"string",
            "format":"date",
            "description":"The date when the work needs to be completed.",
            "example":"2022-06-10"
        },
        "callbackRequired":{
            "type":"string",
            "maxLength":4,
            "description":"Indicates if the customer expects a callback from the utility.",
            "example":"W1YS"
        },
        "address1":{
            "type":"string",
            "maxLength":254,
            "description":"The first line of the service call address.",
            "example":"800 Rosewood Ave"
        },
        "address2":{
            "type":"string",
            "maxLength":254,
            "description":"The second line of the service call address.",
            "example":"Suite 101"
        },
        "address3":{
            "type":"string",
            "maxLength":254,
            "description":"The third line of the service call address."
        },
        "address4":{
            "type":"string",
            "maxLength":254,
            "description":"The fourth line of the service call address."
        },
        "crossStreet":{
            "type":"string",
            "maxLength":64,
            "description":"The major intersection of the service call address.",
            "example":"Rosewood and Main"
        },
        "houseType":{
            "type":"string",
            "enum":[
                "AP  ",
                "CM  "
            ],
            "description":"The property type of the service call address.\n* `AP  ` - Apartment,\n* `CM  ` - Condominium",
            "example":"AP"
        },
        "number1":{
            "type":"string",
            "maxLength":6,
            "description":"Address number 1 of the service call address."
        },
        "number2":{
            "type":"string",
            "maxLength":4,
            "description":"Address number 2 of the service call address."
        },
        "geographicCode":{
            "type":"string",
            "maxLength":11,
            "description":"The geographic code of the service call address."
        },
        "inCityLimit":{
            "type":"boolean",
            "description":"Indicates if the service call address is within the city boundary."
        },
        "city":{
            "type":"string",
            "maxLength":90,
            "description":"The city of the service call address.",
            "example":"North Canton"
        },
        "suburb":{
            "type":"string",
            "maxLength":64,
            "description":"The suburb of the service call address.",
            "example":"Peoria Metropolitan"
        },
        "county":{
            "type":"string",
            "maxLength":90,
            "description":"The county of the service call address.",
            "example":"Fulton"
        },
        "state":{
            "type":"string",
            "maxLength":6,
            "description":"The state of the service call address.",
            "example":"IL"
        },
        "postal":{
            "type":"string",
            "maxLength":12,
            "description":"The zip code of the service call address.",
            "example":"61520"
        },
        "country":{
            "type":"string",
            "maxLength":3,
            "description":"The country of the service call address.",
            "example":"USA"
        },
        "latitude":{
            "type":"number",
            "maximum":9.99999999999999E8,
            "minimum":0,
            "description":"The latitude coordinate of the service call address.",
            "example":"40.558270"
        },
        "longitude":{
            "type":"number",
            "maximum":9.99999999999999E8,
            "minimum":-9.99999999999999E8,
            "description":"The longitude coordinate of the service call address.",
            "example":"-90.035090"
        },
        "isActive":{
            "type":"boolean",
            "description":"Indicates whether the service call is active or not.",
            "example":"true"
        }
    }
}

Nested Schema : serviceCall

Type: object

Show Source

_link: string

_link
serviceCallId: string

Maximum Length: 14

The system-generated unique identifier for the service call.

Example: 20124908366206

{
    "type":"object",
    "properties":{
        "_link":{
            "type":"string",
            "description":"_link"
        },
        "serviceCallId":{
            "type":"string",
            "maxLength":14,
            "description":"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

{
    "type":"object",
    "description":"Service category represents a broad grouping of services provided by the company.",
    "properties":{
        "_link":{
            "type":"string",
            "description":"_link"
        },
        "serviceCategory":{
            "type":"string",
            "maxLength":30,
            "description":"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

{
    "type":"object",
    "description":"Service code is used to assign actions corresponding to the service call received.",
    "properties":{
        "_link":{
            "type":"string",
            "description":"_link"
        },
        "serviceCode":{
            "type":"string",
            "maxLength":30,
            "description":"Service code is used to assign actions corresponding to the service call received.",
            "example":"CM_MeterRead"
        }
    }
}

400 Response

Bad Request

Root Schema : problemDetailDocument

Type: object

Show Source

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.

{
    "type":"object",
    "properties":{
        "problemType":{
            "type":"string",
            "maxLength":60,
            "description":"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."
        },
        "title":{
            "type":"string",
            "maxLength":60,
            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
        },
        "httpStatus":{
            "type":"number",
            "maximum":9999,
            "minimum":0,
            "description":"The HTTP Status code for the error."
        },
        "detail":{
            "type":"string",
            "maxLength":60,
            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
        },
        "problemInstance":{
            "type":"string",
            "maxLength":60,
            "description":"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."
        },
        "stackTrace":{
            "type":"string",
            "maxLength":60,
            "description":"The stack trace shows where the error occurs during the execution of a program."
        },
        "serverMessage":{
            "type":"object",
            "properties":{
                "messageCategory":{
                    "type":"number",
                    "maximum":0,
                    "minimum":0,
                    "description":"Message Category within Oracle Utilities Application Framework."
                },
                "messageNbr":{
                    "type":"number",
                    "maximum":99999,
                    "minimum":-99999,
                    "description":"Message Number within Oracle Utilities Application Framework."
                },
                "callSequence":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Delimited sequence of programs called."
                },
                "programName":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Name of the program that encountered the error."
                },
                "messageText":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
                },
                "longDescription":{
                    "type":"string",
                    "maxLength":60,
                    "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
                }
            }
        }
    }
}

Nested Schema : serverMessage

Type: object

Show Source

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.

{
    "type":"object",
    "properties":{
        "messageCategory":{
            "type":"number",
            "maximum":0,
            "minimum":0,
            "description":"Message Category within Oracle Utilities Application Framework."
        },
        "messageNbr":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Message Number within Oracle Utilities Application Framework."
        },
        "callSequence":{
            "type":"string",
            "maxLength":60,
            "description":"Delimited sequence of programs called."
        },
        "programName":{
            "type":"string",
            "maxLength":60,
            "description":"Name of the program that encountered the error."
        },
        "messageText":{
            "type":"string",
            "maxLength":60,
            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
        },
        "longDescription":{
            "type":"string",
            "maxLength":60,
            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
        }
    }
}

500 Response

Internal Server Error

Root Schema : problemDetailDocument

Type: object

Show Source

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.

{
    "type":"object",
    "properties":{
        "problemType":{
            "type":"string",
            "maxLength":60,
            "description":"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."
        },
        "title":{
            "type":"string",
            "maxLength":60,
            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
        },
        "httpStatus":{
            "type":"number",
            "maximum":9999,
            "minimum":0,
            "description":"The HTTP Status code for the error."
        },
        "detail":{
            "type":"string",
            "maxLength":60,
            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
        },
        "problemInstance":{
            "type":"string",
            "maxLength":60,
            "description":"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."
        },
        "stackTrace":{
            "type":"string",
            "maxLength":60,
            "description":"The stack trace shows where the error occurs during the execution of a program."
        },
        "serverMessage":{
            "type":"object",
            "properties":{
                "messageCategory":{
                    "type":"number",
                    "maximum":0,
                    "minimum":0,
                    "description":"Message Category within Oracle Utilities Application Framework."
                },
                "messageNbr":{
                    "type":"number",
                    "maximum":99999,
                    "minimum":-99999,
                    "description":"Message Number within Oracle Utilities Application Framework."
                },
                "callSequence":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Delimited sequence of programs called."
                },
                "programName":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Name of the program that encountered the error."
                },
                "messageText":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
                },
                "longDescription":{
                    "type":"string",
                    "maxLength":60,
                    "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
                }
            }
        }
    }
}

Nested Schema : serverMessage

Type: object

Show Source

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.

{
    "type":"object",
    "properties":{
        "messageCategory":{
            "type":"number",
            "maximum":0,
            "minimum":0,
            "description":"Message Category within Oracle Utilities Application Framework."
        },
        "messageNbr":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Message Number within Oracle Utilities Application Framework."
        },
        "callSequence":{
            "type":"string",
            "maxLength":60,
            "description":"Delimited sequence of programs called."
        },
        "programName":{
            "type":"string",
            "maxLength":60,
            "description":"Name of the program that encountered the error."
        },
        "messageText":{
            "type":"string",
            "maxLength":60,
            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
        },
        "longDescription":{
            "type":"string",
            "maxLength":60,
            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
        }
    }
}