List account details
| Property | Description |
| Resource URL | /customer/v1/{customer_id} /service_provisioning/accountDetails |
| Method | GET |
| Body | None |
Sample Request
|
1 2 3 |
GET /customer/v1/5a393ea210d91806b7ef702c/service_provisioning/accountDetails HEADER authorization:Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiIiLCJpYXQiOjEzMzIwNjk5MDIsImV4cCI6MTUyMTM3NDE5OSwiYXVkIjoiIiwic3ViIjoiIiwiY3VzdG9tZXJfaWQiOiI1YTM5M2VhMjEwZDkxODA2YjdlZjcwMmMifQ.u4kBXOHCP7W-Vg9oSfkFniSKbxj8t1ULMnTcCAS2ykw |
Sample Response
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 |
{ "result_code":0, "result_description":"Success", "response":{ "account_name":"O-Retail Services", "state":true, "company_size":500, "email":"briane@cabashco.co", "title":"Mrs", "name":"Osas Brian", "surname":"Green", "address":"32 Kings way", "postcode":"ES34 3ES", "country":"United Kingdom", "api_access_enabled":true, "prov_api_version":"v1", "msg_api_version":"v1", "region_id":"ukie", "service_provisioning":{ "permitted_ip_list":[ ], "enable_ip_validation":false, "api_gateway":[ "https://ukie.iotgtw.com" ], "api_path":"/customer/v1/5a393ea210d91806b7ef702c/service_provisioning/", "resources":{ "serviceTemplates":"serviceTemplates/", "serviceTemplateDevices":"serviceTemplateDevices/", "serviceAccessPoints":"serviceAccessPoints/", "messagingEndpoints":"messagingEndpoints/", "devices_retrieve":"devices_retrieve/", "devices_delete":"devices_delete/", "devices_modify":"devices_modify/", "accountDetails":"accountDetails/", "regions":"regions/", "count":"count/" }, "jwt_api_key":"" }, "messaging":{ "resources":{ "retrieve":"retrieve/", "submit":"submit/", "broadcast":"broadcast/", "delete":"delete/", "flush":"flush/" } } } } |
Note:
- Jwt_api_key is issued and returned at account creation. This attribute will always return blank in a GET accountDetails request
- The region_id and associated api-gateway returned are the customer indicated preferred/main region and have no further significance. The customer is not restricted to this region and may use other regions as appropriate
- The attributes highlighted are derived informational values and are not editable using an update account details request.
Update account details
| Property | Description |
| Resource URL | /customer/v1/{customer_id} /service_provisioning/accountDetails |
| Method | PUT |
| Body | Account Details Object |
Sample Request
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 |
PUT /customer/v1/5a393ea210d91806b7ef702c/service_provisioning/accountDetails HEADER authorization:Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiIiLCJpYXQiOjEzMzIwNjk5MDIsImV4cCI6MTUyMTM3NDE5OSwiYXVkIjoiIiwic3ViIjoiIiwiY3VzdG9tZXJfaWQiOiI1YTM5M2VhMjEwZDkxODA2YjdlZjcwMmMifQ.u4kBXOHCP7W-Vg9oSfkFniSKbxj8t1ULMnTcCAS2ykw { "request_id":"", "request_parameters":{ "account_name":"O-Retail Services", "state":true, "company_size":500, "email":"briane@cabashco.co", "title":"Mrs", "name":"Osas Brian", "surname":"Green", "address":"32 Kings way", "postcode":"ES34 3ES", "country":"United Kingdom", "api_access_enabled":true, "region_id":"ukie", "service_provisioning":{ "permitted_ip_list":[ "187.10.20.30", "99.88.77.66" ], "enable_ip_validation":true, "jwt_api_key":"bBy32v16_KK5q60j23X7t3MC01QhET6J1N186YJJFwECc5a" } } } |
Sample Response
|
1 2 3 4 5 |
{ "result_description":"Success", "request_id":"", "result_code":0 } |
Note:
- The customer update is active within a few seconds. Parameter update such as permitted_ip_list and enable_ip_validation if set wrongly can result in your api client requests being rejected (unknown host error). In that case you must logon to the Portal to disable IP validation or update the permited_ip_list parameter.
- If the Jwt_api_key parameter has been set wrongly or no longer remember please send a request to reset the provisioning JWT signing key.
Sample Response Error 1 (403)
|
1 2 3 |
{ "rejected":"Error - Invalid Request" } |
Note:
This is a generic error and can be due to invalid:
This is a generic error and can be due to invalid:
- API endpoint
- JWT signing key used to sign the request
Sample Response Error 2 (403)
|
1 2 3 |
{ "rejected":"Entity IP Validation Error - Please contact the admin to enable this host." } |
Note:
This error is due to IP validation enabled on the customer account for all provisioning API requests. The calling client IP address is not whitelisted in the permitted_ip_list. To resolve the issue update the permitted_ip_list field from a whitelisted client IP or logon to the portal to add the IP address of the additional API client(s) you want to permit.
This error is due to IP validation enabled on the customer account for all provisioning API requests. The calling client IP address is not whitelisted in the permitted_ip_list. To resolve the issue update the permitted_ip_list field from a whitelisted client IP or logon to the portal to add the IP address of the additional API client(s) you want to permit.
Sample Response Error 3 (404)
|
1 2 3 |
{ "rejected":"Not Found" } |
Note:
This is a generic error and can be due to invalid:
This is a generic error and can be due to invalid:
- customer_id
- resource URL construction format
Sample Response Error 4 (400)
|
1 2 3 4 5 6 7 8 |
{ "request_id":"", "result_code":481, "result_description":"input error, please correct the following: state (valid boolean expected)", "response":{ } } |
This error indicates the request could not be fully processed due to an error in the request parameters. The specific reason for the error is indicated in the result description with an associated result code.
In the example above the attribute “state” is of type Boolean. The request attempts to set it to string value “state”:“true”. The expected setting for this attribute is "state": true
In the example above the attribute “state” is of type Boolean. The request attempts to set it to string value “state”:“true”. The expected setting for this attribute is "state": true