/* BPAPI iOS Library See http://api.connome.com/ Copyright (C) 2013 - 2017 Sikom Connect AS Automatically generated from BPAPI source-code 2025-12-06 05:04 Licensing terms not decided as of May 2013 (A permissive license is most probable). Please enquire as necessary to bjorn@sikomconnect.com */ #import @interface BPAPI : NSObject +(void)setServerAddress:(NSString*)serverAddress; +(NSString*)getServerAddress; /** * BPAPI method AppView/Translation * * Returns translations for CONNOME_Sikom_JSON_App for the given {language}.
* * https://api-test.connome.com/documentation/AppViewTranslation.html * * No authorization required HTTP methods allowed: GET * * Syntax: AppView/Translation&language=en-US * * Returns translations for CONNOME_Sikom_JSON_App for the given {language}. * * Information is cached with an 1 hour refresh rate. * */ +(NSMutableURLRequest*) getAppViewTranslation&language=en-US; /** * BPAPI method AppView/AuxiliaryEquipment * * Returns documentation for the given {gateway_type}, especially information about auxiliary equipment.
* * https://api-test.connome.com/documentation/AppViewAuxiliaryEquipment.html * * No authorization required HTTP methods allowed: GET * * Syntax: AppView/{app_version}/GatewayDocumentation/{language}/{gateway_type}/ * * Returns documentation for the given {gateway_type}, especially information about auxiliary equipment. * * Note that null may be returned. * */ +(NSMutableURLRequest*) getAppViewGatewayDocumentationApp_version: (NSString*)app_version gateway_type: (NSString*)gateway_type language: (NSString*)language; /** * BPAPI method AppView * * Returns either AppView for
* * https://api-test.connome.com/documentation/AppView.html * * HTTP methods allowed: GET * * Syntax: AppView/{app_version}/{gateway_id}/ * * Returns either AppView for * 1) List of all gateways (when {gateway_id} indicates that multiple gateways are requested), * or * 2) Single gateway (when {gateway_id} indicates that a single gateway is requested) * For the latter case a refreshing of properties (synchronizing with actual gateway status) will also be performed as needed. * */ +(NSMutableURLRequest*) getAppViewApp_version: (NSString*)app_version gateway_id: (NSString*)gateway_id; /** * BPAPI method AppView/{app_version}/{gateway_id}/Refreshing * * Returns refresh status of gateway identified by {gateway_id} * * https://api-test.connome.com/documentation/AppView{app_version}{gateway_id}Refreshing.html * * HTTP methods allowed: GET * * Syntax: AppView/{app_version}/Refreshing/{gateway_id}/ * * Returns refresh status of gateway identified by {gateway_id} */ +(NSMutableURLRequest*) getAppViewRefreshingApp_version: (NSString*)app_version gateway_id: (NSString*)gateway_id; /** * BPAPI method AppViewSimple * * Returns web app view
* * https://api-test.connome.com/documentation/AppViewSimple.html * * No authorization required HTTP methods allowed: GET * * Syntax: AppViewSimple/{app_version}/{email}/{password}/ * * Returns web app view * (Internal method, not for use the third parties). * * */ +(NSMutableURLRequest*) getAppViewSimpleApp_version: (NSString*)app_version email: (NSString*)email password: (NSString*)password; /** * BPAPI method ChangePassword * * Changes password
* * https://api-test.connome.com/documentation/ChangePassword.html * * No authorization required HTTP methods allowed: GET, POST * * Syntax: ChangePassword/{email}/{old_password}/{new_password}/ * * Changes password * * This call is functionally equivalent to https://api-test.connome.com/documentation/CustomerAddProperty.html with property_name set to "password" except that authorization is done with the parameters {email} and {old_password} instead of through the standard BPAPI authorization mechanism (HTTP Basic Authorization). * * This makes it a bit easier to write a corresponding Javascript client for changing passwords in situations where you want to avoid the web-browser asking the user for credentials for authorization against BPAPI. * * If the credentials are not correct then bpapi_status will be set to "access_error" * * See also https://api-test.connome.com/documentation/ResetPassword.html */ +(NSMutableURLRequest*) getChangePasswordEmail: (NSString*)email old_password: (NSString*)old_password new_password: (NSString*)new_password; +(NSMutableURLRequest*) postChangePasswordEmail: (NSString*)email old_password: (NSString*)old_password new_password: (NSString*)new_password; /** * BPAPI method Customer/Logout * * Sets a flag resulting in the rejection of the HTTP Basic Authorization credentials next time they are supplied for authentication * * https://api-test.connome.com/documentation/CustomerLogout.html * * HTTP methods allowed: GET, POST * * Syntax: Customer/Logout * * Sets a flag resulting in the rejection of the HTTP Basic Authorization credentials next time they are supplied for authentication (in other words, the next HTTP request will fail with a 400 response code) * This call is useful when accessing the HTML user interface (like ui.connome.com) from a web-browserwith locally stored credentials when a change of user-identity is desired. It may then be easier to use this API-call than to instruct the web-browser to clear the credentials. * Note that the flag will be reset the next time correct HTTP Basic Authorization credentials are supplied, regardless of from which client they occur. A new API-call (any call which requires authentication) should therefore be made immediately after this call in order to force the browser to ask for another set of credentials. If not, the flag may (theoretically) be reset by a call from another client, resulting in the browser not being hinted about asking for another set of credentials as desired. * * */ +(NSMutableURLRequest*) getCustomerLogout; +(NSMutableURLRequest*) postCustomerLogout; /** * BPAPI method Customer/AddProperty * * Adds a user-defined property for the customers identified by {id}
* * https://api-test.connome.com/documentation/CustomerAddProperty.html * * HTTP methods allowed: GET, POST * * Syntax: Customer/AddProperty/{property_name}/{value}/ * Syntax: Customer/{id}/AddProperty/{property_name}/{value}/ * * Adds a user-defined property for the customers identified by {id} * * The {id} parameter is optional. If the {id} parameter is not specified it will be derived from the credentials used for authorization. * * {id} may be any of the following types: * customer_id, * All (literally, like "Customer//All/AddProperty"), * * You may also search for multiple {id} values by separating each with comma. The different values may be of different types. * * This method may also be used for changing the value of an existing property (By adding a new property with the same name the old property will be set as "not current") * * * See also https://api-test.connome.com/documentation/NotificationAddEMail.html, https://api-test.connome.com/documentation/NotificationAddCellular.html and https://api-test.connome.com/documentation/NotificationAddApp.html. * Tip: Add / to the end of your query string if the last parameter contains a full stop . or dash - and you want to use HTTP method GET. * */ +(NSMutableURLRequest*) getCustomerAddPropertyProperty_name: (NSString*)property_name value: (NSString*)value; +(NSMutableURLRequest*) postCustomerAddPropertyProperty_name: (NSString*)property_name value: (NSString*)value; /** * BPAPI method Customer/AddProperty * * Adds a user-defined property for the customers identified by {id}
* * https://api-test.connome.com/documentation/CustomerAddProperty.html * * HTTP methods allowed: GET, POST * * Syntax: Customer/AddProperty/{property_name}/{value}/ * Syntax: Customer/{id}/AddProperty/{property_name}/{value}/ * * Adds a user-defined property for the customers identified by {id} * * The {id} parameter is optional. If the {id} parameter is not specified it will be derived from the credentials used for authorization. * * {id} may be any of the following types: * customer_id, * All (literally, like "Customer//All/AddProperty"), * * You may also search for multiple {id} values by separating each with comma. The different values may be of different types. * * This method may also be used for changing the value of an existing property (By adding a new property with the same name the old property will be set as "not current") * * * See also https://api-test.connome.com/documentation/NotificationAddEMail.html, https://api-test.connome.com/documentation/NotificationAddCellular.html and https://api-test.connome.com/documentation/NotificationAddApp.html. * Tip: Add / to the end of your query string if the last parameter contains a full stop . or dash - and you want to use HTTP method GET. * */ +(NSMutableURLRequest*) getCustomerAddPropertyId: (NSString*)id property_name: (NSString*)property_name value: (NSString*)value; +(NSMutableURLRequest*) postCustomerAddPropertyId: (NSString*)id property_name: (NSString*)property_name value: (NSString*)value; /** * BPAPI method Customer/History * * Returns history for the customer identified by {id}
* * https://api-test.connome.com/documentation/CustomerHistory.html * * HTTP methods allowed: GET * * Syntax: Customer//History * Syntax: Customer/{id}/History/ * Syntax: Customer/{id}/History/{limit}/ * * Returns history for the customer identified by {id} * * The parameter {id} is optional. If not given the call will return history about the customer identified by the authorization credentials used. * * The optional parameter {limit} may be used to narrow the result. See https://api-test.connome.com/documentation/PropertyHistory.html for explanation about using {limit}. * * {id} may be any of * bpapi_customer_id, * email, * customer_name, * customer_group_name * * * If {id} identifies more than one customer an error response is generated * See also -PropertyHistory- */ +(NSMutableURLRequest*) getCustomerHistory; /** * BPAPI method Customer/History * * Returns history for the customer identified by {id}
* * https://api-test.connome.com/documentation/CustomerHistory.html * * HTTP methods allowed: GET * * Syntax: Customer//History * Syntax: Customer/{id}/History/ * Syntax: Customer/{id}/History/{limit}/ * * Returns history for the customer identified by {id} * * The parameter {id} is optional. If not given the call will return history about the customer identified by the authorization credentials used. * * The optional parameter {limit} may be used to narrow the result. See https://api-test.connome.com/documentation/PropertyHistory.html for explanation about using {limit}. * * {id} may be any of * bpapi_customer_id, * email, * customer_name, * customer_group_name * * * If {id} identifies more than one customer an error response is generated * See also -PropertyHistory- */ +(NSMutableURLRequest*) getCustomerHistoryId: (NSString*)id; /** * BPAPI method Customer/History * * Returns history for the customer identified by {id}
* * https://api-test.connome.com/documentation/CustomerHistory.html * * HTTP methods allowed: GET * * Syntax: Customer//History * Syntax: Customer/{id}/History/ * Syntax: Customer/{id}/History/{limit}/ * * Returns history for the customer identified by {id} * * The parameter {id} is optional. If not given the call will return history about the customer identified by the authorization credentials used. * * The optional parameter {limit} may be used to narrow the result. See https://api-test.connome.com/documentation/PropertyHistory.html for explanation about using {limit}. * * {id} may be any of * bpapi_customer_id, * email, * customer_name, * customer_group_name * * * If {id} identifies more than one customer an error response is generated * See also -PropertyHistory- */ +(NSMutableURLRequest*) getCustomerHistoryId: (NSString*)id limit: (NSString*)limit; /** * BPAPI method Customer/Property * * Returns property {name} for Customer identified by {id}
* * https://api-test.connome.com/documentation/CustomerProperty.html * * HTTP methods allowed: GET * * Syntax: Customer/{id}/Property/{name}/ * Syntax: Customer/{id}/Property/{name}/{field}/ * * Returns property {name} for Customer identified by {id} * The parameter {id} is optional. If not given the call will return information about the customer identified by the authorization credentials used. * Optionally a sub-field of property may be specified as the {field} parameter. This is useful if just some specific information is needed. * * {name} may consist of multiple property names separated by comma * * See also https://api-test.connome.com/documentation/DeviceProperty.html which shows more query options. */ +(NSMutableURLRequest*) getCustomerPropertyId: (NSString*)id name: (NSString*)name; /** * BPAPI method Customer/Property * * Returns property {name} for Customer identified by {id}
* * https://api-test.connome.com/documentation/CustomerProperty.html * * HTTP methods allowed: GET * * Syntax: Customer/{id}/Property/{name}/ * Syntax: Customer/{id}/Property/{name}/{field}/ * * Returns property {name} for Customer identified by {id} * The parameter {id} is optional. If not given the call will return information about the customer identified by the authorization credentials used. * Optionally a sub-field of property may be specified as the {field} parameter. This is useful if just some specific information is needed. * * {name} may consist of multiple property names separated by comma * * See also https://api-test.connome.com/documentation/DeviceProperty.html which shows more query options. */ +(NSMutableURLRequest*) getCustomerPropertyId: (NSString*)id name: (NSString*)name field: (NSString*)field; /** * BPAPI method Customer/AddChild * * Adds a new parent-child relationship between two customers to the database.
* * https://api-test.connome.com/documentation/CustomerAddChild.html * * HTTP methods allowed: GET, POST * * Syntax: Customer/AddChild/{child}/ * Syntax: Customer/{parent}/AddChild/{child}/ * * Adds a new parent-child relationship between two customers to the database. * Parameter "child" refers to the subordinated customer in the relationship while parameter "parent" referes to the super customer / master customer. * * Note that relationships may extend indefinitely in both directions with a child customer being the parent customer in another sub-ordinated relation and likewise, with a parent customer being the child customer in another super-ordinated relation. * * The {parent} parameter is optional. If the {parent} parameter is not specified it will be derived from the credentials used for authorization. * * The existence of relationships infer rights in the sense that the parent customer may access all properties belonging to the child customer. * The credentials used for authorization must contain the right to change properties of both the parent and child. * The easiest way to accomplish this is to just create the child with the parent's authorization. Alternatively, the method https://api-test.connome.com/documentation/CustomerDelegateRight.html may be executed with the child's authorization before calling https://api-test.connome.com/documentation/CustomerAddChild.html * * See also https://api-test.connome.com/documentation/CustomerDelegateRight.html * * Although the creation of a child-parent relationship is seen from the perspective of the parent API wise (syntax wise) the relationsship in itself will usually show up as a property of the child-object. * * See also https://api-test.connome.com/documentation/CustomerAddAsChild.html which also creates the child-customer as well as adding the parent-child relationship. * */ +(NSMutableURLRequest*) getCustomerAddChildChild: (NSString*)child; +(NSMutableURLRequest*) postCustomerAddChildChild: (NSString*)child; /** * BPAPI method Customer/AddChild * * Adds a new parent-child relationship between two customers to the database.
* * https://api-test.connome.com/documentation/CustomerAddChild.html * * HTTP methods allowed: GET, POST * * Syntax: Customer/AddChild/{child}/ * Syntax: Customer/{parent}/AddChild/{child}/ * * Adds a new parent-child relationship between two customers to the database. * Parameter "child" refers to the subordinated customer in the relationship while parameter "parent" referes to the super customer / master customer. * * Note that relationships may extend indefinitely in both directions with a child customer being the parent customer in another sub-ordinated relation and likewise, with a parent customer being the child customer in another super-ordinated relation. * * The {parent} parameter is optional. If the {parent} parameter is not specified it will be derived from the credentials used for authorization. * * The existence of relationships infer rights in the sense that the parent customer may access all properties belonging to the child customer. * The credentials used for authorization must contain the right to change properties of both the parent and child. * The easiest way to accomplish this is to just create the child with the parent's authorization. Alternatively, the method https://api-test.connome.com/documentation/CustomerDelegateRight.html may be executed with the child's authorization before calling https://api-test.connome.com/documentation/CustomerAddChild.html * * See also https://api-test.connome.com/documentation/CustomerDelegateRight.html * * Although the creation of a child-parent relationship is seen from the perspective of the parent API wise (syntax wise) the relationsship in itself will usually show up as a property of the child-object. * * See also https://api-test.connome.com/documentation/CustomerAddAsChild.html which also creates the child-customer as well as adding the parent-child relationship. * */ +(NSMutableURLRequest*) getCustomerAddChildParent: (NSString*)parent child: (NSString*)child; +(NSMutableURLRequest*) postCustomerAddChildParent: (NSString*)parent child: (NSString*)child; /** * BPAPI method Customer/Add * * Adds a new customer to the database. The parameter {email} used has to be unique.
* * https://api-test.connome.com/documentation/CustomerAdd.html * * No authorization required HTTP methods allowed: GET, POST * * Syntax: Customer/Add/{email}/{password}/ * Syntax: Customer/Add/{email}/{password}/{registration_id}/ * * Adds a new customer to the database. The parameter {email} used has to be unique. * * Returns the customerId of the customer just added. * * If the optional parameter {registration_id} is supplied then the corresponding gateway will be automatically assigned to the customer (rendering use of https://api-test.connome.com/documentation/GatewayAssign.html unnecessary). * * Note: It is also possible to add a Customer by supplying only one parameter which will be regarded as 'organization_name'. This feature is useful for registering dealers. * * Possible data_error values for bpapi_status are:"email_address_already_in_use_data_error" * "illegal_password_data_error" * * When registration_id is specified additional possible data_error values for bpapi_status are: * "gateway_already_registered_data_error" * "invalid_registration_id_data_error" * * For bpapi_status "ok" there will be given more details in the field "ok_detailed_information". * * */ +(NSMutableURLRequest*) getCustomerAddEmail: (NSString*)email password: (NSString*)password; +(NSMutableURLRequest*) postCustomerAddEmail: (NSString*)email password: (NSString*)password; /** * BPAPI method Customer/Add * * Adds a new customer to the database. The parameter {email} used has to be unique.
* * https://api-test.connome.com/documentation/CustomerAdd.html * * No authorization required HTTP methods allowed: GET, POST * * Syntax: Customer/Add/{email}/{password}/ * Syntax: Customer/Add/{email}/{password}/{registration_id}/ * * Adds a new customer to the database. The parameter {email} used has to be unique. * * Returns the customerId of the customer just added. * * If the optional parameter {registration_id} is supplied then the corresponding gateway will be automatically assigned to the customer (rendering use of https://api-test.connome.com/documentation/GatewayAssign.html unnecessary). * * Note: It is also possible to add a Customer by supplying only one parameter which will be regarded as 'organization_name'. This feature is useful for registering dealers. * * Possible data_error values for bpapi_status are:"email_address_already_in_use_data_error" * "illegal_password_data_error" * * When registration_id is specified additional possible data_error values for bpapi_status are: * "gateway_already_registered_data_error" * "invalid_registration_id_data_error" * * For bpapi_status "ok" there will be given more details in the field "ok_detailed_information". * * */ +(NSMutableURLRequest*) getCustomerAddEmail: (NSString*)email password: (NSString*)password registration_id: (NSString*)registration_id; +(NSMutableURLRequest*) postCustomerAddEmail: (NSString*)email password: (NSString*)password registration_id: (NSString*)registration_id; /** * BPAPI method Customer/AddAsChild * * Adds a new customer to the database and creates a parent-child relationship with the customer identified by the credentials used for authorization.
* * https://api-test.connome.com/documentation/CustomerAddAsChild.html * * HTTP methods allowed: GET, POST * * Syntax: Customer/AddAsChild/{email}/{password}/ * Syntax: Customer/AddAsChild/{email}/ * * Adds a new customer to the database and creates a parent-child relationship with the customer identified by the credentials used for authorization. * * The parameter {password} is optional. If the parameter {password} is not specified then the email-address is stored as "last_name" instead of as "email" * * This call is equivalent to first calling https://api-test.connome.com/documentation/CustomerAdd.html and then https://api-test.connome.com/documentation/CustomerAddChild.html. * It is meant for quick manual testing of the API and for quick manual setup of a new customer hierarchy. * Possible data_error values for bpapi_status in addition to that returned by https://api-test.connome.com/documentation/CustomerAdd.html and https://api-test.connome.com/documentation/CustomerAddChild.html are"different_parent_already_set_data_error" * * For bpapi_status "ok" there will be given more details in the field "ok_detailed_information". * */ +(NSMutableURLRequest*) getCustomerAddAsChildEmail: (NSString*)email password: (NSString*)password; +(NSMutableURLRequest*) postCustomerAddAsChildEmail: (NSString*)email password: (NSString*)password; /** * BPAPI method Customer/AddAsChild * * Adds a new customer to the database and creates a parent-child relationship with the customer identified by the credentials used for authorization.
* * https://api-test.connome.com/documentation/CustomerAddAsChild.html * * HTTP methods allowed: GET, POST * * Syntax: Customer/AddAsChild/{email}/{password}/ * Syntax: Customer/AddAsChild/{email}/ * * Adds a new customer to the database and creates a parent-child relationship with the customer identified by the credentials used for authorization. * * The parameter {password} is optional. If the parameter {password} is not specified then the email-address is stored as "last_name" instead of as "email" * * This call is equivalent to first calling https://api-test.connome.com/documentation/CustomerAdd.html and then https://api-test.connome.com/documentation/CustomerAddChild.html. * It is meant for quick manual testing of the API and for quick manual setup of a new customer hierarchy. * Possible data_error values for bpapi_status in addition to that returned by https://api-test.connome.com/documentation/CustomerAdd.html and https://api-test.connome.com/documentation/CustomerAddChild.html are"different_parent_already_set_data_error" * * For bpapi_status "ok" there will be given more details in the field "ok_detailed_information". * */ +(NSMutableURLRequest*) getCustomerAddAsChildEmail: (NSString*)email; +(NSMutableURLRequest*) postCustomerAddAsChildEmail: (NSString*)email; /** * BPAPI method Customer/AddPropertySimple * * Adds a user-defined property for the customer identified by the registration_id
* * https://api-test.connome.com/documentation/CustomerAddPropertySimple.html * * No authorization required HTTP methods allowed: GET, POST * * Syntax: Customer/AddPropertySimple/{registration_id}/{property_name}/{value}/ * * Adds a user-defined property for the customer identified by the registration_id * * This is a restricted call compared to https://api-test.connome.com/documentation/CustomerAddProperty.html since autentication is only done with a registration_id and not email (username) and password. Only a few properties is allowed to set by this method. * * -VerifyRegistrationId- can be used to read the corresponding values that is allowed to set by this method. * possible data_error values for bpapi_status are: * "invalid_registration_id_data_error" * * * * * See also -AddPropertyMultipleSimple-, -VerifyRegistrationId- and https://api-test.connome.com/documentation/CustomerAddProperty.html * */ +(NSMutableURLRequest*) getCustomerAddPropertySimpleRegistration_id: (NSString*)registration_id property_name: (NSString*)property_name value: (NSString*)value; +(NSMutableURLRequest*) postCustomerAddPropertySimpleRegistration_id: (NSString*)registration_id property_name: (NSString*)property_name value: (NSString*)value; /** * BPAPI method Customer/DelegateRight * * Delegate rights from one customer to another.
* * https://api-test.connome.com/documentation/CustomerDelegateRight.html * * HTTP methods allowed: GET, POST * * Syntax: Customer/DelegateRight/{recipient}/ * Syntax: Customer/DelegateRight/{recipient}/{right}/ * Syntax: Customer/DelegateRight/{recipient}/{right}/{delegator}/ * * Delegate rights from one customer to another. * Parameter {recipient} (delegate) refers to the customer object being given delegated rights while parameter {delegator} refers to the customer object whose rights are delegated. * * Note that delegation of rights may extend indefinitely in both directions with a delegator customer being the recipient (delegate) customer in another sub-ordinated delegation and likewise, with a recipient (delegate) customer being the delegator customer in another super-ordinated delegation. * * If only one parameter is specified it is taken as the recipient (delegate) parameter. Rights being delegated will then be "Change" and the delegator will be derived from the credentials used for authorization. * * The credentials used for authorization must contain the right to change properties of the delegator (no rights are needed for the recipient (delegate)). * The easiest way to accomplish this is to just authorize the method call with the delegators credentials and not supplying the delegator-parameter. * * See also https://api-test.connome.com/documentation/CustomerAddChild.html * * Note that syntax-wise multiple recipients and / or multiple delegators may be specified but this is not supported internally as of January 2015. * * The delegation of rights is seen from the perspective of the delegator API wise (syntax wise) but the delegated rights shows up as RelationDelegateDelegator-properties of both the delegator and recipient (delegate). * In addition the delegated rights will show up in the JSON-data as ReadRights and ChangeRights for the delegate and asReadDelegates and ChangeDelegates for the delegator. */ +(NSMutableURLRequest*) getCustomerDelegateRightRecipient: (NSString*)recipient; +(NSMutableURLRequest*) postCustomerDelegateRightRecipient: (NSString*)recipient; /** * BPAPI method Customer/DelegateRight * * Delegate rights from one customer to another.
* * https://api-test.connome.com/documentation/CustomerDelegateRight.html * * HTTP methods allowed: GET, POST * * Syntax: Customer/DelegateRight/{recipient}/ * Syntax: Customer/DelegateRight/{recipient}/{right}/ * Syntax: Customer/DelegateRight/{recipient}/{right}/{delegator}/ * * Delegate rights from one customer to another. * Parameter {recipient} (delegate) refers to the customer object being given delegated rights while parameter {delegator} refers to the customer object whose rights are delegated. * * Note that delegation of rights may extend indefinitely in both directions with a delegator customer being the recipient (delegate) customer in another sub-ordinated delegation and likewise, with a recipient (delegate) customer being the delegator customer in another super-ordinated delegation. * * If only one parameter is specified it is taken as the recipient (delegate) parameter. Rights being delegated will then be "Change" and the delegator will be derived from the credentials used for authorization. * * The credentials used for authorization must contain the right to change properties of the delegator (no rights are needed for the recipient (delegate)). * The easiest way to accomplish this is to just authorize the method call with the delegators credentials and not supplying the delegator-parameter. * * See also https://api-test.connome.com/documentation/CustomerAddChild.html * * Note that syntax-wise multiple recipients and / or multiple delegators may be specified but this is not supported internally as of January 2015. * * The delegation of rights is seen from the perspective of the delegator API wise (syntax wise) but the delegated rights shows up as RelationDelegateDelegator-properties of both the delegator and recipient (delegate). * In addition the delegated rights will show up in the JSON-data as ReadRights and ChangeRights for the delegate and asReadDelegates and ChangeDelegates for the delegator. */ +(NSMutableURLRequest*) getCustomerDelegateRightRecipient: (NSString*)recipient right: (NSString*)right; +(NSMutableURLRequest*) postCustomerDelegateRightRecipient: (NSString*)recipient right: (NSString*)right; /** * BPAPI method Customer/DelegateRight * * Delegate rights from one customer to another.
* * https://api-test.connome.com/documentation/CustomerDelegateRight.html * * HTTP methods allowed: GET, POST * * Syntax: Customer/DelegateRight/{recipient}/ * Syntax: Customer/DelegateRight/{recipient}/{right}/ * Syntax: Customer/DelegateRight/{recipient}/{right}/{delegator}/ * * Delegate rights from one customer to another. * Parameter {recipient} (delegate) refers to the customer object being given delegated rights while parameter {delegator} refers to the customer object whose rights are delegated. * * Note that delegation of rights may extend indefinitely in both directions with a delegator customer being the recipient (delegate) customer in another sub-ordinated delegation and likewise, with a recipient (delegate) customer being the delegator customer in another super-ordinated delegation. * * If only one parameter is specified it is taken as the recipient (delegate) parameter. Rights being delegated will then be "Change" and the delegator will be derived from the credentials used for authorization. * * The credentials used for authorization must contain the right to change properties of the delegator (no rights are needed for the recipient (delegate)). * The easiest way to accomplish this is to just authorize the method call with the delegators credentials and not supplying the delegator-parameter. * * See also https://api-test.connome.com/documentation/CustomerAddChild.html * * Note that syntax-wise multiple recipients and / or multiple delegators may be specified but this is not supported internally as of January 2015. * * The delegation of rights is seen from the perspective of the delegator API wise (syntax wise) but the delegated rights shows up as RelationDelegateDelegator-properties of both the delegator and recipient (delegate). * In addition the delegated rights will show up in the JSON-data as ReadRights and ChangeRights for the delegate and asReadDelegates and ChangeDelegates for the delegator. */ +(NSMutableURLRequest*) getCustomerDelegateRightRecipient: (NSString*)recipient right: (NSString*)right delegator: (NSString*)delegator; +(NSMutableURLRequest*) postCustomerDelegateRightRecipient: (NSString*)recipient right: (NSString*)right delegator: (NSString*)delegator; /** * BPAPI method Customer * * Returns information about the customer or customers identified by {id}
* * https://api-test.connome.com/documentation/Customer.html * * HTTP methods allowed: GET * * Syntax: Customer/{id}/ * * Returns information about the customer or customers identified by {id} * * The parameter {id} is optional. If not given the call will return information about the customer identified by the authorization credentials used. * * {id} may be any of * bpapi_customer_id, * All (literally, like "Customer/All"), * email, * customer_name, * customer_group_name, * A quasi-SQL expression like "WHERE postal_code = '7014'" (this is experimental from august 2014 and is limited to examining a maximum of 100 customers, BEFORE access-rights are considered) * The optional parameter {extend_rights} may be set to 'True' if the concept of representation is used and all customers for which the representative has rights are desired. * This is applicable for the BPAPI HTML admin-interface when searching for other customers to represent, leaving itunnecessary to "log out" from the represented customer before looking up another customer to represent * For more information about the concept of representation, see https://api-test.connome.com/documentation/CustomerRepresent.html * * If {id} can potentially result in more than one customer being returned, the return-data will always be in the form of an array of customers. * */ +(NSMutableURLRequest*) getCustomerId: (NSString*)id; /** * BPAPI method Device/AddProperty * * Adds a user-defined property for the devices identified by {id}
* * https://api-test.connome.com/documentation/DeviceAddProperty.html * * HTTP methods allowed: GET, POST * * Syntax: Device/{id}/AddProperty/{property_name}/{value}/ * Syntax: Device/12345/AddProperty/switch_mode/1/ABCDABCDABCDABCD * * Adds a user-defined property for the devices identified by {id} * May also be used for changing the value of an existing property. * {id} may be any of node_id, user_defined_name, user_defined_group_name and bpapi_device_id * {key} must be given for some subscription types. * See https://api-test.connome.com/documentation/Device.html for more information about what kind of id's that can be used * * Note that this method may possibly not be used to execute commands at the Gateway. * You may possibly not for instance change switch_state with this method. Although switch_state may be queried as a property with https://api-test.connome.com/documentation/DeviceProperty.html (with {name} = 'switch_state') you have to set it with https://api-test.connome.com/documentation/DeviceTurnOn.html or https://api-test.connome.com/documentation/DeviceTurnOff.html */ +(NSMutableURLRequest*) getDeviceAddPropertyId: (NSString*)id property_name: (NSString*)property_name value: (NSString*)value; +(NSMutableURLRequest*) postDeviceAddPropertyId: (NSString*)id property_name: (NSString*)property_name value: (NSString*)value; /** * BPAPI method Device/AddProperty * * Adds a user-defined property for the devices identified by {id}
* * https://api-test.connome.com/documentation/DeviceAddProperty.html * * HTTP methods allowed: GET, POST * * Syntax: Device/{id}/AddProperty/{property_name}/{value}/ * Syntax: Device/12345/AddProperty/switch_mode/1/ABCDABCDABCDABCD * * Adds a user-defined property for the devices identified by {id} * May also be used for changing the value of an existing property. * {id} may be any of node_id, user_defined_name, user_defined_group_name and bpapi_device_id * {key} must be given for some subscription types. * See https://api-test.connome.com/documentation/Device.html for more information about what kind of id's that can be used * * Note that this method may possibly not be used to execute commands at the Gateway. * You may possibly not for instance change switch_state with this method. Although switch_state may be queried as a property with https://api-test.connome.com/documentation/DeviceProperty.html (with {name} = 'switch_state') you have to set it with https://api-test.connome.com/documentation/DeviceTurnOn.html or https://api-test.connome.com/documentation/DeviceTurnOff.html */ +(NSMutableURLRequest*) getDevice12345AddPropertyswitch_mode1ABCDABCDABCDABCD; +(NSMutableURLRequest*) postDevice12345AddPropertyswitch_mode1ABCDABCDABCDABCD; /** * BPAPI method Device/Aggregation * * Returns information about available aggregation history for the device identified by {id} and the property identified by {device_property}.
* * https://api-test.connome.com/documentation/DeviceAggregation.html * * HTTP methods allowed: GET * * Syntax: Device/{id}/Aggregation/{device_property}/ * * Returns information about available aggregation history for the device identified by {id} and the property identified by {device_property}. * * Use this information in order to construct syntax for querying https://api-test.connome.com/documentation/DeviceAggregationHistory.html. * Only relevant to query as HTML (JSON not supported). * * See also https://api-test.connome.com/documentation/PropertyHistory.html * */ +(NSMutableURLRequest*) getDeviceAggregationId: (NSString*)id device_property: (NSString*)device_property; /** * BPAPI method Device/Aggregation/History * * Returns aggregation history for the specified {aggregation_type} and {period} (for the device identified by {id} and the property identified by {device_property}). * * https://api-test.connome.com/documentation/DeviceAggregationHistory.html * * HTTP methods allowed: GET * * Syntax: Device/{id}/Aggregation/{device_property}/{aggregation_type}/{period}/History/ * Syntax: Device/{device_id}/Aggregation/{device_property}/{aggregation_type}/{period}/History/{count}/ * * Returns aggregation history for the specified {aggregation_type} and {period} (for the device identified by {id} and the property identified by {device_property}). * Use https://api-test.connome.com/documentation/DeviceAggregation.html in order to get more information about possible query syntax. * * Typical values for {aggregation_type} may be one of (Sum, Min, Max, Average, Count_True, Count_False) depending on the actual device * * Possible values for {period} are one of (Min15, Hour, Day, Week, Month, Year, Ever) * * {count} is a calue 0 or higher, where 0 is the current period, 1 is the previous, etc. * * */ +(NSMutableURLRequest*) getDeviceAggregationHistoryId: (NSString*)id device_property: (NSString*)device_property aggregation_type: (NSString*)aggregation_type period: (NSString*)period; /** * BPAPI method Device/Aggregation/History * * Returns aggregation history for the specified {aggregation_type} and {period} (for the device identified by {id} and the property identified by {device_property}). * * https://api-test.connome.com/documentation/DeviceAggregationHistory.html * * HTTP methods allowed: GET * * Syntax: Device/{id}/Aggregation/{device_property}/{aggregation_type}/{period}/History/ * Syntax: Device/{device_id}/Aggregation/{device_property}/{aggregation_type}/{period}/History/{count}/ * * Returns aggregation history for the specified {aggregation_type} and {period} (for the device identified by {id} and the property identified by {device_property}). * Use https://api-test.connome.com/documentation/DeviceAggregation.html in order to get more information about possible query syntax. * * Typical values for {aggregation_type} may be one of (Sum, Min, Max, Average, Count_True, Count_False) depending on the actual device * * Possible values for {period} are one of (Min15, Hour, Day, Week, Month, Year, Ever) * * {count} is a calue 0 or higher, where 0 is the current period, 1 is the previous, etc. * * */ +(NSMutableURLRequest*) getDevice{device_id}Aggregation{device_property}{aggregation_type}{period}History{count}; /** * BPAPI method Device/At * * Stores script given by {script} for execution at time indicated by {time} * * https://api-test.connome.com/documentation/DeviceAt.html * * HTTP methods allowed: GET, POST * * Syntax: Device/{id}/At/{time}/{script}/ * * Stores script given by {script} for execution at time indicated by {time} * Note that any colon in {time} is not allowed by our web-server (IIS) with syntax 1 even if you encode it as %3A. Encode as _COLON_ instead * Likewise for syntax 1, any forward slash in {script} must be replaced by _SLASH_ (encoding as %2F does not help) * * See also https://api-test.connome.com/documentation/GatewayAt.html */ +(NSMutableURLRequest*) getDeviceAtId: (NSString*)id time: (NSString*)time script: (NSString*)script; +(NSMutableURLRequest*) postDeviceAtId: (NSString*)id time: (NSString*)time script: (NSString*)script; /** * BPAPI method Device/History * * Returns history for the device identified by {id}
* * https://api-test.connome.com/documentation/DeviceHistory.html * * HTTP methods allowed: GET * * Syntax: Device/{id}/History/ * Syntax: Device/{id}/History/{limit}/ * * Returns history for the device identified by {id} * * The optional parameter {limit} may be used to narrow the result. See https://api-test.connome.com/documentation/PropertyHistory.html for explanation about using {limit}. * * {id} may be any of node_id, user_defined_name, user_defined_group_name and bpapi_device_id * See https://api-test.connome.com/documentation/Device.html for more information about what kind of id's that can be used * * * If {id} identifies more than one device an error response is generated * See also -PropertyHistory- */ +(NSMutableURLRequest*) getDeviceHistoryId: (NSString*)id; /** * BPAPI method Device/History * * Returns history for the device identified by {id}
* * https://api-test.connome.com/documentation/DeviceHistory.html * * HTTP methods allowed: GET * * Syntax: Device/{id}/History/ * Syntax: Device/{id}/History/{limit}/ * * Returns history for the device identified by {id} * * The optional parameter {limit} may be used to narrow the result. See https://api-test.connome.com/documentation/PropertyHistory.html for explanation about using {limit}. * * {id} may be any of node_id, user_defined_name, user_defined_group_name and bpapi_device_id * See https://api-test.connome.com/documentation/Device.html for more information about what kind of id's that can be used * * * If {id} identifies more than one device an error response is generated * See also -PropertyHistory- */ +(NSMutableURLRequest*) getDeviceHistoryId: (NSString*)id limit: (NSString*)limit; /** * BPAPI method Device/Property * * Returns Property {name} for the device identified by {id}.
* * https://api-test.connome.com/documentation/DeviceProperty.html * * HTTP methods allowed: GET * * Syntax: Device/{id}/Property/{name}/ * Syntax: Device/{id}/Property/{name}/{field}/ * * Returns Property {name} for the device identified by {id}. * * Optionally a sub-field of property may be specified as the {field} parameter. This is useful if just some specific information is needed, and especially when a specific properties is needed for many different devices. * * {name} may consist of multiple property names separated by comma. {name} may end with a wildcard '%'. This is useful for properties which may be repeated, like notification_recipient_app_xx. * * {id} may be any of node_id, user_defined_name, user_defined_group_name and bpapi_device_id * See https://api-test.connome.com/documentation/Device.html for more information about what kind of id's that can be used * * Note that even though it is possible in principle to combine an {id} resulting in more then one device, withmultiple property names separated by comma, it is not recommended as the ordering of the result is not guaranteed to be defined in any way. * Note that this method is somewhat "expensive" in the sense that whole devices are read from the database instead of just the properties requested. * * See also -Property/{id}/LastValue-. That call is much more efficient if you already know the property_id of one of the values sincethe API server does not have to read any Device information. * See also https://api-test.connome.com/documentation/GatewayProperty.html * */ +(NSMutableURLRequest*) getDevicePropertyId: (NSString*)id name: (NSString*)name; /** * BPAPI method Device/Property * * Returns Property {name} for the device identified by {id}.
* * https://api-test.connome.com/documentation/DeviceProperty.html * * HTTP methods allowed: GET * * Syntax: Device/{id}/Property/{name}/ * Syntax: Device/{id}/Property/{name}/{field}/ * * Returns Property {name} for the device identified by {id}. * * Optionally a sub-field of property may be specified as the {field} parameter. This is useful if just some specific information is needed, and especially when a specific properties is needed for many different devices. * * {name} may consist of multiple property names separated by comma. {name} may end with a wildcard '%'. This is useful for properties which may be repeated, like notification_recipient_app_xx. * * {id} may be any of node_id, user_defined_name, user_defined_group_name and bpapi_device_id * See https://api-test.connome.com/documentation/Device.html for more information about what kind of id's that can be used * * Note that even though it is possible in principle to combine an {id} resulting in more then one device, withmultiple property names separated by comma, it is not recommended as the ordering of the result is not guaranteed to be defined in any way. * Note that this method is somewhat "expensive" in the sense that whole devices are read from the database instead of just the properties requested. * * See also -Property/{id}/LastValue-. That call is much more efficient if you already know the property_id of one of the values sincethe API server does not have to read any Device information. * See also https://api-test.connome.com/documentation/GatewayProperty.html * */ +(NSMutableURLRequest*) getDevicePropertyId: (NSString*)id name: (NSString*)name field: (NSString*)field; /** * BPAPI method Device/Refresh * * Updates the BPAPI database with current device-information from the Gateway for Device identified by {id} (fetches updated data from gateway)
* * https://api-test.connome.com/documentation/DeviceRefresh.html * * HTTP methods allowed: GET * * Syntax: Device/{id}/Refresh/ * Syntax: Device/{id}/Refresh/{quick}/ * * Updates the BPAPI database with current device-information from the Gateway for Device identified by {id} (fetches updated data from gateway) * * In principle the database should be automatically updated through the BPAPI Listener mechanism. * Use this method if there are indications that the database has not been properly updated. * Note that updating values through this call will bypass the BPAPI Listener's filtering mechanism against improbable values. No aggregations will be calculated either. * * * * {id} may be any of node_id, user_defined_name, user_defined_group_name and bpapi_device_id * See https://api-test.connome.com/documentation/Device.html for more information about what kind of id's that can be used * * Note: This call may take a while to execute (especially if {id} refers to multiple devices). It is mostly designated for internal use when new devices are discovered (DeviceAdded-events) * * The optional parameter {quick} may be set to TRUE or COMMON in order to refresh only properties most commonly needed to be updated on the server. * The optional parameter {quick} may be set to UNCOMMON in order to refresh properties NOT commonly needed to be updated on the server. * The optional parameter {quick} may be set to ALL or left empty in order to refresh ALL properties updated on the server. * For Sikom gateways this typically entails sending only ordinary S-requests for known devices. * * See also -Property/{id}/Refresh- which may be used to refresh a single existing property. * * See also https://api-test.connome.com/documentation/GatewayRefresh.html which is used for discovering devices at gateway. * https://api-test.connome.com/documentation/GatewayRefresh.html (and not https://api-test.connome.com/documentation/DeviceRefresh.html) is necessary to use if the properties 'Vendor' and 'vendor_type' is not known for a device. * The documentation for -Property/{id}/Refresh- does also contain more information about how properties are returned by the gateway and updated in the database * */ +(NSMutableURLRequest*) getDeviceRefreshId: (NSString*)id; /** * BPAPI method Device/Refresh * * Updates the BPAPI database with current device-information from the Gateway for Device identified by {id} (fetches updated data from gateway)
* * https://api-test.connome.com/documentation/DeviceRefresh.html * * HTTP methods allowed: GET * * Syntax: Device/{id}/Refresh/ * Syntax: Device/{id}/Refresh/{quick}/ * * Updates the BPAPI database with current device-information from the Gateway for Device identified by {id} (fetches updated data from gateway) * * In principle the database should be automatically updated through the BPAPI Listener mechanism. * Use this method if there are indications that the database has not been properly updated. * Note that updating values through this call will bypass the BPAPI Listener's filtering mechanism against improbable values. No aggregations will be calculated either. * * * * {id} may be any of node_id, user_defined_name, user_defined_group_name and bpapi_device_id * See https://api-test.connome.com/documentation/Device.html for more information about what kind of id's that can be used * * Note: This call may take a while to execute (especially if {id} refers to multiple devices). It is mostly designated for internal use when new devices are discovered (DeviceAdded-events) * * The optional parameter {quick} may be set to TRUE or COMMON in order to refresh only properties most commonly needed to be updated on the server. * The optional parameter {quick} may be set to UNCOMMON in order to refresh properties NOT commonly needed to be updated on the server. * The optional parameter {quick} may be set to ALL or left empty in order to refresh ALL properties updated on the server. * For Sikom gateways this typically entails sending only ordinary S-requests for known devices. * * See also -Property/{id}/Refresh- which may be used to refresh a single existing property. * * See also https://api-test.connome.com/documentation/GatewayRefresh.html which is used for discovering devices at gateway. * https://api-test.connome.com/documentation/GatewayRefresh.html (and not https://api-test.connome.com/documentation/DeviceRefresh.html) is necessary to use if the properties 'Vendor' and 'vendor_type' is not known for a device. * The documentation for -Property/{id}/Refresh- does also contain more information about how properties are returned by the gateway and updated in the database * */ +(NSMutableURLRequest*) getDeviceRefreshId: (NSString*)id quick: (NSString*)quick; /** * BPAPI method Device/Simulate * * Simulates reporting of value for DeviceProperty identified by {property_name} for the devices identified by {id}
* * https://api-test.connome.com/documentation/DeviceSimulate.html * * HTTP methods allowed: GET, POST * * Syntax: Device/{id}/Simulate/{property_name}/{value}/ * * Simulates reporting of value for DeviceProperty identified by {property_name} for the devices identified by {id} * * For virtual devices ("virtual_mode" = "1" at gateway-level) simulation is attempted by sending a request direct to the virtual gateway. * In other words, simulation will also use the communication and message parsing functionality, that is, going even deeper down the "stack", and the state of the virtual simulation will also be updated * * {id} may be any of node_id, user_defined_name, user_defined_group_name and bpapi_device_id * See https://api-test.connome.com/documentation/Device.html for more information about what kind of id's that can be used * */ +(NSMutableURLRequest*) getDeviceSimulateId: (NSString*)id property_name: (NSString*)property_name value: (NSString*)value; +(NSMutableURLRequest*) postDeviceSimulateId: (NSString*)id property_name: (NSString*)property_name value: (NSString*)value; /** * BPAPI method Device/Temperature * * Shorthand for calling -Device/Property- with {name} = 'temperature' and comparing against value returned. * * https://api-test.connome.com/documentation/DeviceTemperature.html * * HTTP methods allowed: GET * * Syntax: Device/{id}/Temperature/ * * Shorthand for calling https://api-test.connome.com/documentation/DeviceProperty.html with {name} = 'temperature' and comparing against value returned. * * Similar functions: * https://api-test.connome.com/documentation/DeviceTemperature.html * -Device/{id}/Humidity- * -Device/{id}/IsOn- (Contains more scripting examples) * -Device/{id}/IsOff- * * */ +(NSMutableURLRequest*) getDeviceTemperatureId: (NSString*)id; /** * BPAPI method Device/TurnOff * * Turns off the devices identified by {id}
* * https://api-test.connome.com/documentation/DeviceTurnOff.html * * HTTP methods allowed: GET, POST * * Syntax: Device/{id}/TurnOff/ * * Turns off the devices identified by {id} * * Equivalent to https://api-test.connome.com/documentation/DeviceAddProperty.html with parameters switch_mode 0 * * * {id} may be any of node_id, user_defined_name, user_defined_group_name and bpapi_device_id * See https://api-test.connome.com/documentation/Device.html for more information about what kind of id's that can be used * * For confirmation that the command has been executed on the Gateway, use * https://api-test.connome.com/documentation/DeviceProperty.html like this: Device/{id}/Property/switch_mode/value * and check that the returned scalar_value has been set to 0 (Off). * * See also https://api-test.connome.com/documentation/DeviceTurnOn.html, -Gateway/TurnOn- and -Gateway/TurnOff- */ +(NSMutableURLRequest*) getDeviceTurnOffId: (NSString*)id; +(NSMutableURLRequest*) postDeviceTurnOffId: (NSString*)id; /** * BPAPI method Device/TurnOn * * Turns on the devices identified by {id}
* * https://api-test.connome.com/documentation/DeviceTurnOn.html * * HTTP methods allowed: GET, POST * * Syntax: Device/{id}/TurnOn/ * * Turns on the devices identified by {id} * * Equivalent to https://api-test.connome.com/documentation/DeviceAddProperty.html with parameters switch_mode 1 * * * {id} may be any of node_id, user_defined_name, user_defined_group_name and bpapi_device_id * See https://api-test.connome.com/documentation/Device.html for more information about what kind of id's that can be used * * For confirmation that the command has been executed on the Gateway, use * https://api-test.connome.com/documentation/DeviceProperty.html like this: Device/{id}/Property/switch_mode/value * and check that the returned scalar_value has been set to 1 (On). * * See also https://api-test.connome.com/documentation/DeviceTurnOff.html, -Gateway/TurnOn- and -Gateway/TurnOff- */ +(NSMutableURLRequest*) getDeviceTurnOnId: (NSString*)id; +(NSMutableURLRequest*) postDeviceTurnOnId: (NSString*)id; /** * BPAPI method Device/Add * * Manually adding of devices using ProductCode.
* * https://api-test.connome.com/documentation/DeviceAdd.html * * HTTP methods allowed: GET, POST * * Syntax: Device/Add/HOA/87657 * * Manually adding of devices using ProductCode. * * May be used to: * * 1) Add a device for a virtual gateway (a gateway supported by BPAPI Hardware Abstraction with Virtualization). * Returns bpapi_status OK if succeeds * * 2) Add a sub-device for a web-shop Product (for gateways of type Products). * * Returns bpapi_status OK if succeeds * * Note that as of May 2014 this method does not support specifying a gateway_id. The call will affect the gateway assigned to the customer identified by the authorization credentials used. (the call will fail if more than one gateway has been assigned). * * SampleA: Api("Device/Add/ECODimmer/12345") * */ +(NSMutableURLRequest*) getDeviceAddHOA87657; +(NSMutableURLRequest*) postDeviceAddHOA87657; /** * BPAPI method Device * * Returns information about the device or devices identified by {id}
* * https://api-test.connome.com/documentation/Device.html * * HTTP methods allowed: GET * * Syntax: Device/{id}/ * Syntax: Device/{id}/{gateway_id}/ * * Returns information about the device or devices identified by {id} * * {id} may be any of the following types: * node_id, * All (literally, like "Device/All"), (note that all devices for all gateways will be returned unless {gateway_id} is used to narrow down the search) * user_defined_name, * TODO: not workinguser_defined_group_name, * bpapi_device_id (using bpapi_device_id is a little bit more efficient than using node_id), * A quasi-SQL expression like "WHERE connection = 'offline'" (this is experimental from august 2014 and is limited to examining a maximum of 100 customers, BEFORE access-rights are considered) * You may also search for multiple {id} values by separating each with comma. The different values may be of different types. * * You may also add an optional gateway_id, narrowing down the search to one or more specific gateway. * See https://api-test.connome.com/documentation/Gateway.html for how to specify gateways (gateway_id does not necessarily have to refer to only one gateway) * * Either a single Device is returned, or an array consisting of multiple devices. */ +(NSMutableURLRequest*) getDeviceId: (NSString*)id; /** * BPAPI method Device * * Returns information about the device or devices identified by {id}
* * https://api-test.connome.com/documentation/Device.html * * HTTP methods allowed: GET * * Syntax: Device/{id}/ * Syntax: Device/{id}/{gateway_id}/ * * Returns information about the device or devices identified by {id} * * {id} may be any of the following types: * node_id, * All (literally, like "Device/All"), (note that all devices for all gateways will be returned unless {gateway_id} is used to narrow down the search) * user_defined_name, * TODO: not workinguser_defined_group_name, * bpapi_device_id (using bpapi_device_id is a little bit more efficient than using node_id), * A quasi-SQL expression like "WHERE connection = 'offline'" (this is experimental from august 2014 and is limited to examining a maximum of 100 customers, BEFORE access-rights are considered) * You may also search for multiple {id} values by separating each with comma. The different values may be of different types. * * You may also add an optional gateway_id, narrowing down the search to one or more specific gateway. * See https://api-test.connome.com/documentation/Gateway.html for how to specify gateways (gateway_id does not necessarily have to refer to only one gateway) * * Either a single Device is returned, or an array consisting of multiple devices. */ +(NSMutableURLRequest*) getDeviceId: (NSString*)id gateway_id: (NSString*)gateway_id; /** * BPAPI method Documentation/Refresh * * Refreshes the documentation. * * https://api-test.connome.com/documentation/DocumentationRefresh.html * * HTTP methods allowed: GET * * Syntax: Documentation/Refresh * * Refreshes the documentation. * Mostly useful for running repeated series of unit-tests where the id's used to update the database has to be unique. * For instance, the call https://api-test.connome.com/documentation/CustomerAdd.html will fail if there already existsa customer with email {email} in the database. * https://api-test.connome.com/documentation/DocumentationRefresh.html may in such cases be used to ensure a fresh set of unit-testswith a new unique value for {email} * * */ +(NSMutableURLRequest*) getDocumentationRefresh; /** * BPAPI method ExceptionDetails * * Gets details for the last Exception that occurred on the server.
* * https://api-test.connome.com/documentation/ExceptionDetails.html * * HTTP methods allowed: GET * * Syntax: ExceptionDetails/{sub_system}/ * * Gets details for the last Exception that occurred on the server. * This method requires administrative credentials * * * */ +(NSMutableURLRequest*) getExceptionDetailsSub_system: (NSString*)sub_system; /** * BPAPI method Gateway/AddDealer * * Adds a new dealer-gateway relationship to the database.
* * https://api-test.connome.com/documentation/GatewayAddDealer.html * * HTTP methods allowed: GET, POST * * Syntax: Gateway/AddDealer/{dealer}/ * Syntax: Gateway/AddDealer/{gateway}/{child}/ * * Adds a new dealer-gateway relationship to the database. * * The {gateway}-parameter is optional. If the {gateway} parameter is not specified it will be derived from the credentials used for authorization. * * The credentials used for authorization must contain the right to change properties of the gateway involved. * * * See also https://api-test.connome.com/documentation/CustomerDelegateRight.html * * */ +(NSMutableURLRequest*) getGatewayAddDealerDealer: (NSString*)dealer; +(NSMutableURLRequest*) postGatewayAddDealerDealer: (NSString*)dealer; /** * BPAPI method Gateway/AddDealer * * Adds a new dealer-gateway relationship to the database.
* * https://api-test.connome.com/documentation/GatewayAddDealer.html * * HTTP methods allowed: GET, POST * * Syntax: Gateway/AddDealer/{dealer}/ * Syntax: Gateway/AddDealer/{gateway}/{child}/ * * Adds a new dealer-gateway relationship to the database. * * The {gateway}-parameter is optional. If the {gateway} parameter is not specified it will be derived from the credentials used for authorization. * * The credentials used for authorization must contain the right to change properties of the gateway involved. * * * See also https://api-test.connome.com/documentation/CustomerDelegateRight.html * * */ +(NSMutableURLRequest*) getGatewayAddDealerGateway: (NSString*)gateway child: (NSString*)child; +(NSMutableURLRequest*) postGatewayAddDealerGateway: (NSString*)gateway child: (NSString*)child; /** * BPAPI method Gateway/AddProperty * * Adds or changes a user-defined property for the Gateway or Location identified by {id}
* * https://api-test.connome.com/documentation/GatewayAddProperty.html * * HTTP methods allowed: GET, POST * * Syntax: Gateway/AddProperty/{property_name}/{value}/ * Syntax: Gateway/{id}/AddProperty/{property_name}/{value}/ * * Adds or changes a user-defined property for the Gateway or Location identified by {id} * * The parameter {id} is optional. If not given the call will affect the gateway assigned to the customer identified by the authorization credentials used.(in this case the call will fail if more than one gateway has been assigned) * * * For a list of properties which may be added or changed, use the HTML-version of https://api-test.connome.com/documentation/Gateway.html (add /HTML to the end of your URL). * All properties with a Save button next to them are user-changeable. Some properties like subscription_valid_to_date requires administrative access in order to change.TODO: Add support for multiple values. */ +(NSMutableURLRequest*) getGatewayAddPropertyProperty_name: (NSString*)property_name value: (NSString*)value; +(NSMutableURLRequest*) postGatewayAddPropertyProperty_name: (NSString*)property_name value: (NSString*)value; /** * BPAPI method Gateway/AddProperty * * Adds or changes a user-defined property for the Gateway or Location identified by {id}
* * https://api-test.connome.com/documentation/GatewayAddProperty.html * * HTTP methods allowed: GET, POST * * Syntax: Gateway/AddProperty/{property_name}/{value}/ * Syntax: Gateway/{id}/AddProperty/{property_name}/{value}/ * * Adds or changes a user-defined property for the Gateway or Location identified by {id} * * The parameter {id} is optional. If not given the call will affect the gateway assigned to the customer identified by the authorization credentials used.(in this case the call will fail if more than one gateway has been assigned) * * * For a list of properties which may be added or changed, use the HTML-version of https://api-test.connome.com/documentation/Gateway.html (add /HTML to the end of your URL). * All properties with a Save button next to them are user-changeable. Some properties like subscription_valid_to_date requires administrative access in order to change.TODO: Add support for multiple values. */ +(NSMutableURLRequest*) getGatewayAddPropertyId: (NSString*)id property_name: (NSString*)property_name value: (NSString*)value; +(NSMutableURLRequest*) postGatewayAddPropertyId: (NSString*)id property_name: (NSString*)property_name value: (NSString*)value; /** * BPAPI method Gateway/History * * Returns history for the gateway identified by {id}
* * https://api-test.connome.com/documentation/GatewayHistory.html * * HTTP methods allowed: GET * * Syntax: Gateway//History * Syntax: Gateway/{id}/History/ * Syntax: Gateway/{id}/History/{limit}/ * * Returns history for the gateway identified by {id} * * The parameter {id} is optional. If not given the call will return information about the gateway assigned to the customer identified by the authorization credentials used.(in this case the call will fail if more than one gateway has been assigned) * * The optional parameter {limit} may be used to narrow the result. See https://api-test.connome.com/documentation/PropertyHistory.html for explanation about using {limit}. * * {id} may be any of * gateway_id, * user_defined_name, * user_defined_group_name, * * * If {id} identifies more than one gateway an error response is generated * See also -PropertyHistory- */ +(NSMutableURLRequest*) getGatewayHistory; /** * BPAPI method Gateway/History * * Returns history for the gateway identified by {id}
* * https://api-test.connome.com/documentation/GatewayHistory.html * * HTTP methods allowed: GET * * Syntax: Gateway//History * Syntax: Gateway/{id}/History/ * Syntax: Gateway/{id}/History/{limit}/ * * Returns history for the gateway identified by {id} * * The parameter {id} is optional. If not given the call will return information about the gateway assigned to the customer identified by the authorization credentials used.(in this case the call will fail if more than one gateway has been assigned) * * The optional parameter {limit} may be used to narrow the result. See https://api-test.connome.com/documentation/PropertyHistory.html for explanation about using {limit}. * * {id} may be any of * gateway_id, * user_defined_name, * user_defined_group_name, * * * If {id} identifies more than one gateway an error response is generated * See also -PropertyHistory- */ +(NSMutableURLRequest*) getGatewayHistoryId: (NSString*)id; /** * BPAPI method Gateway/History * * Returns history for the gateway identified by {id}
* * https://api-test.connome.com/documentation/GatewayHistory.html * * HTTP methods allowed: GET * * Syntax: Gateway//History * Syntax: Gateway/{id}/History/ * Syntax: Gateway/{id}/History/{limit}/ * * Returns history for the gateway identified by {id} * * The parameter {id} is optional. If not given the call will return information about the gateway assigned to the customer identified by the authorization credentials used.(in this case the call will fail if more than one gateway has been assigned) * * The optional parameter {limit} may be used to narrow the result. See https://api-test.connome.com/documentation/PropertyHistory.html for explanation about using {limit}. * * {id} may be any of * gateway_id, * user_defined_name, * user_defined_group_name, * * * If {id} identifies more than one gateway an error response is generated * See also -PropertyHistory- */ +(NSMutableURLRequest*) getGatewayHistoryId: (NSString*)id limit: (NSString*)limit; /** * BPAPI method Gateway/ListenerLog * * Returns BPAPIListener log information about the Gateway identified by {id}
* * https://api-test.connome.com/documentation/GatewayListenerLog.html * * HTTP methods allowed: GET * * Syntax: Gateway/ListenerLog * Syntax: Gateway/{id}/ListenerLog/ * * Returns BPAPIListener log information about the Gateway identified by {id} * * The parameter {id} is optional. If not given the call will return information about the gateway assigned to the customer identified by the authorization credentials used.(in this case the call will fail if more than one gateway has been assigned) * * Administrative access is required in order to access this method (note that if https://api-test.connome.com/documentation/CustomerRepresent.html is used then access rights considered are that of the representative) * This method is meant for short-term using. Logging will be active for 10 minutes. After that the log will be deleted. * {id} may be any of the following types: * gateway_id, * All (literally, like "Gateway/All"), * user_defined_name, * user_defined_group_name, * * See https://api-test.connome.com/documentation/Gateway.html for more information about what kind of id's that can be used * * * If {id} identifies more than one gateway an error response is generated */ +(NSMutableURLRequest*) getGatewayListenerLog; /** * BPAPI method Gateway/ListenerLog * * Returns BPAPIListener log information about the Gateway identified by {id}
* * https://api-test.connome.com/documentation/GatewayListenerLog.html * * HTTP methods allowed: GET * * Syntax: Gateway/ListenerLog * Syntax: Gateway/{id}/ListenerLog/ * * Returns BPAPIListener log information about the Gateway identified by {id} * * The parameter {id} is optional. If not given the call will return information about the gateway assigned to the customer identified by the authorization credentials used.(in this case the call will fail if more than one gateway has been assigned) * * Administrative access is required in order to access this method (note that if https://api-test.connome.com/documentation/CustomerRepresent.html is used then access rights considered are that of the representative) * This method is meant for short-term using. Logging will be active for 10 minutes. After that the log will be deleted. * {id} may be any of the following types: * gateway_id, * All (literally, like "Gateway/All"), * user_defined_name, * user_defined_group_name, * * See https://api-test.connome.com/documentation/Gateway.html for more information about what kind of id's that can be used * * * If {id} identifies more than one gateway an error response is generated */ +(NSMutableURLRequest*) getGatewayListenerLogId: (NSString*)id; /** * BPAPI method Gateway/{id}/PairEaseeCharger/{chargerId}/{pinCode} * * Pair Easee charger {chargerId} with gateway {id}.
* * https://api-test.connome.com/documentation/Gateway{id}PairEaseeCharger{chargerId}{pinCode}.html * * HTTP methods allowed: GET, POST * * Syntax: Gateway/2474/PairEaseeCharger/EH123456 * * Pair Easee charger {chargerId} with gateway {id}.

