PublicKeyService (Virgil SDK - Android 3.0.2 API)

```
public interface PublicKeyService
```
This interface represents Virgil Public Key's HTTP API.

Author:

Andrii Iakovenko

Method Summary

Methods
Modifier and Type	Method and Description
`retrofit2.Call<VirgilCard>`	`createCard(VirgilCardTemplate template)` Create new Virgil Card.
`retrofit2.Call<Void>`	`delete(String id, String requestSingVCID, DeleteRequest deleteRequest)` Delete Virgil Card.
`retrofit2.Call<Void>`	`deleteKey(String id, Identities identities)` Revoke a Public Key endpoint.
`retrofit2.Call<VirgilCard>`	`getCard(String id)` Returns the information about the Virgil Card by the ID.
`retrofit2.Call<PublicKeyInfo>`	`getKey(String id)` Returns the information about the Public Key by the ID.
`retrofit2.Call<List<VirgilCard>>`	`search(SearchCriteria searchCriteria)` Performs the search by search criteria.
`retrofit2.Call<List<VirgilCard>>`	`searchApp(SearchCriteria searchCriteria)` Performs the global search for the applications' Virgil Cards.
`retrofit2.Call<SignResponse>`	`signCard(String signerCardId, String requestSingVCID, Sign sign)` Signs another Virgil Card addressed in the request to share the information for the signed Virgil Card.
`retrofit2.Call<Void>`	`unsignCard(String signerCardId, String requestSingVCID, Sign sign)` Removes the Sign of another Virgil Card.

Method Detail

createCard

@POST(value="/v3/virgil-card")
retrofit2.Call<VirgilCard> createCard(@Body
                                         VirgilCardTemplate template)

Create new Virgil Card.

Parameters:: template - the template of created Virgil Card.
Returns:: the created Virgil Card.
See Also:: VirgilCard, VirgilCardTemplate, Call

delete

@HTTP(method="DELETE",
      path="/v3/virgil-card/{virgil-card-id}",
      hasBody=true)
retrofit2.Call<Void> delete(@Path(value="virgil-card-id")
                               String id,
                               @Header(value="X-VIRGIL-REQUEST-SIGN-VIRGIL-CARD-ID")
                               String requestSingVCID,
                               @Body
                               DeleteRequest deleteRequest)

Delete Virgil Card.

Parameters:: id - the Virgil Card's identifier.; requestSingVCID - the X-VIRGIL-REQUEST-SIGN-VIRGIL-CARD-ID header's value which is the same as Virgil Card's identifier.; deleteRequest - the delete request data.
Returns:
See Also:: DeleteRequest, Call

deleteKey
```
@DELETE(value="/v3/public-key/{public-key-id}")
retrofit2.Call<Void> deleteKey(@Path(value="public-key-id")
                                    String id,
                                    Identities identities)
```
Revoke a Public Key endpoint. To revoke the Public Key it's mandatory to pass validation tokens obtained on Virgil Identity service for all confirmed Virgil Cards for this Public Key.

Parameters:
id - the Public Key's ID.
identities - the removed identities.

Returns:
See Also:
Call, Identities

getCard

@GET(value="/v3/virgil-card/{virgil-card-id}")
retrofit2.Call<VirgilCard> getCard(@Path(value="virgil-card-id")
                                     String id)

Returns the information about the Virgil Card by the ID.

Parameters:: id - the Virgil Card's identifier.
Returns:
See Also:: Call

getKey
```
@GET(value="/v3/public-key/{public-key-id}")
retrofit2.Call<PublicKeyInfo> getKey(@Path(value="public-key-id")
                                       String id)
```
Returns the information about the Public Key by the ID. For unsigned requests the response will contain only basic information without a list of associated Virgil Cards. In case the request is signed the associated Virgil Cards collection will be returned.

Parameters:
id - the PublicKey's identifier.

Returns:
See Also:
Call, PublicKeyInfo

search

@POST(value="/v3/virgil-card/actions/search")
retrofit2.Call<List<VirgilCard>> search(@Body
                                           SearchCriteria searchCriteria)

Performs the search by search criteria.

Parameters:: searchCriteria - the criteria which used for Virgil Cards filtering during search.
Returns:
See Also:: Call, SearchCriteria, VirgilCard

searchApp

@POST(value="/v3/virgil-card/actions/search/app")
retrofit2.Call<List<VirgilCard>> searchApp(@Body
                                              SearchCriteria searchCriteria)

Performs the global search for the applications' Virgil Cards.

Parameters:: searchCriteria - the criteria which used for Virgil Cards filtering during search.
Returns:
See Also:: Call, SearchCriteria, VirgilCard

signCard

@POST(value="/v3/virgil-card/{virgil-card-id}/actions/sign")
retrofit2.Call<SignResponse> signCard(@Path(value="virgil-card-id")
                                         String signerCardId,
                                         @Header(value="X-VIRGIL-REQUEST-SIGN-VIRGIL-CARD-ID")
                                         String requestSingVCID,
                                         @Body
                                         Sign sign)

Signs another Virgil Card addressed in the request to share the information for the signed Virgil Card.

Parameters:: signerCardId - the identifier of Virgil Card used for signing.; requestSingVCID - the X-VIRGIL-REQUEST-SIGN-VIRGIL-CARD-ID header's value which is the same as Virgil Card's identifier.; sign - the sign.
Returns:
See Also:: Call, Sign, SignResponse

unsignCard

@POST(value="/v3/virgil-card/{virgil-card-id}/actions/unsign")
retrofit2.Call<Void> unsignCard(@Path(value="virgil-card-id")
                                   String signerCardId,
                                   @Header(value="X-VIRGIL-REQUEST-SIGN-VIRGIL-CARD-ID")
                                   String requestSingVCID,
                                   @Body
                                   Sign sign)

Removes the Sign of another Virgil Card.

Parameters:: signerCardId - the identifier of Virgil Card used for signing.; requestSingVCID - the X-VIRGIL-REQUEST-SIGN-VIRGIL-CARD-ID header's value which is the same as Virgil Card's identifier.; sign - the sign.
Returns:
See Also:: Call, Sign

Interface PublicKeyService