Service Ticket API

Introduction to API usage

This API will allow the application to fetch information about a company's incidents and orders done via tickets. Access is limited to the System User used. 

If an order is being processed, any issues with that order must not be reported as an incident. Please update the active order with comments instead.

Only issues with orders that has been completed should be reported as incidents.

For developers, the raw swagger doc for the whole API product can be found in one place here

service-tickets

GET /service-tickets/v2/incidents Get all the Incidents belonging to the Organization.
Description Error responses Try it

Implementation notes

Use this resource to retrieve all the Incidents belonging to the Organization. This also supports filtering , free text search and pagination. See inline description of each field for more details on the usage.

Parameters

  • caseNumber
  • Case Number is an alias to the Incident Id. Incident Id is a technical id typically not shown to the end user in the UI but instead Case Number is used. Incidents can be filtered using the Case Number.
  • query
  • string
  • isClosed
  • Use this to filter incidents on Closed or Open status. The status parameter also does the same but it also allows filtering on interim Status as well.
  • query
  • string
  • status
  • Use this for filtering the incidents based on various Status the incident can be in. Multiple instances of this parameter can be sent in the same request to filter incidents on multiple status at once.
  • query
  • array
  • productCategoryName
  • Use this for filtering based on a given product category. The valid values for this parameter shall be retrieved by calling the GET /productcategories/incidents e.g.. etc. Multiple instances of this parameter can be sent in the same request to filter incidents on multiple product category at once.
  • query
  • array
  • search
  • Use this to search incidents based on a free text search. The search will be run on all parameters of the incidents.
  • query
  • string
  • skip
  • This shall be used for pagination. The skip (aka offset) query string parameter for skipping the resultset. For instance ?skip=5&count=20 would skip the first 5 items and return the next 20 items, assuming there are atleast 25 items in the data set.
  • query
  • integer
  • count
  • This shall be used for pagination. The count (aka Limit) query string parameter for limiting the result. For instance ?skip=5&count=20 would skip the first 5 items and return the next 20 items, assuming there are atleast 25 items in the data set.
  • query
  • integer
  • sortField
  • This shall be used for sorting. This parameter indicates on which field the sort shall be applied. The sort can be applied on most parameters viz caseNumber,status,location,identificationNumber,incidentType and lastActivity
  • query
  • string
  • order
  • This shall be used for sorting. This parameter indicates the sorting direction and shall be used along with the 'sortField' parameter. DESC for sorting in descending order and ASC for sorting in Ascending order.
  • query
  • string
  • loggedBy
  • Use this to filter incidents based on the end user who created them. This is the same user that is passed in the header when the incident was updated. Example value : Ola Nordman etc
  • query
  • string

Response class (Status 200)

Model | Model schema

totalSizeinteger
The total number of available incidents matching the query
countinteger
The count of the retrieved Incidents based on the requested count in the query. Defaults to all if no specific count was requested
incidentsarray
List of Incidents including details of each of them
{
  "totalSize": 2,
  "count": 1,
  "incidents": [
    {
      "id": "5004E000003ZQdKQAW",
      "caseNumber": "Case-00000123",
      "createdDate": "2017-09-06T10:41:30.000+0000",
      "identificationNumber": "LU-12345678",
      "lastModifiedDate": "2017-10-09T01:20:06.000+000",
      "status": "Customer Accepted",
      "subject": "Oslo - Ustabilite - Issue in router connection",
      "location": "Oslo",
      "description": "The connection is unstable and here is a detailed description of the issue. Also see the attachment.",
      "closedDate": "2017-10-09T01:20:03.000+0000",
      "priority": "High",
      "statusReason": "Customer Accepted",
      "productCategoryName": "Nordic Connect",
      "incidentType": "Ustabilitet",
      "rootCause": "Restart",
      "rootCauseDescription": "Overheat of the router",
      "createdBy": {
        "internalUser": false,
        "userName": "Kari Nordman"
      },
      "owner": "System",
      "organizationNumber": "912345678",
      "lastActivity": {
        "id": "a0z4E000000iqEYQAY",
        "date": "2017-10-09T17:21:47.000+0000",
        "content": "test comment",
        "action": "STATUS_CHANGED",
        "fieldName": "status",
        "oldValue": "New",
        "newValue": "Solved",
        "user": {
          "internalUser": false,
          "userName": "Kari Nordman"
        }
      }
    }
  ]
}

Error responses

400
Bad Request:
Error code 400001 - Missing Mandatory Inputs
Error code 400002 - Invalid Inputs
401
Unauthorized:
Error code 401001 - Invalid resource
Error code 401002 - Not Authorized
Error code 401003 - Invalid or Expired Token
404
Not Found:
Error code 404001 - Path or method not found
Error code 404002 - Data or entity not found
500
Internal Server Error:
Error code 500001 - Internal Server Error
503
Service Unavailable:
Error code 503001 - External server error
The Try-It functionality is only available when logged in to the portal.
POST /service-tickets/v2/incidents Creates an incident with the given request
Description Error responses Try it

Implementation notes

Use this resource to create an Incident. Comments and attachments can be added by making a separate POST /comment, and POST /attachments calls after the Incident is created successfully.

Parameters

  • body*
  • This shall contain all the details to create an Incident. Refer to the Model Scheme for details on each param and the structure of the request object.
  • body
  • Model | Model schema

    subjectstring
    Summary of the incident
    descriptionstring
    Detailed description about the Incident. This should have enough information that will help the customer service for internal routing and for the technician to quickly diagnose the problem. It should also have information on what actions have already been taken, example restarting the device, status of any indicator lights etc
    identificationNumberstring
    The identification number will depend on the product or service the incident is reported on. For instance, it may be MSISDN (e.g. 47915363XX or the 12 digits mobile broadband number) for Mobile Broadband, POTS number (e.g. 47515354XX) in case of Fixed products, Logical Unit Number (LU-number of 8 digits) in case of Nordic Connect
    prioritystring
    Priority of the Incident
    createdByCaseUser
    The name of the logged in end-user who created the incident
    localContactContact
    Contact information of a person who is at the site where the incident has occurred. Technicians may reach out to him/her for more details
    productCategoryNamestring
    Product Category Name on which the incident is reported. The valid values for this parameter shall be retrieved by calling GET /incident/productcategories
    locationstring
    Location of the incident
    organizationNumberstring
    Organization number of the customer to which this incident case is attached to. An incident cannot be viewed or modified without the 'System User' have access to this Organization (Company). 'System User' access is administered in Min Bedrift by the API Admin of the company
    incidentTypestring
    Type of Incident.The valid values for this parameter shall be retrieved by calling GET /incident/productcategories

    CaseUser

    internalUserboolean
    Parameter which indicates if the case was registered by a case handling agent, if NOT it is always set to false
    userNamestring
    The name of the logged in end-user who created the incident.

    Contact

    namestring
    Name of the contact person
    emailstring
    Email address of the contact person
    phonestring
    Phone number of the contact person
    {
  "subject": "string",
  "description": "string",
  "identificationNumber": "string",
  "priority": "string",
  "createdBy": {
    "internalUser": "N/A",
    "userName": "Kari Nordman"
  },
  "localContact": {
    "name": "Ola Nordman",
    "email": "ola@nordman.no",
    "phone": "4712345678"
  },
  "contact": {
    "name": "Ola Nordman",
    "email": "ola@nordman.no",
    "phone": "4712345678"
  },
  "productCategoryName": "string",
  "location": "string",
  "organizationNumber": "string",
  "incidentType": "string"
}

Response class (Status 200)

Model | Model schema

idstring
Incident Id is a technical id typically NOT shown to the end user in the UI but is the id that is used in the actual API calls
{
  "id": "5004E000003uH0YQAU"
}

Error responses

201
OK
400
Bad Request:
Error code 400001 - Missing Mandatory Inputs
Error code 400002 - Invalid Inputs
401
Unauthorized:
Error code 401001 - Invalid resource
Error code 401002 - Not Authorized
Error code 401003 - Invalid or Expired Token
404
Not Found:
Error code 404001 - Path or method not found
Error code 404002 - Data or entity not found
500
Internal Server Error:
Error code 500001 - Internal Server Error
503
Service Unavailable:
Error code 503001 - External server error
The Try-It functionality is only available when logged in to the portal.
GET /service-tickets/v2/incidents/activities Get a list of activities on all incidents
Description Error responses Try it

Implementation notes

Get a list of activities on all incidents. The activities typically include when the incident was created, updated, closed, commented, attachment added etc. This also includes basic details of the Incident to which each activity is related to.

Parameters

  • skip
  • This shall be used for pagination. The skip (aka offset) query string parameter for skipping the resultset. For instance ?skip=5&count=20 would skip the first 5 items and return the next 20 items, assuming there are atleast 25 items in the data set.
  • query
  • integer
  • count
  • This shall be used for pagination. The count (aka Limit) query string parameter for limiting the result. For instance ?skip=5&count=20 would skip the first 5 items and return the next 20 items, assuming there are atleast 25 items in the data set.
  • query
  • integer
  • sortField
  • This shall be used for sorting. This parameter indicates on which field the sort shall be applied. The sort can be applied on most parameters like e.g. activity id, case id and lastActivity
  • query
  • string
  • order
  • This shall be used for sorting. This parameter indicates the sorting direction and shall be used along with the 'sortField' parameter. Allowed value is DESC for sorting in Descending order and ASC for sorting in Ascending order
  • query
  • string

Response class (Status 200)

Model | Model schema

totalSizeinteger
The total number of available incidents matching the query
countinteger
The count of the retrieved Incidents based on the requested count in the query. Defaults to all if no specific count was requested
activitiesarray
List of Activities including details of each of them
{
  "totalSize": 2,
  "count": 1,
  "activities": [
    {
      "id": "a0z4E000000iqEYQAY",
      "date": "2017-10-09T17:21:47.000+0000",
      "content": "test comment",
      "action": "STATUS_CHANGED",
      "fieldName": "status",
      "oldValue": "New",
      "newValue": "Solved",
      "user": {
        "internalUser": false,
        "userName": "Kari Nordman"
      },
      "ticket": {
        "id": "5004E000003uH0YQAU",
        "caseNumber": "Case-00001234",
        "subject": "Oslo - Ustabilitet - No connection",
        "location": "Oslo",
        "productCategoryName": "Nordic Connect",
        "incidentType": "Ustabilitet"
      }
    }
  ]
}

