Represents a collection of functions to interact with the API endpoints More...
Classes | |
| class | GetNotaryOptions |
| Get notary settings for a user Gets settings for a notary user. The current user must be a notary. More... | |
| class | ListNotaryJournalsOptions |
| Get notary jurisdictions for a user More... | |
Public Member Functions | |
| NotaryApi (DocuSignClient aplClient) | |
| Initializes a new instance of the NotaryApi class using AplClient object More... | |
| String | GetBasePath () |
| Gets the base path of the API client. More... | |
| Notary | CreateNotary (Notary notary=null) |
| Add a notary to the system Registers the current user as a notary. More... | |
| ApiResponse< Notary > | CreateNotaryWithHttpInfo (Notary notary=null) |
| Add a notary to the system Registers the current user as a notary. More... | |
| async System.Threading.Tasks.Task< Notary > | CreateNotaryAsync (Notary notary=null) |
| Add a notary to the system Registers the current user as a notary. More... | |
| async System.Threading.Tasks.Task< ApiResponse< Notary > > | CreateNotaryAsyncWithHttpInfo (Notary notary=null) |
| Add a notary to the system Registers the current user as a notary. More... | |
| NotaryJurisdiction | CreateNotaryJurisdictions (NotaryJurisdiction notaryJurisdiction=null) |
| Add a notary jurisdiction to the system Creates a jurisdiction object. More... | |
| ApiResponse< NotaryJurisdiction > | CreateNotaryJurisdictionsWithHttpInfo (NotaryJurisdiction notaryJurisdiction=null) |
| Add a notary jurisdiction to the system Creates a jurisdiction object. More... | |
| async System.Threading.Tasks.Task< NotaryJurisdiction > | CreateNotaryJurisdictionsAsync (NotaryJurisdiction notaryJurisdiction=null) |
| Add a notary jurisdiction to the system Creates a jurisdiction object. More... | |
| async System.Threading.Tasks.Task< ApiResponse< NotaryJurisdiction > > | CreateNotaryJurisdictionsAsyncWithHttpInfo (NotaryJurisdiction notaryJurisdiction=null) |
| Add a notary jurisdiction to the system Creates a jurisdiction object. More... | |
| void | DeleteNotaryJurisdiction (string jurisdictionId) |
| Delete a notary jurisdiction a specified user. Deletes the specified jurisdiction. More... | |
| ApiResponse< Object > | DeleteNotaryJurisdictionWithHttpInfo (string jurisdictionId) |
| Delete a notary jurisdiction a specified user. Deletes the specified jurisdiction. More... | |
| async System.Threading.Tasks.Task | DeleteNotaryJurisdictionAsync (string jurisdictionId) |
| Delete a notary jurisdiction a specified user. Deletes the specified jurisdiction. More... | |
| async System.Threading.Tasks.Task< ApiResponse< Object > > | DeleteNotaryJurisdictionAsyncWithHttpInfo (string jurisdictionId) |
| Delete a notary jurisdiction a specified user. Deletes the specified jurisdiction. More... | |
| NotaryResult | GetNotary (NotaryApi.GetNotaryOptions options=null) |
| Get notary settings for a user Gets settings for a notary user. The current user must be a notary. More... | |
| ApiResponse< NotaryResult > | GetNotaryWithHttpInfo (NotaryApi.GetNotaryOptions options=null) |
| Get notary settings for a user Gets settings for a notary user. The current user must be a notary. More... | |
| async System.Threading.Tasks.Task< NotaryResult > | GetNotaryAsync (NotaryApi.GetNotaryOptions options=null) |
| Get notary settings for a user Gets settings for a notary user. The current user must be a notary. More... | |
| async System.Threading.Tasks.Task< ApiResponse< NotaryResult > > | GetNotaryAsyncWithHttpInfo (NotaryApi.GetNotaryOptions options=null) |
| Get notary settings for a user Gets settings for a notary user. The current user must be a notary. More... | |
| NotaryJurisdiction | GetNotaryJurisdiction (string jurisdictionId) |
| Get notary a jurisdiction for a user Gets a jurisdiction object for the current user. The following restrictions apply: - The current user must be a notary. - The `jurisdictionId` must be a jurisdiction that the notary is registered for. More... | |
| ApiResponse< NotaryJurisdiction > | GetNotaryJurisdictionWithHttpInfo (string jurisdictionId) |
| Get notary a jurisdiction for a user Gets a jurisdiction object for the current user. The following restrictions apply: - The current user must be a notary. - The `jurisdictionId` must be a jurisdiction that the notary is registered for. More... | |
| async System.Threading.Tasks.Task< NotaryJurisdiction > | GetNotaryJurisdictionAsync (string jurisdictionId) |
| Get notary a jurisdiction for a user Gets a jurisdiction object for the current user. The following restrictions apply: - The current user must be a notary. - The `jurisdictionId` must be a jurisdiction that the notary is registered for. More... | |
| async System.Threading.Tasks.Task< ApiResponse< NotaryJurisdiction > > | GetNotaryJurisdictionAsyncWithHttpInfo (string jurisdictionId) |
| Get notary a jurisdiction for a user Gets a jurisdiction object for the current user. The following restrictions apply: - The current user must be a notary. - The `jurisdictionId` must be a jurisdiction that the notary is registered for. More... | |
| void | GetNotaryJurisdictionSeal (string jurisdictionId) |
| Get notary seal for a jurisdiction More... | |
| ApiResponse< Object > | GetNotaryJurisdictionSealWithHttpInfo (string jurisdictionId) |
| Get notary seal for a jurisdiction More... | |
| async System.Threading.Tasks.Task | GetNotaryJurisdictionSealAsync (string jurisdictionId) |
| Get notary seal for a jurisdiction More... | |
| async System.Threading.Tasks.Task< ApiResponse< Object > > | GetNotaryJurisdictionSealAsyncWithHttpInfo (string jurisdictionId) |
| Get notary seal for a jurisdiction More... | |
| NotaryJurisdictionList | GetNotaryJurisdictions () |
| Get notary jurisdictions for a user Returns a list of jurisdictions that the notary is registered in. The current user must be a notary. More... | |
| ApiResponse< NotaryJurisdictionList > | GetNotaryJurisdictionsWithHttpInfo () |
| Get notary jurisdictions for a user Returns a list of jurisdictions that the notary is registered in. The current user must be a notary. More... | |
| async System.Threading.Tasks.Task< NotaryJurisdictionList > | GetNotaryJurisdictionsAsync () |
| Get notary jurisdictions for a user Returns a list of jurisdictions that the notary is registered in. The current user must be a notary. More... | |
| async System.Threading.Tasks.Task< ApiResponse< NotaryJurisdictionList > > | GetNotaryJurisdictionsAsyncWithHttpInfo () |
| Get notary jurisdictions for a user Returns a list of jurisdictions that the notary is registered in. The current user must be a notary. More... | |
| NotaryJournalList | ListNotaryJournals (NotaryApi.ListNotaryJournalsOptions options=null) |
| Get notary jurisdictions for a user More... | |
| ApiResponse< NotaryJournalList > | ListNotaryJournalsWithHttpInfo (NotaryApi.ListNotaryJournalsOptions options=null) |
| Get notary jurisdictions for a user More... | |
| async System.Threading.Tasks.Task< NotaryJournalList > | ListNotaryJournalsAsync (NotaryApi.ListNotaryJournalsOptions options=null) |
| Get notary jurisdictions for a user More... | |
| async System.Threading.Tasks.Task< ApiResponse< NotaryJournalList > > | ListNotaryJournalsAsyncWithHttpInfo (NotaryApi.ListNotaryJournalsOptions options=null) |
| Get notary jurisdictions for a user More... | |
| Notary | UpdateNotary (Notary notary=null) |
| Update a notary Updates notary information for the current user. More... | |
| ApiResponse< Notary > | UpdateNotaryWithHttpInfo (Notary notary=null) |
| Update a notary Updates notary information for the current user. More... | |
| async System.Threading.Tasks.Task< Notary > | UpdateNotaryAsync (Notary notary=null) |
| Update a notary Updates notary information for the current user. More... | |
| async System.Threading.Tasks.Task< ApiResponse< Notary > > | UpdateNotaryAsyncWithHttpInfo (Notary notary=null) |
| Update a notary Updates notary information for the current user. More... | |
| NotaryJurisdiction | UpdateNotaryJurisdiction (string jurisdictionId, NotaryJurisdiction notaryJurisdiction=null) |
| Update a notary jurisdiction Updates the jurisdiction information about a notary. The following restrictions apply: - The current user must be a notary. - The `jurisdictionId` path parameter must be a jurisdiction that the notary is registered for. - The `jurisdictionId` path parameter must match the request body's `jurisdiction.jurisdictionId`. The request body must have a full `jurisdiction` object for the jurisdiction property. The best way to do this is to use `getNotaryJurisdiction` to obtain the current values and update the properties you want to change. For example, assume `getNotaryJurisdiction` returns this: ``` { "jurisdiction": { "jurisdictionId": "15", "name": "Iowa", "county": "", "enabled": "true", "countyInSeal": "false", "commissionIdInSeal": "true", "stateNameInSeal": "true", "notaryPublicInSeal": "true", "allowSystemCreatedSeal": "true", "allowUserUploadedSeal": "false" }, "commissionId": "123456", "commissionExpiration": "2020-08-31T07:00:00.0000000Z", "registeredName": "Bob Notary", "county": "Adams", "sealType": "system_created" } ``` If you want to change the name of the notary from "Bob Notary" to "Robert Notary", your request body would be: ``` { "jurisdiction": { "jurisdictionId": "15", "name": "Iowa", "county": "", "enabled": "true", "countyInSeal": "false", "commissionIdInSeal": "true", "stateNameInSeal": "true", "notaryPublicInSeal": "true", "allowSystemCreatedSeal": "true", "allowUserUploadedSeal": "false" }, "commissionId": "123456", "commissionExpiration": "2020-08-31T07:00:00.0000000Z", "registeredName": "Robert Notary", "county": "Adams", "sealType": "system_created" } ``` More... | |
| ApiResponse< NotaryJurisdiction > | UpdateNotaryJurisdictionWithHttpInfo (string jurisdictionId, NotaryJurisdiction notaryJurisdiction=null) |
| Update a notary jurisdiction Updates the jurisdiction information about a notary. The following restrictions apply: - The current user must be a notary. - The `jurisdictionId` path parameter must be a jurisdiction that the notary is registered for. - The `jurisdictionId` path parameter must match the request body's `jurisdiction.jurisdictionId`. The request body must have a full `jurisdiction` object for the jurisdiction property. The best way to do this is to use `getNotaryJurisdiction` to obtain the current values and update the properties you want to change. For example, assume `getNotaryJurisdiction` returns this: ``` { "jurisdiction": { "jurisdictionId": "15", "name": "Iowa", "county": "", "enabled": "true", "countyInSeal": "false", "commissionIdInSeal": "true", "stateNameInSeal": "true", "notaryPublicInSeal": "true", "allowSystemCreatedSeal": "true", "allowUserUploadedSeal": "false" }, "commissionId": "123456", "commissionExpiration": "2020-08-31T07:00:00.0000000Z", "registeredName": "Bob Notary", "county": "Adams", "sealType": "system_created" } ``` If you want to change the name of the notary from "Bob Notary" to "Robert Notary", your request body would be: ``` { "jurisdiction": { "jurisdictionId": "15", "name": "Iowa", "county": "", "enabled": "true", "countyInSeal": "false", "commissionIdInSeal": "true", "stateNameInSeal": "true", "notaryPublicInSeal": "true", "allowSystemCreatedSeal": "true", "allowUserUploadedSeal": "false" }, "commissionId": "123456", "commissionExpiration": "2020-08-31T07:00:00.0000000Z", "registeredName": "Robert Notary", "county": "Adams", "sealType": "system_created" } ``` More... | |
| async System.Threading.Tasks.Task< NotaryJurisdiction > | UpdateNotaryJurisdictionAsync (string jurisdictionId, NotaryJurisdiction notaryJurisdiction=null) |
| Update a notary jurisdiction Updates the jurisdiction information about a notary. The following restrictions apply: - The current user must be a notary. - The `jurisdictionId` path parameter must be a jurisdiction that the notary is registered for. - The `jurisdictionId` path parameter must match the request body's `jurisdiction.jurisdictionId`. The request body must have a full `jurisdiction` object for the jurisdiction property. The best way to do this is to use `getNotaryJurisdiction` to obtain the current values and update the properties you want to change. For example, assume `getNotaryJurisdiction` returns this: ``` { "jurisdiction": { "jurisdictionId": "15", "name": "Iowa", "county": "", "enabled": "true", "countyInSeal": "false", "commissionIdInSeal": "true", "stateNameInSeal": "true", "notaryPublicInSeal": "true", "allowSystemCreatedSeal": "true", "allowUserUploadedSeal": "false" }, "commissionId": "123456", "commissionExpiration": "2020-08-31T07:00:00.0000000Z", "registeredName": "Bob Notary", "county": "Adams", "sealType": "system_created" } ``` If you want to change the name of the notary from "Bob Notary" to "Robert Notary", your request body would be: ``` { "jurisdiction": { "jurisdictionId": "15", "name": "Iowa", "county": "", "enabled": "true", "countyInSeal": "false", "commissionIdInSeal": "true", "stateNameInSeal": "true", "notaryPublicInSeal": "true", "allowSystemCreatedSeal": "true", "allowUserUploadedSeal": "false" }, "commissionId": "123456", "commissionExpiration": "2020-08-31T07:00:00.0000000Z", "registeredName": "Robert Notary", "county": "Adams", "sealType": "system_created" } ``` More... | |
| async System.Threading.Tasks.Task< ApiResponse< NotaryJurisdiction > > | UpdateNotaryJurisdictionAsyncWithHttpInfo (string jurisdictionId, NotaryJurisdiction notaryJurisdiction=null) |
| Update a notary jurisdiction Updates the jurisdiction information about a notary. The following restrictions apply: - The current user must be a notary. - The `jurisdictionId` path parameter must be a jurisdiction that the notary is registered for. - The `jurisdictionId` path parameter must match the request body's `jurisdiction.jurisdictionId`. The request body must have a full `jurisdiction` object for the jurisdiction property. The best way to do this is to use `getNotaryJurisdiction` to obtain the current values and update the properties you want to change. For example, assume `getNotaryJurisdiction` returns this: ``` { "jurisdiction": { "jurisdictionId": "15", "name": "Iowa", "county": "", "enabled": "true", "countyInSeal": "false", "commissionIdInSeal": "true", "stateNameInSeal": "true", "notaryPublicInSeal": "true", "allowSystemCreatedSeal": "true", "allowUserUploadedSeal": "false" }, "commissionId": "123456", "commissionExpiration": "2020-08-31T07:00:00.0000000Z", "registeredName": "Bob Notary", "county": "Adams", "sealType": "system_created" } ``` If you want to change the name of the notary from "Bob Notary" to "Robert Notary", your request body would be: ``` { "jurisdiction": { "jurisdictionId": "15", "name": "Iowa", "county": "", "enabled": "true", "countyInSeal": "false", "commissionIdInSeal": "true", "stateNameInSeal": "true", "notaryPublicInSeal": "true", "allowSystemCreatedSeal": "true", "allowUserUploadedSeal": "false" }, "commissionId": "123456", "commissionExpiration": "2020-08-31T07:00:00.0000000Z", "registeredName": "Robert Notary", "county": "Adams", "sealType": "system_created" } ``` More... | |
 Public Member Functions inherited from DocuSign.eSign.Api.INotaryApi | |
