RPC API documentation v43.0.0

Checks if an invitation given by the uuid exists and if it is in a pending state. If yes return the invitation, otherwise throws an exception.

Example URL

https://[hostname]/krb/rpc/json/invitationsManager/canInvitationBeAccepted

• see URL structure

Example params

{ "sess" : {...} , "uuid" : {...} , "group" : {...} }

• see Passing params

Example response

null

• see Return values
• see HTTP return codes

Extend the invitation date on the expiration to some later date.

Example URL

https://[hostname]/krb/rpc/json/invitationsManager/extendInvitationExpiration

• see URL structure

Example params

{ "invitation" : 61 , "expiration" : "text" }

• see Passing params

Example response

null

• see Return values
• see HTTP return codes

Extend the invitation date on the expiration by one month.

Example URL

https://[hostname]/krb/rpc/json/invitationsManager/extendInvitationExpiration

• see URL structure

Example params

{ "invitation" : 97 }

• see Passing params

Example response

null

• see Return values
• see HTTP return codes

Extend the invitation date on the expiration to some later date.

Example URL

https://[hostname]/krb/rpc/json/invitationsManager/extendInvitationExpirationByUUID

• see URL structure

Example params

{ "uuid" : {...} , "expiration" : "text" }

• see Passing params

Example response

null

• see Return values
• see HTTP return codes

Extend the invitation date on the expiration by one month.

Example URL

https://[hostname]/krb/rpc/json/invitationsManager/extendInvitationExpirationByUUID

• see URL structure

Example params

{ "uuid" : {...} }

• see Passing params

Example response

null

• see Return values
• see HTTP return codes

Get invitation object associated with the application. Return null if such invitation doesn't exist.

Example URL

https://[hostname]/krb/rpc/json/invitationsManager/getInvitationByApplication

• see URL structure

Example params

{ "appId" : 94 }

• see Passing params

Example response

null

• see Return values
• see HTTP return codes

Returns invitation by ID

Example URL

https://[hostname]/krb/rpc/json/invitationsManager/getInvitationById

• see URL structure

Example params

{ "sess" : {...} , "invitation" : {...} }

• see Passing params

Example response

null

• see Return values
• see HTTP return codes

Get page of invitations for the given group. Query parameter specifies offset, page size, sorting order, sorting column, statuses of the invitations, searched range of expiration date and string to search invitations by id, receiver name/email or sender name/email.

Example URL

https://[hostname]/krb/rpc/json/invitationsManager/getInvitationsPage

• see URL structure

Example params

{ "group" : 69 , "query" : {...} }

• see Passing params

Example response

{ ... TODO ... }

• see Return values
• see HTTP return codes

Send invitation link to end user's email. The link leads to the application form of the group, when filled out a pre-approved application is created and associated with the invitation. Pre-approved applications bypass the application process and always are automatically approved.

Example URL

https://[hostname]/krb/rpc/json/invitationsManager/inviteToGroup

• see URL structure

Example params

{ "vo" : 37 , "group" : 76 , "receiverName" : "text" , "receiverEmail" : "text" , "language" : "text" , "expiration" : "text" }

• see Passing params

Example response

{ ... TODO ... }

• see Return values
• see HTTP return codes

Send invitation link to end user's email. The link leads to the application form of the group, when filled out a pre-approved application is created and associated with the invitation. Pre-approved applications bypass the application process and always are automatically approved.

Example URL

https://[hostname]/krb/rpc/json/invitationsManager/inviteToGroup

• see URL structure

Example params

{ "vo" : 31 , "group" : 3 , "receiverName" : "text" , "receiverEmail" : "text" , "language" : "text" }

• see Passing params

Example response

{ ... TODO ... }

• see Return values
• see HTTP return codes

Send invitation link to end user's email. The link leads to the application form of the group, when filled out a pre-approved application is created and associated with the invitation. Pre-approved applications bypass the application process and always are automatically approved.

Example URL

https://[hostname]/krb/rpc/json/invitationsManager/inviteToGroup

• see URL structure

Example params

{ "vo" : 82 , "group" : 15 , "receiverName" : "text" , "receiverEmail" : "text" , "language" : "text" , "expiration" : "text" , "redirectUrl" : "text" }

• see Passing params

Example response

{ ... TODO ... }

• see Return values
• see HTTP return codes

Send invitation link to end user's email. The link leads to the application form of the group, when filled out a pre-approved application is created and associated with the invitation. Pre-approved applications bypass the application process and always are automatically approved.

Example URL

https://[hostname]/krb/rpc/json/invitationsManager/inviteToGroup

• see URL structure

Example params

{ "vo" : 44 , "group" : 36 , "receiverName" : "text" , "receiverEmail" : "text" , "language" : "text" , "redirectUrl" : "text" }

• see Passing params

Example response

{ ... TODO ... }

• see Return values
• see HTTP return codes

Creates invitations based on the CSV parameters, for each generates the UUID token, creates invitation link to the group application form with the token as parameter and sends it to the receiver's email. Optionally a redirect url can be passed, which the user will be redirected to after filling out the form. Should an error occur in the process, the created invitation is set to the UNSENT state.

Expected format: `receiverName;receiverEmail\n`

Example URL

https://[hostname]/krb/rpc/json/invitationsManager/inviteToGroupFromCsv

• see URL structure

Example params

{ "vo" : 95 , "group" : 10 , "invitationData" : ["user2;mail2@mail.cz"] , "language" : "text" , "expiration" : "text" }

• see Passing params

Example response

null

• see Return values
• see HTTP return codes

Creates invitations based on the CSV parameters, for each generates the UUID token, creates invitation link to the group application form with the token as parameter and sends it to the receiver's email. Optionally a redirect url can be passed, which the user will be redirected to after filling out the form. Should an error occur in the process, the created invitation is set to the UNSENT state.

Expected format: `receiverName;receiverEmail\n`

Example URL

https://[hostname]/krb/rpc/json/invitationsManager/inviteToGroupFromCsv

• see URL structure

Example params

{ "vo" : 60 , "group" : 67 , "invitationData" : ["user2;mail2@mail.cz"] , "language" : "text" , "expiration" : "text" , "redirectUrl" : "text" }

• see Passing params

Example response

null

• see Return values
• see HTTP return codes

Resends the notification for the given preapproved invitation.

Example URL

https://[hostname]/krb/rpc/json/invitationsManager/resendInvitation

• see URL structure

Example params

{ "invitation" : 59 }

• see Passing params

Example response

null

• see Return values
• see HTTP return codes

Changes status of invitation with specified id to revoked.

Example URL

https://[hostname]/krb/rpc/json/invitationsManager/revokeInvitationById

• see URL structure

Example params

{ "sess" : {...} , "id" : {...} }

• see Passing params

Example response

{ ... TODO ... }

• see Return values
• see HTTP return codes

Changes status of invitation with specified uuid to revoked.

Example URL

https://[hostname]/krb/rpc/json/invitationsManager/revokeInvitationByUuid

• see URL structure

Example params

{ "sess" : {...} , "uuid" : {...} }

• see Passing params

Example response

{ ... TODO ... }

• see Return values
• see HTTP return codes