TrackingCode

Perform various operations for Symitar parameters.

Symitar eDocs References: Coming soon.

Operations

getTrackingCode

post

No description available.

Authorizations
Body
TrackingCodeCodeintegerRequired
Responses
200

Successful operation.

application/json
post
/getTrackingCode
POST /nexum/627/2022.01/parameter/getTrackingCode HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 145

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "TrackingCodeCode": 1,
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "TrackingCode": {
    "Description": "text",
    "Code": 1
  }
}

getTrackingCodeSelectFields

post

No description available.

Authorizations
Body
TrackingCodeCodeintegerOptional
Responses
200

Successful operation.

application/json
post
/getTrackingCodeSelectFields
POST /nexum/627/2022.01/parameter/getTrackingCodeSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 256

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "TrackingCodeCode": 1,
  "SelectableFields": {
    "IncludeAllTrackingCodeFields": true,
    "TrackingCodeFields": {
      "Code": true,
      "Description": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "TrackingCode": {
    "Description": "text",
    "Code": 1
  }
}

getTrackingCodePagedList

post

No description available.

Authorizations
Body
Responses
200

Successful operation.

application/json
post
/getTrackingCodePagedList
POST /nexum/627/2022.01/parameter/getTrackingCodePagedList HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 218

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 1,
    "Token": "text"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "TrackingCode": [
    {
      "Description": "text",
      "Code": 1
    }
  ],
  "Token": "text"
}

getTrackingCodeListSelectFields

post

No description available.

Authorizations
Body
Responses
200

Successful operation.

application/json
post
/getTrackingCodeListSelectFields
POST /nexum/627/2022.01/parameter/getTrackingCodeListSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 235

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "SelectableFields": {
    "IncludeAllTrackingCodeFields": true,
    "TrackingCodeFields": {
      "Code": true,
      "Description": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "TrackingCodeList": {
    "hasReachedMaximumListSize": true,
    "TrackingCode": [
      {
        "Description": "text",
        "Code": 1
      }
    ]
  }
}

searchTrackingCodeSelectFields

post

Fields available for selecting when retrieving Tracking Code data

Authorizations
Body
Responses
200

Successful operation.

application/json
post
/searchTrackingCodeSelectFields
POST /nexum/627/2022.01/parameter/searchTrackingCodeSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 267

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "SelectableFields": {
    "IncludeAllTrackingCodeFields": true,
    "TrackingCodeFields": {
      "Code": true,
      "Description": true
    }
  },
  "SearchFilter": {
    "Query": "text"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "TrackingCodeList": {
    "hasReachedMaximumListSize": true,
    "TrackingCode": [
      {
        "Description": "text",
        "Code": 1
      }
    ]
  }
}

getTrackingCodePagedListSelectFields

post

No description available.

Authorizations
Body
Responses
200

Successful operation.

application/json
post
/getTrackingCodePagedListSelectFields
POST /nexum/627/2022.01/parameter/getTrackingCodePagedListSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 329

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 1,
    "Token": "text"
  },
  "SelectableFields": {
    "IncludeAllTrackingCodeFields": true,
    "TrackingCodeFields": {
      "Code": true,
      "Description": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "TrackingCode": [
    {
      "Description": "text",
      "Code": 1
    }
  ],
  "Token": "text"
}

searchTrackingCodePagedSelectFields

post

Fields available for selecting when retrieving paginated Tracking Code data

Authorizations
Body
QuerystringOptional
Responses
200

Successful operation.

application/json
post
/searchTrackingCodePagedSelectFields
POST /nexum/627/2022.01/parameter/searchTrackingCodePagedSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 344

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 1,
    "Token": "text"
  },
  "SelectableFields": {
    "IncludeAllTrackingCodeFields": true,
    "TrackingCodeFields": {
      "Code": true,
      "Description": true
    }
  },
  "Query": "text",
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "TrackingCode": [
    {
      "Description": "text",
      "Code": 1
    }
  ],
  "Token": "text"
}

updateTrackingCodeByID

post

Update tracking codes by ID

Authorizations
Body
TrackingCodeCodeintegerOptional
Responses
200

Successful operation.

application/json
post
/updateTrackingCodeByID
POST /nexum/627/2022.01/parameter/updateTrackingCodeByID HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 198

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "TrackingCodeCode": 1,
  "TrackingCodeUpdatableFields": {
    "Description": "text"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "UpdateStatus": {
    "isAllFieldsUpdateSuccess": true,
    "FailedUpdateStatus": [
      {
        "Record": "text",
        "ErrorCode": "text",
        "ErrorMessage": "text",
        "PrimaryKeyField": [
          {
            "Name": "text",
            "Value": "text"
          }
        ]
      }
    ]
  }
}
PreviousTptNextUserFm

Last updated

Was this helpful?