- SitePro api documentation

post

/v1/transactions/change-logs

https://platform.sitepro.com/v1/transactions/change-logs

Transaction change logs across sites and ticket numbers

Sample Request Body

{
  "start": "2024-07-01T00:00:00Z",
  "end": "2024-08-01T00:00:00Z",
  "filters": {
    "siteIds": [
      12345,
      54321
    ],
    "ticketNums": [
      1,
      2,
      3
    ]
  }
}

Expected responses

{
  "description": "",
  "content": {
    "application/json": {
      "schema": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "TransactionID": {
              "type": "number",
              "example": 12345678
            },
            "LogTypeName": {
              "type": "string",
              "example": "Main Ticket",
              "description": "1=Main Ticket | 2=Source Regulatory | 3=Destination Regulatory | 4=Disposal Fee | 5=Service Item"
            },
            "LogType": {
              "type": "number",
              "example": 1
            },
            "TicketNumber": {
              "type": "number",
              "example": 54
            },
            "SiteID": {
              "type": "number",
              "example": 12345
            },
            "SiteName": {
              "type": "string",
              "example": "Test SWD"
            },
            "SiteCompany": {
              "type": "string",
              "example": "SitePro Demo"
            },
            "Editor": {
              "type": "string",
              "example": "John Doe"
            },
            "EditorCompany": {
              "type": "string",
              "example": "Testers LLC"
            },
            "ChangeDate": {
              "type": "string",
              "example": "2019-07-21T15:00:00.000Z"
            },
            "ChangeItems": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "PropertyName": {
                    "type": "string",
                    "example": "HaulRoutStartTime"
                  },
                  "OriginalValue": {
                    "type": "string",
                    "example": ""
                  },
                  "NewValue": {
                    "type": "string",
                    "example": "7/21/2021 2:00:00 PM"
                  }
                },
                "required": [
                  "PropertyName",
                  "OriginalValue",
                  "NewValue"
                ]
              }
            }
          },
          "required": [
            "TransactionID",
            "LogTypeName",
            "LogType",
            "TicketNumber",
            "SiteID",
            "SiteName",
            "SiteCompany",
            "Editor",
            "EditorCompany",
            "ChangeDate",
            "ChangeItems"
          ]
        }
      }
    }
  }
}

Related schemas

Name

Type

Example

Description

start

string

2024-07-01T00:00:00Z

end

string

2024-08-01T00:00:00Z

Max 60-day span from start

filters

object

Name	Type	Example
siteIds	array	12345,54321
ticketNums	array	1,2,3

Name	Type	Example
siteIds	array	12345,54321
ticketNums	array	1,2,3

Download Postman Collection

curl -X POST 
  -H "Authorization: Bearer <JWT_Token>" 
  -H "Content-Type: application/json" 
  -d '{
  "start": "2024-07-01T00:00:00Z",
  "end": "2024-08-01T00:00:00Z"
}' 
  "https://platform.sitepro.com/v1/transactions/change-logs"

Authorization

Bearer

Properties

start

end

filters

Warning: This endpoint can affect production data.