Partners
Allows to get and set information related to partners.
| API | Description |
|---|---|
| GET api/partners/userslist |
Returns a list of users that belong to a partner. |
| GET api/partners/userdetails/{id} |
Returns details about a partner user by user identifier. |
| GET api/partners/userdetails/username/{username} |
Returns details about a partner user by username. |
| DELETE api/partners/delete/{id} |
Delete a partner user by user identifier. |
| DELETE api/partners/delete/username/{username} |
Delete a partner user by username. |
Sms
Allows to get and send SMS.
| API | Description |
|---|---|
| GET api/sms/{id} |
Returns information about a short message. |
| GET api/sms/sent/subject/{text} |
Returns messages sent that matches a given text. |
| GET api/sms/sent/recipient/{recipient}/{initialDate}/{finalDate} |
Returns messages sent addressed to a given recipient and between a date interval. |
| GET api/sms/sent/dates/{initialDate}/{finalDate} |
Returns messages sent between two given dates. |
| POST api/sms |
Sends a SMS. |
Communications
Allows to get and create communications.
| API | Description |
|---|---|
| GET api/communications/{id} |
Returns information about a communication. |
| GET api/communications/inbox/subject/{subject} |
Returns communications received that matches a given subject. |
| GET api/communications/inbox/sender/{sender}/{initialDate}/{finalDate} |
Returns communications received from a given sender and between a date interval. |
| GET api/communications/inbox/dates/{initialDate}/{finalDate} |
Returns communications received between two given dates. |
| GET api/communications/sent/subject/{subject} |
Returns communications sent that matches a given subject. |
| GET api/communications/sent/recipient/{recipient}/{initialDate}/{finalDate} |
Returns communications sent addressed to a given recipient and between a date interval. |
| GET api/communications/sent/dates/{initialDate}/{finalDate} |
Returns communications sent between two given dates. |
| GET api/communications/{talkId}/state |
Returns the state of a communication. |
| GET api/communications/userReference/{userReference}/state |
Returns the state of a communication. |
| GET api/communications/{talkId}/info |
Returns information about a communication, including sender, recipients and documents. |
| GET api/communications/userReference/{userReference}/info |
Returns information about a communication, including sender, recipients and documents, from the authenticated user that matches a user reference id. |
| POST api/communications |
Creates a communication. |
ReverseCharge
Allows to list and create reverse sending invitations.
| API | Description |
|---|---|
| POST api/reversecharge |
Adds a reverse charge sender to the allowed list. |
| DELETE api/reversecharge?email={email} |
Deletes a sender from the allowed list. |
| GET api/ReverseCharge |
Returns a list of allowed senders. |
Documents
Allows to get and create documents.
| API | Description |
|---|---|
| GET api/documents/{id} |
Gets information about a document. |
| POST api/documents/{id} |
Uploads a document. |
Token
Allows to authenticate an user.
| API | Description |
|---|---|
| POST api/token/authenticate |
Validates a set of user's credentials and returns an authentication token. |
| POST api/token/delegatedlogin |
Allows to authenticate a partner user. |
Contracts
Allows to get and create contracts.
| API | Description |
|---|---|
| GET api/contracts/{id} |
Returns information about a contract. |
| GET api/contracts/inbox/subject/{subject} |
Returns contracts received that matches a given subject. |
| GET api/contracts/inbox/sender/{sender}?initialDate={initialDate}&finalDate={finalDate} |
Returns contracts received from a given sender and between a date interval. |
| GET api/contracts/inbox/dates/{initialDate}/{finalDate} |
Returns contracts received between two given dates. |
| GET api/contracts/sent/subject/{subject} |
Returns contracts sent that matches a given subject. |
| GET api/contracts/sent/recipient/{recipient}?initialDate={initialDate}&finalDate={finalDate} |
Returns contracts sent addressed to a given recipient and between a date interval. |
| GET api/contracts/sent/dates/{initialDate}/{finalDate} |
Returns contracts sent between two given dates. |
| GET api/contracts/{talkId}/state |
Returns the state of a contract. |
| POST api/contracts |
Creates a contract. |
| POST api/contracts/servicecontract |
Creates a service contract. |