Adding an Equipment Item

URL

https://app.bluefolder.com/api/2.0/equipment/add.aspx

Request

<request>
    <equipmentAdd>
        <customerId></customerId>
        <equipName></equipName>
        <equipType></equipType>
        <externalId></externalId>
        <locationId></locationId>
        <mfrName></mfrName>
        <modelNo></modelNo>
        <nextServiceDate></nextServiceDate>
        <notes></notes>
        <purchaseDate></purchaseDate>
        <refNo></refNo>
        <serialNo></serialNo>
        <serviceInterval></serviceInterval>
        <serviceIntervalUnit></serviceIntervalUnit>
        <wherePurchased></wherePurchased>
        <customFields> 
            <customField name="field_name1"></customField> 
            <customField name="field_name2"></customField> 
        </customFields>
    </equipmentAdd>
</request>

customerId - (required) integer, indicating the customer who owns the equipment item
equipName - (required) string, equipment name (100 char limit)
equipType - string, arbitrary type of equipment (fax, copier, server, etc.) (50 char limit)
externalId - string, external identifier that can be used to query the equipment item (255 char limit, must be a unique value)
locationId - (required) integer - use the 'Add Customer Location' API to create this Id
mfrName - string (50 char limit)
modelNo - string (50 char limit)
nextServiceDate - date
notes - string (no char limit)
purchaseDate - date
refNo - string, reference number (50 char limit)
serialNo - string, serial number (50 char limit)
serviceInterval - integer
serviceIntervalUnit - string (25 char limit)
wherePurchased - string (50 char limit)
customFields
- customField - the "name" attribute must specify the exact name of a custom field in your account. The actual value included between the opening and closing "customField" element tags should be a string value, regardless of the custom field's "data type".

Response

<response status="ok">
    <equipmentId>xxxxxx</equipmentId>
</response>

Editing an Equipment Item

URL

https://app.bluefolder.com/api/2.0/equipment/edit.aspx

Request

<request>
    <equipmentEdit>
        <equipmentId></equipmentId>
        <customerId></customerId>
        <equipName></equipName>
        <equipType></equipType>
        <externalId></externalId>
        <locationId></locationId>
        <mfrName></mfrName>
        <modelNo></modelNo>
        <nextServiceDate></nextServiceDate>
        <notes></notes>
        <purchaseDate></purchaseDate>
        <refNo></refNo>
        <serialNo></serialNo>
        <serviceInterval></serviceInterval>
        <serviceIntervalUnit></serviceIntervalUnit>
        <wherePurchased></wherePurchased>
        <customFields> 
            <customField name="field_name1"></customField> 
            <customField name="field_name2"></customField> 
        </customFields>
    </equipmentEdit>
</request>

equipmentId - (required, unless externalId is provided) GUID, which is the unique Id for the equipment item
customerId - integer, indicating the customer who owns the equipment item
equipName - string, equipment name (100 char limit)
equipType - string, arbitrary type of equipment (fax, copier, server, etc.) (50 char limit)
externalId - (required if equipmentId not provided) string, external identifier that can be used to query the equipment item (255 char limit, externalId must be a unique value)
locationId - integer - use the 'Add Customer Location' API to create this Id
mfrName - string (50 char limit)
modelNo - string (50 char limit)
nextServiceDate - date
notes - string (no char limit)
purchaseDate - date
refNo - string, reference number (50 char limit)
serialNo - string, serial number (50 char limit)
serviceInterval - integer
serviceIntervalUnit - string (25 char limit)
wherePurchased - string (50 char limit)
customFields
- customField - the "name" attribute must specify the exact name of a custom field in your account. The actual value included between the opening and closing "customField" element tags should be a string value, regardless of the custom field's "data type".

Response

<response status="ok">
    <equipmentId>xxxxxx</equipmentId>
    <externalId>xxxxxx</externalId>
</response>

Retrieving a Single Equipment Item

URL

https://app.bluefolder.com/api/2.0/equipment/get.aspx

Request

<request>
    <equipmentId>xxxxxx</equipmentId>
    <externalId>xxxxxx</externalId>
</request>

Response

