\ClientCheckInApi

All URIs are relative to /api

Method	HTTP request	Description
V2CheckInGet	Get /v2/check-in	Get Client Check-In settings
V2CheckInHistoryGet	Get /v2/check-in/history	Get Client Check-In history object
V2CheckInHistoryPost	Post /v2/check-in/history	Add a Note to Client Check-In History
V2CheckInPut	Put /v2/check-in	Update Client Check-In object
V3CheckInGet	Get /v3/check-in	Get Client Check-In settings
V3CheckInHistoryGet	Get /v3/check-in/history	Get Client Check-In history object
V3CheckInHistoryPost	Post /v3/check-in/history	Add a Note to Client Check-In History
V3CheckInPut	Put /v3/check-in	Update Client Check-In object

V2CheckInGet

ClientCheckInV2 V2CheckInGet(ctx).Execute()

Get Client Check-In settings

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {

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

Path Parameters

This endpoint does not need any parameter.

Other Parameters

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

Return type

ClientCheckInV2

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

V2CheckInHistoryGet

HistorySearchResultsV1 V2CheckInHistoryGet(ctx).Page(page).PageSize(pageSize).Sort(sort).Filter(filter).Execute()

Get Client Check-In history object

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    page := int32(56) // int32 |  (optional) (default to 0)
    pageSize := int32(56) // int32 |  (optional) (default to 100)
    sort := []string{"Inner_example"} // []string | Sorting criteria in the format: property:asc/desc. Default sort is name:asc. Multiple sort criteria are supported and must be separated with a comma. Example: sort=date:desc,username:asc  (optional) (default to ["date:desc"])
    filter := "filter_example" // string | Query in the RSQL format, allowing to filter history notes collection. Default filter is empty query - returning all results for the requested page. Fields allowed in the query: username, date, note, details. This param can be combined with paging and sorting. Example: filter=username!=admin and details==*disabled* and date<2019-12-15 (optional) (default to "")

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ClientCheckInApi.V2CheckInHistoryGet(context.Background()).Page(page).PageSize(pageSize).Sort(sort).Filter(filter).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ClientCheckInApi.V2CheckInHistoryGet``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `V2CheckInHistoryGet`: HistorySearchResultsV1
    fmt.Fprintf(os.Stdout, "Response from `ClientCheckInApi.V2CheckInHistoryGet`: %v\n", resp)
}

Path Parameters

Other Parameters

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

Name	Type	Description	Notes
page	int32		[default to 0]
pageSize	int32		[default to 100]
sort	[]string	Sorting criteria in the format: property:asc/desc. Default sort is name:asc. Multiple sort criteria are supported and must be separated with a comma. Example: sort=date:desc,username:asc	[default to ["date:desc"]]
filter	string	Query in the RSQL format, allowing to filter history notes collection. Default filter is empty query - returning all results for the requested page. Fields allowed in the query: username, date, note, details. This param can be combined with paging and sorting. Example: filter=username!=admin and details==disabled and date<2019-12-15	[default to ""]

Return type

HistorySearchResultsV1

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

V2CheckInHistoryPost

HrefResponse V2CheckInHistoryPost(ctx).ObjectHistoryNote(objectHistoryNote).Execute()

Add a Note to Client Check-In History

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    objectHistoryNote := *openapiclient.NewObjectHistoryNote("A generic note can sometimes be useful, but generally not.") // ObjectHistoryNote | history notes to create

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

Path Parameters

Other Parameters

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

Name	Type	Description	Notes
objectHistoryNote	ObjectHistoryNote	history notes to create

Return type

HrefResponse

Authorization

Bearer

HTTP request headers

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

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

V2CheckInPut

ClientCheckInV2 V2CheckInPut(ctx).ClientCheckInV2(clientCheckInV2).Execute()

Update Client Check-In object

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    clientCheckInV2 := *openapiclient.NewClientCheckInV2() // ClientCheckInV2 | Client Check-In object to update

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

Path Parameters

Other Parameters

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

