\OfficeAPI

All URIs are relative to https://yasm.prodyna.com:443/api/v1

Method	HTTP request	Description
AddOrganizationOffice	Post /organizations/{organizationId}/offices/{officeId}	Assign an office to an organization
CreateOffice	Post /offices	Create an Office in an Organization
DeleteOffice	Delete /offices/{officeId}	Delete an Office
DeleteOfficeCountry	Delete /offices/{officeId}/countries/{countryId}	Delete the office from a Person
DeleteOrganizationOffice	Delete /organizations/{organizationId}/offices/{officeId}	Delete an office from an organization
DeletePersonOffice	Delete /persons/{personId}/offices/{officeId}	Delete the office from a Person
GetOfficeDetails	Get /offices/{officeId}	Get details about an Office
SearchOffices	Post /offices/search	Search over offices
UpdateOffice	Put /offices/{officeId}	Update an Office
UpdateOfficeCountry	Put /offices/{officeId}/countries/{countryId}	Assign a country to an office
UpdatePersonOffice	Put /persons/{personId}/offices/{officeId}	Assign a person to an office

AddOrganizationOffice

OrganizationDetails AddOrganizationOffice(ctx, organizationId, officeId).Execute()

Assign an office to an organization

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/prodyna-yasm/yasm-api-go"
)