Error responses

400
Bad Request:
Error code 400001 - Missing Mandatory Inputs
Error code 400002 - Invalid Inputs
401
Unauthorized:
Error code 401001 - Invalid resource
Error code 401002 - Not Authorized
Error code 401003 - Invalid or Expired Token
404
Not Found:
Error code 404001 - Path or method not found
Error code 404002 - Data or entity not found
500
Internal Server Error:
Error code 500001 - Internal Server Error
503
Service Unavailable:
Error code 503001 - External server error
The Try-It functionality is only available when logged in to the portal.
GET /service-tickets/v2/incidents/count Get the total count of the available incidents
Description Error responses Try it

Implementation notes

Used for pagination. This resource returns the total count of the available incidents based on the filter, search criteria and sorting applied

Parameters

  • isClosed
  • Use this to filter incidents on Closed or Open status. The status parameter also does the same but it also allows filtering on interim Status as well
  • query
  • string
  • status
  • Use this for filtering the incidents based on various Status the incident can be in. Multiple instances of this parameter can be sent in the same request to filter incidents on multiple status at once
  • query
  • array
  • productCategoryName
  • Use this for filtering based on a given product category. The valid values for this parameter shall be retrieved by calling the GET /incidents/productcategories e.g.. Multiple instances of this parameter can be sent in the same request to filter incidents on multiple product category at once
  • query
  • array

Response class (Status 200)

Model | Model schema

countinteger
The count of retrieved Incidents for a given user logon
{
  "count": 1
}

Error responses

400
Bad Request:
Error code 400001 - Missing Mandatory Inputs
Error code 400002 - Invalid Inputs
401
Unauthorized:
Error code 401001 - Invalid resource
Error code 401002 - Not Authorized
Error code 401003 - Invalid or Expired Token
404
Not Found:
Error code 404001 - Path or method not found
Error code 404002 - Data or entity not found
500
Internal Server Error:
Error code 500001 - Internal Server Error
503
Service Unavailable:
Error code 503001 - External server error
The Try-It functionality is only available when logged in to the portal.
GET /service-tickets/v2/incidents/productcategories Get the product categories available for reporting incidents
Description Error responses Try it

Implementation notes

Get the product categories available for reporting incidents

Parameters

Response class (Status 200)

Model | Model schema

orgNostring
Organization Number Linked to the Product Category
incidentTypesarray
Possible incident values to be used by this product category
productCatNamestring
Product Category name
productsarray
Possible products to be used by this product category
[{
  "orgNo": "971183675",
  "incidentTypes": "Annen type feil, Ikke på nett, Treghet, Ustabilitet",
  "productCatName": "Ethernet Connect",
  "products": [
    {
      "productId": "01tb0000002oaMrAAI",
      "productName": "Ethernet Connect"
    }
  ]
}]

Error responses

400
Bad Request:
Error code 400001 - Missing Mandatory Inputs
Error code 400002 - Invalid Inputs
401
Unauthorized:
Error code 401001 - Invalid resource
Error code 401002 - Not Authorized
Error code 401003 - Invalid or Expired Token
404
Not Found:
Error code 404001 - Path or method not found
Error code 404002 - Data or entity not found
500
Internal Server Error:
Error code 500001 - Internal Server Error
503
Service Unavailable:
Error code 503001 - External server error
The Try-It functionality is only available when logged in to the portal.
GET /service-tickets/v2/incidents/{incidentId} Get a specific incident identified by the incident id
Description Error responses Try it

Implementation notes

Get a specific incident identified by the incident id

Parameters

  • incidentId*
  • 'Incident id' of the incident to fetch the details for. The incident id typically is in the format, eg: 5007E000004ywhfQAA. NOTE : Incident Id is a technical id typically not shown to the end user in the UI but instead 'Case Number' is used. Case Number is human readable alias to the technical Incident Id
  • path
  • string

Response class (Status 200)

Model | Model schema

idstring
Incident Id is a technical id typically NOT shown to the end user in the UI but is the id that is used in the actual API calls
caseNumberstring
Case Number is an alias to the Incident Id and is typically shown to the end user in the UI
createdDatestring
Contains the date when the Incident was created
identificationNumberstring
Service identification number (e.g MSISDN, POTS number or LU-number)
lastModifiedDatestring
Contains the date when the Incident was last modified
statusstring
The current status of the incident
subjectstring
Summary of the Incident
locationstring
The location where this Incident actually has occurred
descriptionstring
Detailed description about the Incident
closedDatestring
If the current Incident status is closed, then this holds the date when the Incident was closed
prioritystring
Current priority of the Incident
statusReasonstring
If the current status is 'Customer Accepted' and 'Solved', then this will contain more details
productCategoryNamestring
The Name of the Product Category on which the Incident is reported
incidentTypestring
Type of Incident
rootCausestring
The root cause of the Incident
rootCauseDescriptionstring
Detailed description of the root cause of the Incident
localContactContact
Contact information of a person who is at the site
createdByCaseUser
The name of the logged in end-user who created the case
caseAssignedTostring
The Incident handling agent/group name
organizationNumberstring
Organization number of the customer to which this case is attached to
attachmentsarray
List of Attachments (if any, will contain meta data only)
activitiesarray
List of Activities that was performed on the Incident inlcuding its details. Eg: 'NEW','CREATED','UPDATED','STATUS_CHANGED','COMMENTED','ADDED_ATTACHMENT','CLOSED' etc

Contact

namestring
Name of the contact person
emailstring
Email address of the contact person
phonestring
Phone number of the contact person

CaseUser

internalUserboolean
Parameter which indicates if the case was registered by a case handling agent, if NOT it is always set to false
userNamestring
The name of the logged in end-user who created the incident.
{
  "id": "5004E000003uH0YQAU",
  "caseNumber": "Case-00001234",
  "createdDate": "2017-10-09T17:21:40.000+0000",
  "identificationNumber": "4712345678",
  "lastModifiedDate": "2017-10-09T17:46:04.000+0000",
  "status": "Customer Accepted",
  "subject": "Oslo - Ustabilitet - No connection",
  "location": "Oslo",
  "description": "The connection is unstable and here is a detailed description of the issue. Also the the attachment.",
  "closedDate": "2017-10-09T17:46:04.000+0000",
  "priority": "High",
  "statusReason": "Confirmed with customer",
  "productCategoryName": "Nordic Connect",
  "incidentType": "Ustabilitet",
  "rootCause": "Restart",
  "rootCauseDescription": "RCA description",
  "localContact": {
    "name": "Ola Nordman",
    "email": "ola@nordman.no",
    "phone": "4712345678"
  },
  "contact": {
    "name": "Ola Nordman",
    "email": "ola@nordman.no",
    "phone": "4712345678"
  },
  "createdBy": {
    "internalUser": "N/A",
    "userName": "Kari Nordman"
  },
  "caseAssignedTo": "System",
  "organizationNumber": "900000123",
  "attachments": [
    {
      "id": "00P4E0000027tHNUAY",
      "name": "test_attachment.txt",
      "size": 14,
      "contentType": "text/plain",
      "createdDate": "2017-10-09T20:07:47.000+000"
    }
  ],
  "activities": [
    {
      "id": "a0z4E000000iqEYQAY",
      "date": "2017-10-09T17:21:47.000+0000",
      "content": "test comment",
      "action": "STATUS_CHANGED",
      "fieldName": "status",
      "oldValue": "New",
      "newValue": "Solved",
      "user": {
        "internalUser": false,
        "userName": "Kari Nordman"
      }
    }
  ]
}

Error responses

400
Bad Request:
Error code 400001 - Missing Mandatory Inputs
Error code 400002 - Invalid Inputs
401
Unauthorized:
Error code 401001 - Invalid resource
Error code 401002 - Not Authorized
Error code 401003 - Invalid or Expired Token
404
Not Found:
Error code 404001 - Path or method not found
Error code 404002 - Data or entity not found
500
Internal Server Error:
Error code 500001 - Internal Server Error
503
Service Unavailable:
Error code 503001 - External server error
The Try-It functionality is only available when logged in to the portal.
PUT /service-tickets/v2/incidents/{incidentId} Updates an incident with the given changes
Description Error responses Try it

Implementation notes

Updates an incident with the given changes

Parameters

  • X-User-Name*
  • The name of the end-user who is logged into the client application which is being used for updating the Incident. This is a plain text user name, for example : Ola Nordman. This info is needed for auditing purposes
  • header
  • string
  • incidentId*
  • The 'Incident id' to which update has to be made. The id typically is in the format , eg : 5007A0000015EYjQAM
  • path
  • string
  • body*
  • This shall contain the parameters that requires an update. Refer to the Model Scheme for details on each param and the structure of the request object
  • body
  • Model | Model schema

    subjectstring
    Summary of the incident
    descriptionstring
    Detailed description about the Incident. This should have enough information that will help the customer service for internal routing and for the technician to quickly diagnose the problem. It should also have information on what actions have already been taken, example restarting the device, status of any indicator lights etc
    identificationNumberstring
    The identification number will depend on the product or service the incident is reported on. For instance, it may be MSISDN (e.g. 47915363XX or the 12 digits mobile broadband number) for Mobile Broadband, POTS number (e.g. 47515354XX) in case of Fixed products, Logical Unit Number (LU-number of 8 digits) in case of Nordic Connect
    prioritystring
    Priority of the Incident
    createdByCaseUser
    The name of the logged in end-user who created the incident
    localContactContact
    Contact information of a person who is at the site where the incident has occurred. Technicians may reach out to him/her for more details
    productCategoryNamestring
    Product Category Name on which the incident is reported. The valid values for this parameter shall be retrieved by calling GET /incident/productcategories
    locationstring
    Location of the incident
    organizationNumberstring
    Organization number of the customer to which this incident case is attached to. An incident cannot be viewed or modified without the 'System User' have access to this Organization (Company). 'System User' access is administered in Min Bedrift by the API Admin of the company
    incidentTypestring
    Type of Incident.The valid values for this parameter shall be retrieved by calling GET /incident/productcategories

    CaseUser

    internalUserboolean
    Parameter which indicates if the case was registered by a case handling agent, if NOT it is always set to false
    userNamestring
    The name of the logged in end-user who created the incident.

    Contact

    namestring
    Name of the contact person
    emailstring
    Email address of the contact person
    phonestring
    Phone number of the contact person
    {
  "subject": "string",
  "description": "string",
  "identificationNumber": "string",
  "priority": "string",
  "createdBy": {
    "internalUser": "N/A",
    "userName": "Kari Nordman"
  },
  "localContact": {
    "name": "Ola Nordman",
    "email": "ola@nordman.no",
    "phone": "4712345678"
  },
  "contact": {
    "name": "Ola Nordman",
    "email": "ola@nordman.no",
    "phone": "4712345678"
  },
  "productCategoryName": "string",
  "location": "string",
  "organizationNumber": "string",
  "incidentType": "string"
}

