bfsapi


Click here for a complete list of operations.

CreateFile

Create file

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 /preview1/api/bfsapi.asmx HTTP/1.1
Host: stage.bricknode.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://tempuri.org/CreateFile"

<?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>
    <CreateFile xmlns="http://tempuri.org/">
      <req>
        <FileInfoUpload>
          <Owner>guid</Owner>
          <FileName>string</FileName>
          <ContentType>string</ContentType>
          <Permission>All or AdminPartner or AdminOnly</Permission>
          <fileBytes>base64Binary</fileBytes>
          <CustomFields>
            <CustomField xsi:nil="true" />
            <CustomField xsi:nil="true" />
          </CustomFields>
        </FileInfoUpload>
      </req>
    </CreateFile>
  </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>
    <CreateFileResponse xmlns="http://tempuri.org/">
      <CreateFileResult>
        <FileId>guid</FileId>
      </CreateFileResult>
    </CreateFileResponse>
  </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 /preview1/api/bfsapi.asmx HTTP/1.1
Host: stage.bricknode.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>
    <CreateFile xmlns="http://tempuri.org/">
      <req>
        <FileInfoUpload>
          <Owner>guid</Owner>
          <FileName>string</FileName>
          <ContentType>string</ContentType>
          <Permission>All or AdminPartner or AdminOnly</Permission>
          <fileBytes>base64Binary</fileBytes>
          <CustomFields>
            <CustomField xsi:nil="true" />
            <CustomField xsi:nil="true" />
          </CustomFields>
        </FileInfoUpload>
      </req>
    </CreateFile>
  </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>
    <CreateFileResponse xmlns="http://tempuri.org/">
      <CreateFileResult>
        <FileId>guid</FileId>
      </CreateFileResult>
    </CreateFileResponse>
  </soap12:Body>
</soap12:Envelope>