func main() {
    organizationId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | 
    officeId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.OfficeAPI.AddOrganizationOffice(context.Background(), organizationId, officeId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `OfficeAPI.AddOrganizationOffice``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `AddOrganizationOffice`: OrganizationDetails
    fmt.Fprintf(os.Stdout, "Response from `OfficeAPI.AddOrganizationOffice`: %v\n", resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
organizationId	string
officeId	string

Other Parameters

Other parameters are passed through a pointer to a apiAddOrganizationOfficeRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

OrganizationDetails

Authorization

oidcScheme, bearerScheme

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

CreateOffice

OfficeDetails CreateOffice(ctx).Office(office).Execute()

Create an Office in an Organization

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/prodyna-yasm/yasm-api-go"
)

func main() {
    office := *openapiclient.NewOffice("Id_example", "Name_example") // Office | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.OfficeAPI.CreateOffice(context.Background()).Office(office).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `OfficeAPI.CreateOffice``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `CreateOffice`: OfficeDetails
    fmt.Fprintf(os.Stdout, "Response from `OfficeAPI.CreateOffice`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiCreateOfficeRequest struct via the builder pattern

Name	Type	Description	Notes
office	Office

Return type

OfficeDetails

Authorization

oidcScheme, bearerScheme

HTTP request headers

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

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

DeleteOffice

Status DeleteOffice(ctx, officeId).Execute()

Delete an Office

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/prodyna-yasm/yasm-api-go"
)

func main() {
    officeId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.OfficeAPI.DeleteOffice(context.Background(), officeId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `OfficeAPI.DeleteOffice``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `DeleteOffice`: Status
    fmt.Fprintf(os.Stdout, "Response from `OfficeAPI.DeleteOffice`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
officeId	string

Other Parameters

Other parameters are passed through a pointer to a apiDeleteOfficeRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

Status

Authorization

oidcScheme, bearerScheme

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

DeleteOfficeCountry

OfficeDetails DeleteOfficeCountry(ctx, officeId, countryId).Execute()

Delete the office from a Person

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/prodyna-yasm/yasm-api-go"
)

func main() {
    officeId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | 
    countryId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.OfficeAPI.DeleteOfficeCountry(context.Background(), officeId, countryId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `OfficeAPI.DeleteOfficeCountry``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `DeleteOfficeCountry`: OfficeDetails
    fmt.Fprintf(os.Stdout, "Response from `OfficeAPI.DeleteOfficeCountry`: %v\n", resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
officeId	string
countryId	string

Other Parameters

Other parameters are passed through a pointer to a apiDeleteOfficeCountryRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

OfficeDetails

Authorization

oidcScheme, bearerScheme

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

DeleteOrganizationOffice

OrganizationDetails DeleteOrganizationOffice(ctx, organizationId, officeId).Execute()

Delete an office from an organization

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/prodyna-yasm/yasm-api-go"
)

func main() {
    organizationId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | 
    officeId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.OfficeAPI.DeleteOrganizationOffice(context.Background(), organizationId, officeId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `OfficeAPI.DeleteOrganizationOffice``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `DeleteOrganizationOffice`: OrganizationDetails
    fmt.Fprintf(os.Stdout, "Response from `OfficeAPI.DeleteOrganizationOffice`: %v\n", resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
organizationId	string
officeId	string

Other Parameters

Other parameters are passed through a pointer to a apiDeleteOrganizationOfficeRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

OrganizationDetails

Authorization

oidcScheme, bearerScheme

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

DeletePersonOffice

PersonDetails DeletePersonOffice(ctx, personId, officeId).Execute()

Delete the office from a Person

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/prodyna-yasm/yasm-api-go"
)

func main() {
    personId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | 
    officeId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.OfficeAPI.DeletePersonOffice(context.Background(), personId, officeId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `OfficeAPI.DeletePersonOffice``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `DeletePersonOffice`: PersonDetails
    fmt.Fprintf(os.Stdout, "Response from `OfficeAPI.DeletePersonOffice`: %v\n", resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
personId	string
officeId	string

Other Parameters

Other parameters are passed through a pointer to a apiDeletePersonOfficeRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

PersonDetails

Authorization

oidcScheme, bearerScheme

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

GetOfficeDetails

OfficeDetails GetOfficeDetails(ctx, officeId).Execute()

Get details about an Office

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/prodyna-yasm/yasm-api-go"
)

func main() {
    officeId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.OfficeAPI.GetOfficeDetails(context.Background(), officeId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `OfficeAPI.GetOfficeDetails``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetOfficeDetails`: OfficeDetails
    fmt.Fprintf(os.Stdout, "Response from `OfficeAPI.GetOfficeDetails`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
officeId	string

Other Parameters

Other parameters are passed through a pointer to a apiGetOfficeDetailsRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

OfficeDetails

Authorization

oidcScheme, bearerScheme

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

SearchOffices

PagedOffices SearchOffices(ctx).OfficeSearch(officeSearch).Execute()

Search over offices

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/prodyna-yasm/yasm-api-go"
)

func main() {
    officeSearch := *openapiclient.NewOfficeSearch(int32(123), int32(123)) // OfficeSearch |  (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.OfficeAPI.SearchOffices(context.Background()).OfficeSearch(officeSearch).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `OfficeAPI.SearchOffices``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `SearchOffices`: PagedOffices
    fmt.Fprintf(os.Stdout, "Response from `OfficeAPI.SearchOffices`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiSearchOfficesRequest struct via the builder pattern

Name	Type	Description	Notes
officeSearch	OfficeSearch

Return type

PagedOffices

Authorization

oidcScheme, bearerScheme

HTTP request headers

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

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

UpdateOffice

OfficeDetails UpdateOffice(ctx, officeId).Office(office).Execute()

Update an Office

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/prodyna-yasm/yasm-api-go"
)

func main() {
    officeId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | 
    office := *openapiclient.NewOffice("Id_example", "Name_example") // Office | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.OfficeAPI.UpdateOffice(context.Background(), officeId).Office(office).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `OfficeAPI.UpdateOffice``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `UpdateOffice`: OfficeDetails
    fmt.Fprintf(os.Stdout, "Response from `OfficeAPI.UpdateOffice`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
officeId	string

Other Parameters

Other parameters are passed through a pointer to a apiUpdateOfficeRequest struct via the builder pattern

Name	Type	Description	Notes

office | Office | |

Return type

OfficeDetails

Authorization

oidcScheme, bearerScheme

HTTP request headers

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

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

UpdateOfficeCountry

OfficeDetails UpdateOfficeCountry(ctx, officeId, countryId).Execute()

Assign a country to an office

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/prodyna-yasm/yasm-api-go"
)

func main() {
    officeId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | 
    countryId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.OfficeAPI.UpdateOfficeCountry(context.Background(), officeId, countryId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `OfficeAPI.UpdateOfficeCountry``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `UpdateOfficeCountry`: OfficeDetails
    fmt.Fprintf(os.Stdout, "Response from `OfficeAPI.UpdateOfficeCountry`: %v\n", resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
officeId	string
countryId	string

Other Parameters

Other parameters are passed through a pointer to a apiUpdateOfficeCountryRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

OfficeDetails

Authorization

oidcScheme, bearerScheme

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

UpdatePersonOffice

PersonDetails UpdatePersonOffice(ctx, personId, officeId).Execute()

Assign a person to an office

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/prodyna-yasm/yasm-api-go"
)

func main() {
    personId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | 
    officeId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.OfficeAPI.UpdatePersonOffice(context.Background(), personId, officeId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `OfficeAPI.UpdatePersonOffice``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `UpdatePersonOffice`: PersonDetails
    fmt.Fprintf(os.Stdout, "Response from `OfficeAPI.UpdatePersonOffice`: %v\n", resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
personId	string
officeId	string

Other Parameters

Other parameters are passed through a pointer to a apiUpdatePersonOfficeRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

PersonDetails

Authorization

oidcScheme, bearerScheme

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

Files

OfficeAPI.md

Latest commit

History

OfficeAPI.md

File metadata and controls

\OfficeAPI

AddOrganizationOffice

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

CreateOffice

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

DeleteOffice

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

DeleteOfficeCountry

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

DeleteOrganizationOffice

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

DeletePersonOffice

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

GetOfficeDetails

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

SearchOffices

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

UpdateOffice

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

UpdateOfficeCountry

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

UpdatePersonOffice

Example

Path Parameters