Variable PidApiConst

Type declaration

• apiV2PidsOptions:function

  • apiV2PidsOptions(options?): AxiosPromise<void>

  • Parameters

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<void>

    Summary

    Responds with the HTTP methods allowed for the endpoint.

    Throws

• getPid:function

  • getPid(requestParameters, options?): AxiosPromise<PidDtoResponse>

  • Required JWT roles for access: .

    Parameters

    • requestParameters: PidApiGetPidRequest

      Request parameters.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<PidDtoResponse>

    Summary

    Retrieves the Persistent Identifier (PID) for a given prefix and suffix.

    Throws

• getPids:function

  • getPids(requestParameters?, options?): AxiosPromise<PidDtoPagedResponse>

  • Required JWT roles for access: administrator.

    Parameters

    • requestParameters: PidApiGetPidsRequest = {}

      Request parameters.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<PidDtoPagedResponse>

    Summary

    Retrieves all PIDs.

    Throws

• sendRequestToOwner:function

  • sendRequestToOwner(requestParameters, options?): AxiosPromise<void>

  • Required JWT roles for access: .

    Parameters

    • requestParameters: PidApiSendRequestToOwnerRequest

      Request parameters.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<void>

    Summary

    Sends an inquiry to the owner of the given PID.

    Throws