Response class (Status 200)

Model | Model schema

Error responses

204
OK
400
Bad Request:
Error code 400001 - Missing Mandatory Inputs
Error code 400002 - Invalid Inputs
401
Unauthorized:
Error code 401001 - Invalid resource
Error code 401002 - Not Authorized
Error code 401003 - Invalid or Expired Token
404
Not Found:
Error code 404001 - Path or method not found
Error code 404002 - Data or entity not found
500
Internal Server Error:
Error code 500001 - Internal Server Error
503
Service Unavailable:
Error code 503001 - External server error
The Try-It functionality is only available when logged in to the portal.
GET /service-tickets/v2/incidents/{incidentId}/activities Get the activities of an incident identified by the 'Incident id'
Description Error responses Try it

Implementation notes

Get the activities of an incident identified by the 'Incident id'. The activites typically include when the incident was created, updated, closed, commented, attachment added etc

Parameters

  • incidentId*
  • Incident id for which the activities need to be fetched. The id typically is in the format, eg : 5007A0000015EYjQAM
  • path
  • string
  • skip
  • This shall be used for pagination. The skip (aka offset) query string parameter for skipping the resultset. For instance ?skip=5&count=20 would skip the first 5 items and return the next 20 items, assuming there are atleast 25 items in the data set.
  • query
  • integer
  • count
  • This shall be used for pagination. The count (aka Limit) query string parameter for limiting the result. For instance ?skip=5&count=20 would skip the first 5 items and return the next 20 items, assuming there are atleast 25 items in the data set.
  • query
  • integer
  • sortField
  • This shall be used for sorting. This parameter indicates on which field the sort shall be applied. The sort can be applied on most parameters like e.g. caseNumber,status,location,identificationNumber,incidentType and lastActivity
  • query
  • string
  • order
  • This shall be used for sorting. This parameter indicates the sortering direction and shall be used along with the 'sortField' parameter. Allowed value is DESC for sorting in Descending order and ASC for sorting in Ascending order
  • query
  • string

Response class (Status 200)

Model | Model schema

totalSizeinteger
The total number of available incidents matching the query
countinteger
The count of the retrieved Incidents based on the requested count in the query. Defaults to all if no specific count was requested
activitiesarray
List of Activities including details of each of them
{
  "totalSize": 2,
  "count": 1,
  "activities": [
    {
      "id": "a0z4E000000iqEYQAY",
      "date": "2017-10-09T17:21:47.000+0000",
      "content": "test comment",
      "action": "STATUS_CHANGED",
      "fieldName": "status",
      "oldValue": "New",
      "newValue": "Solved",
      "user": {
        "internalUser": false,
        "userName": "Kari Nordman"
      },
      "ticket": {
        "id": "5004E000003uH0YQAU",
        "caseNumber": "Case-00001234",
        "subject": "Oslo - Ustabilitet - No connection",
        "location": "Oslo",
        "productCategoryName": "Nordic Connect",
        "incidentType": "Ustabilitet"
      }
    }
  ]
}

Error responses

400
Bad Request:
Error code 400001 - Missing Mandatory Inputs
Error code 400002 - Invalid Inputs
401
Unauthorized:
Error code 401001 - Invalid resource
Error code 401002 - Not Authorized
Error code 401003 - Invalid or Expired Token
404
Not Found:
Error code 404001 - Path or method not found
Error code 404002 - Data or entity not found
500
Internal Server Error:
Error code 500001 - Internal Server Error
503
Service Unavailable:
Error code 503001 - External server error
The Try-It functionality is only available when logged in to the portal.
GET /service-tickets/v2/incidents/{incidentId}/activities/{activityId} Get details of a specific activity of an incident
Description Error responses Try it

Implementation notes

Get the activities of a given incident identified by 'Incident Id' and 'activity id'

Parameters

  • incidentId*
  • 'Incident id' of the incident for which the activity need to be fetched. The id typically is in the format, eg : 5007A0000015EYjQAM
  • path
  • string
  • activityId*
  • Incidents 'activity id' for which the details need to be fetched. The activity id is typically in the format, eg : a0u7A0000002msNQAQ
  • path
  • string

Response class (Status 200)

Model | Model schema

idstring
Unique Id of the given activity
datestring
Date when this activity was created
contentstring
Actual content of the Activity
actionstring
What the activity was
fieldNamestring
If this is a field update activity, the field that was updated is returned here
oldValuestring
If this is a field update activity, this contains the old value that was in the field
newValuestring
If this is a field update activity, this contains the new value that was entered in the field
userCaseUser
Name of the user who created this activity

CaseUser

internalUserboolean
Parameter which indicates if the case was registered by a case handling agent, if NOT it is always set to false
userNamestring
The name of the logged in end-user who created the incident.
{
  "id": "a0z4E000000iqEYQAY",
  "date": "2017-10-09T17:21:47.000+0000",
  "content": "test comment",
  "action": "STATUS_CHANGED",
  "fieldName": "status",
  "oldValue": "New",
  "newValue": "Solved",
  "user": {
    "internalUser": "N/A",
    "userName": "Kari Nordman"
  }
}

Error responses

400
Bad Request:
Error code 400001 - Missing Mandatory Inputs
Error code 400002 - Invalid Inputs
401
Unauthorized:
Error code 401001 - Invalid resource
Error code 401002 - Not Authorized
Error code 401003 - Invalid or Expired Token
404
Not Found:
Error code 404001 - Path or method not found
Error code 404002 - Data or entity not found
500
Internal Server Error:
Error code 500001 - Internal Server Error
503
Service Unavailable:
Error code 503001 - External server error
The Try-It functionality is only available when logged in to the portal.
GET /service-tickets/v2/incidents/{incidentId}/attachments Get the list of all attachments for a given incident
Description Error responses Try it

Implementation notes

Get the list of all attachments for a given incident identified by its 'incident id'

Parameters

  • incidentId*
  • 'Incident id' of the incident for which the attachment has to be fetched. The id typically is in the format, eg : 5007A0000015EYjQAM
  • path
  • string

Response class (Status 200)

Model | Model schema

idstring
Unique Id of the attachment
namestring
The name of the file along with its extension. Eg:Router_Light_Status.jpg
sizeinteger
Size of the file in bytes
contentTypestring
The content type of the file. Eg: image/jpg
createdDatestring
The date when the file was attached
[{
  "id": "00P4E0000027tHNUAY",
  "name": "test_attachment.txt",
  "size": 14,
  "contentType": "text/plain",
  "createdDate": "2017-10-09T20:07:47.000+000"
}]

Error responses

400
Bad Request:
Error code 400001 - Missing Mandatory Inputs
Error code 400002 - Invalid Inputs
401
Unauthorized:
Error code 401001 - Invalid resource
Error code 401002 - Not Authorized
Error code 401003 - Invalid or Expired Token
404
Not Found:
Error code 404001 - Path or method not found
Error code 404002 - Data or entity not found
500
Internal Server Error:
Error code 500001 - Internal Server Error
503
Service Unavailable:
Error code 503001 - External server error
The Try-It functionality is only available when logged in to the portal.
POST /service-tickets/v2/incidents/{incidentId}/attachments Adds an attachment for a given Incident
Description Error responses Try it

Implementation notes

Adds an attachment for a given Incident.The POST body has to be in multipart/form-data format. Files that are executable are not permitted as attachments

Parameters

  • X-User-Name*
  • The name of the end-user who is logged into the client application which is being used for updating the order. This is a plain text user name, for example : Ola Nordman. This info is needed for auditing purposes
  • header
  • string
  • incidentId*
  • The 'Incident id' to which attachment to be added. The id typically is in the format , eg : 5007A0000015EYjQAM
  • path
  • string
  • file
  • Attachment to be added
  • formData
  • file
  • contentType
  • Content Type of the Attachment to be added
  • formData
  • string

Response class (Status 200)

Model | Model schema

idstring
Attachment Id is a technical id typically NOT shown to the end user in the UI but is the id that is used in the actual API calls
{
  "id": "00P4E000001yZzrUAE"
}

Error responses

201
OK
400
Bad Request:
Error code 400001 - Missing Mandatory Inputs
Error code 400002 - Invalid Inputs
401
Unauthorized:
Error code 401001 - Invalid resource
Error code 401002 - Not Authorized
Error code 401003 - Invalid or Expired Token
404
Not Found:
Error code 404001 - Path or method not found
Error code 404002 - Data or entity not found
500
Internal Server Error:
Error code 500001 - Internal Server Error
503
Service Unavailable:
Error code 503001 - External server error
The Try-It functionality is only available when logged in to the portal.
GET /service-tickets/v2/incidents/{incidentId}/attachments/{attachmentId} Get a specific attachment for a given incident
Description Error responses Try it

Implementation notes

Get a specific attachment for a given incident, identified by an incident Id and attachment id.The response will contain the file which can be downloaded directly.

Parameters

  • incidentId*
  • The 'incident id' to which update has to be made. The id typically is in the format, eg : 5007A0000015EYjQAM
  • path
  • string
  • attachmentId*
  • The 'attachment id' of the incident attachment to be fetched. The id typically is in the format, eg : 00P7E000002xhiHUAQ
  • path
  • string

Response class (Status 200)

Model | Model schema 

{}

Error responses

400
Bad Request:
Error code 400001 - Missing Mandatory Inputs
Error code 400002 - Invalid Inputs
401
Unauthorized:
Error code 401001 - Invalid resource
Error code 401002 - Not Authorized
Error code 401003 - Invalid or Expired Token
404
Not Found:
Error code 404001 - Path or method not found
Error code 404002 - Data or entity not found
500
Internal Server Error:
Error code 500001 - Internal Server Error
503
Service Unavailable:
Error code 503001 - External server error
The Try-It functionality is only available when logged in to the portal.
DELETE /service-tickets/v2/incidents/{incidentId}/attachments/{attachmentId} Delete a specific attachment for a given incident
Description Error responses Try it

Implementation notes

Delete a specific attachment for a given incident

Parameters

  • X-User-Name*
  • The name of the end-user who is logged into the client application which is being used for updating the incident. This is a plain text user name, for example : Ola Nordman. This info is needed for auditing purposes
  • header
  • string
  • incidentId*
  • The 'Incident id' to which update has to be made. The id typically is in the format , eg : 5007A0000015EYjQAM
  • path
  • string
  • attachmentId*
  • The 'attachment id' of attachment which has to be deleted. The id typically is in the format, eg : 00P7E000002xhiHUAQ. Both attachmentId and exact fileName with extension is required.
  • path
  • string
  • fileName*
  • The file name of the attachment which has to be deleted. Example : screenshot_1.jpeg
  • query
  • string

Response class (Status 200)

Model | Model schema

Error responses

400
Bad Request:
Error code 400001 - Missing Mandatory Inputs
Error code 400002 - Invalid Inputs
401
Unauthorized:
Error code 401001 - Invalid resource
Error code 401002 - Not Authorized
Error code 401003 - Invalid or Expired Token
404
Not Found:
Error code 404001 - Path or method not found
Error code 404002 - Data or entity not found
500
Internal Server Error:
Error code 500001 - Internal Server Error
503
Service Unavailable:
Error code 503001 - External server error
The Try-It functionality is only available when logged in to the portal.
GET /service-tickets/v2/incidents/{incidentId}/comments Get a list of Comments for a given Incident Id
Description Error responses Try it

Implementation notes

Get a list of Comments for a given Incident Id

Parameters

  • incidentId*
  • Order Id to which the comments have to be fetched
  • path
  • string

Response class (Status 200)

Model | Model schema

idstring
Comment Id
createdDatestring
Comment Creation Date
commentBodystring
Actual Comments
[{
  "id": "00a4E000000YRpqQAG",
  "createdDate": "2017-08-31T10:01:31.000+0000",
  "commentBody": "Hello!!!"
}]

Error responses

400
Bad Request:
Error code 400001 - Missing Mandatory Inputs
Error code 400002 - Invalid Inputs
401
Unauthorized:
Error code 401001 - Invalid resource
Error code 401002 - Not Authorized
Error code 401003 - Invalid or Expired Token
404
Not Found:
Error code 404001 - Path or method not found
Error code 404002 - Data or entity not found
500
Internal Server Error:
Error code 500001 - Internal Server Error
503
Service Unavailable:
Error code 503001 - External server error
The Try-It functionality is only available when logged in to the portal.
POST /service-tickets/v2/incidents/{incidentId}/comments Add a comment to a given incident
Description Error responses Try it

Implementation notes

Add a comment to a given incident. This also generates an activity

Parameters

  • X-User-Name*
  • The name of the end-user who is logged into the client application which is being adding the comment to the incident. This is a plain text user name, for example : Ola Nordman. This info is needed for auditing purposes
  • header
  • string
  • incidentId*
  • The 'Incident id' to which the comment has to be added. The id typically is in the format , eg : 5007A0000015EYjQAM
  • path
  • string
  • body
  • This shall contain the comment text. Refer to the Model Scheme for structure of the request object
  • body
  • Model | Model schema

    textstring
    Actual Comment
    userNamestring
    Name of the user who adds the Comment
    {
  "text": "Hello!!!",
  "userName": "Ola Nordman"
}

Response class (Status 200)

Model | Model schema

idstring
Comment Id is a technical id typically NOT shown to the end user in the UI but is the id that is used in the actual API calls
{
  "id": "00a4E000000YRpqQAG"
}

Error responses

201
OK
400
Bad Request:
Error code 400001 - Missing Mandatory Inputs
Error code 400002 - Invalid Inputs
401
Unauthorized:
Error code 401001 - Invalid resource
Error code 401002 - Not Authorized
Error code 401003 - Invalid or Expired Token
404
Not Found:
Error code 404001 - Path or method not found
Error code 404002 - Data or entity not found
500
Internal Server Error:
Error code 500001 - Internal Server Error
503
Service Unavailable:
Error code 503001 - External server error
The Try-It functionality is only available when logged in to the portal.
PUT /service-tickets/v2/incidents/{incidentId}/contact Update a contact for a given incident
Description Error responses Try it

Implementation notes

This resource shall be used for updating the main Case contact. The local contact person where the incident has occured can be updated using a seperate resource /localcontact

Parameters

  • X-User-Name*
  • The name of the end-user who is logged into the client application which is being adding the comment to the incident. This is a plain text user name, for example : Ola Nordman. This info is needed for auditing purposes
  • header
  • string
  • incidentId*
  • The 'Incident id' to which the Contact has to be updated. The id typically is in the format , eg : 5007A0000015EYjQAM
  • path
  • string
  • body*
  • This shall contain the Contact Details. Refer to the Model Scheme for structure of the request object
  • body
  • Model | Model schema

    namestring
    Name of the contact person
    emailstring
    Email address of the contact person
    phonestring
    Phone number of the contact person
    {
  "name": "Ola Nordman",
  "email": "ola@nordman.no",
  "phone": "4712345678"
}

Response class (Status 200)

Model | Model schema

Error responses

204
OK
400
Bad Request:
Error code 400001 - Missing Mandatory Inputs
Error code 400002 - Invalid Inputs
401
Unauthorized:
Error code 401001 - Invalid resource
Error code 401002 - Not Authorized
Error code 401003 - Invalid or Expired Token
404
Not Found:
Error code 404001 - Path or method not found
Error code 404002 - Data or entity not found
500
Internal Server Error:
Error code 500001 - Internal Server Error
503
Service Unavailable:
Error code 503001 - External server error
The Try-It functionality is only available when logged in to the portal.
PUT /service-tickets/v2/incidents/{incidentId}/localcontact Update an incident with the given local contact. Local contact is the person at the site where the incident happened
Description Error responses Try it

Implementation notes

Update an incident with the given local contact. Local contact is the person at the site where the incident happened

Parameters

  • X-User-Name*
  • The name of the end-user who is logged into the client application which is being used for updating the incident. This is a plain text user name, for example : Ola Nordman. This info is needed for auditing purposes
  • header
  • string
  • incidentId*
  • The 'Incident id' to which local contact has to be updatedThe id typically is in the format , eg : 5007A0000015EYjQAM
  • path
  • string
  • body*
  • This shall contain the Local Contact Details. Refer to the Model Scheme for structure of the request object
  • body
  • Model | Model schema

    namestring
    Name of the contact person
    emailstring
    Email address of the contact person
    phonestring
    Phone number of the contact person
    {
  "name": "Ola Nordman",
  "email": "ola@nordman.no",
  "phone": "4712345678"
}

Response class (Status 200)

Model | Model schema

Error responses

204
OK
400
Bad Request:
Error code 400001 - Missing Mandatory Inputs
Error code 400002 - Invalid Inputs
401
Unauthorized:
Error code 401001 - Invalid resource
Error code 401002 - Not Authorized
Error code 401003 - Invalid or Expired Token
404
Not Found:
Error code 404001 - Path or method not found
Error code 404002 - Data or entity not found
500
Internal Server Error:
Error code 500001 - Internal Server Error
503
Service Unavailable:
Error code 503001 - External server error
The Try-It functionality is only available when logged in to the portal.
DELETE /service-tickets/v2/incidents/{incidentId}/localcontact Deletes a Local Contact for a given Incident
Description Error responses Try it

Implementation notes

Deletes a Local Contact for a given Incident

Parameters

  • X-User-Name*
  • The name of the end-user who is logged into the client application which is being used for updating the incident. This is a plain text user name, for example : Ola Nordman. This info is needed for auditing purposes
  • header
  • string
  • incidentId*
  • The 'Incident id' to which Local contact has to be deleted. The id typically is in the format , eg : 5007A0000015EYjQAM
  • path
  • string

Response class (Status 200)

Model | Model schema

Error responses

204
OK
400
Bad Request:
Error code 400001 - Missing Mandatory Inputs
Error code 400002 - Invalid Inputs
401
Unauthorized:
Error code 401001 - Invalid resource
Error code 401002 - Not Authorized
Error code 401003 - Invalid or Expired Token
404
Not Found:
Error code 404001 - Path or method not found
Error code 404002 - Data or entity not found
500
Internal Server Error:
Error code 500001 - Internal Server Error
503
Service Unavailable:
Error code 503001 - External server error
The Try-It functionality is only available when logged in to the portal.
PUT /service-tickets/v2/incidents/{incidentId}/status Update the status of an incident
Description Error responses Try it

Implementation notes

Update the status of an incident. This also generates an activity

Parameters

  • X-User-Name*
  • The name of the end-user who is logged into the client application which is being used for updating the incident. This is a plain text user name, for example : Ola Nordman. This info is needed for auditing purposes
  • header
  • string
  • incidentId*
  • The 'Incident id' to which update has to be made. The id typically is in the format , eg : 5007A0000015EYjQAM
  • path
  • string
  • body*
  • This shall contain all the details to change the status an Incident. Refer to the Model Scheme for details on each param and the structure of the request object
  • body
  • Model | Model schema

    statusstring
    Case Status
    textstring
    Additional status comment to be added while changing the status
    {
  "status": "string",
  "text": "string"
}

Response class (Status 200)

Model | Model schema

Error responses

400
Bad Request:
Error code 400001 - Missing Mandatory Inputs
Error code 400002 - Invalid Inputs
401
Unauthorized:
Error code 401001 - Invalid resource
Error code 401002 - Not Authorized
Error code 401003 - Invalid or Expired Token
403
Forbidden:
Error code 403001 - Forbidden
404
Not Found:
Error code 404001 - Path or method not found
Error code 404002 - Data or entity not found
500
Internal Server Error:
Error code 500001 - Internal Server Error
503
Service Unavailable:
Error code 503001 - External server error
The Try-It functionality is only available when logged in to the portal.
GET /service-tickets/v2/orders Get all the Orders belonging to the Organization
Description Error responses Try it

Implementation notes

Use this resource to retrieve all the Orders belonging to the Organization. This also supports filtering , free text search and pagination. See inline description of each field for more details on the usage

Parameters

  • caseNumber
  • Case Number is an alias to the Order Id. Order Id is a technical id typically not shown to the end user in the UI but instead Case Number is used. Orders can be filtered using the Case Number.
  • query
  • string
  • isClosed
  • Use this to filter orders on Closed or Open status. The status parameter also does the same but it also allows filtering on interim Status as well
  • query
  • string
  • status
  • Use this for filtering the orders based on various Status the order can be in. Multiple instances of this parameter can be sent in the same request to filter orders on multiple status at once
  • query
  • array
  • productCategoryName
  • Use this for filtering based on a given product category. The valid values for this parameter shall be retrieved by calling the GET /productcategories/orders. e.g.. etc. Multiple instances of this parameter can be sent in the same request to filter orders on multiple product category at once
  • query
  • array
  • search
  • Use this to search orders based on a free text search. The search will be run on all parameters of the orders
  • query
  • string
  • skip
  • This shall be used for pagination. The skip (aka offset) query string parameter for skipping the resultset. For instance ?skip=5&count=20 would skip the first 5 items and return the next 20 items, assuming there are atleast 25 items in the data set.
  • query
  • integer
  • count
  • This shall be used for pagination. The count (aka Limit) query string parameter for limiting the result. For instance ?skip=5&count=20 would skip the first 5 items and return the next 20 items, assuming there are atleast 25 items in the data set.
  • query
  • integer
  • sortField
  • This shall be used for sorting. This parameter indicates on which field the sort shall be applied. The sort can be applied on most parameters viz caseNumber,status etc
  • query
  • string
  • order
  • This shall be used for sorting. This parameter indicates the sorting direction and shall be used along with the 'sortField' parameter. Allowed value is DESC for sorting in descending order and ASC for sorting in Ascending order
  • query
  • string
  • loggedBy
  • Use this to filter incidents based on the end user who created them. This is the same user that is passed in the header when the incident was updated. Example value : Ola Nordman etc
  • query
  • string

Response class (Status 200)

Model | Model schema

totalSizeinteger
OrderList total Size
countinteger
OrderList total count requested
ordersarray
Order details
{
  "totalSize": "int",
  "count": "int",
  "orders": [
    {
      "id": "string",
      "owner": "string",
      "organizationNumber": "string",
      "caseNumber": "string",
      "createdDate": "string",
      "lastModifiedDate": "string",
      "status": "string",
      "reason": "string",
      "type": "string",
      "subject": "string",
      "location": "string",
      "product": "string",
      "quantity": "number",
      "description": "string",
      "closedDate": "string",
      "priority": "string",
      "orderReference": "string",
      "productCategoryName": "string",
      "productId": "string",
      "productName": "string",
      "originDetail": "string",
      "installationAddress": {
        "street": "Fornebu",
        "floor": "H202",
        "zipCode": "1365",
        "city": "Oslo",
        "addressId": "123456"
      },
      "createdBy": {
        "internalUser": false,
        "userName": "Kari Nordman"
      },
      "lastActivity": {
        "id": "a0z4E000000iqEYQAY",
        "date": "2017-10-09T17:21:47.000+0000",
        "content": "test comment",
        "action": "STATUS_CHANGED",
        "fieldName": "status",
        "oldValue": "New",
        "newValue": "Solved",
        "user": {
          "internalUser": false,
          "userName": "Kari Nordman"
        }
      },
      "customerReference": "string",
      "internalSubSystemReference": "string"
    }
  ]
}

Error responses

400
Bad Request:
Error code 400001 - Missing Mandatory Inputs
Error code 400002 - Invalid Inputs
401
Unauthorized:
Error code 401001 - Invalid resource
Error code 401002 - Not Authorized
Error code 401003 - Invalid or Expired Token
404
Not Found:
Error code 404001 - Path or method not found
Error code 404002 - Data or entity not found
500
Internal Server Error:
Error code 500001 - Internal Server Error
503
Service Unavailable:
Error code 503001 - External server error
The Try-It functionality is only available when logged in to the portal.
POST /service-tickets/v2/orders Creates an order with the given inputs
Description Error responses Try it

Implementation notes

Use this resource to create an Order. Comments and attachments can be added by making a separate POST /comment and POST /attachments calls after the Order is created successfully

Parameters

  • body*
  • This shall contain all the details to create an Order. Refer to the Model Scheme for details on each param and the structure of the request object
  • body
  • Model | Model schema

    subjectstring
    Single line summary of the order
    descriptionstring
    Detailed description about the Order including any prefered date and time for delivery or other relevant information.
    reasonstring
    Reason for ordering eg: Nybestilling , Endring Or Oppsigelse
    typestring
    Order Type
    createdByCaseUser
    The name of the logged in end-user who created the order
    prioritystring
    Priority of the Order. Default is set to High
    contactContact
    Contact information of the person who will be contacted by customer service regarding the order. For example, to ask for missing information Or to change the status or priority of the order in agreement with this person. Can sometimes be the Order creator
    productstring
    Product name, set by default
    quantitynumber
    Quantity of the order
    locationstring
    Location where the order needs to be fullfilled
    orderReferencestring
    Order Reference number
    customerReferencestring
    Reference Number at source Order System. This field is also searchable, so the Order creator can enter their own reference
    organizationNumberstring
    Organization number of the customer to which this order case is attached to. An order cannot be viewed or modified without the 'System User' have access to this Organization (Company). 'System User' access is administered in Min Bedrift by the API Admin of the company
    productCategoryNamestring
    Product Category Name on which the order is created. The valid values for this parameter shall be retrieved by calling GET /order/productcategories
    productIdstring
    Product Id on which the order is created. The valid values for this parameter shall be retrieved by calling GET /order/productcategories
    productNamestring
    Product name on which the order is created. The valid values for this parameter shall be retrieved by calling GET /order/productcategories
    installationAddressAddress
    order Installation address.Optional, but should always be included

    CaseUser

    internalUserboolean
    Parameter which indicates if the case was registered by a case handling agent, if NOT it is always set to false
    userNamestring
    The name of the logged in end-user who created the incident.

    Contact

    namestring
    Name of the contact person
    emailstring
    Email address of the contact person
    phonestring
    Phone number of the contact person

    Address

    streetstring
    Street Name of the Installation Address
    floorstring
    Floor number of the Installation Address
    zipCodestring
    Zipcode of the Installation Address
    citystring
    City Name of the Installation Address
    addressIdstring
    FarId of the Installation Address
    {
  "subject": "Fornebu - Nordic Connect Multi VPN -SP - Required",
  "description": "Nordic Connect Multi VPN is required at Fornebu. Expected delivery by 11/11/2018 by 10:CET. See attachment for more info about the order",
  "reason": "Nybestilling",
  "type": "Nybestilling",
  "createdBy": {
    "internalUser": "N/A",
    "userName": "Kari Nordman"
  },
  "priority": "High",
  "contact": {
    "name": "Ola Nordman",
    "email": "ola@nordman.no",
    "phone": "4712345678"
  },
  "localContact": {
    "name": "Ola Nordman",
    "email": "ola@nordman.no",
    "phone": "4712345678"
  },
  "product": "Mobil",
  "quantity": 1,
  "location": "Oslo",
  "orderReference": "OrdRef1234",
  "customerReference": "CustRef1234",
  "organizationNumber": "string",
  "productCategoryName": "Nordic Connect",
  "productId": "string",
  "productName": "string",
  "installationAddress": {
    "street": "Fornebu",
    "floor": "H202",
    "zipCode": "1365",
    "city": "Oslo",
    "addressId": "123456"
  }
}

Response class (Status 200)

Model | Model schema

idstring
Order Id is a technical id typically NOT shown to the end user in the UI but is the id that is used in the actual API calls
{
  "id": "5004E000003b6LbQAI"
}

Error responses

201
OK
400
Bad Request:
Error code 400001 - Missing Mandatory Inputs
Error code 400002 - Invalid Inputs
401
Unauthorized:
Error code 401001 - Invalid resource
Error code 401002 - Not Authorized
Error code 401003 - Invalid or Expired Token
404
Not Found:
Error code 404001 - Path or method not found
Error code 404002 - Data or entity not found
500
Internal Server Error:
Error code 500001 - Internal Server Error
503
Service Unavailable:
Error code 503001 - External server error
The Try-It functionality is only available when logged in to the portal.
GET /service-tickets/v2/orders/activities Get a list of activities on all orders
Description Error responses Try it

Implementation notes

Get a list of activities on all orders. The activities typically include when the order was created, updated, closed, commented, attachment added etc. This also includes basic details of the Order to which each activity is related to.

Parameters

  • skip
  • This shall be used for pagination. The skip (aka offset) query string parameter for skipping the resultset. For instance ?skip=5&count=20 would skip the first 5 items and return the next 20 items, assuming there are atleast 25 items in the data set.
  • query
  • integer
  • count
  • This shall be used for pagination. The count (aka Limit) query string parameter for limiting the result. For instance ?skip=5&count=20 would skip the first 5 items and return the next 20 items, assuming there are atleast 25 items in the data set.
  • query
  • integer
  • sortField
  • This shall be used for sorting. This parameter indicates on which field the sort shall be applied. The sort can be applied on most parameters like e.g. activity id, case id and lastActivity
  • query
  • string
  • order
  • This shall be used for sorting. This parameter indicates the sorting direction and shall be used along with the 'sortField' parameter. Allowed value is DESC for sorting in descending order and ASC for sorting in Ascending order
  • query
  • string

