\ProfileAPI

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

Method	HTTP request	Description
AddPersonProfile	Post /persons/{personId}/profiles/{profileId}	Add a Profile to a Person
CreateProfile	Post /profiles	Create a new Profile
DeletePersonProfile	Delete /persons/{personId}/profiles/{profileId}	Remove a Profile from a Person
DeleteProfile	Delete /profiles/{profileId}	Delete a Profile
GetProfile	Get /profiles/{profileId}	Get details about a Profile
SearchProfiles	Post /profiles/search	Search over profiles
UpdateProfile	Put /profiles/{profileId}	Update a Profile

AddPersonProfile

PersonDetails AddPersonProfile(ctx, personId, profileId).Execute()

Add a Profile to 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 | 
    profileId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | 

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

Path Parameters

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

Other Parameters

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

CreateProfile

ProfileDetails CreateProfile(ctx).Profile(profile).Execute()

Create a new Profile

Example

package main

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

func main() {
    profile := *openapiclient.NewProfile("Id_example", "Name_example") // Profile | 

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

Path Parameters

Other Parameters

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

Name	Type	Description	Notes
profile	Profile

Return type

ProfileDetails

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]

DeletePersonProfile

PersonDetails DeletePersonProfile(ctx, personId, profileId).Execute()

Remove a Profile 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 | 
    profileId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | 

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

Path Parameters

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

Other Parameters

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

DeleteProfile

Status DeleteProfile(ctx, profileId).Execute()

Delete a Profile

Example

package main

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

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

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

Path Parameters

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

Other Parameters

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

GetProfile

ProfileDetails GetProfile(ctx, profileId).Execute()

Get details about a Profile

Example

package main

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

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

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

Path Parameters

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

Other Parameters

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

Name	Type	Description	Notes

Return type

ProfileDetails

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]

SearchProfiles

PagedProfiles SearchProfiles(ctx).Search(search).Execute()

Search over profiles

Example

package main

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

func main() {
    search := *openapiclient.NewSearch(int32(123), int32(123)) // Search |  (optional)

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

Path Parameters

Other Parameters

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

Name	Type	Description	Notes
search	Search

Return type

PagedProfiles

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]

UpdateProfile

ProfileDetails UpdateProfile(ctx, profileId).Profile(profile).Execute()

Update a Profile

Example

package main

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

func main() {
    profileId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | 
    profile := *openapiclient.NewProfile("Id_example", "Name_example") // Profile | 

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

Path Parameters

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

Other Parameters

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

Name	Type	Description	Notes

profile | Profile | |

Return type

ProfileDetails

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

ProfileAPI.md

Latest commit

History

ProfileAPI.md

File metadata and controls

\ProfileAPI

AddPersonProfile

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

CreateProfile

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

DeletePersonProfile

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

DeleteProfile

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

GetProfile

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

SearchProfiles

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

UpdateProfile

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers