api_auth

<back to all web services

JoinRequest

The following routes are available for this service:
GET/api/joinInformation about invitation corresponding to the given pass phrase. Based on this information user can decide whether or not to accept this invitation
POST/api/joinAccept invitation corresponding to the given pass phrase.
JoinRequest Parameters:
NameParameterData TypeRequiredDescription
PassPhrasebodystringNoPass phrase received by user during invitation process
SiteIDbodylong?NoID of a site to join to (if joining without invitation)
PseudonymIDbodyint?NoPseudonym for this site (optional)
InvitationDetailResponse Parameters:
NameParameterData TypeRequiredDescription
ValidformboolNo
UsedformboolNo
ExistsformboolNo
ExpiredformboolNo
ExpirationTimeformDateTime?No
SiteformstringNo
GroupformstringNo
IssuerformstringNo
IsStrictEmailformboolNo
EmailformstringNo
TelephoneformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /api/join HTTP/1.1 
Host: 1.hyper.id 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<JoinRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Bitpub.Api.Auth.Requests">
  <PassPhrase>String</PassPhrase>
  <PseudonymID>0</PseudonymID>
  <SiteID>0</SiteID>
</JoinRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<InvitationDetailResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Bitpub.Api.Auth.Requests">
  <Email>String</Email>
  <Exists>false</Exists>
  <ExpirationTime>0001-01-01T00:00:00</ExpirationTime>
  <Expired>false</Expired>
  <Group>String</Group>
  <IsStrictEmail>false</IsStrictEmail>
  <Issuer>String</Issuer>
  <Site>String</Site>
  <Telephone>String</Telephone>
  <Used>false</Used>
</InvitationDetailResponse>