Operation
get /data/esmBrowser/customer/getAllCustomersJ/{localTimeZoneOffset}getAllCustomers (getAllCustomersJ : /data/esmBrowser/customer/getAllCustomersJ/{localTimeZoneOffset})
Fetches all esm customers details in json format
Path parameters
Name |
IsRequired |
Description |
Enum |
|---|---|---|---|
| localTimeZoneOffset | required | client time Zone offset to be updated,the value of clientZoneOffset depends on the location of the user.Generally clientZoneOffset= UTC+Offset or UTC-Offset. | --- |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
CustomerUIDataList
|
| 401Unauthorized | --- |
| 403Forbidden | --- |
| 404Not Found | --- |
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type response header.
application/json
External Docs
See Also :
Operation
get /esmBrowser/customer/getAllCustomersJ/{localTimeZoneOffset}getAllCustomers (getAllCustomersJ : /esmBrowser/customer/getAllCustomersJ/{localTimeZoneOffset})
Fetches all esm customers details in json format
Path parameters
Name |
IsRequired |
Description |
Enum |
|---|---|---|---|
| localTimeZoneOffset | required | client time Zone offset to be updated,the value of clientZoneOffset depends on the location of the user.Generally clientZoneOffset= UTC+Offset or UTC-Offset. | --- |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
CustomerUIDataList
|
| 401Unauthorized | --- |
| 403Forbidden | --- |
| 404Not Found | --- |
Example Request Data
https://{{serverIp}}:8443/oms1350/esmBrowser/customer/getAllCustomersJ/+5:30?dojo.preventCache=14679731
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type response header.
application/json
Example Response Data
{ "customerUIDataList": [ { "customerId": 2, "customerName": "ETH-CUSTOMER-1", "phone": null, "address": null, "emailId": null, "descr": null, "creationTime": "2016-01-04 15:00:52", "lastModificationTime": "2016-01-04 15:00:52" } ] }
External Docs
See Also :
Operation
get /data/esmBrowser/customer/getCustomer/{customerName}getCustomer (getCustomerDetails : /data/esmBrowser/customer/getCustomer/{customerName})
Fetches Esm Customer's details based on given Customer Name
Path parameters
Name |
IsRequired |
Description |
Enum |
|---|---|---|---|
| customerName | required | Customer Name | --- |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
CustomerData
|
| 401Unauthorized | --- |
| 403Forbidden | --- |
| 404Not Found | --- |
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type response header.
application/xml
External Docs
See Also :
Operation
get /esmBrowser/customer/getCustomer/{customerName}getCustomer (getCustomerDetails : /esmBrowser/customer/getCustomer/{customerName})
Fetches Esm Customer's details based on given Customer Name
Path parameters
Name |
IsRequired |
Description |
Enum |
|---|---|---|---|
| customerName | required | Customer Name | --- |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
CustomerData
|
| 401Unauthorized | --- |
| 403Forbidden | --- |
| 404Not Found | --- |
Example Request Data
https://{{serverIp}}:8443/oms1350/esmBrowser/customer/getCustomer/ETH-CUSTOMER-1?dojo.preventCache=14679731
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type response header.
application/xml
Example Response Data
<CustomerData> <customerName>ETH-CUSTOMER-1</customerName> <creationTime>1449559205206</creationTime> <lastUpdationTime>1449559205207</lastUpdationTime> </CustomerData>
External Docs
See Also :
CustomerData
Name |
Type |
Description |
Enum |
|---|---|---|---|
| customerId | Long long |
CustomerId | --- |
| customerName | String string |
CustomerName | --- |
| phoneNumber | String string |
Phone | --- |
| emailId | String string |
EmailId | --- |
| address | String string |
Address | --- |
| descr | String string |
Description | --- |
| creationTime | String string |
CreationTime | --- |
| lastUpdationTime | String string |
ModificationTime | --- |
| id | Long long |
CustomerId | --- |
| guiLabel | String string |
GuiLabel | --- |
| className | String string |
ClassName | --- |
| key | String string |
Key | --- |
| additionalInfo | Object object |
AdditionalInfo | --- |
CustomerUIData
Name |
Type |
Description |
Enum |
|---|---|---|---|
| customerId | Long long |
CustomerId | --- |
| customerName | String string |
CustomerName | --- |
| phone | String string |
Phone | --- |
| address | String string |
Address | --- |
| emailId | String string |
EmailId | --- |
| descr | String string |
Description | --- |
| creationTime | String string |
CreationTime | --- |
| lastModificationTime | String string |
ModificationTime | --- |
CustomerUIDataList
Name |
Type |
Description |
Enum |
|---|---|---|---|
| customerUIDataList | array[CustomerUIData] CustomerUIData |
--- | --- |
| items | array[CustomerUIData] CustomerUIData |
--- | --- |