Skip to content

Latest commit

 

History

History
322 lines (224 loc) · 11.5 KB

ObjectUserstagedApi.md

File metadata and controls

322 lines (224 loc) · 11.5 KB

ObjectUserstagedApi

All URIs are relative to https://prod.api.appcluster01.ca-central-1.ezmax.com/rest

Method HTTP request Description
userstagedCreateUserV1 POST /1/object/userstaged/{pkiUserstagedID}/createUser Create a User from a Userstaged and then map it
userstagedDeleteObjectV1 DELETE /1/object/userstaged/{pkiUserstagedID} Delete an existing Userstaged
userstagedGetListV1 GET /1/object/userstaged/getList Retrieve Userstaged list
userstagedGetObjectV2 GET /2/object/userstaged/{pkiUserstagedID} Retrieve an existing Userstaged
userstagedMapV1 POST /1/object/userstaged/{pkiUserstagedID}/map Map the Userstaged to an existing user

userstagedCreateUserV1

-(NSURLSessionTask*) userstagedCreateUserV1WithPkiUserstagedID: (NSNumber*) pkiUserstagedID
    body: (NSObject*) body
        completionHandler: (void (^)(UserstagedCreateUserV1Response* output, NSError* error)) handler;

Create a User from a Userstaged and then map it

Default values will be used while creating the User. If you need to change those values, you should use the route to edit a User.

Example

DefaultConfiguration *apiConfig = [DefaultConfiguration sharedConfig];

// Configure API key authorization: (authentication scheme: Authorization)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


NSNumber* pkiUserstagedID = @56; // 
NSObject* body = NULL; // 

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

// Create a User from a Userstaged and then map it
[apiInstance userstagedCreateUserV1WithPkiUserstagedID:pkiUserstagedID
              body:body
          completionHandler: ^(UserstagedCreateUserV1Response* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ObjectUserstagedApi->userstagedCreateUserV1: %@", error);
                        }
                    }];

Parameters

Name Type Description Notes
pkiUserstagedID NSNumber*
body NSObject*

Return type

UserstagedCreateUserV1Response*

Authorization

Authorization

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

userstagedDeleteObjectV1

-(NSURLSessionTask*) userstagedDeleteObjectV1WithPkiUserstagedID: (NSNumber*) pkiUserstagedID
        completionHandler: (void (^)(UserstagedDeleteObjectV1Response* output, NSError* error)) handler;

Delete an existing Userstaged

Example

DefaultConfiguration *apiConfig = [DefaultConfiguration sharedConfig];

// Configure API key authorization: (authentication scheme: Authorization)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


NSNumber* pkiUserstagedID = @56; // 

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

// Delete an existing Userstaged
[apiInstance userstagedDeleteObjectV1WithPkiUserstagedID:pkiUserstagedID
          completionHandler: ^(UserstagedDeleteObjectV1Response* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ObjectUserstagedApi->userstagedDeleteObjectV1: %@", error);
                        }
                    }];

Parameters

Name Type Description Notes
pkiUserstagedID NSNumber*

Return type

UserstagedDeleteObjectV1Response*

Authorization

Authorization

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

userstagedGetListV1

-(NSURLSessionTask*) userstagedGetListV1WithEOrderBy: (NSString*) eOrderBy
    iRowMax: (NSNumber*) iRowMax
    iRowOffset: (NSNumber*) iRowOffset
    acceptLanguage: (HeaderAcceptLanguage) acceptLanguage
    sFilter: (NSString*) sFilter
        completionHandler: (void (^)(UserstagedGetListV1Response* output, NSError* error)) handler;

Retrieve Userstaged list

Example

DefaultConfiguration *apiConfig = [DefaultConfiguration sharedConfig];

// Configure API key authorization: (authentication scheme: Authorization)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


NSString* eOrderBy = @"eOrderBy_example"; // Specify how you want the results to be sorted (optional)
NSNumber* iRowMax = @56; //  (optional)
NSNumber* iRowOffset = @0; //  (optional) (default to @0)
HeaderAcceptLanguage acceptLanguage = [[HeaderAcceptLanguage alloc] init]; //  (optional)
NSString* sFilter = @"sFilter_example"; //  (optional)

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

// Retrieve Userstaged list
[apiInstance userstagedGetListV1WithEOrderBy:eOrderBy
              iRowMax:iRowMax
              iRowOffset:iRowOffset
              acceptLanguage:acceptLanguage
              sFilter:sFilter
          completionHandler: ^(UserstagedGetListV1Response* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ObjectUserstagedApi->userstagedGetListV1: %@", error);
                        }
                    }];

Parameters

Name Type Description Notes
eOrderBy NSString* Specify how you want the results to be sorted [optional]
iRowMax NSNumber* [optional]
iRowOffset NSNumber* [optional] [default to @0]
acceptLanguage HeaderAcceptLanguage [optional]
sFilter NSString* [optional]

Return type

UserstagedGetListV1Response*

Authorization

Authorization

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

[Back to top] [Back to API list] [Back to Model list] [Back to README]

userstagedGetObjectV2

-(NSURLSessionTask*) userstagedGetObjectV2WithPkiUserstagedID: (NSNumber*) pkiUserstagedID
        completionHandler: (void (^)(UserstagedGetObjectV2Response* output, NSError* error)) handler;

Retrieve an existing Userstaged

Example

DefaultConfiguration *apiConfig = [DefaultConfiguration sharedConfig];

// Configure API key authorization: (authentication scheme: Authorization)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


NSNumber* pkiUserstagedID = @56; // 

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

// Retrieve an existing Userstaged
[apiInstance userstagedGetObjectV2WithPkiUserstagedID:pkiUserstagedID
          completionHandler: ^(UserstagedGetObjectV2Response* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ObjectUserstagedApi->userstagedGetObjectV2: %@", error);
                        }
                    }];

Parameters

Name Type Description Notes
pkiUserstagedID NSNumber*

Return type

UserstagedGetObjectV2Response*

Authorization

Authorization

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

userstagedMapV1

-(NSURLSessionTask*) userstagedMapV1WithPkiUserstagedID: (NSNumber*) pkiUserstagedID
    userstagedMapV1Request: (UserstagedMapV1Request*) userstagedMapV1Request
        completionHandler: (void (^)(UserstagedMapV1Response* output, NSError* error)) handler;

Map the Userstaged to an existing user

Example

DefaultConfiguration *apiConfig = [DefaultConfiguration sharedConfig];

// Configure API key authorization: (authentication scheme: Authorization)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


NSNumber* pkiUserstagedID = @56; // 
UserstagedMapV1Request* userstagedMapV1Request = [[UserstagedMapV1Request alloc] init]; // 

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

// Map the Userstaged to an existing user
[apiInstance userstagedMapV1WithPkiUserstagedID:pkiUserstagedID
              userstagedMapV1Request:userstagedMapV1Request
          completionHandler: ^(UserstagedMapV1Response* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ObjectUserstagedApi->userstagedMapV1: %@", error);
                        }
                    }];

Parameters

Name Type Description Notes
pkiUserstagedID NSNumber*
userstagedMapV1Request UserstagedMapV1Request*

Return type

UserstagedMapV1Response*

Authorization

Authorization

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]