| NotaryResult | GetNotary (NotaryApi.GetNotaryOptions options=null) |
| Get notary settings for a user More... | |
| ApiResponse< NotaryResult > | GetNotaryWithHttpInfo (NotaryApi.GetNotaryOptions options=null) |
| Get notary settings for a user More... | |
| NotaryJournalList | ListNotaryJournals (NotaryApi.ListNotaryJournalsOptions options=null) |
| Get notary jurisdictions for a user More... | |
| ApiResponse< NotaryJournalList > | ListNotaryJournalsWithHttpInfo (NotaryApi.ListNotaryJournalsOptions options=null) |
| Get notary jurisdictions for a user More... | |
| System.Threading.Tasks.Task< NotaryResult > | GetNotaryAsync (NotaryApi.GetNotaryOptions options=null) |
| Get notary settings for a user More... | |
| System.Threading.Tasks.Task< ApiResponse< NotaryResult > > | GetNotaryAsyncWithHttpInfo (NotaryApi.GetNotaryOptions options=null) |
| Get notary settings for a user More... | |
| System.Threading.Tasks.Task< NotaryJournalList > | ListNotaryJournalsAsync (NotaryApi.ListNotaryJournalsOptions options=null) |
| Get notary jurisdictions for a user More... | |
| System.Threading.Tasks.Task< ApiResponse< NotaryJournalList > > | ListNotaryJournalsAsyncWithHttpInfo (NotaryApi.ListNotaryJournalsOptions options=null) |
| Get notary jurisdictions for a user More... | |
Properties | |
| DocuSignClient | ApiClient [get, set] |
| Gets or sets the ApiClient object More... | |
| DocuSign.eSign.Client.ExceptionFactory | ExceptionFactory [get, set] |
| Provides a factory method hook for the creation of exceptions. More... | |
| Properties inherited from DocuSign.eSign.Client.IApiAccessor | |
| DocuSignClient | ApiClient [get, set] |
| Gets or sets the ApiClient object More... | |
| ExceptionFactory | ExceptionFactory [get, set] |
| Provides a factory method hook for the creation of exceptions. More... | |
Detailed Description
Represents a collection of functions to interact with the API endpoints
Constructor & Destructor Documentation
◆ NotaryApi()
|
inline |
Initializes a new instance of the NotaryApi class using AplClient object
- Parameters
-
aplClient An instance of AplClient
- Returns
Member Function Documentation
◆ CreateNotary()
Add a notary to the system Registers the current user as a notary.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
notary (optional)
- Returns
- Notary
Implements DocuSign.eSign.Api.INotaryApi.
◆ CreateNotaryAsync()
|
inline |
Add a notary to the system Registers the current user as a notary.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
notary (optional)
- Returns
- Task of Notary
Implements DocuSign.eSign.Api.INotaryApi.
◆ CreateNotaryAsyncWithHttpInfo()
|
inline |
Add a notary to the system Registers the current user as a notary.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
notary (optional)
- Returns
- Task of ApiResponse (Notary)
Implements DocuSign.eSign.Api.INotaryApi.
◆ CreateNotaryJurisdictions()
|
inline |
Add a notary jurisdiction to the system Creates a jurisdiction object.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
notaryJurisdiction (optional)
- Returns
- NotaryJurisdiction
Implements DocuSign.eSign.Api.INotaryApi.
◆ CreateNotaryJurisdictionsAsync()
|
inline |
Add a notary jurisdiction to the system Creates a jurisdiction object.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
notaryJurisdiction (optional)
- Returns
- Task of NotaryJurisdiction
Implements DocuSign.eSign.Api.INotaryApi.
◆ CreateNotaryJurisdictionsAsyncWithHttpInfo()
|
inline |
Add a notary jurisdiction to the system Creates a jurisdiction object.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
notaryJurisdiction (optional)
- Returns
- Task of ApiResponse (NotaryJurisdiction)
Implements DocuSign.eSign.Api.INotaryApi.
◆ CreateNotaryJurisdictionsWithHttpInfo()
|
inline |
Add a notary jurisdiction to the system Creates a jurisdiction object.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
notaryJurisdiction (optional)
- Returns
- ApiResponse of NotaryJurisdiction
Implements DocuSign.eSign.Api.INotaryApi.
◆ CreateNotaryWithHttpInfo()
|
inline |
Add a notary to the system Registers the current user as a notary.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
notary (optional)
- Returns
- ApiResponse of Notary
Implements DocuSign.eSign.Api.INotaryApi.
◆ DeleteNotaryJurisdiction()
|
inline |
Delete a notary jurisdiction a specified user. Deletes the specified jurisdiction.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
jurisdictionId
- Returns
Implements DocuSign.eSign.Api.INotaryApi.
◆ DeleteNotaryJurisdictionAsync()
|
inline |
Delete a notary jurisdiction a specified user. Deletes the specified jurisdiction.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
jurisdictionId
- Returns
- Task of void
Implements DocuSign.eSign.Api.INotaryApi.
◆ DeleteNotaryJurisdictionAsyncWithHttpInfo()
|
inline |
Delete a notary jurisdiction a specified user. Deletes the specified jurisdiction.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
jurisdictionId
- Returns
- Task of ApiResponse
Implements DocuSign.eSign.Api.INotaryApi.
◆ DeleteNotaryJurisdictionWithHttpInfo()
|
inline |
Delete a notary jurisdiction a specified user. Deletes the specified jurisdiction.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
jurisdictionId
- Returns
- ApiResponse of Object(void)
Implements DocuSign.eSign.Api.INotaryApi.
◆ GetBasePath()
|
inline |
◆ GetNotary()
|
inline |
Get notary settings for a user Gets settings for a notary user. The current user must be a notary.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
options Options for modifying the behavior of the function.
- Returns
- NotaryResult
◆ GetNotaryAsync()
|
inline |
Get notary settings for a user Gets settings for a notary user. The current user must be a notary.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
options Options for modifying the behavior of the function.
- Returns
- Task of NotaryResult
◆ GetNotaryAsyncWithHttpInfo()
|
inline |
Get notary settings for a user Gets settings for a notary user. The current user must be a notary.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
options Options for modifying the behavior of the function.
- Returns
- Task of ApiResponse (NotaryResult)
◆ GetNotaryJurisdiction()
|
inline |
Get notary a jurisdiction for a user Gets a jurisdiction object for the current user. The following restrictions apply: - The current user must be a notary. - The `jurisdictionId` must be a jurisdiction that the notary is registered for.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
jurisdictionId
- Returns
- NotaryJurisdiction
Implements DocuSign.eSign.Api.INotaryApi.
◆ GetNotaryJurisdictionAsync()
|
inline |
Get notary a jurisdiction for a user Gets a jurisdiction object for the current user. The following restrictions apply: - The current user must be a notary. - The `jurisdictionId` must be a jurisdiction that the notary is registered for.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
jurisdictionId
- Returns
- Task of NotaryJurisdiction
Implements DocuSign.eSign.Api.INotaryApi.
◆ GetNotaryJurisdictionAsyncWithHttpInfo()
|
inline |
Get notary a jurisdiction for a user Gets a jurisdiction object for the current user. The following restrictions apply: - The current user must be a notary. - The `jurisdictionId` must be a jurisdiction that the notary is registered for.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
jurisdictionId
- Returns
- Task of ApiResponse (NotaryJurisdiction)
Implements DocuSign.eSign.Api.INotaryApi.
◆ GetNotaryJurisdictions()
|
inline |
Get notary jurisdictions for a user Returns a list of jurisdictions that the notary is registered in. The current user must be a notary.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Returns
- NotaryJurisdictionList
Implements DocuSign.eSign.Api.INotaryApi.
◆ GetNotaryJurisdictionsAsync()
|
inline |
Get notary jurisdictions for a user Returns a list of jurisdictions that the notary is registered in. The current user must be a notary.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Returns
- Task of NotaryJurisdictionList
Implements DocuSign.eSign.Api.INotaryApi.
◆ GetNotaryJurisdictionsAsyncWithHttpInfo()
|
inline |
Get notary jurisdictions for a user Returns a list of jurisdictions that the notary is registered in. The current user must be a notary.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Returns
- Task of ApiResponse (NotaryJurisdictionList)
Implements DocuSign.eSign.Api.INotaryApi.
◆ GetNotaryJurisdictionSeal()
|
inline |
Get notary seal for a jurisdiction
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
jurisdictionId
- Returns
Implements DocuSign.eSign.Api.INotaryApi.
◆ GetNotaryJurisdictionSealAsync()
|
inline |
Get notary seal for a jurisdiction
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
jurisdictionId
- Returns
- Task of void
Implements DocuSign.eSign.Api.INotaryApi.
◆ GetNotaryJurisdictionSealAsyncWithHttpInfo()
|
inline |
Get notary seal for a jurisdiction
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
jurisdictionId
- Returns
- Task of ApiResponse
Implements DocuSign.eSign.Api.INotaryApi.
◆ GetNotaryJurisdictionSealWithHttpInfo()
|
inline |
Get notary seal for a jurisdiction
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
jurisdictionId
- Returns
- ApiResponse of Object(void)
Implements DocuSign.eSign.Api.INotaryApi.
◆ GetNotaryJurisdictionsWithHttpInfo()
|
inline |
Get notary jurisdictions for a user Returns a list of jurisdictions that the notary is registered in. The current user must be a notary.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Returns
- ApiResponse of NotaryJurisdictionList
Implements DocuSign.eSign.Api.INotaryApi.
◆ GetNotaryJurisdictionWithHttpInfo()
|
inline |
Get notary a jurisdiction for a user Gets a jurisdiction object for the current user. The following restrictions apply: - The current user must be a notary. - The `jurisdictionId` must be a jurisdiction that the notary is registered for.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
jurisdictionId
- Returns
- ApiResponse of NotaryJurisdiction
Implements DocuSign.eSign.Api.INotaryApi.
◆ GetNotaryWithHttpInfo()
|
inline |
Get notary settings for a user Gets settings for a notary user. The current user must be a notary.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
options Options for modifying the behavior of the function.
- Returns
- ApiResponse of NotaryResult
◆ ListNotaryJournals()
|
inline |
Get notary jurisdictions for a user
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
options Options for modifying the behavior of the function.
- Returns
- NotaryJournalList
◆ ListNotaryJournalsAsync()
|
inline |
Get notary jurisdictions for a user
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
options Options for modifying the behavior of the function.
- Returns
- Task of NotaryJournalList
◆ ListNotaryJournalsAsyncWithHttpInfo()
|
inline |
Get notary jurisdictions for a user
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
options Options for modifying the behavior of the function.
- Returns
- Task of ApiResponse (NotaryJournalList)
◆ ListNotaryJournalsWithHttpInfo()
|
inline |
Get notary jurisdictions for a user
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
options Options for modifying the behavior of the function.
- Returns
- ApiResponse of NotaryJournalList
◆ UpdateNotary()
Update a notary Updates notary information for the current user.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
notary (optional)
- Returns
- Notary
Implements DocuSign.eSign.Api.INotaryApi.
◆ UpdateNotaryAsync()
|
inline |
Update a notary Updates notary information for the current user.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
notary (optional)
- Returns
- Task of Notary
Implements DocuSign.eSign.Api.INotaryApi.
◆ UpdateNotaryAsyncWithHttpInfo()
|
inline |
Update a notary Updates notary information for the current user.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
notary (optional)
- Returns
- Task of ApiResponse (Notary)
Implements DocuSign.eSign.Api.INotaryApi.
◆ UpdateNotaryJurisdiction()
|
inline |
Update a notary jurisdiction Updates the jurisdiction information about a notary. The following restrictions apply: - The current user must be a notary. - The `jurisdictionId` path parameter must be a jurisdiction that the notary is registered for. - The `jurisdictionId` path parameter must match the request body's `jurisdiction.jurisdictionId`. The request body must have a full `jurisdiction` object for the jurisdiction property. The best way to do this is to use `getNotaryJurisdiction` to obtain the current values and update the properties you want to change. For example, assume `getNotaryJurisdiction` returns this: ``` { "jurisdiction": { "jurisdictionId": "15", "name": "Iowa", "county": "", "enabled": "true", "countyInSeal": "false", "commissionIdInSeal": "true", "stateNameInSeal": "true", "notaryPublicInSeal": "true", "allowSystemCreatedSeal": "true", "allowUserUploadedSeal": "false" }, "commissionId": "123456", "commissionExpiration": "2020-08-31T07:00:00.0000000Z", "registeredName": "Bob Notary", "county": "Adams", "sealType": "system_created" } ``` If you want to change the name of the notary from "Bob Notary" to "Robert Notary", your request body would be: ``` { "jurisdiction": { "jurisdictionId": "15", "name": "Iowa", "county": "", "enabled": "true", "countyInSeal": "false", "commissionIdInSeal": "true", "stateNameInSeal": "true", "notaryPublicInSeal": "true", "allowSystemCreatedSeal": "true", "allowUserUploadedSeal": "false" }, "commissionId": "123456", "commissionExpiration": "2020-08-31T07:00:00.0000000Z", "registeredName": "Robert Notary", "county": "Adams", "sealType": "system_created" } ```
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
jurisdictionId notaryJurisdiction (optional)
- Returns
- NotaryJurisdiction
Implements DocuSign.eSign.Api.INotaryApi.
◆ UpdateNotaryJurisdictionAsync()
|
inline |
Update a notary jurisdiction Updates the jurisdiction information about a notary. The following restrictions apply: - The current user must be a notary. - The `jurisdictionId` path parameter must be a jurisdiction that the notary is registered for. - The `jurisdictionId` path parameter must match the request body's `jurisdiction.jurisdictionId`. The request body must have a full `jurisdiction` object for the jurisdiction property. The best way to do this is to use `getNotaryJurisdiction` to obtain the current values and update the properties you want to change. For example, assume `getNotaryJurisdiction` returns this: ``` { "jurisdiction": { "jurisdictionId": "15", "name": "Iowa", "county": "", "enabled": "true", "countyInSeal": "false", "commissionIdInSeal": "true", "stateNameInSeal": "true", "notaryPublicInSeal": "true", "allowSystemCreatedSeal": "true", "allowUserUploadedSeal": "false" }, "commissionId": "123456", "commissionExpiration": "2020-08-31T07:00:00.0000000Z", "registeredName": "Bob Notary", "county": "Adams", "sealType": "system_created" } ``` If you want to change the name of the notary from "Bob Notary" to "Robert Notary", your request body would be: ``` { "jurisdiction": { "jurisdictionId": "15", "name": "Iowa", "county": "", "enabled": "true", "countyInSeal": "false", "commissionIdInSeal": "true", "stateNameInSeal": "true", "notaryPublicInSeal": "true", "allowSystemCreatedSeal": "true", "allowUserUploadedSeal": "false" }, "commissionId": "123456", "commissionExpiration": "2020-08-31T07:00:00.0000000Z", "registeredName": "Robert Notary", "county": "Adams", "sealType": "system_created" } ```
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
jurisdictionId notaryJurisdiction (optional)
- Returns
- Task of NotaryJurisdiction
Implements DocuSign.eSign.Api.INotaryApi.
◆ UpdateNotaryJurisdictionAsyncWithHttpInfo()
|
inline |
Update a notary jurisdiction Updates the jurisdiction information about a notary. The following restrictions apply: - The current user must be a notary. - The `jurisdictionId` path parameter must be a jurisdiction that the notary is registered for. - The `jurisdictionId` path parameter must match the request body's `jurisdiction.jurisdictionId`. The request body must have a full `jurisdiction` object for the jurisdiction property. The best way to do this is to use `getNotaryJurisdiction` to obtain the current values and update the properties you want to change. For example, assume `getNotaryJurisdiction` returns this: ``` { "jurisdiction": { "jurisdictionId": "15", "name": "Iowa", "county": "", "enabled": "true", "countyInSeal": "false", "commissionIdInSeal": "true", "stateNameInSeal": "true", "notaryPublicInSeal": "true", "allowSystemCreatedSeal": "true", "allowUserUploadedSeal": "false" }, "commissionId": "123456", "commissionExpiration": "2020-08-31T07:00:00.0000000Z", "registeredName": "Bob Notary", "county": "Adams", "sealType": "system_created" } ``` If you want to change the name of the notary from "Bob Notary" to "Robert Notary", your request body would be: ``` { "jurisdiction": { "jurisdictionId": "15", "name": "Iowa", "county": "", "enabled": "true", "countyInSeal": "false", "commissionIdInSeal": "true", "stateNameInSeal": "true", "notaryPublicInSeal": "true", "allowSystemCreatedSeal": "true", "allowUserUploadedSeal": "false" }, "commissionId": "123456", "commissionExpiration": "2020-08-31T07:00:00.0000000Z", "registeredName": "Robert Notary", "county": "Adams", "sealType": "system_created" } ```
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
jurisdictionId notaryJurisdiction (optional)
- Returns
- Task of ApiResponse (NotaryJurisdiction)
Implements DocuSign.eSign.Api.INotaryApi.
◆ UpdateNotaryJurisdictionWithHttpInfo()
|
inline |
Update a notary jurisdiction Updates the jurisdiction information about a notary. The following restrictions apply: - The current user must be a notary. - The `jurisdictionId` path parameter must be a jurisdiction that the notary is registered for. - The `jurisdictionId` path parameter must match the request body's `jurisdiction.jurisdictionId`. The request body must have a full `jurisdiction` object for the jurisdiction property. The best way to do this is to use `getNotaryJurisdiction` to obtain the current values and update the properties you want to change. For example, assume `getNotaryJurisdiction` returns this: ``` { "jurisdiction": { "jurisdictionId": "15", "name": "Iowa", "county": "", "enabled": "true", "countyInSeal": "false", "commissionIdInSeal": "true", "stateNameInSeal": "true", "notaryPublicInSeal": "true", "allowSystemCreatedSeal": "true", "allowUserUploadedSeal": "false" }, "commissionId": "123456", "commissionExpiration": "2020-08-31T07:00:00.0000000Z", "registeredName": "Bob Notary", "county": "Adams", "sealType": "system_created" } ``` If you want to change the name of the notary from "Bob Notary" to "Robert Notary", your request body would be: ``` { "jurisdiction": { "jurisdictionId": "15", "name": "Iowa", "county": "", "enabled": "true", "countyInSeal": "false", "commissionIdInSeal": "true", "stateNameInSeal": "true", "notaryPublicInSeal": "true", "allowSystemCreatedSeal": "true", "allowUserUploadedSeal": "false" }, "commissionId": "123456", "commissionExpiration": "2020-08-31T07:00:00.0000000Z", "registeredName": "Robert Notary", "county": "Adams", "sealType": "system_created" } ```
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
jurisdictionId notaryJurisdiction (optional)
- Returns
- ApiResponse of NotaryJurisdiction
Implements DocuSign.eSign.Api.INotaryApi.
◆ UpdateNotaryWithHttpInfo()
|
inline |
Update a notary Updates notary information for the current user.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
notary (optional)
- Returns
- ApiResponse of Notary
Implements DocuSign.eSign.Api.INotaryApi.
Property Documentation
◆ ApiClient
|
getset |
Gets or sets the ApiClient object
An instance of the ApiClient
◆ ExceptionFactory
|
getset |
Provides a factory method hook for the creation of exceptions.
The documentation for this class was generated from the following file:
- sdk/src/DocuSign.eSign/Api/NotaryApi.cs
