Skip to content

Latest commit

 

History

History
244 lines (165 loc) · 9.8 KB

ObjectUsergroupmembershipApi.md

File metadata and controls

244 lines (165 loc) · 9.8 KB

ObjectUsergroupmembershipApi

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

Method HTTP request Description
usergroupmembershipCreateObjectV1 POST /1/object/usergroupmembership Create a new Usergroupmembership
usergroupmembershipDeleteObjectV1 DELETE /1/object/usergroupmembership/{pkiUsergroupmembershipID} Delete an existing Usergroupmembership
usergroupmembershipEditObjectV1 PUT /1/object/usergroupmembership/{pkiUsergroupmembershipID} Edit an existing Usergroupmembership
usergroupmembershipGetObjectV2 GET /2/object/usergroupmembership/{pkiUsergroupmembershipID} Retrieve an existing Usergroupmembership

usergroupmembershipCreateObjectV1

-(NSURLSessionTask*) usergroupmembershipCreateObjectV1WithUsergroupmembershipCreateObjectV1Request: (UsergroupmembershipCreateObjectV1Request*) usergroupmembershipCreateObjectV1Request
        completionHandler: (void (^)(UsergroupmembershipCreateObjectV1Response* output, NSError* error)) handler;

Create a new Usergroupmembership

The endpoint allows to create one or many elements at once.

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"];


UsergroupmembershipCreateObjectV1Request* usergroupmembershipCreateObjectV1Request = [[UsergroupmembershipCreateObjectV1Request alloc] init]; // 

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

// Create a new Usergroupmembership
[apiInstance usergroupmembershipCreateObjectV1WithUsergroupmembershipCreateObjectV1Request:usergroupmembershipCreateObjectV1Request
          completionHandler: ^(UsergroupmembershipCreateObjectV1Response* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ObjectUsergroupmembershipApi->usergroupmembershipCreateObjectV1: %@", error);
                        }
                    }];

Parameters

Name Type Description Notes
usergroupmembershipCreateObjectV1Request UsergroupmembershipCreateObjectV1Request*

Return type

UsergroupmembershipCreateObjectV1Response*

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]

usergroupmembershipDeleteObjectV1

-(NSURLSessionTask*) usergroupmembershipDeleteObjectV1WithPkiUsergroupmembershipID: (NSNumber*) pkiUsergroupmembershipID
        completionHandler: (void (^)(UsergroupmembershipDeleteObjectV1Response* output, NSError* error)) handler;

Delete an existing Usergroupmembership

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* pkiUsergroupmembershipID = @56; // 

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

// Delete an existing Usergroupmembership
[apiInstance usergroupmembershipDeleteObjectV1WithPkiUsergroupmembershipID:pkiUsergroupmembershipID
          completionHandler: ^(UsergroupmembershipDeleteObjectV1Response* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ObjectUsergroupmembershipApi->usergroupmembershipDeleteObjectV1: %@", error);
                        }
                    }];

Parameters

Name Type Description Notes
pkiUsergroupmembershipID NSNumber*

Return type

UsergroupmembershipDeleteObjectV1Response*

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]

usergroupmembershipEditObjectV1

-(NSURLSessionTask*) usergroupmembershipEditObjectV1WithPkiUsergroupmembershipID: (NSNumber*) pkiUsergroupmembershipID
    usergroupmembershipEditObjectV1Request: (UsergroupmembershipEditObjectV1Request*) usergroupmembershipEditObjectV1Request
        completionHandler: (void (^)(UsergroupmembershipEditObjectV1Response* output, NSError* error)) handler;

Edit an existing Usergroupmembership

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* pkiUsergroupmembershipID = @56; // 
UsergroupmembershipEditObjectV1Request* usergroupmembershipEditObjectV1Request = [[UsergroupmembershipEditObjectV1Request alloc] init]; // 

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

// Edit an existing Usergroupmembership
[apiInstance usergroupmembershipEditObjectV1WithPkiUsergroupmembershipID:pkiUsergroupmembershipID
              usergroupmembershipEditObjectV1Request:usergroupmembershipEditObjectV1Request
          completionHandler: ^(UsergroupmembershipEditObjectV1Response* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ObjectUsergroupmembershipApi->usergroupmembershipEditObjectV1: %@", error);
                        }
                    }];

Parameters

Name Type Description Notes
pkiUsergroupmembershipID NSNumber*
usergroupmembershipEditObjectV1Request UsergroupmembershipEditObjectV1Request*

Return type

UsergroupmembershipEditObjectV1Response*

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]

usergroupmembershipGetObjectV2

-(NSURLSessionTask*) usergroupmembershipGetObjectV2WithPkiUsergroupmembershipID: (NSNumber*) pkiUsergroupmembershipID
        completionHandler: (void (^)(UsergroupmembershipGetObjectV2Response* output, NSError* error)) handler;

Retrieve an existing Usergroupmembership

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* pkiUsergroupmembershipID = @56; // 

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

// Retrieve an existing Usergroupmembership
[apiInstance usergroupmembershipGetObjectV2WithPkiUsergroupmembershipID:pkiUsergroupmembershipID
          completionHandler: ^(UsergroupmembershipGetObjectV2Response* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ObjectUsergroupmembershipApi->usergroupmembershipGetObjectV2: %@", error);
                        }
                    }];

Parameters

Name Type Description Notes
pkiUsergroupmembershipID NSNumber*

Return type

UsergroupmembershipGetObjectV2Response*

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]