Skip to content

Latest commit

 

History

History
156 lines (116 loc) · 5.53 KB

SWGSchedulesApi.md

File metadata and controls

156 lines (116 loc) · 5.53 KB
Raw

SWGSchedulesApi

All URIs are relative to https://api.phone.com/v4

Method HTTP request Description
getAccountSchedule GET /accounts/{account_id}/schedules/{schedule_id} Show details of an individual schedule
listAccountSchedules GET /accounts/{account_id}/schedules Get a list of schedules for an account

getAccountSchedule

-(NSURLSessionTask*) getAccountScheduleWithAccountId: (NSNumber*) accountId
    scheduleId: (NSNumber*) scheduleId
        completionHandler: (void (^)(SWGScheduleFull* output, NSError* error)) handler;

Show details of an individual schedule

Show details of an individual schedule

Example

SWGDefaultConfiguration *apiConfig = [SWGDefaultConfiguration sharedConfig];

// Configure API key authorization: (authentication scheme: apiKey)
[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* accountId = @56; // Account ID
NSNumber* scheduleId = @56; // Schedule ID

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

// Show details of an individual schedule
[apiInstance getAccountScheduleWithAccountId:accountId
              scheduleId:scheduleId
          completionHandler: ^(SWGScheduleFull* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling SWGSchedulesApi->getAccountSchedule: %@", error);
                        }
                    }];

Parameters

Name Type Description Notes
accountId NSNumber* Account ID
scheduleId NSNumber* Schedule ID

Return type

SWGScheduleFull*

Authorization

apiKey

HTTP request headers

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

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

listAccountSchedules

-(NSURLSessionTask*) listAccountSchedulesWithAccountId: (NSNumber*) accountId
    filtersId: (NSArray<NSString*>*) filtersId
    filtersName: (NSArray<NSString*>*) filtersName
    sortId: (NSString*) sortId
    sortName: (NSString*) sortName
    limit: (NSNumber*) limit
    offset: (NSNumber*) offset
    fields: (NSString*) fields
        completionHandler: (void (^)(SWGListSchedules* output, NSError* error)) handler;

Get a list of schedules for an account

Get a list of schedules for an account

Example

SWGDefaultConfiguration *apiConfig = [SWGDefaultConfiguration sharedConfig];

// Configure API key authorization: (authentication scheme: apiKey)
[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* accountId = @56; // Account ID
NSArray<NSString*>* filtersId = @[@"filtersId_example"]; // ID filter (optional)
NSArray<NSString*>* filtersName = @[@"filtersName_example"]; // Name filter (optional)
NSString* sortId = @"sortId_example"; // ID sorting (optional)
NSString* sortName = @"sortName_example"; // Name sorting (optional)
NSNumber* limit = @56; // Max results (optional)
NSNumber* offset = @56; // Results to skip (optional)
NSString* fields = @"fields_example"; // Field set (optional)

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

// Get a list of schedules for an account
[apiInstance listAccountSchedulesWithAccountId:accountId
              filtersId:filtersId
              filtersName:filtersName
              sortId:sortId
              sortName:sortName
              limit:limit
              offset:offset
              fields:fields
          completionHandler: ^(SWGListSchedules* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling SWGSchedulesApi->listAccountSchedules: %@", error);
                        }
                    }];

Parameters

Name Type Description Notes
accountId NSNumber* Account ID
filtersId NSArray<NSString>** ID filter [optional]
filtersName NSArray<NSString>** Name filter [optional]
sortId NSString* ID sorting [optional]
sortName NSString* Name sorting [optional]
limit NSNumber* Max results [optional]
offset NSNumber* Results to skip [optional]
fields NSString* Field set [optional]

Return type

SWGListSchedules*

Authorization

apiKey

HTTP request headers

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

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