Response class (Status 200)

Model | Model schema

totalSizeinteger
The total number of available incidents matching the query
countinteger
The count of the retrieved Incidents based on the requested count in the query. Defaults to all if no specific count was requested
activitiesarray
List of Activities including details of each of them
{
  "totalSize": 2,
  "count": 1,
  "activities": [
    {
      "id": "a0z4E000000iqEYQAY",
      "date": "2017-10-09T17:21:47.000+0000",
      "content": "test comment",
      "action": "STATUS_CHANGED",
      "fieldName": "status",
      "oldValue": "New",
      "newValue": "Solved",
      "user": {
        "internalUser": false,
        "userName": "Kari Nordman"
      },
      "ticket": {
        "id": "5004E000003uH0YQAU",
        "caseNumber": "Case-00001234",
        "subject": "Oslo - Ustabilitet - No connection",
        "location": "Oslo",
        "productCategoryName": "Nordic Connect",
        "incidentType": "Ustabilitet"
      }
    }
  ]
}

Error responses

400
Bad Request:
Error code 400001 - Missing Mandatory Inputs
Error code 400002 - Invalid Inputs
401
Unauthorized:
Error code 401001 - Invalid resource
Error code 401002 - Not Authorized
Error code 401003 - Invalid or Expired Token
404
Not Found:
Error code 404001 - Path or method not found
Error code 404002 - Data or entity not found
500
Internal Server Error:
Error code 500001 - Internal Server Error
503
Service Unavailable:
Error code 503001 - External server error
The Try-It functionality is only available when logged in to the portal.
GET /service-tickets/v2/orders/count Get the total count of the available orders
Description Error responses Try it

Implementation notes

Used for pagination. This resource returns the total count of the available orders based on the filter, search criteria and sorting applied.

Parameters

  • isClosed
  • Use this to filter orders on Closed or Open status. The status parameter also does the same but it also allows filtering on interim Status as well
  • query
  • string
  • status
  • Use this for filtering the orders based on various Status the order can be in. Multiple instances of this parameter can be sent in the same request to filter orders on multiple status at once
  • query
  • array
  • productCategoryName
  • Use this for filtering based on a given product category. The valid values for this parameter shall be retrieved by calling the GET /productcategories/orders. e.g.. etc. Multiple instances of this parameter can be sent in the same request to filter incidents on multiple product category at once
  • query
  • array

Response class (Status 200)

Model | Model schema

countinteger
The count of retrieved Orders for a given user logon
{
  "count": 1
}

Error responses

400
Bad Request:
Error code 400001 - Missing Mandatory Inputs
Error code 400002 - Invalid Inputs
401
Unauthorized:
Error code 401001 - Invalid resource
Error code 401002 - Not Authorized
Error code 401003 - Invalid or Expired Token
404
Not Found:
Error code 404001 - Path or method not found
Error code 404002 - Data or entity not found
500
Internal Server Error:
Error code 500001 - Internal Server Error
503
Service Unavailable:
Error code 503001 - External server error
The Try-It functionality is only available when logged in to the portal.
GET /service-tickets/v2/orders/productcategories Get the product categories available for placing orders
Description Error responses Try it

Implementation notes

Get the product categories available for placing orders

Parameters

Response class (Status 200)

Model | Model schema

orgNostring
Organization Number Linked to the Product Category
productCatNamestring
Product Category name
productsarray
Possible products to be used by this product category
[{
  "orgNo": "971183675",
  "productCatName": "Ethernet Connect",
  "products": [
    {
      "productId": "01tb0000002oaMrAAI",
      "productName": "Ethernet Connect"
    }
  ]
}]

Error responses

400
Bad Request:
Error code 400001 - Missing Mandatory Inputs
Error code 400002 - Invalid Inputs
401
Unauthorized:
Error code 401001 - Invalid resource
Error code 401002 - Not Authorized
Error code 401003 - Invalid or Expired Token
404
Not Found:
Error code 404001 - Path or method not found
Error code 404002 - Data or entity not found
500
Internal Server Error:
Error code 500001 - Internal Server Error
503
Service Unavailable:
Error code 503001 - External server error
The Try-It functionality is only available when logged in to the portal.
GET /service-tickets/v2/orders/{orderId} Get a specific order identified by the order id
Description Error responses Try it

Implementation notes

Get a specific order identified by the order id

Parameters

  • orderId*
  • 'Order id' of the order to fetch the details for. The order id typically is in the format, eg: 5007E000004ywhfQAA. NOTE : Order Id is a technical id typically not shown to the end user in the UI but instead 'Case Number' is used. Case Number is human readable alias to the technical Order Id.
  • path
  • string

Response class (Status 200)

Model | Model schema

idstring
Order Id
ownerstring
Order Owner
organizationNumberstring
Organization number of the customer to which this case is attached to
caseNumberstring
Order Number
createdDatestring
Order created date
lastModifiedDatestring
Order last modified date
statusstring
Order current status
reasonstring
Order created reason
typestring
Order Type
subjectstring
Summary of the case
locationstring
Order created location
productstring
Order created on product
quantitynumber
Order quantity
descriptionstring
Detailed description about the case
closedDatestring
Order closed date
prioritystring
Priority of the Order
orderReferencestring
Order order reference
productCategoryNamestring
Product Category Name on which the Order is reported
productIdstring
Order Product Id
productNamestring
Order Product Name
originDetailstring
Order Origin Detail
contactContact
Contact information of the person who will be contacted by customer service regarding the case
installationAddressAddress
Order Installation Address
createdByCaseUser
The name of the logged in end-user who created the case
attachmentsarray
Order Attachments
activitiesarray
Order Activities
customerReferencestring
Order Customer Reference
internalSubSystemReferencestring
Order SubSystem Reference

Contact

namestring
Name of the contact person
emailstring
Email address of the contact person
phonestring
Phone number of the contact person

Address

streetstring
Street Name of the Installation Address
floorstring
Floor number of the Installation Address
zipCodestring
Zipcode of the Installation Address
citystring
City Name of the Installation Address
addressIdstring
FarId of the Installation Address

CaseUser

internalUserboolean
Parameter which indicates if the case was registered by a case handling agent, if NOT it is always set to false
userNamestring
The name of the logged in end-user who created the incident.
{
  "id": "string",
  "owner": "string",
  "organizationNumber": "string",
  "caseNumber": "string",
  "createdDate": "string",
  "lastModifiedDate": "string",
  "status": "string",
  "reason": "string",
  "type": "string",
  "subject": "string",
  "location": "string",
  "product": "string",
  "quantity": "N/A",
  "description": "string",
  "closedDate": "string",
  "priority": "string",
  "orderReference": "string",
  "productCategoryName": "string",
  "productId": "string",
  "productName": "string",
  "originDetail": "string",
  "contact": {
    "name": "Ola Nordman",
    "email": "ola@nordman.no",
    "phone": "4712345678"
  },
  "localContact": {
    "name": "Ola Nordman",
    "email": "ola@nordman.no",
    "phone": "4712345678"
  },
  "installationAddress": {
    "street": "Fornebu",
    "floor": "H202",
    "zipCode": "1365",
    "city": "Oslo",
    "addressId": "123456"
  },
  "createdBy": {
    "internalUser": "N/A",
    "userName": "Kari Nordman"
  },
  "attachments": [
    {
      "id": "00P4E0000027tHNUAY",
      "name": "test_attachment.txt",
      "size": 14,
      "contentType": "text/plain",
      "createdDate": "2017-10-09T20:07:47.000+000"
    }
  ],
  "activities": [
    {
      "id": "a0z4E000000iqEYQAY",
      "date": "2017-10-09T17:21:47.000+0000",
      "content": "test comment",
      "action": "STATUS_CHANGED",
      "fieldName": "status",
      "oldValue": "New",
      "newValue": "Solved",
      "user": {
        "internalUser": false,
        "userName": "Kari Nordman"
      }
    }
  ],
  "customerReference": "string",
  "internalSubSystemReference": "string"
}

Error responses

400
Bad Request:
Error code 400001 - Missing Mandatory Inputs
Error code 400002 - Invalid Inputs
401
Unauthorized:
Error code 401001 - Invalid resource
Error code 401002 - Not Authorized
Error code 401003 - Invalid or Expired Token
404
Not Found:
Error code 404001 - Path or method not found
Error code 404002 - Data or entity not found
500
Internal Server Error:
Error code 500001 - Internal Server Error
503
Service Unavailable:
Error code 503001 - External server error
The Try-It functionality is only available when logged in to the portal.
PUT /service-tickets/v2/orders/{orderId} Update an order with the given inputs
Description Error responses Try it

Implementation notes

Update an order with the given inputs

