Logo
Submit a request
Follow

Equipment

Adding an Equipment Item

URL

https://app.bluefolder.com/api/1.0/customers/addEquipment.aspx

Request

<request>
    <customerAddEquipment>
        <createdByUserID></createdByUserID>
        <customerID></customerID>
        <equipName></equipName>
        <equipType></equipType>
        <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>
        <externalID></externalID>
    </customerAddEquipment>
</request>
            
  • createdByUser - integer, referencing a user ID (defaults to the current API user if not provided)
  • 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)
  • 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".
  • externalID - string, external identifier that can be used to query the equipment item (255 char limit)

Response

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

Editing an Equipment Item

URL

https://app.bluefolder.com/api/1.0/customers/editEquipment.aspx

Request

<request>
    <customerEditEquipment>
        <equipmentItemID></equipmentItemID>
        <createdByUserID></createdByUserID>
        <customerID></customerID>
        <equipName></equipName>
        <equipType></equipType>
        <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>
        <externalID></externalID>
    </customerEditEquipment>
</request>
            
  • equipmentItemID - (required, if externalID not provided) guid string, which is the unique ID for the item
  • createdByUser - integer, referencing a user ID (defaults to the current API user if not provided)
  • 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)
  • 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".
  • externalID - (required, if equipmentItemID not provided) string, external identifier that can be used to query the equipment item (255 char limit)

Response

<response status="ok">
    <equipmentItemID>xxxxxx</equipmentItemID>
    <externalID>xxxxxx</externalID>
</response>
            

Retrieving a Single Equipment Item

URL

https://app.bluefolder.com/api/1.0/customers/getEquipment.aspx

Request

<request>
    <itemID>xxxxxx</itemID>
</request>
            

Response

<response status="ok">
    <equipmentItem>
        <id></id>
        <createdByUserID></createdByUserID>
        <customerID></customerID>
        <dateTimeCreated></dateTimeCreated>
        <equipName></equipName>
        <equipType></equipType>
        <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>
        <externalID></externalID>
        <customFields> 
            <customField> 
                <name></name> 
                <value></value>
            </customField>
        </customFields>
    </equipmentItem>
</response>
            

Retrieving a List of Equipment

URL

https://app.bluefolder.com/api/1.0/customers/listEquipment.aspx

Request

<request>
    <equipmentList>
        <listType></listType>
        <customerID></customerID>
        <customerExternalID></customerExternalID>
    </equipmentList>
</request>
            
  • listType - string, either 'basic' (default) or 'full', determines type of list to return
  • customerID - numeric, the ID of the customer whose equipment items to return
  • externalID - string, the external ID of the customer whose equipment items to return

Response (for 'basic' list)

<response status="ok">
    <equipmentItem>
        <ID></ID>
        <customerID></customerID>
        <equipName></equipName>
        <equipType></equipType>
        <locationID></locationID>
        <serialNo></serialNo>
    </equipmentItem>
</response>
            

Response (for 'full' list)

<response status="ok">
    <equipmentItem>
        <ID></ID>
        <createdByUserID></createdByUserID>
        <customerID></customerID>
        <dateTimeCreated></dateTimeCreated>
        <equipName></equipName>
        <equipType></equipType>
        <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>
</response>
            
Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request