bpapi_status is "ok"/"not_ok" depending on whether the operation was successfully applied or not.
bpapi_message is the reson for bpapi_status being "ok"/"not_ok". MAY only be used for direct display to end user. */ +(NSMutableURLRequest*) getGateway2474PairEaseeChargerEH123456; +(NSMutableURLRequest*) postGateway2474PairEaseeChargerEH123456; /** * BPAPI method Gateway/Property * * Returns property {name} for Gateway or Location identified by {id}
* * https://api-test.connome.com/documentation/GatewayProperty.html * * HTTP methods allowed: GET * * Syntax: Gateway/{id}/Property/{name}/ * Syntax: Gateway/{id}/Property/{name}/{field}/ * * Returns property {name} for Gateway or Location identified by {id} * ///The parameter {id} is optional. If not given the call will return information about the gateway assigned to the customer identified by the authorization credentials used.(in this case the call will fail if more than one gateway has been assigned). See https://api-test.connome.com/documentation/Gateway.html for more information about specifying {id} * * Optionally a sub-field of property may be specified as the {field} parameter.This is useful if just some specific information is needed. * * {name} may consist of multiple property names separated by comma * * * See also https://api-test.connome.com/documentation/DeviceProperty.html which shows more query options. */ +(NSMutableURLRequest*) getGatewayPropertyId: (NSString*)id name: (NSString*)name; /** * BPAPI method Gateway/Property * * Returns property {name} for Gateway or Location identified by {id}
* * https://api-test.connome.com/documentation/GatewayProperty.html * * HTTP methods allowed: GET * * Syntax: Gateway/{id}/Property/{name}/ * Syntax: Gateway/{id}/Property/{name}/{field}/ * * Returns property {name} for Gateway or Location identified by {id} * ///The parameter {id} is optional. If not given the call will return information about the gateway assigned to the customer identified by the authorization credentials used.(in this case the call will fail if more than one gateway has been assigned). See https://api-test.connome.com/documentation/Gateway.html for more information about specifying {id} * * Optionally a sub-field of property may be specified as the {field} parameter.This is useful if just some specific information is needed. * * {name} may consist of multiple property names separated by comma * * * See also https://api-test.connome.com/documentation/DeviceProperty.html which shows more query options. */ +(NSMutableURLRequest*) getGatewayPropertyId: (NSString*)id name: (NSString*)name field: (NSString*)field; /** * BPAPI method Gateway/Refresh * * Updates the BPAPI database with current device-information from the Gateway identified by {id} (fetches updated data from gateway)
* * https://api-test.connome.com/documentation/GatewayRefresh.html * * HTTP methods allowed: GET * * Syntax: Gateway/Refresh * Syntax: Gateway/{id}/Refresh/ * Syntax: Gateway/{id}/Refresh/{quick}/ * * Updates the BPAPI database with current device-information from the Gateway identified by {id} (fetches updated data from gateway) * * The parameter {id} is optional. If not given the call will refresh the gateway assigned to the customer identified by the authorization credentials used.(in this case the call will fail if more than one gateway has been assigned) * * The optional parameter {quick} may be set to TRUE or COMMON in order to refresh only properties most commonly needed to be updated on the server. * The optional parameter {quick} may be set to UNCOMMON in order to refresh properties NOT commonly needed to be updated on the server. * The optional parameter {quick} may be set to ALL or left empty in order to refresh ALL properties updated on the server. * For Sikom gateways this typically entails sending only ordinary S-requests for known devices. * For 'gateways' representing product presentation (internal use) {quick} may be set to a specific language like 'nb-NO', eventually with |quick added * * Note that already known devices are not refreshed. You will have to use https://api-test.connome.com/documentation/DeviceRefresh.html for each known device individually if you want a total update. * In principle the database should automatically always be updated through the BPAPI Listener mechanism.Use this method if there are indications that the database has not been properly updated * * * * See also https://api-test.connome.com/documentation/DeviceRefresh.html which is used for refreshing properties for individual devices. */ +(NSMutableURLRequest*) getGatewayRefresh; /** * BPAPI method Gateway/Refresh * * Updates the BPAPI database with current device-information from the Gateway identified by {id} (fetches updated data from gateway)
* * https://api-test.connome.com/documentation/GatewayRefresh.html * * HTTP methods allowed: GET * * Syntax: Gateway/Refresh * Syntax: Gateway/{id}/Refresh/ * Syntax: Gateway/{id}/Refresh/{quick}/ * * Updates the BPAPI database with current device-information from the Gateway identified by {id} (fetches updated data from gateway) * * The parameter {id} is optional. If not given the call will refresh the gateway assigned to the customer identified by the authorization credentials used.(in this case the call will fail if more than one gateway has been assigned) * * The optional parameter {quick} may be set to TRUE or COMMON in order to refresh only properties most commonly needed to be updated on the server. * The optional parameter {quick} may be set to UNCOMMON in order to refresh properties NOT commonly needed to be updated on the server. * The optional parameter {quick} may be set to ALL or left empty in order to refresh ALL properties updated on the server. * For Sikom gateways this typically entails sending only ordinary S-requests for known devices. * For 'gateways' representing product presentation (internal use) {quick} may be set to a specific language like 'nb-NO', eventually with |quick added * * Note that already known devices are not refreshed. You will have to use https://api-test.connome.com/documentation/DeviceRefresh.html for each known device individually if you want a total update. * In principle the database should automatically always be updated through the BPAPI Listener mechanism.Use this method if there are indications that the database has not been properly updated * * * * See also https://api-test.connome.com/documentation/DeviceRefresh.html which is used for refreshing properties for individual devices. */ +(NSMutableURLRequest*) getGatewayRefreshId: (NSString*)id; /** * BPAPI method Gateway/Refresh * * Updates the BPAPI database with current device-information from the Gateway identified by {id} (fetches updated data from gateway)
* * https://api-test.connome.com/documentation/GatewayRefresh.html * * HTTP methods allowed: GET * * Syntax: Gateway/Refresh * Syntax: Gateway/{id}/Refresh/ * Syntax: Gateway/{id}/Refresh/{quick}/ * * Updates the BPAPI database with current device-information from the Gateway identified by {id} (fetches updated data from gateway) * * The parameter {id} is optional. If not given the call will refresh the gateway assigned to the customer identified by the authorization credentials used.(in this case the call will fail if more than one gateway has been assigned) * * The optional parameter {quick} may be set to TRUE or COMMON in order to refresh only properties most commonly needed to be updated on the server. * The optional parameter {quick} may be set to UNCOMMON in order to refresh properties NOT commonly needed to be updated on the server. * The optional parameter {quick} may be set to ALL or left empty in order to refresh ALL properties updated on the server. * For Sikom gateways this typically entails sending only ordinary S-requests for known devices. * For 'gateways' representing product presentation (internal use) {quick} may be set to a specific language like 'nb-NO', eventually with |quick added * * Note that already known devices are not refreshed. You will have to use https://api-test.connome.com/documentation/DeviceRefresh.html for each known device individually if you want a total update. * In principle the database should automatically always be updated through the BPAPI Listener mechanism.Use this method if there are indications that the database has not been properly updated * * * * See also https://api-test.connome.com/documentation/DeviceRefresh.html which is used for refreshing properties for individual devices. */ +(NSMutableURLRequest*) getGatewayRefreshId: (NSString*)id quick: (NSString*)quick; /** * BPAPI method Gateway/SendRawCommand * * Sends {command} direct to the gateway identified by {id}.
* * https://api-test.connome.com/documentation/GatewaySendRawCommand.html * * HTTP methods allowed: GET, POST * * Syntax: Gateway/SendRawCommand/{command}/ * Syntax: Gateway/{id}/SendRawCommand/{command}/ * * Sends {command} direct to the gateway identified by {id}. * * This method is meant for testing purposes by qualified personell only. No verification / parsing is done on the server side.Administrative access is therefore required in order to access this method (note that if https://api-test.connome.com/documentation/CustomerRepresent.html is used then access rights considered are that of the representative) * The parameter {id} is optional. If not given the command will be sent to the gateway assigned to the customer identified by the authorization credentials used.(in this case the call will fail if more than one gateway has been assigned) * * {id} may be any of * gateway_id, * user_defined_name, * user_defined_group_name, * * See https://api-test.connome.com/documentation/Gateway.html for more information about what kind of id's that can be used * * * If {id} identifies more than one gateway an error response is generated * */ +(NSMutableURLRequest*) getGatewaySendRawCommandCommand: (NSString*)command; +(NSMutableURLRequest*) postGatewaySendRawCommandCommand: (NSString*)command; /** * BPAPI method Gateway/SendRawCommand * * Sends {command} direct to the gateway identified by {id}.
* * https://api-test.connome.com/documentation/GatewaySendRawCommand.html * * HTTP methods allowed: GET, POST * * Syntax: Gateway/SendRawCommand/{command}/ * Syntax: Gateway/{id}/SendRawCommand/{command}/ * * Sends {command} direct to the gateway identified by {id}. * * This method is meant for testing purposes by qualified personell only. No verification / parsing is done on the server side.Administrative access is therefore required in order to access this method (note that if https://api-test.connome.com/documentation/CustomerRepresent.html is used then access rights considered are that of the representative) * The parameter {id} is optional. If not given the command will be sent to the gateway assigned to the customer identified by the authorization credentials used.(in this case the call will fail if more than one gateway has been assigned) * * {id} may be any of * gateway_id, * user_defined_name, * user_defined_group_name, * * See https://api-test.connome.com/documentation/Gateway.html for more information about what kind of id's that can be used * * * If {id} identifies more than one gateway an error response is generated * */ +(NSMutableURLRequest*) getGatewaySendRawCommandId: (NSString*)id command: (NSString*)command; +(NSMutableURLRequest*) postGatewaySendRawCommandId: (NSString*)id command: (NSString*)command; /** * BPAPI method Gateway/TransmitLocalControlKey * * Generates a temporary key for use with subscription type LocalControl and transmits it using UDP on the provided port and IP address. The IP address has to be a local address. * * https://api-test.connome.com/documentation/GatewayTransmitLocalControlKey.html * * HTTP methods allowed: GET, POST * * Syntax: Gateway/12345/TransmitLocalControlKey/192.168.0.15/19000 * * Generates a temporary key for use with subscription type LocalControl and transmits it using UDP on the provided port and IP address. The IP address has to be a local address. * */ +(NSMutableURLRequest*) getGateway12345TransmitLocalControlKey192.168.0.1519000; +(NSMutableURLRequest*) postGateway12345TransmitLocalControlKey192.168.0.1519000; /** * BPAPI method Gateway/UpdateFirmware * * Update the Gateway with id to the specified version. * * https://api-test.connome.com/documentation/GatewayUpdateFirmware.html * * HTTP methods allowed: GET * * Syntax: Gateway/{id}/UpdateFirmware/{requested_version}/{force} * * Update the Gateway with id to the specified version.Method fails if the requested version is older than current or version is not compatibable with gateway. * * If {id} identifies more than one gateway an error response is generated. {requested_version} is etc.... */ +(NSMutableURLRequest*) getGateway{id}UpdateFirmware{requested_version}{force}; /** * BPAPI method Gateway/ReplaceWith * * Replaces one gateway with another for a customer.
* * https://api-test.connome.com/documentation/GatewayReplaceWith.html * * HTTP methods allowed: GET, POST * * Syntax: Gateway/{old_registration_id}/ReplaceWith/{new_registration_id}/ * * Replaces one gateway with another for a customer. * {old_registration_id} has to be registered to an e-mail address, while {new_registration_id} can not be registered to an e-mail address. * * This API-method will also give an explanation in the form of the necessary equivalent API calls (URLs) in order perform the same operation "manually",that is replace {old_registration_id} with {new_registration_id} * * * */ +(NSMutableURLRequest*) getGatewayReplaceWithOld_registration_id: (NSString*)old_registration_id new_registration_id: (NSString*)new_registration_id; +(NSMutableURLRequest*) postGatewayReplaceWithOld_registration_id: (NSString*)old_registration_id new_registration_id: (NSString*)new_registration_id; /** * BPAPI method Gateway/Add * * Adds a Gateway to the database.
* * https://api-test.connome.com/documentation/GatewayAdd.html * * No authorization required HTTP methods allowed: GET, POST * * Syntax: Gateway/Add/{network_id}/{registration_id}/{gateway_type}/ * * Adds a Gateway to the database. * * A gateway represents a physical device. * * * For GSM based gateways network_id is the ICCID (SIM-card number), usually starting with ICCID_89. * * registration_id is the ID later used by the end-customer in order to identify the gateway when assigning it with https://api-test.connome.com/documentation/GatewayAssign.html. * * registration_id may also be used as (case insensitive) credentials together with a standard quasi-secret password * In the latter case a customer with registration_id and standard quasi-secret password as credentials will be automaticaly created * and the gateway will be automatically assigned to this customer. * (see https://api-test.connome.com/documentation/CustomerAdd.html for how to then change credentials to ordinary email and password after the automatic assignment has been executed) * * registration_id can be any value as long as it is unique, easy and convenient for the end-customer to locate and enter and at the same time relatively difficult to guess. * Also called Value code with value like 'ab1234cd'. * * See also https://api-test.connome.com/documentation/GatewayAssign.html * * */ +(NSMutableURLRequest*) getGatewayAddNetwork_id: (NSString*)network_id registration_id: (NSString*)registration_id gateway_type: (NSString*)gateway_type; +(NSMutableURLRequest*) postGatewayAddNetwork_id: (NSString*)network_id registration_id: (NSString*)registration_id gateway_type: (NSString*)gateway_type; /** * BPAPI method Gateway/AddPropertySimple * * Adds a user-defined property for the gateway identified by the registration_id
* * https://api-test.connome.com/documentation/GatewayAddPropertySimple.html * * No authorization required HTTP methods allowed: GET, POST * * Syntax: Gateway/AddPropertySimple/{registration_id}/{property_name}/{value}/ * * Adds a user-defined property for the gateway identified by the registration_id * * This is a restricted call compared to https://api-test.connome.com/documentation/GatewayAddProperty.html since autentication is only done with a registration_idand not email (username) and password. Only a few properties is allowed to set by this method. * * -VerifyRegistrationId- can be used to read the corresponding values that is allowed to set by this method. * possible data_error values for bpapi_status are: * "invalid_registration_id_data_error" * * * See also -VerifyRegistrationId- and https://api-test.connome.com/documentation/GatewayAddProperty.html * */ +(NSMutableURLRequest*) getGatewayAddPropertySimpleRegistration_id: (NSString*)registration_id property_name: (NSString*)property_name value: (NSString*)value; +(NSMutableURLRequest*) postGatewayAddPropertySimpleRegistration_id: (NSString*)registration_id property_name: (NSString*)property_name value: (NSString*)value; /** * BPAPI method Gateway/At * * Stores script given by {script} for execution at time indicated by {time} * * https://api-test.connome.com/documentation/GatewayAt.html * * HTTP methods allowed: GET, POST * * Syntax: Gateway/At/{time}/{script}/ * * Stores script given by {script} for execution at time indicated by {time} * Note that any colon in {time} is not allowed by our web-server (IIS) with syntax 1 even if you encode it as %3A. Encode as _COLON_ instead * Likewise for syntax 1, any forward slash in {script} must be replaced by _SLASH_ (encoding as %2F does not help) * * See also https://api-test.connome.com/documentation/DeviceAt.html */ +(NSMutableURLRequest*) getGatewayAtTime: (NSString*)time script: (NSString*)script; +(NSMutableURLRequest*) postGatewayAtTime: (NSString*)time script: (NSString*)script; /** * BPAPI method Gateway * * Returns information about the Gateway identified by {id}
* * https://api-test.connome.com/documentation/Gateway.html * * HTTP methods allowed: GET * * Syntax: Gateway * Syntax: Gateway/{id}/ * * Returns information about the Gateway identified by {id} * * The parameter {id} is optional. If not given the call will return information about the gateway assigned to the customer identified by the authorization credentials used.(in this case the call will fail if more than one gateway has been assigned) * * {id} may be any of the following types: * gateway_id, * All (literally, like "Gateway/All"), * user_defined_name, * user_defined_group_name, * A quasi-SQL expression like "WHERE virtual_mode = 1" (this is experimental from august 2014 and is limited to examining a maximum of 100 customers, BEFORE access-rights are considered) * You may also search for multiple {id} values by separating each with comma.The different values may be of different types. * * * * */ +(NSMutableURLRequest*) getGateway; /** * BPAPI method Gateway * * Returns information about the Gateway identified by {id}
* * https://api-test.connome.com/documentation/Gateway.html * * HTTP methods allowed: GET * * Syntax: Gateway * Syntax: Gateway/{id}/ * * Returns information about the Gateway identified by {id} * * The parameter {id} is optional. If not given the call will return information about the gateway assigned to the customer identified by the authorization credentials used.(in this case the call will fail if more than one gateway has been assigned) * * {id} may be any of the following types: * gateway_id, * All (literally, like "Gateway/All"), * user_defined_name, * user_defined_group_name, * A quasi-SQL expression like "WHERE virtual_mode = 1" (this is experimental from august 2014 and is limited to examining a maximum of 100 customers, BEFORE access-rights are considered) * You may also search for multiple {id} values by separating each with comma.The different values may be of different types. * * * * */ +(NSMutableURLRequest*) getGatewayId: (NSString*)id; /** * BPAPI method HTTPStatus * * Returns an HTTP / HTML-response with the specified HTTP {status_code} and the specified plain-text {message}
* * https://api-test.connome.com/documentation/HTTPStatus.html * * No authorization required HTTP methods allowed: GET * * Syntax: HTTPStatus * Syntax: HTTPStatus/{status_code}/ * Syntax: HTTPStatus/{status_code}/{message}/ * * Returns an HTTP / HTML-response with the specified HTTP {status_code} and the specified plain-text {message} * * Not used by the API itself. Used for presentation of static HTML pages in order to have standardized error-pages * * If {status_code} is not given or if {status_code} is an invalid HTTP status code then 404 is assumed. * If {message} is not given then string-value of .NET System.Net.HttpStatusCode will be returned. * if {status_code} starts with '3' and {message} starts with 'http' then the HTTP Location header in the returned response will be set to {message} * HTML is returned regardless of HTML being added at the end of the query-string or not. * * */ +(NSMutableURLRequest*) getHTTPStatus; /** * BPAPI method HTTPStatus * * Returns an HTTP / HTML-response with the specified HTTP {status_code} and the specified plain-text {message}
* * https://api-test.connome.com/documentation/HTTPStatus.html * * No authorization required HTTP methods allowed: GET * * Syntax: HTTPStatus * Syntax: HTTPStatus/{status_code}/ * Syntax: HTTPStatus/{status_code}/{message}/ * * Returns an HTTP / HTML-response with the specified HTTP {status_code} and the specified plain-text {message} * * Not used by the API itself. Used for presentation of static HTML pages in order to have standardized error-pages * * If {status_code} is not given or if {status_code} is an invalid HTTP status code then 404 is assumed. * If {message} is not given then string-value of .NET System.Net.HttpStatusCode will be returned. * if {status_code} starts with '3' and {message} starts with 'http' then the HTTP Location header in the returned response will be set to {message} * HTML is returned regardless of HTML being added at the end of the query-string or not. * * */ +(NSMutableURLRequest*) getHTTPStatusStatus_code: (NSString*)status_code; /** * BPAPI method HTTPStatus * * Returns an HTTP / HTML-response with the specified HTTP {status_code} and the specified plain-text {message}
* * https://api-test.connome.com/documentation/HTTPStatus.html * * No authorization required HTTP methods allowed: GET * * Syntax: HTTPStatus * Syntax: HTTPStatus/{status_code}/ * Syntax: HTTPStatus/{status_code}/{message}/ * * Returns an HTTP / HTML-response with the specified HTTP {status_code} and the specified plain-text {message} * * Not used by the API itself. Used for presentation of static HTML pages in order to have standardized error-pages * * If {status_code} is not given or if {status_code} is an invalid HTTP status code then 404 is assumed. * If {message} is not given then string-value of .NET System.Net.HttpStatusCode will be returned. * if {status_code} starts with '3' and {message} starts with 'http' then the HTTP Location header in the returned response will be set to {message} * HTML is returned regardless of HTML being added at the end of the query-string or not. * * */ +(NSMutableURLRequest*) getHTTPStatusStatus_code: (NSString*)status_code message: (NSString*)message; /** * BPAPI method Notification/AddApp * * Adds an identification for sending notifications to a Smartphone App
* * https://api-test.connome.com/documentation/NotificationAddApp.html * * HTTP methods allowed: GET, POST * * Syntax: Notification/AddApp/{app_name}/{id}/ * * Adds an identification for sending notifications to a Smartphone App * * Supports the following types of notifications: * 1) An Android GCM (Google Cloud Messaging) RegistrationId. See http://developer.android.com/google/gcm/index.html for more information. Or * 2) An APNS (Apple Push Notification Service) DeviceToken. See https://developer.apple.com/library/ios/documentation/NetworkingInternet/Conceptual/RemoteNotificationsPG/Chapters/ApplePushService.html for more information * * * If the {id} (RegistrationId / DeviceToken) already exist then the actual property's last_valid field will be updated (together with {app_name}). * If the {id} do not exist then the method is equivalent to * Customer/AddProperty/notification_recipient_app_X/{id}/ * where X should be the first "non-occupied" index found (except that less syntax-checking will be done). (see https://api-test.connome.com/documentation/CustomerAddProperty.html) * * Tip: Add a slash, /, to the end of your query string if the last parameter contains a full stop . or dash - and you want to use HTTP method GET. * * Note that a Smartphone App is expected to regularly confirm an id (RegistrationId / DeviceToken). Old ids may be purged regularly from BPAPI. Ids may also be purged if they are confirmed invalid by the relevant service (Google Cloud Messaging / Apple Push Notification Service) * * Note that a given {id} can only exist for one customer at a time in the database. Duplicates will be set no-longer-current. The rationale behind this is to ensure that a given smartphone only receives notifications for the latest customer which the user has logged in as. * (for instance, an installator would not want to continue to receive notifications for all old customers' systems that he has ever tested with his smartphone) * */ +(NSMutableURLRequest*) getNotificationAddAppApp_name: (NSString*)app_name id: (NSString*)id; +(NSMutableURLRequest*) postNotificationAddAppApp_name: (NSString*)app_name id: (NSString*)id; /** * BPAPI method Notification/AddCellular * * Adds a cellular notification recipient for the customer
* * https://api-test.connome.com/documentation/NotificationAddCellular.html * * HTTP methods allowed: GET, POST * * Syntax: Notification/AddCellular/{number}/ * Syntax: Notification/AddCellular/{number}/{name}/ * * Adds a cellular notification recipient for the customer * By cellular is meant a telephone number capable of receiving voice-calls and SMS-messages. * * The method is equivalent to * Customer/AddProperty/notification_recipient_cellular_X/{number}|{name}/ * where X should be the first "non-occupied" index found (except that less syntax-checking will be done). (see https://api-test.connome.com/documentation/CustomerAddProperty.html) * * Tip: Add / to the end of your query string if the last parameter contains a full stop . or dash - and you want to use HTTP method GET. */ +(NSMutableURLRequest*) getNotificationAddCellularNumber: (NSString*)number; +(NSMutableURLRequest*) postNotificationAddCellularNumber: (NSString*)number; /** * BPAPI method Notification/AddCellular * * Adds a cellular notification recipient for the customer
* * https://api-test.connome.com/documentation/NotificationAddCellular.html * * HTTP methods allowed: GET, POST * * Syntax: Notification/AddCellular/{number}/ * Syntax: Notification/AddCellular/{number}/{name}/ * * Adds a cellular notification recipient for the customer * By cellular is meant a telephone number capable of receiving voice-calls and SMS-messages. * * The method is equivalent to * Customer/AddProperty/notification_recipient_cellular_X/{number}|{name}/ * where X should be the first "non-occupied" index found (except that less syntax-checking will be done). (see https://api-test.connome.com/documentation/CustomerAddProperty.html) * * Tip: Add / to the end of your query string if the last parameter contains a full stop . or dash - and you want to use HTTP method GET. */ +(NSMutableURLRequest*) getNotificationAddCellularNumber: (NSString*)number name: (NSString*)name; +(NSMutableURLRequest*) postNotificationAddCellularNumber: (NSString*)number name: (NSString*)name; /** * BPAPI method Notification/AddEMail * * Adds an email notification recipient for the customer
* * https://api-test.connome.com/documentation/NotificationAddEMail.html * * HTTP methods allowed: GET, POST * * Syntax: Notification/AddEMail/{email}/ * Syntax: Notification/AddEMail/{email}/{name}/ * * Adds an email notification recipient for the customer * * The method is equivalent to * Customer/AddProperty/notification_recipient_email_X/{email}|{name}/ * where X should be the first "non-occupied" index found (except that less syntax-checking will be done). (see https://api-test.connome.com/documentation/CustomerAddProperty.html) * Tip: Add / to the end of your query string if the last parameter contains a full stop . or dash - and you want to use HTTP method GET. */ +(NSMutableURLRequest*) getNotificationAddEMailEmail: (NSString*)email; +(NSMutableURLRequest*) postNotificationAddEMailEmail: (NSString*)email; /** * BPAPI method Notification/AddEMail * * Adds an email notification recipient for the customer
* * https://api-test.connome.com/documentation/NotificationAddEMail.html * * HTTP methods allowed: GET, POST * * Syntax: Notification/AddEMail/{email}/ * Syntax: Notification/AddEMail/{email}/{name}/ * * Adds an email notification recipient for the customer * * The method is equivalent to * Customer/AddProperty/notification_recipient_email_X/{email}|{name}/ * where X should be the first "non-occupied" index found (except that less syntax-checking will be done). (see https://api-test.connome.com/documentation/CustomerAddProperty.html) * Tip: Add / to the end of your query string if the last parameter contains a full stop . or dash - and you want to use HTTP method GET. */ +(NSMutableURLRequest*) getNotificationAddEMailEmail: (NSString*)email name: (NSString*)name; +(NSMutableURLRequest*) postNotificationAddEMailEmail: (NSString*)email name: (NSString*)name; /** * BPAPI method Notification/AddPowel * * Adds a Powel DMS-id for the customer
* * https://api-test.connome.com/documentation/NotificationAddPowel.html * * HTTP methods allowed: GET, POST * * Syntax: Notification/AddPowel/{dms_id}/ * Syntax: Notification/AddPowel/{dms_id}/{name}/ * * Adds a Powel DMS-id for the customer * An additional parameter {name} may be supplied and will be stored internally (but not used) by BPAPI * * * The method is equivalent to * Customer/AddProperty/notification_recipient_powel_X/{number}|{name}/ * where X should be the first "non-occupied" index found (except that less syntax-checking will be done). (see https://api-test.connome.com/documentation/CustomerAddProperty.html) * * Tip: Add / to the end of your query string if the last parameter contains a full stop . or dash - and you want to use HTTP method GET. */ +(NSMutableURLRequest*) getNotificationAddPowelDms_id: (NSString*)dms_id; +(NSMutableURLRequest*) postNotificationAddPowelDms_id: (NSString*)dms_id; /** * BPAPI method Notification/AddPowel * * Adds a Powel DMS-id for the customer
* * https://api-test.connome.com/documentation/NotificationAddPowel.html * * HTTP methods allowed: GET, POST * * Syntax: Notification/AddPowel/{dms_id}/ * Syntax: Notification/AddPowel/{dms_id}/{name}/ * * Adds a Powel DMS-id for the customer * An additional parameter {name} may be supplied and will be stored internally (but not used) by BPAPI * * * The method is equivalent to * Customer/AddProperty/notification_recipient_powel_X/{number}|{name}/ * where X should be the first "non-occupied" index found (except that less syntax-checking will be done). (see https://api-test.connome.com/documentation/CustomerAddProperty.html) * * Tip: Add / to the end of your query string if the last parameter contains a full stop . or dash - and you want to use HTTP method GET. */ +(NSMutableURLRequest*) getNotificationAddPowelDms_id: (NSString*)dms_id name: (NSString*)name; +(NSMutableURLRequest*) postNotificationAddPowelDms_id: (NSString*)dms_id name: (NSString*)name; /** * BPAPI method Notify * * Sends notification
* * https://api-test.connome.com/documentation/Notify.html * * HTTP methods allowed: GET, POST * * Syntax: Notify/{text}/ * Syntax: Notify/{text}/{time_filter}/ * * Sends notification * Sends notification with text {text} to all notification recipients registered with methods like * https://api-test.connome.com/documentation/NotificationAddEMail.html, * https://api-test.connome.com/documentation/NotificationAddCellular.html, * https://api-test.connome.com/documentation/NotificationAddApp.html and * https://api-test.connome.com/documentation/NotificationAddPowel.html (for testing against Powel, use a valid DeviceProperty like 'temperature_notification_triggered' or with the text '_not' inserted like 'temperature_notification_not_triggered' as {text} * * If a notification with identical text has been sent after the point in time indicated by {time_filter} then the notification will be discarded. {time_filter} is optional, with default value of "10min". * * * Tip: Add / to the end of your query string if the last parameter contains a full stop . or dash - and you want to use HTTP method GET. */ +(NSMutableURLRequest*) getNotifyText: (NSString*)text; +(NSMutableURLRequest*) postNotifyText: (NSString*)text; /** * BPAPI method Notify * * Sends notification
* * https://api-test.connome.com/documentation/Notify.html * * HTTP methods allowed: GET, POST * * Syntax: Notify/{text}/ * Syntax: Notify/{text}/{time_filter}/ * * Sends notification * Sends notification with text {text} to all notification recipients registered with methods like * https://api-test.connome.com/documentation/NotificationAddEMail.html, * https://api-test.connome.com/documentation/NotificationAddCellular.html, * https://api-test.connome.com/documentation/NotificationAddApp.html and * https://api-test.connome.com/documentation/NotificationAddPowel.html (for testing against Powel, use a valid DeviceProperty like 'temperature_notification_triggered' or with the text '_not' inserted like 'temperature_notification_not_triggered' as {text} * * If a notification with identical text has been sent after the point in time indicated by {time_filter} then the notification will be discarded. {time_filter} is optional, with default value of "10min". * * * Tip: Add / to the end of your query string if the last parameter contains a full stop . or dash - and you want to use HTTP method GET. */ +(NSMutableURLRequest*) getNotifyText: (NSString*)text time_filter: (NSString*)time_filter; +(NSMutableURLRequest*) postNotifyText: (NSString*)text time_filter: (NSString*)time_filter; /** * BPAPI method Places * * Executes a search for places recognized by the given service (typical a weather forecast service).
* * https://api-test.connome.com/documentation/Places.html * * HTTP methods allowed: GET * * Syntax: Places/{service}/{search_criteria}/ * * Executes a search for places recognized by the given service (typical a weather forecast service). * * A maximum of 20 places are returned. * * Returns a key / value collection where the format of the key is suitable for direct insertion into REST URLs as used by the given service. * For instance if yr.no is used as the service the format of the keys will be in one of the following two forms: * * [COUNTRY]/[REGION]/[PLACE] like "Zimbabwe/Matabeleland_South/Springfontein" or * "Norway/[FYLKE]/[KOMMUNE]/[STED] like "Norge/Sør-Trøndelag/Trondheim/Lade" * * These strings can in turn be inserted directly into a REST URL consumed by yr.no like * * http://www.yr.no/sted/Zimbabwe/Matabeleland_South/Springfontein/varsel.xml or like * http://www.yr.no/sted/Norge/Sør-Trøndelag/Trondheim/Lade/varsel.xml * * The value in every key / value pair returned will be in a form suitable for human consumption. * For instance like "Springfontein (Matabeleland_South, Zimbabwe)" or like "Lade (Trondheim, Sør-Trøndelag, Norway)" * * Note: This method requires authentication in order to facilitate tailored result for the customer identified by the authorization credentials used. * * A cache of places is kept within BPAPI. As of February 2014 the following URL is used to look for unknown places: * https://ws.geonorge.no/SKWS3Index/ssr/sok?navn=[search_criteria]*&eksakteForst=true * Confer with this URL if search through BPAPI does not give the desired result. * Places with "navnetype" other than * Kommune, By, Bydel, Tettbebyggelse, Bygdelag (bygd), Grend, SkogomrÃ¥de, Flyplass, Bruk (gardsbruk), Enebolig/mindre bolig (villa) * are ignored by BPAPI. * */ +(NSMutableURLRequest*) getPlacesService: (NSString*)service search_criteria: (NSString*)search_criteria; /** * BPAPI method Project/GatewayIds * * Returns list of IDs for all gateway registered in a project or subproject.
* * https://api-test.connome.com/documentation/ProjectGatewayIds.html * * HTTP methods allowed: GET * * Syntax: Customer/{id}/Project/GatewayIds/ * Syntax: Customer/Project/GatewayIds * * Returns list of IDs for all gateway registered in a project or subproject. * * {id} is either a project or subproject ID. If not specified, it defaults to the current user's ID. * * */ +(NSMutableURLRequest*) getCustomerProjectGatewayIdsId: (NSString*)id; /** * BPAPI method Project/GatewayIds * * Returns list of IDs for all gateway registered in a project or subproject.
* * https://api-test.connome.com/documentation/ProjectGatewayIds.html * * HTTP methods allowed: GET * * Syntax: Customer/{id}/Project/GatewayIds/ * Syntax: Customer/Project/GatewayIds * * Returns list of IDs for all gateway registered in a project or subproject. * * {id} is either a project or subproject ID. If not specified, it defaults to the current user's ID. * * */ +(NSMutableURLRequest*) getCustomerProjectGatewayIds; /** * BPAPI method Property/AddProperty * * Adds a child-property to the property identified by {id}
* * https://api-test.connome.com/documentation/PropertyAddProperty.html * * HTTP methods allowed: GET, POST * * Syntax: Property/{id}/AddProperty/{property_name}/{value}/ * * Adds a child-property to the property identified by {id} * * * */ +(NSMutableURLRequest*) getPropertyAddPropertyId: (NSString*)id property_name: (NSString*)property_name value: (NSString*)value; +(NSMutableURLRequest*) postPropertyAddPropertyId: (NSString*)id property_name: (NSString*)property_name value: (NSString*)value; /** * BPAPI method Property/History * * Shows historical values for property identified by {id}
* * https://api-test.connome.com/documentation/PropertyHistory.html * * HTTP methods allowed: GET * * Syntax: Property/{id}/History/ * Syntax: Property/{id}/History/{limit}/{no_filter}/ * Syntax: Property/{id}/History/{limit}/ * * Shows historical values for property identified by {id} * {id} is usually found as the current property for a Device for instance. * The actual {id} does not necessarily have to be that of the last "current" property. The id of any old no-longer-current property may also be used. * * The optional parameter {limit} may be used to narrow the result. {limit} may be set to: * A) A maximum count of history records returned like '42' or * B) A relative time interval like '5min', '7hours' or similar (only newer records will be returned) or * C) An absolute point-in-time like '2014-08-01 10:00' (only newer records will be returned. Note that _COLON_ must be used instead of ':' if HTTP GET syntax 1 is used * * The optional parameter {no_filter} may be set to 'True' if absolutely all records are desired. * This is applicable for 'notification'-properties for which notifications deactivated by the customer himself / herself are usually not shown. * In other words {no_filter} is useful when you want to see the customer's notification-history, even messages that has been deleted from a corresponding app. * * * Note that if https://api-test.connome.com/documentation/PropertySetNoLongerCurrent.html has been called earlier with credentials corresponding to the CustomerId1 of a property with Name 'notification', that property will not be included. * * See also https://api-test.connome.com/documentation/DeviceAggregation.html, https://api-test.connome.com/documentation/CustomerHistory.html, https://api-test.connome.com/documentation/GatewayHistory.html and https://api-test.connome.com/documentation/DeviceHistory.html */ +(NSMutableURLRequest*) getPropertyHistoryId: (NSString*)id; /** * BPAPI method Property/History * * Shows historical values for property identified by {id}
* * https://api-test.connome.com/documentation/PropertyHistory.html * * HTTP methods allowed: GET * * Syntax: Property/{id}/History/ * Syntax: Property/{id}/History/{limit}/{no_filter}/ * Syntax: Property/{id}/History/{limit}/ * * Shows historical values for property identified by {id} * {id} is usually found as the current property for a Device for instance. * The actual {id} does not necessarily have to be that of the last "current" property. The id of any old no-longer-current property may also be used. * * The optional parameter {limit} may be used to narrow the result. {limit} may be set to: * A) A maximum count of history records returned like '42' or * B) A relative time interval like '5min', '7hours' or similar (only newer records will be returned) or * C) An absolute point-in-time like '2014-08-01 10:00' (only newer records will be returned. Note that _COLON_ must be used instead of ':' if HTTP GET syntax 1 is used * * The optional parameter {no_filter} may be set to 'True' if absolutely all records are desired. * This is applicable for 'notification'-properties for which notifications deactivated by the customer himself / herself are usually not shown. * In other words {no_filter} is useful when you want to see the customer's notification-history, even messages that has been deleted from a corresponding app. * * * Note that if https://api-test.connome.com/documentation/PropertySetNoLongerCurrent.html has been called earlier with credentials corresponding to the CustomerId1 of a property with Name 'notification', that property will not be included. * * See also https://api-test.connome.com/documentation/DeviceAggregation.html, https://api-test.connome.com/documentation/CustomerHistory.html, https://api-test.connome.com/documentation/GatewayHistory.html and https://api-test.connome.com/documentation/DeviceHistory.html */ +(NSMutableURLRequest*) getPropertyHistoryId: (NSString*)id limit: (NSString*)limit no_filter: (NSString*)no_filter; /** * BPAPI method Property/History * * Shows historical values for property identified by {id}
* * https://api-test.connome.com/documentation/PropertyHistory.html * * HTTP methods allowed: GET * * Syntax: Property/{id}/History/ * Syntax: Property/{id}/History/{limit}/{no_filter}/ * Syntax: Property/{id}/History/{limit}/ * * Shows historical values for property identified by {id} * {id} is usually found as the current property for a Device for instance. * The actual {id} does not necessarily have to be that of the last "current" property. The id of any old no-longer-current property may also be used. * * The optional parameter {limit} may be used to narrow the result. {limit} may be set to: * A) A maximum count of history records returned like '42' or * B) A relative time interval like '5min', '7hours' or similar (only newer records will be returned) or * C) An absolute point-in-time like '2014-08-01 10:00' (only newer records will be returned. Note that _COLON_ must be used instead of ':' if HTTP GET syntax 1 is used * * The optional parameter {no_filter} may be set to 'True' if absolutely all records are desired. * This is applicable for 'notification'-properties for which notifications deactivated by the customer himself / herself are usually not shown. * In other words {no_filter} is useful when you want to see the customer's notification-history, even messages that has been deleted from a corresponding app. * * * Note that if https://api-test.connome.com/documentation/PropertySetNoLongerCurrent.html has been called earlier with credentials corresponding to the CustomerId1 of a property with Name 'notification', that property will not be included. * * See also https://api-test.connome.com/documentation/DeviceAggregation.html, https://api-test.connome.com/documentation/CustomerHistory.html, https://api-test.connome.com/documentation/GatewayHistory.html and https://api-test.connome.com/documentation/DeviceHistory.html */ +(NSMutableURLRequest*) getPropertyHistoryId: (NSString*)id limit: (NSString*)limit; /** * BPAPI method Property/SetNoLongerCurrent * * Marks the property identified by {id} as 'not current'.
* * https://api-test.connome.com/documentation/PropertySetNoLongerCurrent.html * * HTTP methods allowed: GET, POST * * Syntax: Property/{id}/SetNoLongerCurrent/ * * Marks the property identified by {id} as 'not current'. * The property is not deleted from the database, but 'not current' means that it will be ignored in normal circumstances. * You may usually generate history for 'not current' properties. * Note that as of April 2013 it is allowed to mark any property as 'not current'. You may use https://api-test.connome.com/documentation/GatewayRefresh.html if you want to restore any accidentally marked properties. * */ +(NSMutableURLRequest*) getPropertySetNoLongerCurrentId: (NSString*)id; +(NSMutableURLRequest*) postPropertySetNoLongerCurrentId: (NSString*)id; /** * BPAPI method Property/SupportIncidentsForType * * Shows historical values for support incidents with a specific type. For internal use only. The support * * https://api-test.connome.com/documentation/PropertySupportIncidentsForType.html * * HTTP methods allowed: GET * * Syntax: Property/SupportIncidentsForType/{support_incident_type_name}/{limit}/ * * Shows historical values for support incidents with a specific type. For internal use only. The supportincident type must be member of ", or null/empty to meanall types. * */ +(NSMutableURLRequest*) getPropertySupportIncidentsForTypeSupport_incident_type_name: (NSString*)support_incident_type_name limit: (NSString*)limit; /** * BPAPI method Property * * Returns information about the property identified by {id} * * https://api-test.connome.com/documentation/Property.html * * HTTP methods allowed: GET * * Syntax: Property/{id}/ * * Returns information about the property identified by {id} */ +(NSMutableURLRequest*) getPropertyId: (NSString*)id; /** * BPAPI method Report/001 * * Monthly payment report for period identified by {period} * * https://api-test.connome.com/documentation/Report001.html * * HTTP methods allowed: GET * * Syntax: Report/001/{period}/ * Syntax: Report/001/2014-12 * * Monthly payment report for period identified by {period} * * */ +(NSMutableURLRequest*) getReport001Period: (NSString*)period; /** * BPAPI method Report/001 * * Monthly payment report for period identified by {period} * * https://api-test.connome.com/documentation/Report001.html * * HTTP methods allowed: GET * * Syntax: Report/001/{period}/ * Syntax: Report/001/2014-12 * * Monthly payment report for period identified by {period} * * */ +(NSMutableURLRequest*) getReport0012014-12; /** * BPAPI method ResetPassword * * Resets password ("lost" password functionality) for customer identified by the credentials used for authorization.
* * https://api-test.connome.com/documentation/ResetPassword.html * * No authorization required HTTP methods allowed: GET, POST * * Syntax: ResetPassword/{email_or_value_code}/ * Syntax: ResetPassword/{email_or_value_code}/{execute_id}/{app_version}/ * Syntax: ResetPassword/{email_or_value_code}/{execute_id}/ * Syntax: ResetPassword/{email_or_value_code}/{execute_id}/{app_version}/{new_email}/ * Syntax: ResetPassword/{email_or_value_code}/{execute_id}/{app_version}/{new_email}/{new_password}/ * * Resets password ("lost" password functionality) for customer identified by the credentials used for authorization. * * The process consists of 2 or 3 steps: * Step 1: {email_or_value_code} and {app_version} given. User enters registered email address or valuecode. app_version is set by app. If app_version is string="null" or null, assume call from old app (i.e MinHytte). Request that an execute_id be created and sent to the specified email-address. The email created is based on app_version * Step 2a: {email_or_value_code}{execute_id} given. This call is made by old app (i.e MinHytte). The execute_id is that given in the email message created in Step 1. * Step 2b: {email_or_value_code}{execute_id}{app_version} and {new_email_or_value_code} given. {email_or_value_code} and {new_email_or_value_code} should be the same (if they are different a "NotImplementedException" is thrown). {app_version} is set by new app (can be anything but null or string="null". The execute_id is that given in the email message created in Step 1. * * Step 3: {email_or_value_code}/{execute_id}/{app_version}/{new_email}/{new_password}". {email_or_value_code} and {new_email_or_value_code} should be the same. {execute_id} must be the same as set in Step1. {app_version} is set by new app (can be anything but null or string="null".) * Both Step 1 and Step 2 uses this same API-method * * Step 1 is supposed to be called from code or app and will return JSON / technical HTML-response as "normal" in BPAPI while * Step 2a is supposed to be done by the client (customer) and will always return an end-user friendly HTML-response. * Step 2b is called by app and will return JSON response with information if the password is reset successfully or not. * * In Step 2a the current password for the customer will be deactivated and the HTTP-request will be redirected to https://api-test.connome.com/documentation/SubscriptionRegister.html * from which the user may repeat the original registration-process. * Note that it is also resets the email-address used for the customer in this manner since technically * after accessing the URL-command given in Step 1 https://api-test.connome.com/documentation/SubscriptionRegister.html will function as if no e-mail or password has been registered for the customer (that is, it will function as if the gateway is unregistered). * * * In Step 2b the customer has entered the execute_id in the app and the execute_id is verified. A JSON response indicating success is the following:bpapi_result { * ResetPasswordStep2 { * can_reset_password: true * * All other cases indicates that the passwordreset was unsuccesful.When the execute_id has been verified and the app receives "can_reset_password: true", it can move to the next step, enter a new password. The call with the new_password goes to Step3. * In Step 3 the execute_id has been verified. , where all input is verified and password is set to new_password. Step3 JSON responses are:reset_password_step_3: { ///success: true ///} ///Indicating that the password has been successfully set. If success=false, the new_password was not set. /// * NOTE: As of March 2016 this functionality does not work when multiple gateways are registered for the customer identified by the credentials used for authorization. Information about this will only be given in Step 2, not Step 1. * * See also https://api-test.connome.com/documentation/ChangePassword.html */ +(NSMutableURLRequest*) getResetPasswordEmail_or_value_code: (NSString*)email_or_value_code; +(NSMutableURLRequest*) postResetPasswordEmail_or_value_code: (NSString*)email_or_value_code; /** * BPAPI method ResetPassword * * Resets password ("lost" password functionality) for customer identified by the credentials used for authorization.
* * https://api-test.connome.com/documentation/ResetPassword.html * * No authorization required HTTP methods allowed: GET, POST * * Syntax: ResetPassword/{email_or_value_code}/ * Syntax: ResetPassword/{email_or_value_code}/{execute_id}/{app_version}/ * Syntax: ResetPassword/{email_or_value_code}/{execute_id}/ * Syntax: ResetPassword/{email_or_value_code}/{execute_id}/{app_version}/{new_email}/ * Syntax: ResetPassword/{email_or_value_code}/{execute_id}/{app_version}/{new_email}/{new_password}/ * * Resets password ("lost" password functionality) for customer identified by the credentials used for authorization. * * The process consists of 2 or 3 steps: * Step 1: {email_or_value_code} and {app_version} given. User enters registered email address or valuecode. app_version is set by app. If app_version is string="null" or null, assume call from old app (i.e MinHytte). Request that an execute_id be created and sent to the specified email-address. The email created is based on app_version * Step 2a: {email_or_value_code}{execute_id} given. This call is made by old app (i.e MinHytte). The execute_id is that given in the email message created in Step 1. * Step 2b: {email_or_value_code}{execute_id}{app_version} and {new_email_or_value_code} given. {email_or_value_code} and {new_email_or_value_code} should be the same (if they are different a "NotImplementedException" is thrown). {app_version} is set by new app (can be anything but null or string="null". The execute_id is that given in the email message created in Step 1. * * Step 3: {email_or_value_code}/{execute_id}/{app_version}/{new_email}/{new_password}". {email_or_value_code} and {new_email_or_value_code} should be the same. {execute_id} must be the same as set in Step1. {app_version} is set by new app (can be anything but null or string="null".) * Both Step 1 and Step 2 uses this same API-method * * Step 1 is supposed to be called from code or app and will return JSON / technical HTML-response as "normal" in BPAPI while * Step 2a is supposed to be done by the client (customer) and will always return an end-user friendly HTML-response. * Step 2b is called by app and will return JSON response with information if the password is reset successfully or not. * * In Step 2a the current password for the customer will be deactivated and the HTTP-request will be redirected to https://api-test.connome.com/documentation/SubscriptionRegister.html * from which the user may repeat the original registration-process. * Note that it is also resets the email-address used for the customer in this manner since technically * after accessing the URL-command given in Step 1 https://api-test.connome.com/documentation/SubscriptionRegister.html will function as if no e-mail or password has been registered for the customer (that is, it will function as if the gateway is unregistered). * * * In Step 2b the customer has entered the execute_id in the app and the execute_id is verified. A JSON response indicating success is the following:bpapi_result { * ResetPasswordStep2 { * can_reset_password: true * * All other cases indicates that the passwordreset was unsuccesful.When the execute_id has been verified and the app receives "can_reset_password: true", it can move to the next step, enter a new password. The call with the new_password goes to Step3. * In Step 3 the execute_id has been verified. , where all input is verified and password is set to new_password. Step3 JSON responses are:reset_password_step_3: { ///success: true ///} ///Indicating that the password has been successfully set. If success=false, the new_password was not set. /// * NOTE: As of March 2016 this functionality does not work when multiple gateways are registered for the customer identified by the credentials used for authorization. Information about this will only be given in Step 2, not Step 1. * * See also https://api-test.connome.com/documentation/ChangePassword.html */ +(NSMutableURLRequest*) getResetPasswordEmail_or_value_code: (NSString*)email_or_value_code execute_id: (NSString*)execute_id app_version: (NSString*)app_version; +(NSMutableURLRequest*) postResetPasswordEmail_or_value_code: (NSString*)email_or_value_code execute_id: (NSString*)execute_id app_version: (NSString*)app_version; /** * BPAPI method ResetPassword * * Resets password ("lost" password functionality) for customer identified by the credentials used for authorization.
* * https://api-test.connome.com/documentation/ResetPassword.html * * No authorization required HTTP methods allowed: GET, POST * * Syntax: ResetPassword/{email_or_value_code}/ * Syntax: ResetPassword/{email_or_value_code}/{execute_id}/{app_version}/ * Syntax: ResetPassword/{email_or_value_code}/{execute_id}/ * Syntax: ResetPassword/{email_or_value_code}/{execute_id}/{app_version}/{new_email}/ * Syntax: ResetPassword/{email_or_value_code}/{execute_id}/{app_version}/{new_email}/{new_password}/ * * Resets password ("lost" password functionality) for customer identified by the credentials used for authorization. * * The process consists of 2 or 3 steps: * Step 1: {email_or_value_code} and {app_version} given. User enters registered email address or valuecode. app_version is set by app. If app_version is string="null" or null, assume call from old app (i.e MinHytte). Request that an execute_id be created and sent to the specified email-address. The email created is based on app_version * Step 2a: {email_or_value_code}{execute_id} given. This call is made by old app (i.e MinHytte). The execute_id is that given in the email message created in Step 1. * Step 2b: {email_or_value_code}{execute_id}{app_version} and {new_email_or_value_code} given. {email_or_value_code} and {new_email_or_value_code} should be the same (if they are different a "NotImplementedException" is thrown). {app_version} is set by new app (can be anything but null or string="null". The execute_id is that given in the email message created in Step 1. * * Step 3: {email_or_value_code}/{execute_id}/{app_version}/{new_email}/{new_password}". {email_or_value_code} and {new_email_or_value_code} should be the same. {execute_id} must be the same as set in Step1. {app_version} is set by new app (can be anything but null or string="null".) * Both Step 1 and Step 2 uses this same API-method * * Step 1 is supposed to be called from code or app and will return JSON / technical HTML-response as "normal" in BPAPI while * Step 2a is supposed to be done by the client (customer) and will always return an end-user friendly HTML-response. * Step 2b is called by app and will return JSON response with information if the password is reset successfully or not. * * In Step 2a the current password for the customer will be deactivated and the HTTP-request will be redirected to https://api-test.connome.com/documentation/SubscriptionRegister.html * from which the user may repeat the original registration-process. * Note that it is also resets the email-address used for the customer in this manner since technically * after accessing the URL-command given in Step 1 https://api-test.connome.com/documentation/SubscriptionRegister.html will function as if no e-mail or password has been registered for the customer (that is, it will function as if the gateway is unregistered). * * * In Step 2b the customer has entered the execute_id in the app and the execute_id is verified. A JSON response indicating success is the following:bpapi_result { * ResetPasswordStep2 { * can_reset_password: true * * All other cases indicates that the passwordreset was unsuccesful.When the execute_id has been verified and the app receives "can_reset_password: true", it can move to the next step, enter a new password. The call with the new_password goes to Step3. * In Step 3 the execute_id has been verified. , where all input is verified and password is set to new_password. Step3 JSON responses are:reset_password_step_3: { ///success: true ///} ///Indicating that the password has been successfully set. If success=false, the new_password was not set. /// * NOTE: As of March 2016 this functionality does not work when multiple gateways are registered for the customer identified by the credentials used for authorization. Information about this will only be given in Step 2, not Step 1. * * See also https://api-test.connome.com/documentation/ChangePassword.html */ +(NSMutableURLRequest*) getResetPasswordEmail_or_value_code: (NSString*)email_or_value_code execute_id: (NSString*)execute_id; +(NSMutableURLRequest*) postResetPasswordEmail_or_value_code: (NSString*)email_or_value_code execute_id: (NSString*)execute_id; /** * BPAPI method ResetPassword * * Resets password ("lost" password functionality) for customer identified by the credentials used for authorization.
* * https://api-test.connome.com/documentation/ResetPassword.html * * No authorization required HTTP methods allowed: GET, POST * * Syntax: ResetPassword/{email_or_value_code}/ * Syntax: ResetPassword/{email_or_value_code}/{execute_id}/{app_version}/ * Syntax: ResetPassword/{email_or_value_code}/{execute_id}/ * Syntax: ResetPassword/{email_or_value_code}/{execute_id}/{app_version}/{new_email}/ * Syntax: ResetPassword/{email_or_value_code}/{execute_id}/{app_version}/{new_email}/{new_password}/ * * Resets password ("lost" password functionality) for customer identified by the credentials used for authorization. * * The process consists of 2 or 3 steps: * Step 1: {email_or_value_code} and {app_version} given. User enters registered email address or valuecode. app_version is set by app. If app_version is string="null" or null, assume call from old app (i.e MinHytte). Request that an execute_id be created and sent to the specified email-address. The email created is based on app_version * Step 2a: {email_or_value_code}{execute_id} given. This call is made by old app (i.e MinHytte). The execute_id is that given in the email message created in Step 1. * Step 2b: {email_or_value_code}{execute_id}{app_version} and {new_email_or_value_code} given. {email_or_value_code} and {new_email_or_value_code} should be the same (if they are different a "NotImplementedException" is thrown). {app_version} is set by new app (can be anything but null or string="null". The execute_id is that given in the email message created in Step 1. * * Step 3: {email_or_value_code}/{execute_id}/{app_version}/{new_email}/{new_password}". {email_or_value_code} and {new_email_or_value_code} should be the same. {execute_id} must be the same as set in Step1. {app_version} is set by new app (can be anything but null or string="null".) * Both Step 1 and Step 2 uses this same API-method * * Step 1 is supposed to be called from code or app and will return JSON / technical HTML-response as "normal" in BPAPI while * Step 2a is supposed to be done by the client (customer) and will always return an end-user friendly HTML-response. * Step 2b is called by app and will return JSON response with information if the password is reset successfully or not. * * In Step 2a the current password for the customer will be deactivated and the HTTP-request will be redirected to https://api-test.connome.com/documentation/SubscriptionRegister.html * from which the user may repeat the original registration-process. * Note that it is also resets the email-address used for the customer in this manner since technically * after accessing the URL-command given in Step 1 https://api-test.connome.com/documentation/SubscriptionRegister.html will function as if no e-mail or password has been registered for the customer (that is, it will function as if the gateway is unregistered). * * * In Step 2b the customer has entered the execute_id in the app and the execute_id is verified. A JSON response indicating success is the following:bpapi_result { * ResetPasswordStep2 { * can_reset_password: true * * All other cases indicates that the passwordreset was unsuccesful.When the execute_id has been verified and the app receives "can_reset_password: true", it can move to the next step, enter a new password. The call with the new_password goes to Step3. * In Step 3 the execute_id has been verified. , where all input is verified and password is set to new_password. Step3 JSON responses are:reset_password_step_3: { ///success: true ///} ///Indicating that the password has been successfully set. If success=false, the new_password was not set. /// * NOTE: As of March 2016 this functionality does not work when multiple gateways are registered for the customer identified by the credentials used for authorization. Information about this will only be given in Step 2, not Step 1. * * See also https://api-test.connome.com/documentation/ChangePassword.html */ +(NSMutableURLRequest*) getResetPasswordEmail_or_value_code: (NSString*)email_or_value_code execute_id: (NSString*)execute_id app_version: (NSString*)app_version new_email: (NSString*)new_email; +(NSMutableURLRequest*) postResetPasswordEmail_or_value_code: (NSString*)email_or_value_code execute_id: (NSString*)execute_id app_version: (NSString*)app_version new_email: (NSString*)new_email; /** * BPAPI method ResetPassword * * Resets password ("lost" password functionality) for customer identified by the credentials used for authorization.
* * https://api-test.connome.com/documentation/ResetPassword.html * * No authorization required HTTP methods allowed: GET, POST * * Syntax: ResetPassword/{email_or_value_code}/ * Syntax: ResetPassword/{email_or_value_code}/{execute_id}/{app_version}/ * Syntax: ResetPassword/{email_or_value_code}/{execute_id}/ * Syntax: ResetPassword/{email_or_value_code}/{execute_id}/{app_version}/{new_email}/ * Syntax: ResetPassword/{email_or_value_code}/{execute_id}/{app_version}/{new_email}/{new_password}/ * * Resets password ("lost" password functionality) for customer identified by the credentials used for authorization. * * The process consists of 2 or 3 steps: * Step 1: {email_or_value_code} and {app_version} given. User enters registered email address or valuecode. app_version is set by app. If app_version is string="null" or null, assume call from old app (i.e MinHytte). Request that an execute_id be created and sent to the specified email-address. The email created is based on app_version * Step 2a: {email_or_value_code}{execute_id} given. This call is made by old app (i.e MinHytte). The execute_id is that given in the email message created in Step 1. * Step 2b: {email_or_value_code}{execute_id}{app_version} and {new_email_or_value_code} given. {email_or_value_code} and {new_email_or_value_code} should be the same (if they are different a "NotImplementedException" is thrown). {app_version} is set by new app (can be anything but null or string="null". The execute_id is that given in the email message created in Step 1. * * Step 3: {email_or_value_code}/{execute_id}/{app_version}/{new_email}/{new_password}". {email_or_value_code} and {new_email_or_value_code} should be the same. {execute_id} must be the same as set in Step1. {app_version} is set by new app (can be anything but null or string="null".) * Both Step 1 and Step 2 uses this same API-method * * Step 1 is supposed to be called from code or app and will return JSON / technical HTML-response as "normal" in BPAPI while * Step 2a is supposed to be done by the client (customer) and will always return an end-user friendly HTML-response. * Step 2b is called by app and will return JSON response with information if the password is reset successfully or not. * * In Step 2a the current password for the customer will be deactivated and the HTTP-request will be redirected to https://api-test.connome.com/documentation/SubscriptionRegister.html * from which the user may repeat the original registration-process. * Note that it is also resets the email-address used for the customer in this manner since technically * after accessing the URL-command given in Step 1 https://api-test.connome.com/documentation/SubscriptionRegister.html will function as if no e-mail or password has been registered for the customer (that is, it will function as if the gateway is unregistered). * * * In Step 2b the customer has entered the execute_id in the app and the execute_id is verified. A JSON response indicating success is the following:bpapi_result { * ResetPasswordStep2 { * can_reset_password: true * * All other cases indicates that the passwordreset was unsuccesful.When the execute_id has been verified and the app receives "can_reset_password: true", it can move to the next step, enter a new password. The call with the new_password goes to Step3. * In Step 3 the execute_id has been verified. , where all input is verified and password is set to new_password. Step3 JSON responses are:reset_password_step_3: { ///success: true ///} ///Indicating that the password has been successfully set. If success=false, the new_password was not set. /// * NOTE: As of March 2016 this functionality does not work when multiple gateways are registered for the customer identified by the credentials used for authorization. Information about this will only be given in Step 2, not Step 1. * * See also https://api-test.connome.com/documentation/ChangePassword.html */ +(NSMutableURLRequest*) getResetPasswordEmail_or_value_code: (NSString*)email_or_value_code execute_id: (NSString*)execute_id app_version: (NSString*)app_version new_email: (NSString*)new_email new_password: (NSString*)new_password; +(NSMutableURLRequest*) postResetPasswordEmail_or_value_code: (NSString*)email_or_value_code execute_id: (NSString*)execute_id app_version: (NSString*)app_version new_email: (NSString*)new_email new_password: (NSString*)new_password; /** * BPAPI method Subscription/Receipt * * Generates and returns a PDF-receipt of the latest payment for the customer corresponding to {value_code}.
* * https://api-test.connome.com/documentation/SubscriptionReceipt.html * * No authorization required HTTP methods allowed: GET * * Syntax: Subscription/Receipt/{registration_id}/ * * Generates and returns a PDF-receipt of the latest payment for the customer corresponding to {value_code}. * Note that if the customer has multiple gateways then the returned receipt may not necessary belong to the gateway identified by {value_code}. * * */ +(NSMutableURLRequest*) getSubscriptionReceiptRegistration_id: (NSString*)registration_id; /** * BPAPI method Subscription/Register * * This is not an ordinary API-method since it returns a "complete" HTML / Javascript application for account-management. * * https://api-test.connome.com/documentation/SubscriptionRegister.html * * No authorization required HTTP methods allowed: GET * * Syntax: Subscription/Register/{service}/ * Syntax: Subscription/Register/{service}/{functionality}/ * Syntax: Subscription/Register/{service}/{functionality}/{registration_id}/ * Syntax: Subscription/Register/{service}/{functionality}/{registration_id}/{device_identification}/ * * This is not an ordinary API-method since it returns a "complete" HTML / Javascript application for account-management. Some of the API-functionality covered is https://api-test.connome.com/documentation/SubscriptionVerifyRegistrationId.html, https://api-test.connome.com/documentation/CustomerAdd.html, https://api-test.connome.com/documentation/CustomerAddProperty.html, https://api-test.connome.com/documentation/SubscriptionRegisterPayment.html, https://api-test.connome.com/documentation/SubscriptionRegisterPaymentCallback.html. * The application in other words supports general password and account management. * * For the optional parameter functionality the following comma-separated list of values are recognized: * "all" : Returns all functionality. Useful for testing. May also be presented to the end-user. * "account" : First time registration of email and password, or later change of password (the interface will adopt accordingly). * "name": Change of Customer's name (first_name, last_name) (may be used irrespectively of gateway having been registered or not, registration_id is used as identifier). * "subscription": Status of subscription and payment of subscription. * "lostPassword" : Functionality for helping with lost password. registrationId (valueCode) or e-mail address may be used for identification. * If functionality is not specified then "all" is assumed. * Note that the functionality is specified in the generated HTML-page in the same order as specified within the parameter functionality * * The optional parameter registration_id (valueCode) is the customers token for qualification of a free trial period. * * The optional parameter device_identification is used to identify from which device the request was made. * It is usually the IMEI number of the customer's smartphone used for registration (Note: As of juli 2014 this information is discarded by BPAPI) * * The response will always be in HTML-format (with Javascript). JSON will not be returned (except when the request-syntax is invalid or any of the parameters are invalid) * * Workflow for payment of subscriptions: https://api-test.connome.com/documentation/SubscriptionRegister.html (with functionality specifying 'subscription') => * https://api-test.connome.com/documentation/SubscriptionVerifyRegistrationId.html (by Javascript from page generated by https://api-test.connome.com/documentation/SubscriptionRegister.html. Will return buy_descriptions describing possible subscriptions) => * https://api-test.connome.com/documentation/SubscriptionRegisterPayment.html (by Javascript from page generated by https://api-test.connome.com/documentation/SubscriptionRegister.html) => * payment_completion_url (external Payment provider) => * https://api-test.connome.com/documentation/SubscriptionRegisterPaymentCallback.html (by callback from Payment provider) => * https://api-test.connome.com/documentation/SubscriptionRegister.html (internal transfer from https://api-test.connome.com/documentation/SubscriptionRegisterPaymentCallback.html by BPAPI) * */ +(NSMutableURLRequest*) getSubscriptionRegisterService: (NSString*)service; /** * BPAPI method Subscription/Register * * This is not an ordinary API-method since it returns a "complete" HTML / Javascript application for account-management. * * https://api-test.connome.com/documentation/SubscriptionRegister.html * * No authorization required HTTP methods allowed: GET * * Syntax: Subscription/Register/{service}/ * Syntax: Subscription/Register/{service}/{functionality}/ * Syntax: Subscription/Register/{service}/{functionality}/{registration_id}/ * Syntax: Subscription/Register/{service}/{functionality}/{registration_id}/{device_identification}/ * * This is not an ordinary API-method since it returns a "complete" HTML / Javascript application for account-management. Some of the API-functionality covered is https://api-test.connome.com/documentation/SubscriptionVerifyRegistrationId.html, https://api-test.connome.com/documentation/CustomerAdd.html, https://api-test.connome.com/documentation/CustomerAddProperty.html, https://api-test.connome.com/documentation/SubscriptionRegisterPayment.html, https://api-test.connome.com/documentation/SubscriptionRegisterPaymentCallback.html. * The application in other words supports general password and account management. * * For the optional parameter functionality the following comma-separated list of values are recognized: * "all" : Returns all functionality. Useful for testing. May also be presented to the end-user. * "account" : First time registration of email and password, or later change of password (the interface will adopt accordingly). * "name": Change of Customer's name (first_name, last_name) (may be used irrespectively of gateway having been registered or not, registration_id is used as identifier). * "subscription": Status of subscription and payment of subscription. * "lostPassword" : Functionality for helping with lost password. registrationId (valueCode) or e-mail address may be used for identification. * If functionality is not specified then "all" is assumed. * Note that the functionality is specified in the generated HTML-page in the same order as specified within the parameter functionality * * The optional parameter registration_id (valueCode) is the customers token for qualification of a free trial period. * * The optional parameter device_identification is used to identify from which device the request was made. * It is usually the IMEI number of the customer's smartphone used for registration (Note: As of juli 2014 this information is discarded by BPAPI) * * The response will always be in HTML-format (with Javascript). JSON will not be returned (except when the request-syntax is invalid or any of the parameters are invalid) * * Workflow for payment of subscriptions: https://api-test.connome.com/documentation/SubscriptionRegister.html (with functionality specifying 'subscription') => * https://api-test.connome.com/documentation/SubscriptionVerifyRegistrationId.html (by Javascript from page generated by https://api-test.connome.com/documentation/SubscriptionRegister.html. Will return buy_descriptions describing possible subscriptions) => * https://api-test.connome.com/documentation/SubscriptionRegisterPayment.html (by Javascript from page generated by https://api-test.connome.com/documentation/SubscriptionRegister.html) => * payment_completion_url (external Payment provider) => * https://api-test.connome.com/documentation/SubscriptionRegisterPaymentCallback.html (by callback from Payment provider) => * https://api-test.connome.com/documentation/SubscriptionRegister.html (internal transfer from https://api-test.connome.com/documentation/SubscriptionRegisterPaymentCallback.html by BPAPI) * */ +(NSMutableURLRequest*) getSubscriptionRegisterService: (NSString*)service functionality: (NSString*)functionality; /** * BPAPI method Subscription/Register * * This is not an ordinary API-method since it returns a "complete" HTML / Javascript application for account-management. * * https://api-test.connome.com/documentation/SubscriptionRegister.html * * No authorization required HTTP methods allowed: GET * * Syntax: Subscription/Register/{service}/ * Syntax: Subscription/Register/{service}/{functionality}/ * Syntax: Subscription/Register/{service}/{functionality}/{registration_id}/ * Syntax: Subscription/Register/{service}/{functionality}/{registration_id}/{device_identification}/ * * This is not an ordinary API-method since it returns a "complete" HTML / Javascript application for account-management. Some of the API-functionality covered is https://api-test.connome.com/documentation/SubscriptionVerifyRegistrationId.html, https://api-test.connome.com/documentation/CustomerAdd.html, https://api-test.connome.com/documentation/CustomerAddProperty.html, https://api-test.connome.com/documentation/SubscriptionRegisterPayment.html, https://api-test.connome.com/documentation/SubscriptionRegisterPaymentCallback.html. * The application in other words supports general password and account management. * * For the optional parameter functionality the following comma-separated list of values are recognized: * "all" : Returns all functionality. Useful for testing. May also be presented to the end-user. * "account" : First time registration of email and password, or later change of password (the interface will adopt accordingly). * "name": Change of Customer's name (first_name, last_name) (may be used irrespectively of gateway having been registered or not, registration_id is used as identifier). * "subscription": Status of subscription and payment of subscription. * "lostPassword" : Functionality for helping with lost password. registrationId (valueCode) or e-mail address may be used for identification. * If functionality is not specified then "all" is assumed. * Note that the functionality is specified in the generated HTML-page in the same order as specified within the parameter functionality * * The optional parameter registration_id (valueCode) is the customers token for qualification of a free trial period. * * The optional parameter device_identification is used to identify from which device the request was made. * It is usually the IMEI number of the customer's smartphone used for registration (Note: As of juli 2014 this information is discarded by BPAPI) * * The response will always be in HTML-format (with Javascript). JSON will not be returned (except when the request-syntax is invalid or any of the parameters are invalid) * * Workflow for payment of subscriptions: https://api-test.connome.com/documentation/SubscriptionRegister.html (with functionality specifying 'subscription') => * https://api-test.connome.com/documentation/SubscriptionVerifyRegistrationId.html (by Javascript from page generated by https://api-test.connome.com/documentation/SubscriptionRegister.html. Will return buy_descriptions describing possible subscriptions) => * https://api-test.connome.com/documentation/SubscriptionRegisterPayment.html (by Javascript from page generated by https://api-test.connome.com/documentation/SubscriptionRegister.html) => * payment_completion_url (external Payment provider) => * https://api-test.connome.com/documentation/SubscriptionRegisterPaymentCallback.html (by callback from Payment provider) => * https://api-test.connome.com/documentation/SubscriptionRegister.html (internal transfer from https://api-test.connome.com/documentation/SubscriptionRegisterPaymentCallback.html by BPAPI) * */ +(NSMutableURLRequest*) getSubscriptionRegisterService: (NSString*)service functionality: (NSString*)functionality registration_id: (NSString*)registration_id; /** * BPAPI method Subscription/Register * * This is not an ordinary API-method since it returns a "complete" HTML / Javascript application for account-management. * * https://api-test.connome.com/documentation/SubscriptionRegister.html * * No authorization required HTTP methods allowed: GET * * Syntax: Subscription/Register/{service}/ * Syntax: Subscription/Register/{service}/{functionality}/ * Syntax: Subscription/Register/{service}/{functionality}/{registration_id}/ * Syntax: Subscription/Register/{service}/{functionality}/{registration_id}/{device_identification}/ * * This is not an ordinary API-method since it returns a "complete" HTML / Javascript application for account-management. Some of the API-functionality covered is https://api-test.connome.com/documentation/SubscriptionVerifyRegistrationId.html, https://api-test.connome.com/documentation/CustomerAdd.html, https://api-test.connome.com/documentation/CustomerAddProperty.html, https://api-test.connome.com/documentation/SubscriptionRegisterPayment.html, https://api-test.connome.com/documentation/SubscriptionRegisterPaymentCallback.html. * The application in other words supports general password and account management. * * For the optional parameter functionality the following comma-separated list of values are recognized: * "all" : Returns all functionality. Useful for testing. May also be presented to the end-user. * "account" : First time registration of email and password, or later change of password (the interface will adopt accordingly). * "name": Change of Customer's name (first_name, last_name) (may be used irrespectively of gateway having been registered or not, registration_id is used as identifier). * "subscription": Status of subscription and payment of subscription. * "lostPassword" : Functionality for helping with lost password. registrationId (valueCode) or e-mail address may be used for identification. * If functionality is not specified then "all" is assumed. * Note that the functionality is specified in the generated HTML-page in the same order as specified within the parameter functionality * * The optional parameter registration_id (valueCode) is the customers token for qualification of a free trial period. * * The optional parameter device_identification is used to identify from which device the request was made. * It is usually the IMEI number of the customer's smartphone used for registration (Note: As of juli 2014 this information is discarded by BPAPI) * * The response will always be in HTML-format (with Javascript). JSON will not be returned (except when the request-syntax is invalid or any of the parameters are invalid) * * Workflow for payment of subscriptions: https://api-test.connome.com/documentation/SubscriptionRegister.html (with functionality specifying 'subscription') => * https://api-test.connome.com/documentation/SubscriptionVerifyRegistrationId.html (by Javascript from page generated by https://api-test.connome.com/documentation/SubscriptionRegister.html. Will return buy_descriptions describing possible subscriptions) => * https://api-test.connome.com/documentation/SubscriptionRegisterPayment.html (by Javascript from page generated by https://api-test.connome.com/documentation/SubscriptionRegister.html) => * payment_completion_url (external Payment provider) => * https://api-test.connome.com/documentation/SubscriptionRegisterPaymentCallback.html (by callback from Payment provider) => * https://api-test.connome.com/documentation/SubscriptionRegister.html (internal transfer from https://api-test.connome.com/documentation/SubscriptionRegisterPaymentCallback.html by BPAPI) * */ +(NSMutableURLRequest*) getSubscriptionRegisterService: (NSString*)service functionality: (NSString*)functionality registration_id: (NSString*)registration_id device_identification: (NSString*)device_identification; /** * BPAPI method Subscription/RegisterPayment * * Registers initiation of subscription payment for the given {customer_id} and {subscription}.
* * https://api-test.connome.com/documentation/SubscriptionRegisterPayment.html * * No authorization required HTTP methods allowed: GET * * Syntax: Subscription/RegisterPayment/{customer_id}/{subscription}/ * Syntax: Subscription/RegisterPayment/{customer_id}/{subscription}/{callback_url}/ * * Registers initiation of subscription payment for the given {customer_id} and {subscription}. * * {customer_id} may also (more useful) be specified as registrationId (valueCode) of a specific gateway. This is essential if the customer has more than one gateway. * Returns the following key / value information * transaction_id: Id that may be used for completing the payment (completion as seen from the user's perspective. See also completion_url) * completion_url: URL for completing the payment (completion as seen from the user's perspective. Note that completion and credit-card handling is usually done outside of BPAPI by a third-party) * * payment_completion_information: When developer_mode has been set this property will give test credit-card numbers that may be used. (This last key-value property will most probably not be used as calling this method is usually done after necessary information has been presented to the user. Note that the same property payment_completion_information is also available by https://api-test.connome.com/documentation/SubscriptionVerifyRegistrationId.html which is called earlier in the payment process.) * * {callback_url} specifies to where the clients web browser should be redirected after the payment process has completed. https:// will be prepended to this URL and a status like Fail or OK will be appended * * * See https://api-test.connome.com/documentation/SubscriptionRegister.html */ +(NSMutableURLRequest*) getSubscriptionRegisterPaymentCustomer_id: (NSString*)customer_id subscription: (NSString*)subscription; /** * BPAPI method Subscription/RegisterPayment * * Registers initiation of subscription payment for the given {customer_id} and {subscription}.
* * https://api-test.connome.com/documentation/SubscriptionRegisterPayment.html * * No authorization required HTTP methods allowed: GET * * Syntax: Subscription/RegisterPayment/{customer_id}/{subscription}/ * Syntax: Subscription/RegisterPayment/{customer_id}/{subscription}/{callback_url}/ * * Registers initiation of subscription payment for the given {customer_id} and {subscription}. * * {customer_id} may also (more useful) be specified as registrationId (valueCode) of a specific gateway. This is essential if the customer has more than one gateway. * Returns the following key / value information * transaction_id: Id that may be used for completing the payment (completion as seen from the user's perspective. See also completion_url) * completion_url: URL for completing the payment (completion as seen from the user's perspective. Note that completion and credit-card handling is usually done outside of BPAPI by a third-party) * * payment_completion_information: When developer_mode has been set this property will give test credit-card numbers that may be used. (This last key-value property will most probably not be used as calling this method is usually done after necessary information has been presented to the user. Note that the same property payment_completion_information is also available by https://api-test.connome.com/documentation/SubscriptionVerifyRegistrationId.html which is called earlier in the payment process.) * * {callback_url} specifies to where the clients web browser should be redirected after the payment process has completed. https:// will be prepended to this URL and a status like Fail or OK will be appended * * * See https://api-test.connome.com/documentation/SubscriptionRegister.html */ +(NSMutableURLRequest*) getSubscriptionRegisterPaymentCustomer_id: (NSString*)customer_id subscription: (NSString*)subscription callback_url: (NSString*)callback_url; /** * BPAPI method Subscription/RegisterPaymentCallback * * Used by the Payment provider after the customer has completed payment for a Subscription (completion as seen from the customer's perspective)
* * https://api-test.connome.com/documentation/SubscriptionRegisterPaymentCallback.html * * No authorization required HTTP methods allowed: GET * * Syntax: Subscription/RegisterPaymentCallback/{transactionId}/{responseCode}/ * * Used by the Payment provider after the customer has completed payment for a Subscription (completion as seen from the customer's perspective) * * Redirects to functionality as given by https://api-test.connome.com/documentation/SubscriptionRegister.html which will complete payment as seen from BPAPI's perspective. * (in other words, this is not an ordinary API-method API-method since it returns a "complete" HTML / Javascript application for account-management) * * * See also https://api-test.connome.com/documentation/SubscriptionRegister.html */ +(NSMutableURLRequest*) getSubscriptionRegisterPaymentCallbackTransactionId: (NSString*)transactionId responseCode: (NSString*)responseCode; /** * BPAPI method Subscription/RepeatPayment * * Executes a recurrent payment for the given {gateway_id}.
* * https://api-test.connome.com/documentation/SubscriptionRepeatPayment.html * * HTTP methods allowed: GET * * Syntax: Subscription/RepeatPayment/{gateway_id}/ * * Executes a recurrent payment for the given {gateway_id}. * * Administrative access is required in order to access this method. * * Note that this method is "safe" to use in the sense that the payment-process will only be completed when all conditions for renewal of subscription are present (mainly, GatewayProperty.subscription_automatic_renewal_mode must be on and GatewayProperty.subscription_valid_to_date must not be too far into future (the limit as of March 2016 is max 5 days into the future) * {gateway_id} may be any of * gateway_id, * user_defined_name, * user_defined_group_name, * * See https://api-test.connome.com/documentation/Gateway.html for more information about what kind of id's that can be used * * * See https://api-test.connome.com/documentation/SubscriptionRegister.html */ +(NSMutableURLRequest*) getSubscriptionRepeatPaymentGateway_id: (NSString*)gateway_id; /** * BPAPI method Subscription/VerifyRegistrationId * * Verifies the status of the given registration_id.
* * https://api-test.connome.com/documentation/SubscriptionVerifyRegistrationId.html * * No authorization required HTTP methods allowed: GET * * Syntax: Subscription/VerifyRegistrationId/{registration_id}/ * * Verifies the status of the given registration_id. * Used for lightweight initialization of customer account. * * Returns the following fields: * registration_id_status * registration_id_status_description: A textual description like "GSM Fixi Plus, registrert" or "GSM Fixi Plus, ikke registrert" or "Ukjent verdikode". Note that text will be translated. * * registration_id_status may be one of * "ok": The registration_id is a valid code and has not been used * "ok_already_registered": The registration_id is a valid code but it has already been "used", that is, it is registered to a customer e-mail address already * "invalid": The registration_id does not exist * * In the first two cases some additional information is also returned like: * * customer_email * customer_first_name * customer_last_name * customer_dealer_name (Taken from RelationDealerGateway, alternatively from free-text format CustomerProperty dealer_name) * subscription_description * payment_completion_information: When developer_mode has been set this property will give test credit-card numbers that may be used. * buy_descriptions: A key-value collection with descriptions for subscriptions that the customer can buy. * * For every key in buy_descriptions (consisting of a subscriptionType) there is a key-value collection with the following items: *     buy_description: Textual description of what the customer may buy (this will be correct translated)    fee: Fee for subscription, including any taxes.    valid_to_date: The date until which the subscription will be valid after purchase. * (One of the keys of buy_descriptions may be used later against API-call https://api-test.connome.com/documentation/SubscriptionRegisterPayment.html) * (note that more specific customer information is not returned, for that a full login will be needed). * * * See also https://api-test.connome.com/documentation/SubscriptionRegister.html */ +(NSMutableURLRequest*) getSubscriptionVerifyRegistrationIdRegistration_id: (NSString*)registration_id; /** * BPAPI method Summary * * Returns a HTML summary for the customer identified by {id}
* * https://api-test.connome.com/documentation/Summary.html * * HTTP methods allowed: GET * * Syntax: Summary/{id}/ * * Returns a HTML summary for the customer identified by {id} * * The parameter {id} is optional. If not given the call will return information about the customer identified by the authorization credentials used. * * {id} may be any of * bpapi_customer_id, * email, * customer_name, * customer_group_name * * * If {id} identifies more than one customer an error response is generated * The response will always be in HTML-format (with Javascript). JSON will not be returned. */ +(NSMutableURLRequest*) getSummaryId: (NSString*)id; /** * BPAPI method Translations/Version * * Gets version id of translations for the given client_id and language.
* * https://api-test.connome.com/documentation/TranslationsVersion.html * * No authorization required HTTP methods allowed: GET * * Syntax: Translations/Version/{client_id}/{language}/ * * Gets version id of translations for the given client_id and language. * * DEPRECATED, use new AppView concept instead * * Note that there is some minutes lag between new translations being added to the database (through https://api-test.connome.com/documentation/DeviceAddProperty.html) and the return value of this method being updated. * * If the language is not recognized then information about 'en-US' is returned (American English). * Usually translations are cached by the client. * This call may be used by the client to verify that the locally cached translations at the client side are up to date. * This can be done by the client comparing the result of this call with the last value of 'version_id' returned by https://api-test.connome.com/documentation/Translations.html. * * Note that the version_id returned looks like a date and time but it is sufficient to just store it as a string and do string comparision against the value of 'version_id' returned by https://api-test.connome.com/documentation/Translations.html * If the version_id does not match then https://api-test.connome.com/documentation/Translations.html can be called in ordet to update the cache at the client side. * * See https://api-test.connome.com/documentation/Translations.html for more information about how to specify client_id and language. * */ +(NSMutableURLRequest*) getTranslationsVersionClient_id: (NSString*)client_id language: (NSString*)language; /** * BPAPI method Translations * * Gets translations for the given {client_id} and {language}.
* * https://api-test.connome.com/documentation/Translations.html * * No authorization required HTTP methods allowed: GET, POST * * Syntax: Translations/{client_id}/{language}/{keys}/ * * Gets translations for the given {client_id} and {language}. * * If the language is not recognized then information about 'en-US' is returned (American English). * The parameter keys consists of a comma-separated list of keys that needs to be translated. * * Language can be specified in the same manner as the HTTP Header Field Accept-Language, like 'en-US', 'nb-NO', 'da-DK', 'sv-SE' (or just 'en', 'nb', 'da', 'sv'). * You may store the preferred language as property "preferred_language" for the customer. * (https://api-test.connome.com/documentation/CustomerAddProperty.html with property_name "preferred_language") * Note that the returned 'version_id' may be stored locally and later checked with a quick call to https://api-test.connome.com/documentation/TranslationsVersion.html. (that is, to to avoid uneccessarily calling https://api-test.connome.com/documentation/Translations.html when there are no new data on the server.)\ * * Note that this method call is available with HTTP POST in order to facilitate long lists of keys. * * */ +(NSMutableURLRequest*) getTranslationsClient_id: (NSString*)client_id language: (NSString*)language keys: (NSString*)keys; +(NSMutableURLRequest*) postTranslationsClient_id: (NSString*)client_id language: (NSString*)language keys: (NSString*)keys; /** * BPAPI method VerifyCredentials * * Verifies that the credentials you supply for authorization correspond to a customer in the database.
* * https://api-test.connome.com/documentation/VerifyCredentials.html * * HTTP methods allowed: GET * * Syntax: VerifyCredentials * * Verifies that the credentials you supply for authorization correspond to a customer in the database. * Note that the credentials in themselves are not supplied as parameters to this method as authorization is done "outside" of BPAPI (as HTTP Basic authentication) * * Returnes scalar_result true if the credentials are correct * * If the credentials are not correct the response will be an error message from the authorization mechanism used, * this will not be in the standard BPAPI-format, that is bpapi_status, scalar_result or similar will NOT be defined. * * This method is somewhat more reliable than just doing an API-call and checking that no HTTP 4xx error code was returned, since * it checks for the affirmative instead of the negative. It is recommended that the client uses this method whenever the client asks the * user for credentials (that is, whenever the client asks the user for login-information). * * * See also https://api-test.connome.com/documentation/VerifyPassword.html which may be better for Javascript-applications running in a web-browser * */ +(NSMutableURLRequest*) getVerifyCredentials; /** * BPAPI method VerifyPassword * * Verifies that the {email} and {password} supplied are valid as credentials.
* * https://api-test.connome.com/documentation/VerifyPassword.html * * No authorization required HTTP methods allowed: GET, POST * * Syntax: VerifyPassword/{email}/{password}/ * * Verifies that the {email} and {password} supplied are valid as credentials. * * See also https://api-test.connome.com/documentation/VerifyCredentials.html. * Returns one of the following access_granted values: * NoAccess * LimitedAccessRegistrationIdUsed: Access is given to a few methods like -Customer/AddProperty/Simple-, -Gateway/AddProperty/Simple- and -RegisterPayment- which uses registrationId as a credential-parameter * FullAccess * * Returns in addition the following two values: * 1) payment_completion_information: If a customer has been identified and developer_mode has been set this property will give test credit-card numbers that may be used (this functionality is useful if https://api-test.connome.com/documentation/VerifyPassword.html is called in relation to a -WebShop/Register-) * 2) email: This is useful when access_granted is LimitedAccessRegistrationIdUsed, this will be the email to use in order to get access_granted FullAccess. This information is useful when the users forgets that he has registered with email and password and continues to log in with only his registrationId (valueCode) * * * * */ +(NSMutableURLRequest*) getVerifyPasswordEmail: (NSString*)email password: (NSString*)password; +(NSMutableURLRequest*) postVerifyPasswordEmail: (NSString*)email password: (NSString*)password; /** * BPAPI method WebShop/Order * * Gives details about a specific web-shop order
* * https://api-test.connome.com/documentation/WebShopOrder.html * * HTTP methods allowed: GET * * Syntax: WebShop/Order/{order_id}/ * * Gives details about a specific web-shop order * * The response will always be in HTML-format (with Javascript). JSON will not be returned (except when the request-syntax is invalid or any of the parameters are invalid) * Note that the parameter order_id may be either the WebShop order_id or the corresponding Payment transaction_id. * * See also -WebShop/Register- * */ +(NSMutableURLRequest*) getWebShopOrderOrder_id: (NSString*)order_id; /** * BPAPI method WebShop/RegisterPaymentCallback * * Used by the Payment provider after the customer has completed payment for a WebShop order (completion as seen from the customer's perspective)
* * https://api-test.connome.com/documentation/WebShopRegisterPaymentCallback.html * * No authorization required HTTP methods allowed: GET * * Syntax: WebShop/RegisterPaymentCallback/{transactionId}/{responseCode}/ * * Used by the Payment provider after the customer has completed payment for a WebShop order (completion as seen from the customer's perspective) * * Redirects to functionality as given by -WebShop/Register- which will complete payment as seen from BPAPI's perspective. * (in other words, this is not an API-method) * * * See also -WebShop/Register- */ +(NSMutableURLRequest*) getWebShopRegisterPaymentCallbackTransactionId: (NSString*)transactionId responseCode: (NSString*)responseCode; @end