Parameters

  • X-User-Name*
  • The name of the end-user who is logged into the client application which is being used for updating the order. This is a plain text user name, for example : Ola Nordman. This info is needed for auditing purposes
  • header
  • string
  • orderId*
  • The 'Order id' to which update has to be made. The id typically is in the format , eg : 5007A0000015EYjQAM
  • path
  • string
  • body*
  • This shall contain the parameters that requires an update. Refer to the Model Scheme for details on each param and the structure of the request object
  • body
  • Model | Model schema

    subjectstring
    Single line summary of the order
    descriptionstring
    Detailed description about the Order including any prefered date and time for delivery or other relevant information.
    reasonstring
    Reason for ordering eg: Nybestilling , Endring Or Oppsigelse
    typestring
    Order Type
    createdByCaseUser
    The name of the logged in end-user who created the order
    prioritystring
    Priority of the Order. Default is set to High
    contactContact
    Contact information of the person who will be contacted by customer service regarding the order. For example, to ask for missing information Or to change the status or priority of the order in agreement with this person. Can sometimes be the Order creator
    productstring
    Product name, set by default
    quantitynumber
    Quantity of the order
    locationstring
    Location where the order needs to be fullfilled
    orderReferencestring
    Order Reference number
    customerReferencestring
    Reference Number at source Order System. This field is also searchable, so the Order creator can enter their own reference
    organizationNumberstring
    Organization number of the customer to which this order case is attached to. An order cannot be viewed or modified without the 'System User' have access to this Organization (Company). 'System User' access is administered in Min Bedrift by the API Admin of the company
    productCategoryNamestring
    Product Category Name on which the order is created. The valid values for this parameter shall be retrieved by calling GET /order/productcategories
    productIdstring
    Product Id on which the order is created. The valid values for this parameter shall be retrieved by calling GET /order/productcategories
    productNamestring
    Product name on which the order is created. The valid values for this parameter shall be retrieved by calling GET /order/productcategories
    installationAddressAddress
    order Installation address.Optional, but should always be included

    CaseUser

    internalUserboolean
    Parameter which indicates if the case was registered by a case handling agent, if NOT it is always set to false
    userNamestring
    The name of the logged in end-user who created the incident.

    Contact

    namestring
    Name of the contact person
    emailstring
    Email address of the contact person
    phonestring
    Phone number of the contact person

    Address

    streetstring
    Street Name of the Installation Address
    floorstring
    Floor number of the Installation Address
    zipCodestring
    Zipcode of the Installation Address
    citystring
    City Name of the Installation Address
    addressIdstring
    FarId of the Installation Address
    {
  "subject": "Fornebu - Nordic Connect Multi VPN -SP - Required",
  "description": "Nordic Connect Multi VPN is required at Fornebu. Expected delivery by 11/11/2018 by 10:CET. See attachment for more info about the order",
  "reason": "Nybestilling",
  "type": "Nybestilling",
  "createdBy": {
    "internalUser": "N/A",
    "userName": "Kari Nordman"
  },
  "priority": "High",
  "contact": {
    "name": "Ola Nordman",
    "email": "ola@nordman.no",
    "phone": "4712345678"
  },
  "localContact": {
    "name": "Ola Nordman",
    "email": "ola@nordman.no",
    "phone": "4712345678"
  },
  "product": "Mobil",
  "quantity": 1,
  "location": "Oslo",
  "orderReference": "OrdRef1234",
  "customerReference": "CustRef1234",
  "organizationNumber": "string",
  "productCategoryName": "Nordic Connect",
  "productId": "string",
  "productName": "string",
  "installationAddress": {
    "street": "Fornebu",
    "floor": "H202",
    "zipCode": "1365",
    "city": "Oslo",
    "addressId": "123456"
  }
}

Response class (Status 200)

Model | Model schema

Error responses

204
OK
400
Bad Request:
Error code 400001 - Missing Mandatory Inputs
Error code 400002 - Invalid Inputs
401
Unauthorized:
Error code 401001 - Invalid resource
Error code 401002 - Not Authorized
Error code 401003 - Invalid or Expired Token
404
Not Found:
Error code 404001 - Path or method not found
Error code 404002 - Data or entity not found
500
Internal Server Error:
Error code 500001 - Internal Server Error
503
Service Unavailable:
Error code 503001 - External server error
The Try-It functionality is only available when logged in to the portal.
GET /service-tickets/v2/orders/{orderId}/activities Get the activities of an order identified by the 'Order id'
Description Error responses Try it

Implementation notes

Get the activities of an order identified by the 'Order id'. The activities typically include when the order was created, updated, closed, commented, attachment added etc

Parameters

  • orderId*
  • Order id for which the activities need to be fetched.
  • path
  • string
  • skip
  • This shall be used for pagination. The skip (aka offset) query string parameter for skipping the resultset. For instance ?skip=5&count=20 would skip the first 5 items and return the next 20 items, assuming there are atleast 25 items in the data set.
  • query
  • integer
  • count
  • This shall be used for pagination. The count (aka Limit) query string parameter for limiting the result. For instance ?skip=5&count=20 would skip the first 5 items and return the next 20 items, assuming there are atleast 25 items in the data set.
  • query
  • integer
  • sortField
  • This shall be used for sorting. This parameter indicates on which field the sort shall be applied. The sort can be applied on most parameters like e.g. caseNumber,status etc
  • query
  • string
  • order
  • This shall be used for sorting. This parameter indicates the sorting direction and shall be used along with the 'sortField' parameter. Allowed value is DESC for sorting in descending order and ASC for sorting in Ascending order
  • query
  • string

Response class (Status 200)

Model | Model schema

totalSizeinteger
The total number of available incidents matching the query
countinteger
The count of the retrieved Incidents based on the requested count in the query. Defaults to all if no specific count was requested
activitiesarray
List of Activities including details of each of them
{
  "totalSize": 2,
  "count": 1,
  "activities": [
    {
      "id": "a0z4E000000iqEYQAY",
      "date": "2017-10-09T17:21:47.000+0000",
      "content": "test comment",
      "action": "STATUS_CHANGED",
      "fieldName": "status",
      "oldValue": "New",
      "newValue": "Solved",
      "user": {
        "internalUser": false,
        "userName": "Kari Nordman"
      },
      "ticket": {
        "id": "5004E000003uH0YQAU",
        "caseNumber": "Case-00001234",
        "subject": "Oslo - Ustabilitet - No connection",
        "location": "Oslo",
        "productCategoryName": "Nordic Connect",
        "incidentType": "Ustabilitet"
      }
    }
  ]
}

Error responses

400
Bad Request:
Error code 400001 - Missing Mandatory Inputs
Error code 400002 - Invalid Inputs
401
Unauthorized:
Error code 401001 - Invalid resource
Error code 401002 - Not Authorized
Error code 401003 - Invalid or Expired Token
404
Not Found:
Error code 404001 - Path or method not found
Error code 404002 - Data or entity not found
500
Internal Server Error:
Error code 500001 - Internal Server Error
503
Service Unavailable:
Error code 503001 - External server error
The Try-It functionality is only available when logged in to the portal.
GET /service-tickets/v2/orders/{orderId}/activities/{activityId} Get details of a specific activity of an order
Description Error responses Try it

Implementation notes

Get the activities of a given order identified by 'order Id' and 'activity id'

Parameters

  • orderId*
  • 'Order id' of the order for which the activity need to be fetched.
  • path
  • string
  • activityId*
  • Orders 'activity id' for which the details need to be fetched. The activity id is typically in the format, eg : a0u7A0000002msNQAQ
  • path
  • string

Response class (Status 200)

Model | Model schema

idstring
Unique Id of the given activity
datestring
Date when this activity was created
contentstring
Actual content of the Activity
actionstring
What the activity was
fieldNamestring
If this is a field update activity, the field that was updated is returned here
oldValuestring
If this is a field update activity, this contains the old value that was in the field
newValuestring
If this is a field update activity, this contains the new value that was entered in the field
userCaseUser
Name of the user who created this activity

CaseUser

internalUserboolean
Parameter which indicates if the case was registered by a case handling agent, if NOT it is always set to false
userNamestring
The name of the logged in end-user who created the incident.
{
  "id": "a0z4E000000iqEYQAY",
  "date": "2017-10-09T17:21:47.000+0000",
  "content": "test comment",
  "action": "STATUS_CHANGED",
  "fieldName": "status",
  "oldValue": "New",
  "newValue": "Solved",
  "user": {
    "internalUser": "N/A",
    "userName": "Kari Nordman"
  }
}

Error responses

400
Bad Request:
Error code 400001 - Missing Mandatory Inputs
Error code 400002 - Invalid Inputs
401
Unauthorized:
Error code 401001 - Invalid resource
Error code 401002 - Not Authorized
Error code 401003 - Invalid or Expired Token
404
Not Found:
Error code 404001 - Path or method not found
Error code 404002 - Data or entity not found
500
Internal Server Error:
Error code 500001 - Internal Server Error
503
Service Unavailable:
Error code 503001 - External server error
The Try-It functionality is only available when logged in to the portal.
GET /service-tickets/v2/orders/{orderId}/attachments Get the list of all attachments for a given order
Description Error responses Try it

Implementation notes

Get the list of all attachments for a given order identified by its 'order id'

Parameters

  • X-Saml-Token*
  • SAML Token value which will be generated based on User / System logon
  • header
  • string
  • X-Application-Id*
  • Application Id of the logged in User / System
  • header
  • string
  • orderId*
  • 'Order id' of the order for which the attachment has to be fetched
  • path
  • string

Response class (Status 200)

Model | Model schema

idstring
Unique Id of the attachment
namestring
The name of the file along with its extension. Eg:Router_Light_Status.jpg
sizeinteger
Size of the file in bytes
contentTypestring
The content type of the file. Eg: image/jpg
createdDatestring
The date when the file was attached
[{
  "id": "00P4E0000027tHNUAY",
  "name": "test_attachment.txt",
  "size": 14,
  "contentType": "text/plain",
  "createdDate": "2017-10-09T20:07:47.000+000"
}]

Error responses

400
Bad Request:
Error code 400001 - Missing Mandatory Inputs
Error code 400002 - Invalid Inputs
401
Unauthorized:
Error code 401001 - Invalid resource
Error code 401002 - Not Authorized
Error code 401003 - Invalid or Expired Token
404
Not Found:
Error code 404001 - Path or method not found
Error code 404002 - Data or entity not found
500
Internal Server Error:
Error code 500001 - Internal Server Error
503
Service Unavailable:
Error code 503001 - External server error
The Try-It functionality is only available when logged in to the portal.
POST /service-tickets/v2/orders/{orderId}/attachments Adds an attachment for a given Order
Description Error responses Try it

Implementation notes

Adds an attachment for a given Order

Parameters

  • X-User-Name*
  • The name of the end-user who is logged into the client application which is being used for updating the incident. This is a plain text user name, for example : Ola Nordman. This info is needed for auditing purposes
  • header
  • string
  • orderId*
  • order Id to which attachment to be added
  • path
  • string
  • file
  • Attachment to be added
  • formData
  • file
  • contentType
  • Content Type of the Attachment to be added
  • formData
  • string

Response class (Status 200)

Model | Model schema

idstring
Attachment Id is a technical id typically NOT shown to the end user in the UI but is the id that is used in the actual API calls
{
  "id": "00P4E000001yZzrUAE"
}

Error responses

