agmv / boatsbackend

OutSystemsBoatsBackend

Authentication Basic Authentication is required for all requests.

This ObjC package is automatically generated by the Swagger Codegen project:

• API version: 1
• Package version:
• Build package: io.swagger.codegen.languages.ObjcClientCodegen

Requirements

The SDK requires ARC (Automatic Reference Counting) to be enabled in the Xcode project.

Installation & Usage

Install from Github using CocoaPods

Add the following to the Podfile:

pod 'OutSystemsBoatsBackend', :git => 'https://github.com//.git'

To specify a particular branch, append , :branch => 'branch-name-here'

To specify a particular commit, append , :commit => '11aa22'

Install from local path using CocoaPods

Put the SDK under your project folder (e.g. /path/to/objc_project/Vendor/OutSystemsBoatsBackend) and then add the following to the Podfile:

pod 'OutSystemsBoatsBackend', :path => 'Vendor/OutSystemsBoatsBackend'

Usage

Import the following:

#import <OutSystemsBoatsBackend/OS_ApiClient.h>
#import <OutSystemsBoatsBackend/OS_Configuration.h>
// load models
#import <OutSystemsBoatsBackend/OS_Boat.h>
#import <OutSystemsBoatsBackend/OS_BoatBoatImageRecord.h>
#import <OutSystemsBoatsBackend/OS_BoatBoatImagesRecord.h>
#import <OutSystemsBoatsBackend/OS_BoatImage.h>
// load API classes for accessing endpoints
#import <OutSystemsBoatsBackend/OS_BoatsApi.h>

Recommendation

It's recommended to create an instance of ApiClient per thread in a multi-threaded environment to avoid any potential issues.

Getting Started

Please follow the installation procedure and then run the following:

OS_Configuration *apiConfig = [OS_Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basic)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];



OS_BoatsApi *apiInstance = [[OS_BoatsApi alloc] init];

[apiInstance getAllWithCompletionHandler: 
              ^(NSArray<OS_BoatBoatImageRecord>* output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

Documentation for API Endpoints

All URIs are relative to https://E1O0V-DV2D50.outsystemsenterprise.com/BoatsBackend/rest/Boats

Class	Method	HTTP request	Description
OS_BoatsApi	getAll	GET /GetAll
OS_BoatsApi	getBoatDetail	GET /GetBoatDetail

Documentation For Models

• OS_Boat
• OS_BoatBoatImageRecord
• OS_BoatBoatImagesRecord
• OS_BoatImage

Documentation For Authorization

basic

• Type: HTTP basic authentication

Author