Skip to content

ObjectBuyercontractApi.md

Latest commit

 

History

History
376 lines (259 loc) · 14.7 KB

ObjectBuyercontractApi.md

File metadata and controls

376 lines (259 loc) · 14.7 KB
Raw

ObjectBuyercontractApi

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

Method HTTP request Description
buyercontractGetCommunicationCountV1 GET /1/object/buyercontract/{pkiBuyercontractID}/getCommunicationCount Retrieve Communication count
buyercontractGetCommunicationListV1 GET /1/object/buyercontract/{pkiBuyercontractID}/getCommunicationList Retrieve Communication list
buyercontractGetCommunicationrecipientsV1 GET /1/object/buyercontract/{pkiBuyercontractID}/getCommunicationrecipients Retrieve Buyercontract's Communicationrecipient
buyercontractGetCommunicationsendersV1 GET /1/object/buyercontract/{pkiBuyercontractID}/getCommunicationsenders Retrieve Buyercontract's Communicationsender
buyercontractGetListV1 GET /1/object/buyercontract/getList Retrieve Buyercontract list
buyercontractImportIntoEDMV1 POST /1/object/buyercontract/{pkiBuyercontractID}/importIntoEDM Import attachments into the Buyercontract

buyercontractGetCommunicationCountV1

-(NSURLSessionTask*) buyercontractGetCommunicationCountV1WithPkiBuyercontractID: (NSNumber*) pkiBuyercontractID
        completionHandler: (void (^)(BuyercontractGetCommunicationCountV1Response* output, NSError* error)) handler;

Retrieve Communication count

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

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

// Retrieve Communication count
[apiInstance buyercontractGetCommunicationCountV1WithPkiBuyercontractID:pkiBuyercontractID
          completionHandler: ^(BuyercontractGetCommunicationCountV1Response* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ObjectBuyercontractApi->buyercontractGetCommunicationCountV1: %@", error);
                        }
                    }];

Parameters

Name Type Description Notes
pkiBuyercontractID NSNumber*

Return type

BuyercontractGetCommunicationCountV1Response*

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]

buyercontractGetCommunicationListV1

-(NSURLSessionTask*) buyercontractGetCommunicationListV1WithPkiBuyercontractID: (NSNumber*) pkiBuyercontractID
        completionHandler: (void (^)(BuyercontractGetCommunicationListV1Response* output, NSError* error)) handler;

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


NSNumber* pkiBuyercontractID = @56; // 

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

// Retrieve Communication list
[apiInstance buyercontractGetCommunicationListV1WithPkiBuyercontractID:pkiBuyercontractID
          completionHandler: ^(BuyercontractGetCommunicationListV1Response* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ObjectBuyercontractApi->buyercontractGetCommunicationListV1: %@", error);
                        }
                    }];

Parameters

Name Type Description Notes
pkiBuyercontractID NSNumber*

Return type

BuyercontractGetCommunicationListV1Response*

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]

buyercontractGetCommunicationrecipientsV1

-(NSURLSessionTask*) buyercontractGetCommunicationrecipientsV1WithPkiBuyercontractID: (NSNumber*) pkiBuyercontractID
        completionHandler: (void (^)(BuyercontractGetCommunicationrecipientsV1Response* output, NSError* error)) handler;

Retrieve Buyercontract's Communicationrecipient

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

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

// Retrieve Buyercontract's Communicationrecipient
[apiInstance buyercontractGetCommunicationrecipientsV1WithPkiBuyercontractID:pkiBuyercontractID
          completionHandler: ^(BuyercontractGetCommunicationrecipientsV1Response* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ObjectBuyercontractApi->buyercontractGetCommunicationrecipientsV1: %@", error);
                        }
                    }];

Parameters

Name Type Description Notes
pkiBuyercontractID NSNumber*

Return type

BuyercontractGetCommunicationrecipientsV1Response*

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]

buyercontractGetCommunicationsendersV1

-(NSURLSessionTask*) buyercontractGetCommunicationsendersV1WithPkiBuyercontractID: (NSNumber*) pkiBuyercontractID
        completionHandler: (void (^)(BuyercontractGetCommunicationsendersV1Response* output, NSError* error)) handler;

Retrieve Buyercontract's Communicationsender

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

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

// Retrieve Buyercontract's Communicationsender
[apiInstance buyercontractGetCommunicationsendersV1WithPkiBuyercontractID:pkiBuyercontractID
          completionHandler: ^(BuyercontractGetCommunicationsendersV1Response* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ObjectBuyercontractApi->buyercontractGetCommunicationsendersV1: %@", error);
                        }
                    }];

Parameters

Name Type Description Notes
pkiBuyercontractID NSNumber*

Return type

BuyercontractGetCommunicationsendersV1Response*

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]

buyercontractGetListV1

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

Retrieve Buyercontract list

Enum values that can be filtered in query parameter sFilter: | Variable | Valid values | |---|---| | eBuyercontractStep | Imported
Active
Modified
ContractEnded
ExpiredContract
Bought | | eBuyercontractType | Rent
Sale
RentOrSale |

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)

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

// Retrieve Buyercontract list
[apiInstance buyercontractGetListV1WithEOrderBy:eOrderBy
              iRowMax:iRowMax
              iRowOffset:iRowOffset
              acceptLanguage:acceptLanguage
              sFilter:sFilter
          completionHandler: ^(BuyercontractGetListV1Response* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ObjectBuyercontractApi->buyercontractGetListV1: %@", 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

BuyercontractGetListV1Response*

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]

buyercontractImportIntoEDMV1

-(NSURLSessionTask*) buyercontractImportIntoEDMV1WithPkiBuyercontractID: (NSNumber*) pkiBuyercontractID
    buyercontractImportIntoEDMV1Request: (BuyercontractImportIntoEDMV1Request*) buyercontractImportIntoEDMV1Request
        completionHandler: (void (^)(BuyercontractImportIntoEDMV1Response* output, NSError* error)) handler;

Import attachments into the Buyercontract

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* pkiBuyercontractID = @56; // 
BuyercontractImportIntoEDMV1Request* buyercontractImportIntoEDMV1Request = [[BuyercontractImportIntoEDMV1Request alloc] init]; // 

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

// Import attachments into the Buyercontract
[apiInstance buyercontractImportIntoEDMV1WithPkiBuyercontractID:pkiBuyercontractID
              buyercontractImportIntoEDMV1Request:buyercontractImportIntoEDMV1Request
          completionHandler: ^(BuyercontractImportIntoEDMV1Response* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ObjectBuyercontractApi->buyercontractImportIntoEDMV1: %@", error);
                        }
                    }];

Parameters

Name Type Description Notes
pkiBuyercontractID NSNumber*
buyercontractImportIntoEDMV1Request BuyercontractImportIntoEDMV1Request*

Return type

BuyercontractImportIntoEDMV1Response*

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]