201
OK
400
Bad Request:
Error code 400001 - Missing Mandatory Inputs
Error code 400002 - Invalid Inputs
401
Unauthorized:
Error code 401001 - Invalid resource
Error code 401002 - Not Authorized
Error code 401003 - Invalid or Expired Token
404
Not Found:
Error code 404001 - Path or method not found
Error code 404002 - Data or entity not found
500
Internal Server Error:
Error code 500001 - Internal Server Error
503
Service Unavailable:
Error code 503001 - External server error
The Try-It functionality is only available when logged in to the portal.
GET /service-tickets/v2/orders/{orderId}/attachments/{attachmentId} Get a specific attachment for a given order
Description Error responses Try it

Implementation notes

Get a specific attachment for a given order, identified by an order Id and attachment id.The response will contain the file which can be downloaded directly.

Parameters

  • orderId*
  • The 'order id' to which update has to be made. The id typically is in the format, eg : 5007A0000015EYjQAM
  • path
  • string
  • attachmentId*
  • The 'order id' of the order attachment to be fetched. The id typically is in the format, eg : 00P7E000002xhiHUAQ
  • path
  • string

Response class (Status 200)

Model | Model schema 

{}

Error responses

400
Bad Request:
Error code 400001 - Missing Mandatory Inputs
Error code 400002 - Invalid Inputs
401
Unauthorized:
Error code 401001 - Invalid resource
Error code 401002 - Not Authorized
Error code 401003 - Invalid or Expired Token
404
Not Found:
Error code 404001 - Path or method not found
Error code 404002 - Data or entity not found
500
Internal Server Error:
Error code 500001 - Internal Server Error
503
Service Unavailable:
Error code 503001 - External server error
The Try-It functionality is only available when logged in to the portal.
DELETE /service-tickets/v2/orders/{orderId}/attachments/{attachmentId} Delete a specific attachment for a given order
Description Error responses Try it

Implementation notes

Delete a specific attachment for a given order

Parameters

  • X-User-Name*
  • The name of the end-user who is logged into the client application which is being used for updating the incident. This is a plain text user name, for example : Ola Nordman. This info is needed for auditing purposes
  • header
  • string
  • orderId*
  • The 'Order id' to which update has to be made. The id typically is in the format , eg : 5007A0000015EYjQAM
  • path
  • string
  • attachmentId*
  • The 'attachment id' of attachment which has to be deleted. The id typically is in the format, eg : 00P7E000002xhiHUAQ. Both attachmentId and exact fileName with extension is required.
  • path
  • string
  • fileName*
  • The file name of the attachment which has to be deleted. Example : screenshot_1.jpeg
  • query
  • string

Response class (Status 200)

Model | Model schema

Error responses

400
Bad Request:
Error code 400001 - Missing Mandatory Inputs
Error code 400002 - Invalid Inputs
401
Unauthorized:
Error code 401001 - Invalid resource
Error code 401002 - Not Authorized
Error code 401003 - Invalid or Expired Token
404
Not Found:
Error code 404001 - Path or method not found
Error code 404002 - Data or entity not found
500
Internal Server Error:
Error code 500001 - Internal Server Error
503
Service Unavailable:
Error code 503001 - External server error
The Try-It functionality is only available when logged in to the portal.
GET /service-tickets/v2/orders/{orderId}/comments Get a list of Comments for a given Order Id
Description Error responses Try it

Implementation notes

Get a list of Comments for a given Order Id

Parameters

  • orderId*
  • Order Id to which the comments have to be fetched
  • path
  • string

Response class (Status 200)

Model | Model schema

idstring
Comment Id
createdDatestring
Comment Creation Date
commentBodystring
Actual Comments
[{
  "id": "00a4E000000YRpqQAG",
  "createdDate": "2017-08-31T10:01:31.000+0000",
  "commentBody": "Hello!!!"
}]

Error responses

400
Bad Request:
Error code 400001 - Missing Mandatory Inputs
Error code 400002 - Invalid Inputs
401
Unauthorized:
Error code 401001 - Invalid resource
Error code 401002 - Not Authorized
Error code 401003 - Invalid or Expired Token
404
Not Found:
Error code 404001 - Path or method not found
Error code 404002 - Data or entity not found
500
Internal Server Error:
Error code 500001 - Internal Server Error
503
Service Unavailable:
Error code 503001 - External server error
The Try-It functionality is only available when logged in to the portal.
POST /service-tickets/v2/orders/{orderId}/comments Add a comment to a given order
Description Error responses Try it

Implementation notes

Add a comment to a given order. This also generates an activity

Parameters

  • X-User-Name*
  • The name of the end-user who is logged into the client application which is being adding the comment to the order. This is a plain text user name, for example : Ola Nordman. This info is needed for auditing purposes
  • header
  • string
  • orderId*
  • The 'Order id' to which the comment has to be added. The id typically is in the format , eg : 5007A0000015EYjQAM
  • path
  • string
  • body
  • This shall contain the comment text. Refer to the Model Scheme for structure of the request object
  • body
  • Model | Model schema

    textstring
    Actual Comment
    userNamestring
    Name of the user who adds the Comment
    {
  "text": "Hello!!!",
  "userName": "Ola Nordman"
}

Response class (Status 200)

Model | Model schema

idstring
Comment Id is a technical id typically NOT shown to the end user in the UI but is the id that is used in the actual API calls
{
  "id": "00a4E000000YRpqQAG"
}

Error responses

400
Bad Request:
Error code 400001 - Missing Mandatory Inputs
Error code 400002 - Invalid Inputs
401
Unauthorized:
Error code 401001 - Invalid resource
Error code 401002 - Not Authorized
Error code 401003 - Invalid or Expired Token
404
Not Found:
Error code 404001 - Path or method not found
Error code 404002 - Data or entity not found
500
Internal Server Error:
Error code 500001 - Internal Server Error
503
Service Unavailable:
Error code 503001 - External server error
The Try-It functionality is only available when logged in to the portal.
PUT /service-tickets/v2/orders/{orderId}/contact Update a contact for a given order
Description Error responses Try it

Implementation notes

This resource shall be used for updating the main Case contact

Parameters

  • X-User-Name*
  • The name of the end-user who is logged into the client application which is being used for updating the contact. This is a plain text user name, for example : Ola Nordman. This info is needed for auditing purposes
  • header
  • string
  • orderId*
  • The 'Order id' to which Contact has to be updated. The id typically is in the format , eg : 5007A0000015EYjQAM
  • path
  • string
  • body*
  • This shall contain all the details to update a contact. Refer to the Model Scheme for details on each param and the structure of the request object
  • body
  • Model | Model schema

    namestring
    Name of the contact person
    emailstring
    Email address of the contact person
    phonestring
    Phone number of the contact person
    {
  "name": "Ola Nordman",
  "email": "ola@nordman.no",
  "phone": "4712345678"
}

Response class (Status 200)

Model | Model schema

Error responses

204
OK
400
Bad Request:
Error code 400001 - Missing Mandatory Inputs
Error code 400002 - Invalid Inputs
401
Unauthorized:
Error code 401001 - Invalid resource
Error code 401002 - Not Authorized
Error code 401003 - Invalid or Expired Token
404
Not Found:
Error code 404001 - Path or method not found
Error code 404002 - Data or entity not found
500
Internal Server Error:
Error code 500001 - Internal Server Error
503
Service Unavailable:
Error code 503001 - External server error
The Try-It functionality is only available when logged in to the portal.
PUT /service-tickets/v2/orders/{orderId}/localcontact Update an order with the given local contact. Local contact is the person at the site where the order requested
Description Error responses Try it

Implementation notes

Update an order with the given local contact. Local contact is the person at the site where the order requested

Parameters

  • X-User-Name*
  • The name of the end-user who is logged into the client application which is being used for updating the incident. This is a plain text user name, for example : Ola Nordman. This info is needed for auditing purposes
  • header
  • string
  • orderId*
  • The 'Order id' to which local contact has to be updated. The id typically is in the format , eg : 5007A0000015EYjQAM
  • path
  • string
  • body*
  • This shall contain all the details to update a local contact. Refer to the Model Scheme for details on each param and the structure of the request object
  • body
  • Model | Model schema

    namestring
    Name of the contact person
    emailstring
    Email address of the contact person
    phonestring
    Phone number of the contact person
    {
  "name": "Ola Nordman",
  "email": "ola@nordman.no",
  "phone": "4712345678"
}

Response class (Status 200)

Model | Model schema

Error responses

204
OK
400
Bad Request:
Error code 400001 - Missing Mandatory Inputs
Error code 400002 - Invalid Inputs
401
Unauthorized:
Error code 401001 - Invalid resource
Error code 401002 - Not Authorized
Error code 401003 - Invalid or Expired Token
404
Not Found:
Error code 404001 - Path or method not found
Error code 404002 - Data or entity not found
500
Internal Server Error:
Error code 500001 - Internal Server Error
503
Service Unavailable:
Error code 503001 - External server error
The Try-It functionality is only available when logged in to the portal.
DELETE /service-tickets/v2/orders/{orderId}/localcontact Deletes a Local Contact for a given Order
Description Error responses Try it

Implementation notes

Deletes a Local Contact for a given Order

Parameters

  • X-User-Name*
  • The name of the end-user who is logged into the client application which is being used for updating the incident. This is a plain text user name, for example : Ola Nordman. This info is needed for auditing purposes
  • header
  • string
  • orderId*
  • The 'Order id' to which Local contact has to be deleted. The id typically is in the format , eg : 5007A0000015EYjQAM
  • path
  • string

Response class (Status 200)

Model | Model schema

Error responses

204
OK
400
Bad Request:
Error code 400001 - Missing Mandatory Inputs
Error code 400002 - Invalid Inputs
401
Unauthorized:
Error code 401001 - Invalid resource
Error code 401002 - Not Authorized
Error code 401003 - Invalid or Expired Token
404
Not Found:
Error code 404001 - Path or method not found
Error code 404002 - Data or entity not found
500
Internal Server Error:
Error code 500001 - Internal Server Error
503
Service Unavailable:
Error code 503001 - External server error
The Try-It functionality is only available when logged in to the portal.