SpiraPlan: ImportExport SOAP Web Service


Click here for a complete list of operations.

User_Create

Creates a new user in the system and adds them to the current project as the specified role

Test

The test form is only available for requests from the local machine.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /Spira/Services/v2_2/ImportExport.asmx HTTP/1.1
Host: api.inflectra.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.inflectra.com/SpiraTest/Services/v2.2/User_Create"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <User_Create xmlns="http://www.inflectra.com/SpiraTest/Services/v2.2/">
      <remoteUser>
        <UserId>int</UserId>
        <FirstName>string</FirstName>
        <LastName>string</LastName>
        <MiddleInitial>string</MiddleInitial>
        <UserName>string</UserName>
        <Password>string</Password>
        <LdapDn>string</LdapDn>
        <EmailAddress>string</EmailAddress>
        <Admin>boolean</Admin>
        <Active>boolean</Active>
      </remoteUser>
      <projectRoleId>int</projectRoleId>
    </User_Create>
  </soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <User_CreateResponse xmlns="http://www.inflectra.com/SpiraTest/Services/v2.2/">
      <User_CreateResult>
        <UserId>int</UserId>
        <FirstName>string</FirstName>
        <LastName>string</LastName>
        <MiddleInitial>string</MiddleInitial>
        <UserName>string</UserName>
        <Password>string</Password>
        <LdapDn>string</LdapDn>
        <EmailAddress>string</EmailAddress>
        <Admin>boolean</Admin>
        <Active>boolean</Active>
      </User_CreateResult>
    </User_CreateResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /Spira/Services/v2_2/ImportExport.asmx HTTP/1.1
Host: api.inflectra.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <User_Create xmlns="http://www.inflectra.com/SpiraTest/Services/v2.2/">
      <remoteUser>
        <UserId>int</UserId>
        <FirstName>string</FirstName>
        <LastName>string</LastName>
        <MiddleInitial>string</MiddleInitial>
        <UserName>string</UserName>
        <Password>string</Password>
        <LdapDn>string</LdapDn>
        <EmailAddress>string</EmailAddress>
        <Admin>boolean</Admin>
        <Active>boolean</Active>
      </remoteUser>
      <projectRoleId>int</projectRoleId>
    </User_Create>
  </soap12:Body>
</soap12:Envelope>
HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <User_CreateResponse xmlns="http://www.inflectra.com/SpiraTest/Services/v2.2/">
      <User_CreateResult>
        <UserId>int</UserId>
        <FirstName>string</FirstName>
        <LastName>string</LastName>
        <MiddleInitial>string</MiddleInitial>
        <UserName>string</UserName>
        <Password>string</Password>
        <LdapDn>string</LdapDn>
        <EmailAddress>string</EmailAddress>
        <Admin>boolean</Admin>
        <Active>boolean</Active>
      </User_CreateResult>
    </User_CreateResponse>
  </soap12:Body>
</soap12:Envelope>