Skip to content

Latest commit

 

History

History
244 lines (165 loc) · 8.85 KB

ObjectSignatureApi.md

File metadata and controls

244 lines (165 loc) · 8.85 KB
Raw

ObjectSignatureApi

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

Method HTTP request Description
signatureCreateObjectV1 POST /1/object/signature Create a new Signature
signatureDeleteObjectV1 DELETE /1/object/signature/{pkiSignatureID} Delete an existing Signature
signatureEditObjectV1 PUT /1/object/signature/{pkiSignatureID} Edit an existing Signature
signatureGetObjectV2 GET /2/object/signature/{pkiSignatureID} Retrieve an existing Signature

signatureCreateObjectV1

-(NSURLSessionTask*) signatureCreateObjectV1WithSignatureCreateObjectV1Request: (SignatureCreateObjectV1Request*) signatureCreateObjectV1Request
        completionHandler: (void (^)(SignatureCreateObjectV1Response* output, NSError* error)) handler;

Create a new Signature

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


SignatureCreateObjectV1Request* signatureCreateObjectV1Request = [[SignatureCreateObjectV1Request alloc] init]; // 

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

// Create a new Signature
[apiInstance signatureCreateObjectV1WithSignatureCreateObjectV1Request:signatureCreateObjectV1Request
          completionHandler: ^(SignatureCreateObjectV1Response* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ObjectSignatureApi->signatureCreateObjectV1: %@", error);
                        }
                    }];

Parameters

Name Type Description Notes
signatureCreateObjectV1Request SignatureCreateObjectV1Request*

Return type

SignatureCreateObjectV1Response*

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]

signatureDeleteObjectV1

-(NSURLSessionTask*) signatureDeleteObjectV1WithPkiSignatureID: (NSNumber*) pkiSignatureID
        completionHandler: (void (^)(SignatureDeleteObjectV1Response* output, NSError* error)) handler;

Delete an existing Signature

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* pkiSignatureID = @56; // The unique ID of the Signature

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

// Delete an existing Signature
[apiInstance signatureDeleteObjectV1WithPkiSignatureID:pkiSignatureID
          completionHandler: ^(SignatureDeleteObjectV1Response* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ObjectSignatureApi->signatureDeleteObjectV1: %@", error);
                        }
                    }];

Parameters

Name Type Description Notes
pkiSignatureID NSNumber* The unique ID of the Signature

Return type

SignatureDeleteObjectV1Response*

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]

signatureEditObjectV1

-(NSURLSessionTask*) signatureEditObjectV1WithPkiSignatureID: (NSNumber*) pkiSignatureID
    signatureEditObjectV1Request: (SignatureEditObjectV1Request*) signatureEditObjectV1Request
        completionHandler: (void (^)(SignatureEditObjectV1Response* output, NSError* error)) handler;

Edit an existing Signature

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* pkiSignatureID = @56; // The unique ID of the Signature
SignatureEditObjectV1Request* signatureEditObjectV1Request = [[SignatureEditObjectV1Request alloc] init]; // 

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

// Edit an existing Signature
[apiInstance signatureEditObjectV1WithPkiSignatureID:pkiSignatureID
              signatureEditObjectV1Request:signatureEditObjectV1Request
          completionHandler: ^(SignatureEditObjectV1Response* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ObjectSignatureApi->signatureEditObjectV1: %@", error);
                        }
                    }];

Parameters

Name Type Description Notes
pkiSignatureID NSNumber* The unique ID of the Signature
signatureEditObjectV1Request SignatureEditObjectV1Request*

Return type

SignatureEditObjectV1Response*

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]

signatureGetObjectV2

-(NSURLSessionTask*) signatureGetObjectV2WithPkiSignatureID: (NSNumber*) pkiSignatureID
        completionHandler: (void (^)(SignatureGetObjectV2Response* output, NSError* error)) handler;

Retrieve an existing Signature

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* pkiSignatureID = @56; // The unique ID of the Signature

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

// Retrieve an existing Signature
[apiInstance signatureGetObjectV2WithPkiSignatureID:pkiSignatureID
          completionHandler: ^(SignatureGetObjectV2Response* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ObjectSignatureApi->signatureGetObjectV2: %@", error);
                        }
                    }];

Parameters

Name Type Description Notes
pkiSignatureID NSNumber* The unique ID of the Signature

Return type

SignatureGetObjectV2Response*

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]