\AwardAPI

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

Method	HTTP request	Description
AddPersonAward	Post /persons/{personId}/awards/{awardId}	Add an award to a Person
CreateAward	Post /awards	Create a new Award in an Organization
DeleteAward	Delete /awards/{awardId}	Delete an award
DeletePersonAward	Delete /persons/{personId}/awards/{awardId}	Remove an Award from a Person
GetAward	Get /awards/{awardId}	Get details of an award by ID
MoveAward	Put /awards/{awardId}/organizations/{organizationId}	Move an award to an Organization
SearchAwards	Post /awards/search	Search for awards
UpdateAward	Put /awards/{awardId}	Update an award
UpdatePersonAward	Put /persons/{personId}/awards/{awardId}	Update an Award of a Person

AddPersonAward

PersonDetails AddPersonAward(ctx, personId, awardId).Body(body).Execute()

Add an award to a Person

Example

package main

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

func main() {
    personId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | 
    awardId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | 
    body := time.Now() // string | 

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

Path Parameters

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

Other Parameters

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

Name	Type	Description	Notes

body | string | |

Return type

PersonDetails

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]

CreateAward

AwardDetails CreateAward(ctx).OrganizationId(organizationId).Award(award).Execute()

Create a new Award in 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 | The ID of the organization
    award := *openapiclient.NewAward("Id_example", "Name_example") // Award | 

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

Path Parameters

Other Parameters

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

Name	Type	Description	Notes
organizationId	string	The ID of the organization
award	Award

Return type

AwardDetails

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]

DeleteAward

Status DeleteAward(ctx, awardId).Execute()

Delete an award

Example

package main

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

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

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

Path Parameters

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

Other Parameters

Other parameters are passed through a pointer to a apiDeleteAwardRequest 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]

DeletePersonAward

PersonDetails DeletePersonAward(ctx, personId, awardId).Execute()

Remove an Award 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 | 
    awardId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | 

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

Path Parameters

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

Other Parameters

Other parameters are passed through a pointer to a apiDeletePersonAwardRequest 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]

GetAward

AwardDetails GetAward(ctx, awardId).Execute()

Get details of an award by ID

Example

package main

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

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

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

Path Parameters

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

Other Parameters

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

Name	Type	Description	Notes

Return type

AwardDetails

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]

MoveAward

AwardDetails MoveAward(ctx, awardId, organizationId).Execute()

Move an award to an Organization

Example

package main

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

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

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

Path Parameters

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

Other Parameters

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

Name	Type	Description	Notes

Return type

AwardDetails

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]

SearchAwards

PagedAwards SearchAwards(ctx).AwardSearch(awardSearch).Execute()

Search for awards

Example

package main

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

func main() {
    awardSearch := *openapiclient.NewAwardSearch(int32(123), int32(123)) // AwardSearch |  (optional)

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

Path Parameters

Other Parameters

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

Name	Type	Description	Notes
awardSearch	AwardSearch

Return type

PagedAwards

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]

UpdateAward

AwardDetails UpdateAward(ctx, awardId).Award(award).Execute()

Update an award

Example

package main

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

func main() {
    awardId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | 
    award := *openapiclient.NewAward("Id_example", "Name_example") // Award | 

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

Path Parameters

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

Other Parameters

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

Name	Type	Description	Notes

award | Award | |

Return type

AwardDetails

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]

UpdatePersonAward

PersonDetails UpdatePersonAward(ctx, personId, awardId).Body(body).Execute()

Update an Award of a Person

Example

package main

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

func main() {
    personId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | 
    awardId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | 
    body := time.Now() // string | 

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

Path Parameters

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

Other Parameters

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

Name	Type	Description	Notes

body | string | |

Return type

PersonDetails

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]

Files

AwardAPI.md

Latest commit

History

AwardAPI.md

File metadata and controls

\AwardAPI

AddPersonAward

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

CreateAward

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

DeleteAward

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

DeletePersonAward

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

GetAward

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

MoveAward

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

SearchAwards

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

UpdateAward

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

UpdatePersonAward

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers