Skip to content

Latest commit

 

History

History
357 lines (233 loc) · 10.6 KB

SkillsProfileAPI.md

File metadata and controls

357 lines (233 loc) · 10.6 KB
Raw

\SkillsProfileAPI

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

Method HTTP request Description
CreateSkillsProfileForPerson Post /persons/{personId}/skills-profiles Create a SkillsProfile
DeleteSkillsProfile Delete /skillsProfiles/{skillsProfileId} Delete a skills profile
GetPersonSkillsProfiles Get /persons/{personId}/skills-profiles Get all SkillsProfiles of a single person
GetSkillsProfile Get /skillsProfiles/{skillsProfileId} Get a SkillsProfile
UpdateSkillsProfile Put /skillsProfiles/{skillsProfileId} Update a SkillsProfile

CreateSkillsProfileForPerson

SkillsProfileDetails CreateSkillsProfileForPerson(ctx, personId).SkillsProfileRequest(skillsProfileRequest).Execute()

Create a SkillsProfile

Example

package main

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

func main() {
    personId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | 
    skillsProfileRequest := *openapiclient.NewSkillsProfileRequest() // SkillsProfileRequest | 

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

Path Parameters

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

Other Parameters

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

Name Type Description Notes

skillsProfileRequest | SkillsProfileRequest | |

Return type

SkillsProfileDetails

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]

DeleteSkillsProfile

Status DeleteSkillsProfile(ctx, skillsProfileId).Execute()

Delete a skills profile

Example

package main

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

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

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

Path Parameters

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

Other Parameters

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

GetPersonSkillsProfiles

PagedSkillsProfiles GetPersonSkillsProfiles(ctx, personId).Execute()

Get all SkillsProfiles of a single 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 | 

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

Path Parameters

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

Other Parameters

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

Name Type Description Notes

Return type

PagedSkillsProfiles

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]

GetSkillsProfile

SkillsProfileDetails GetSkillsProfile(ctx, skillsProfileId).Execute()

Get a SkillsProfile

Example

package main

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

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

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

Path Parameters

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

Other Parameters

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

Name Type Description Notes

Return type

SkillsProfileDetails

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]

UpdateSkillsProfile

SkillsProfileDetails UpdateSkillsProfile(ctx, skillsProfileId).SkillsProfileRequest(skillsProfileRequest).Execute()

Update a SkillsProfile

Example

package main

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

func main() {
    skillsProfileId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | 
    skillsProfileRequest := *openapiclient.NewSkillsProfileRequest() // SkillsProfileRequest | 

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

Path Parameters

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

Other Parameters

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

Name Type Description Notes

skillsProfileRequest | SkillsProfileRequest | |

Return type

SkillsProfileDetails

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]