Name	Type	Description	Notes
clientCheckInV2	ClientCheckInV2	Client Check-In object to update

Return type

ClientCheckInV2

Authorization

Bearer

HTTP request headers

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

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

V3CheckInGet

ClientCheckInV3 V3CheckInGet(ctx).Execute()

Get Client Check-In settings

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {

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

Path Parameters

This endpoint does not need any parameter.

Other Parameters

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

Return type

ClientCheckInV3

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

V3CheckInHistoryGet

HistorySearchResultsV1 V3CheckInHistoryGet(ctx).Page(page).PageSize(pageSize).Sort(sort).Filter(filter).Execute()

Get Client Check-In history object

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    page := int32(56) // int32 |  (optional) (default to 0)
    pageSize := int32(56) // int32 |  (optional) (default to 100)
    sort := []string{"Inner_example"} // []string | Sorting criteria in the format: property:asc/desc. Default sort is name:asc. Multiple sort criteria are supported and must be separated with a comma. Example: sort=date:desc,username:asc  (optional) (default to ["date:desc"])
    filter := "filter_example" // string | Query in the RSQL format, allowing to filter history notes collection. Default filter is empty query - returning all results for the requested page. Fields allowed in the query: username, date, note, details. This param can be combined with paging and sorting. Example: filter=username!=admin and details==*disabled* and date<2019-12-15 (optional) (default to "")

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ClientCheckInApi.V3CheckInHistoryGet(context.Background()).Page(page).PageSize(pageSize).Sort(sort).Filter(filter).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ClientCheckInApi.V3CheckInHistoryGet``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `V3CheckInHistoryGet`: HistorySearchResultsV1
    fmt.Fprintf(os.Stdout, "Response from `ClientCheckInApi.V3CheckInHistoryGet`: %v\n", resp)
}

Path Parameters

Other Parameters

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

Name	Type	Description	Notes
page	int32		[default to 0]
pageSize	int32		[default to 100]
sort	[]string	Sorting criteria in the format: property:asc/desc. Default sort is name:asc. Multiple sort criteria are supported and must be separated with a comma. Example: sort=date:desc,username:asc	[default to ["date:desc"]]
filter	string	Query in the RSQL format, allowing to filter history notes collection. Default filter is empty query - returning all results for the requested page. Fields allowed in the query: username, date, note, details. This param can be combined with paging and sorting. Example: filter=username!=admin and details==disabled and date<2019-12-15	[default to ""]

Return type

HistorySearchResultsV1

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

V3CheckInHistoryPost

HrefResponse V3CheckInHistoryPost(ctx).ObjectHistoryNote(objectHistoryNote).Execute()

Add a Note to Client Check-In History

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    objectHistoryNote := *openapiclient.NewObjectHistoryNote("A generic note can sometimes be useful, but generally not.") // ObjectHistoryNote | history notes to create

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

Path Parameters

Other Parameters

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

Name	Type	Description	Notes
objectHistoryNote	ObjectHistoryNote	history notes to create

Return type

HrefResponse

Authorization

Bearer

HTTP request headers

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

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

V3CheckInPut

ClientCheckInV3 V3CheckInPut(ctx).ClientCheckInV3(clientCheckInV3).Execute()

Update Client Check-In object

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    clientCheckInV3 := *openapiclient.NewClientCheckInV3() // ClientCheckInV3 | Client Check-In object to update

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

Path Parameters

Other Parameters

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

Name	Type	Description	Notes
clientCheckInV3	ClientCheckInV3	Client Check-In object to update

Return type

ClientCheckInV3

Authorization

Bearer

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

ClientCheckInApi.md

Latest commit

History

ClientCheckInApi.md

File metadata and controls

\ClientCheckInApi

V2CheckInGet

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

V2CheckInHistoryGet

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

V2CheckInHistoryPost

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

V2CheckInPut

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

V3CheckInGet

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

V3CheckInHistoryGet

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

V3CheckInHistoryPost

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

V3CheckInPut

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers