Skip to main content

Get a list of job stocks​

Retrieve a paged collection of job stocks (required scope jobs:read)

Path Parameters
    jobId int64 required

    Possible values: >= 1

    The unique identifer of the job

Query Parameters
    jobStockId int64[]

    Only return job stocks where JobStockId matches the value(s) provided

    stockDetailsId int64[]

    Only return job stocks where 'StockDetailsId' matches the value(s) provided

    stockItemId int64[]

    Only return job stocks where 'StockItemId' matches the value(s) provided

    action JobStockActionFilter

    Possible values: [noMovement, broughtAndLeft, broughtAndTakenBack, broughtToSwap, onSiteAndTakenBack, onSiteAndLeft, usedInStock]

    Only return job stocks where 'Action' matches the value provided

    isActual boolean

    Only return job stocks where 'IsActual' matches the value provided

    pageNumber int32

    Possible values: >= 1 and <= 2147483

    The page number being requested (minimum: 1, maximum: 2147483)

    pageSize int32

    Possible values: >= 1 and <= 1000

    The page size being requested (minimum: 1, maximum: 1000)

Header Parameters
    Customer-Id int64 required

    The customer identifier

Responses

Success

Schema
    items object[]

    The items returned for the requested page

  • Array [
    • id int64

    The unique identifier of the job

    typeId int64

    The unique identifier of the type assigned to this job

    typeName string

    The name of the type assigned to this job

    contactId int64

    The unique identifier of the contact (customer) for whom this job is to be performed

    contactName string

    The name of the customer (business or individual) for whom this job is to be performed

    contactAddress string

    The complete address of the contact (customer) for whom this job is to be performed

    contactLocation object

    Represents a geographical location

    latitude double required

    Latitude of the center of the location

    longitude double required

    Longitude of the center of the location

    status JobStatus

    Possible values: [new, scheduled, unscheduled, sent, read, accepted, refused, onTheWay, started, suspended, completedOk, completedWithIssues, cancelled, lateStart, lateFinish, rescheduled]

    Describes each possible status of a Job

    Possible values:

    • new: A job that is newly created in BigChange All Jobs start with a New status, regardless of schedule detail
    • scheduled: Job has been scheduled. Scheduled status is when the Vehicle, Driver, and Planned Date Time are all allocated
    • unscheduled: Job has been unscheduled. Unscheduled status happens when any combination of the Vehicle, Driver, and Planned Date Time are all removed from a Scheduled job
    • sent: The scheduled job has been delivered to the driver's mobile device (tablet/phone). The driver must be logged into BigChange for jobs to be sent
    • read: Job Detail has been read by the Driver on their mobile terminal
    • accepted: Driver accepted the job
    • refused: Driver refused the job
    • onTheWay: Driver indicated they are on route to the Job Address
    • started: Driver has indicated they have started the work detailed in the Job
    • suspended: Driver paused work – ie taking a break
    • completedOk: Job Completed with no issues
    • completedWithIssues: Job Completed with issues
    • cancelled: Job was Cancelled
    • lateStart: Internal Status used by BigChange Alert Management - should not be visible from the the API
    • lateFinish: Internal Status used by BigChange Alert Management - should not be visible from the the API
    • rescheduled: Internal Status used by BigChange Alert Management - should not be visible from the the API

    statusModifiedAt date-time nullable

    The UTC timestamp for when the job status was last updated

    plannedDuration int32

    The planned duration of the job, specified in minutes

    dueAt date-time nullable

    The UTC date and time the job is required to be completed by

    reference string

    The internal reference of the job - should usually be unique

    description string

    The textual details about the job

    createdAt date-time

    The UTC timestamp of when this job was created

    orderNumber string nullable

    The order number associated to the job

    personId uuid nullable

    The unique uuid identifier of the person who will serve as primary point of contact for the job

    personName string nullable

    The full name of the person who will serve as primary point of contact for the job

    isConfirmed boolean

    A flag indicating whether the job has been confirmed by the contact

    categoryId int32 nullable

    The unique identifier of the category that the job is assigned to

    categoryName string nullable

    The name of the category that the job is assigned

    resourceId int64 nullable

    The unique identifier of the resource assigned to this job

    resourceName string nullable

    The full name of the resource assigned to this job

    vehicleId int64 nullable

    The unique identifier of the vehicle assigned to this job

    vehicleRegistration string nullable

    The registration number of the vehicle assigned to this job

    plannedStartAt date-time nullable

    The UTC timestamp for when the job is planned to begin

    plannedEndAt date-time nullable

    The UTC timestamp for when the job is planned to finish

    actualStartAt date-time nullable

    The UTC timestamp for when the job actually started (as indicated by resource's device)

    actualEndAt date-time nullable

    The UTC timestamp for when the job actually finished (as indicated by resource's device)

    actualDuration int32 nullable

    The actual duration of the job, specified in seconds (as indicated by resource's device)

    internalComment string

    Notes about the job outcome, added by the back office

    resourcesComment string

    Notes about the job outcome, added by the resource

    contactComment string

    Notes about the job outcome, added by the customer

    result string nullable

    The result of a job that has been completed or completed with issues. This will be null if the job has any other status

    customFields object[]

    Custom fields applied to this job

  • Array [
    • definitionId int64

    The unique identifier of the associated custom field definition

    value string nullable

    The current value set for the custom field

    definition object

    Represents the definition of a custom field

    caption string

    The caption of a custom field

    type CustomFieldType

    Possible values: [boolean, integer, decimal, text, list, statement, date, note, time, systemList]

    The type of the custom field. New field types may be added in the future, so integrations should be resilient to this

    Possible values:

    • boolean: Indicates a boolean field (Example: "false")
    • integer: Indicates an integer numeric field (Example: "1001")
    • decimal: Indicates a floating point numeric field (Example: "1.42")
    • text: Indicates an editable text field (Example: "Purple")
    • list: Indicates a field with a single value from a predefined list of options (Example: "Purple")
    • statement: Indicates a text field that cannot be edited. The value is always equal to the default value (Example: "By signing this you agree to the following...")
    • date: Indicates a date field, which will be represented as an RFC3339 formatted date string. The default value is not supported for this type and will always be null (Example: "2024-01-31")
    • note: Indicates a multiline, editable text field. Lines are seperated with a line feed character (Example: "This is a note.")
    • time: Indicates a time field, formatted as HH:mm. The default value is not supported for this type and will always be null (Example: "10:30")
    • systemList: Indicates the ID of a related resource, vehicle or web user (Example: "228007")

    listOptions string[] nullable

    Shows the possible values for a list type custom field. Value will be null if type is not list

    isRequired boolean

    Indicates if the field is required in the UI. This is NOT enforced in the API

    isEditable boolean

    Indicates if the field is editable

    default string nullable

    The default value of a custom field. Formatted in accordance with the rules of the field type

    systemListValueMetadata object

    Represents details of custom field value of type system list

    label string nullable

    A descriptive label for the specific resource, vehicle or web user that this system list value relates to

    entityType CustomFieldSystemListType

    Possible values: [resource, vehicle, webUser]

    The type of entity used for custom field value of type system list

    Possible values:

    • resource
    • vehicle
    • webUser

  • ]
  • ]
    • pageNumber int32

    The page number of the response where 1 is the first page

    pageSize int32

    The number of items requested for the current page

    pageItemCount int32

    The number of items returned in the current page

Loading...