SpiraPlan: ImportExport SOAP Web Service


Click here for a complete list of operations.

ProjectRole_Retrieve

Retrieves a list of project roles in the system

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/ProjectRole_Retrieve"

<?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>
    <ProjectRole_Retrieve xmlns="http://www.inflectra.com/SpiraTest/Services/v2.2/" />
  </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>
    <ProjectRole_RetrieveResponse xmlns="http://www.inflectra.com/SpiraTest/Services/v2.2/">
      <ProjectRole_RetrieveResult>
        <RemoteProjectRole>
          <ProjectRoleId>int</ProjectRoleId>
          <Name>string</Name>
          <Description>string</Description>
          <Active>boolean</Active>
          <Admin>boolean</Admin>
          <DocumentsAdd>boolean</DocumentsAdd>
          <DocumentsEdit>boolean</DocumentsEdit>
          <DocumentsDelete>boolean</DocumentsDelete>
          <DiscussionsAdd>boolean</DiscussionsAdd>
          <SourceCodeView>boolean</SourceCodeView>
        </RemoteProjectRole>
        <RemoteProjectRole>
          <ProjectRoleId>int</ProjectRoleId>
          <Name>string</Name>
          <Description>string</Description>
          <Active>boolean</Active>
          <Admin>boolean</Admin>
          <DocumentsAdd>boolean</DocumentsAdd>
          <DocumentsEdit>boolean</DocumentsEdit>
          <DocumentsDelete>boolean</DocumentsDelete>
          <DiscussionsAdd>boolean</DiscussionsAdd>
          <SourceCodeView>boolean</SourceCodeView>
        </RemoteProjectRole>
      </ProjectRole_RetrieveResult>
    </ProjectRole_RetrieveResponse>
  </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>
    <ProjectRole_Retrieve xmlns="http://www.inflectra.com/SpiraTest/Services/v2.2/" />
  </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>
    <ProjectRole_RetrieveResponse xmlns="http://www.inflectra.com/SpiraTest/Services/v2.2/">
      <ProjectRole_RetrieveResult>
        <RemoteProjectRole>
          <ProjectRoleId>int</ProjectRoleId>
          <Name>string</Name>
          <Description>string</Description>
          <Active>boolean</Active>
          <Admin>boolean</Admin>
          <DocumentsAdd>boolean</DocumentsAdd>
          <DocumentsEdit>boolean</DocumentsEdit>
          <DocumentsDelete>boolean</DocumentsDelete>
          <DiscussionsAdd>boolean</DiscussionsAdd>
          <SourceCodeView>boolean</SourceCodeView>
        </RemoteProjectRole>
        <RemoteProjectRole>
          <ProjectRoleId>int</ProjectRoleId>
          <Name>string</Name>
          <Description>string</Description>
          <Active>boolean</Active>
          <Admin>boolean</Admin>
          <DocumentsAdd>boolean</DocumentsAdd>
          <DocumentsEdit>boolean</DocumentsEdit>
          <DocumentsDelete>boolean</DocumentsDelete>
          <DiscussionsAdd>boolean</DiscussionsAdd>
          <SourceCodeView>boolean</SourceCodeView>
        </RemoteProjectRole>
      </ProjectRole_RetrieveResult>
    </ProjectRole_RetrieveResponse>
  </soap12:Body>
</soap12:Envelope>