<response status="ok">
    <equipmentItem>
        <equipmentId></equipmentId>
        <createdByUserId></createdByUserId>
        <customerId></customerId>
        <dateTimeCreated></dateTimeCreated>
        <equipName></equipName>
        <equipType></equipType>
        <externalId></externalId>
        <installDate></installDate>
        <locationId></locationId>
        <mfrName></mfrName>
        <modelNo></modelNo>
        <nextServiceDate></nextServiceDate>
        <notes></notes>
        <purchaseDate></purchaseDate>
        <refNo></refNo>
        <serialNo></serialNo>
        <serviceInterval></serviceInterval>
        <serviceIntervalUnit></serviceIntervalUnit>
        <warrantyExpirationDate></warrantyExpirationDate>
        <wherePurchased></wherePurchased>
        <customFields> 
            <customField> 
                <name></name> 
                <value></value>
            </customField>
        </customFields>
    </equipmentItem>
</response>

Retrieving a List of Equipment

URL

https://app.bluefolder.com/api/2.0/equipment/list.aspx

Request

<request>
    <equipmentList>
        <listType></listType>
        <customerId></customerId>
        <customerExternalId></customerExternalId>
        <dateRange dateField="dateTimeCreated">
            <startDate>MM-DD-YYYY HH:MM AM/PM</startDate>
            <endDate>MM-DD-YYYY HH:MM AM/PM</endDate>
        </dateRange>
    </equipmentList>
</request>

listType - (required) string, either 'basic' (default) or 'full', determines type of list to return
customerId - numeric, the Id of the customer whose equipment items to return
customerExternalId - string, the externalId of the customer whose equipment items to return
dateRange dateField="dateTimeCreated" - filters the list to equipment created within the given range. If omitted, the list defaults to the last 90 days on 'dateTimeCreated'. An explicit dateRange may span at most 180 days; a wider range is rejected. Whichever range was actually applied - explicit or defaulted - is echoed back in the response's <filtersApplied> node, with a wasDefaulted attribute indicating which case occurred.

Response (for 'basic' list)

<response status="ok">
    <equipmentItem>
        <equipmentId></equipmentId>
        <customerId></customerId>
        <equipName></equipName>
        <equipType></equipType>
        <locationId></locationId>
        <serialNo></serialNo>
    </equipmentItem>
    <filtersApplied>
        <customerId></customerId>
        <customerExternalId></customerExternalId>
        <dateRange dateField="dateTimeCreated" wasDefaulted="true|false">
            <startDate></startDate>
            <endDate></endDate>
        </dateRange>
    </filtersApplied>
</response>

filtersApplied - echoes back exactly which filters produced this result, including the dateRange that was actually applied. wasDefaulted is "true" when no explicit dateRange was supplied and the 90-day default was used instead, or "false" when the caller's own dateRange was used.

Response (for 'full' list)

<response status="ok">
    <equipmentItem>
        <equipmentId></equipmentId>
        <createdByUserId></createdByUserId>
        <customerId></customerId>
        <dateTimeCreated></dateTimeCreated>
        <equipName></equipName>
        <equipType></equipType>
        <externalId></externalId>
        <installDate></installDate>
        <locationId></locationId>
        <mfrName></mfrName>
        <modelNo></modelNo>
        <nextServiceDate></nextServiceDate>
        <notes></notes>
        <refNo></refNo>
        <serialNo></serialNo>
        <serviceInterval></serviceInterval>
        <serviceIntervalUnit></serviceIntervalUnit>
        <warrantyExpirationDate></warrantyExpirationDate>
        <wherePurchased></wherePurchased>
        <customFields>
            <customField>
                <name></name>
                <value></value>
            </customField>
        </customFields>
    </equipmentItem>
    <filtersApplied>
        <customerId></customerId>
        <customerExternalId></customerExternalId>
        <dateRange dateField="dateTimeCreated" wasDefaulted="true|false">
            <startDate></startDate>
            <endDate></endDate>
        </dateRange>
    </filtersApplied>
</response>

Retrieving Custom Field List for Equipment

URL

https://app.bluefolder.com/api/2.0/equipment/getCustomFields.aspx

Request

<request></request>

Response

<response status="ok">
    <customFields>
        <customField>
            <DisplayOrder></DisplayOrder>
            <FieldDataType></FieldDataType>
            <FieldId></FieldId>
            <FieldListValues>
                <FieldListValue></FieldListValue>
                ...
            </FieldListValues>
            <FieldName></FieldName>
            <FieldRequired></FieldRequired>
        </customField>
        ...
    </customFields>
</response>