C# Class IdokladSdk.Clients.ContactClient

Contacts section. Here are described methods for working with agendas contacts. API allows creation of invoice only for already created contacts.
Inheritance: BaseClient
Datei anzeigen Open project: mholec/idoklad-sdk-csharp

Public Methods

Method Description
Contact ( int contactId ) : Contact

GET api/Contacts/{id} Returns contact by Id.

ContactClient ( ApiContext apiContext ) : IdokladSdk.ApiFilters
ContactExpand ( int contactId ) : ContactExpand

GET api/Contacts/{id}/Expand Returns contact with related entities by contact Id.

Contacts ( Paging paging = null ) : RowsResultWrapper

GET api/Contacts List of contacts.

ContactsExpand ( ContactFilter filter = null ) : RowsResultWrapper

GET api/Contacts/Expand List of contacts with related entities.

Create ( ContactCreate model ) : Contact

POST api/Contacts Add new contact.

Default ( ) : Contact

GET api/Contacts/Default Returns default contact. This resource is suitable for creation of new contact by the POST method.

Delete ( int contactId ) : bool

DELETE api/Contacts/{id} Deletes contact.

Update ( int contactId, ContactUpdate model ) : Contact

PUT api/Contacts/{id} Update contact. Partial update is also possible.

Method Details

Contact() public method

GET api/Contacts/{id} Returns contact by Id.
public Contact ( int contactId ) : Contact
contactId int
return IdokladSdk.ApiModels.Contact

ContactClient() public method

public ContactClient ( ApiContext apiContext ) : IdokladSdk.ApiFilters
apiContext ApiContext
return IdokladSdk.ApiFilters

ContactExpand() public method

GET api/Contacts/{id}/Expand Returns contact with related entities by contact Id.
public ContactExpand ( int contactId ) : ContactExpand
contactId int
return IdokladSdk.ApiModels.ContactExpand

Contacts() public method

GET api/Contacts List of contacts.
public Contacts ( Paging paging = null ) : RowsResultWrapper
paging IdokladSdk.ApiFilters.Paging
return RowsResultWrapper

ContactsExpand() public method

GET api/Contacts/Expand List of contacts with related entities.
public ContactsExpand ( ContactFilter filter = null ) : RowsResultWrapper
filter IdokladSdk.ApiFilters.ContactFilter
return RowsResultWrapper

Create() public method

POST api/Contacts Add new contact.
public Create ( ContactCreate model ) : Contact
model IdokladSdk.ApiModels.ContactCreate
return IdokladSdk.ApiModels.Contact

Default() public method

GET api/Contacts/Default Returns default contact. This resource is suitable for creation of new contact by the POST method.
public Default ( ) : Contact
return IdokladSdk.ApiModels.Contact

Delete() public method

DELETE api/Contacts/{id} Deletes contact.
public Delete ( int contactId ) : bool
contactId int
return bool

Update() public method

PUT api/Contacts/{id} Update contact. Partial update is also possible.
public Update ( int contactId, ContactUpdate model ) : Contact
contactId int
model IdokladSdk.ApiModels.ContactUpdate
return IdokladSdk.ApiModels.Contact