Versions Compared

Version Old Version 8 New Version 9
Changes made by

Jason Andrew

Jason Andrew

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Published by Scroll Versions from space SBUD and version 5

Status
colourGreen
title5.4.0

A pass-through API to ServiceDispatch (when configured) which allows the ServiceDispatch's "Update Request for Authorization" API to be called.

Panel
borderColorgrey
bgColorwhitesmoke
borderStylesolid

On this page:

Table of Contents
maxLevel2

Related pages:

Resource URL Summary

Panel
borderColorgrey
bgColorwhitesmoke
borderStylesolid

Pass Through Call to ServiceDispatch's "Update Request for Authorization" API

PUT /up/v5/serviceAuthorizations/status/${id}

Include Page
_Default HTTP Headers
_Default HTTP Headers

API Specific Parameters

ParameterTypeRequired?Description

${id}

integer

Yes

The Request for Authorization ID to be updated.

API Specifics

Panel
borderColor#D3D3D3

Pass Through Call to ServiceDispatch's "Update Request for Authorization" API

This RESTified API will perform a pass-through call to the ServiceDispatch sub-system's "Update Request for Authorization" API (when configured).

URL

Panel
borderColorgrey
bgColorwhitesmoke
borderStylesolid

POST /up/v5/serviceAuthorizations/status/${id}

HTTP Request Body

This request requires a JSON object supplied in the HTTP request body, which defines the parameters that will be passed through to the ServiceDispatch "Update Request for Authorization" API.  

UpdateRequestForAuthorization Object Format

Code Block
languagejs
{
    "ApprovedAmounts": {
        "AuthorizedLabor": 250,
        "AuthorizedLaborTax": 0,
        "AuthorizedMiles": 75,
        "AuthorizedMileage": 41.25,
        "AuthorizedOther": 0,
        "AuthorizedOtherTax": 0,
        "AuthorizedParts": 5.50,
        "AuthorizedPartsTax": 0,
        "AuthorizedShipping": 0,
        "AuthorizedFreight": 0,
        "AuthorizedTax": 0,
        "AuthorizedTravel": 0
    },
    "Notes": {
        "NotesOnly": "Y",
        "InternalNotes": "INTERNAL NOTES",
        "InternalNotesReason": "OTH",
        "ServicerNotes": "SERVICERNOTES",
        "ServicerNotesReason": "OTH"
    },
    "StatusInfo": {
        "NewStatus": "WAI",
        "StatusChangeReason": ""
    },
    "RequiredParts": [
        {
            "Qty": 1,
            "ProdAttrs": {
                "SequenceNumber": 1,
                "SubRequestNumber": "8999290-01"
            }
        }
    ],
    "ApproveOrRejectInfo": {
        "ApprovedOrAdditionalInformationRequestNotes": "TEST INFO X",
        "ChangedBy": "AUSERID",
        "ReasonCode": ""
    }
}

UpdateRequestForAuthorization Object Properties

PropertyTypeRequired?DescriptionServiceDispatch Field Mapping
ApprovedAmountsobjectNo

Pass through parameter to the ServiceDispatch "Update Request for Authorization" API.

ApprovedAmounts

AuthorizedLaborintegerNoPass through parameter to the ServiceDispatch "Update Request for Authorization" API.AuthorizedLabor

AuthorizedLaborTaxintegerNoPass through parameter to the ServiceDispatch "Update Request for Authorization" API.AuthorizedLaborTax

AuthorizedMilesintegerNoPass through parameter to the ServiceDispatch "Update Request for Authorization" API.AuthorizedMiles

AuthorizedMileagefloatNoPass through parameter to the ServiceDispatch "Update Request for Authorization" API.AuthorizedMileage

AuthorizedOtherintegerNoPass through parameter to the ServiceDispatch "Update Request for Authorization" API.AuthorizedOther

AuthorizedOtherTaxintegerNoPass through parameter to the ServiceDispatch "Update Request for Authorization" API.AuthorizedOtherTax

AuthorizedPartsfloatNoPass through parameter to the ServiceDispatch "Update Request for Authorization" API.AuthorizedParts

AuthorizedPartsTaxintegerNoPass through parameter to the ServiceDispatch "Update Request for Authorization" API.AuthorizedPartsTax

AuthorizedShippingintegerNoPass through parameter to the ServiceDispatch "Update Request for Authorization" API.AuthorizedShipping

AuthorizedFreightintegerNoPass through parameter to the ServiceDispatch "Update Request for Authorization" API.AuthorizedFreight

AuthorizedTaxintegerNoPass through parameter to the ServiceDispatch "Update Request for Authorization" API.AuthorizedTax

AuthorizedTravelintegerNoPass through parameter to the ServiceDispatch "Update Request for Authorization" API.AuthorizedTravel
NotesobjectNoPass through parameter to the ServiceDispatch "Update Request for Authorization" API.Notes

NotesOnlystringNoPass through parameter to the ServiceDispatch "Update Request for Authorization" API.NotesOnly

InternalNotesstringNoPass through parameter to the ServiceDispatch "Update Request for Authorization" API.InternalNotes

InternalNotesReasonstringNoPass through parameter to the ServiceDispatch "Update Request for Authorization" API.InternalNotesReason

ServicerNotesstringNoPass through parameter to the ServiceDispatch "Update Request for Authorization" API.ServicerNotes

ServicerNotesReasonstringNoPass through parameter to the ServiceDispatch "Update Request for Authorization" API.ServicerNotesReason
StatusInfoobjectNoPass through parameter to the ServiceDispatch "Update Request for Authorization" API.StatusInfo

NewStatusstringNoPass through parameter to the ServiceDispatch "Update Request for Authorization" API.NewStatus

StatusChangeReasonstringNoPass through parameter to the ServiceDispatch "Update Request for Authorization" API.StatusChangeReason
RequiredPartsarrayNoPass through parameter to the ServiceDispatch "Update Request for Authorization" API.RequiredParts

QtyintegerNoPass through parameter to the ServiceDispatch "Update Request for Authorization" API.Qty

ProdAttrsobjectNoPass through parameter to the ServiceDispatch "Update Request for Authorization" API.ProdAttrs


SequenceNumberintegerNoPass through parameter to the ServiceDispatch "Update Request for Authorization" API.SequenceNumber


SubRequestNumberstringNoPass through parameter to the ServiceDispatch "Update Request for Authorization" API.SubRequestNumber
ApproveOrRejectInfoobjectNoPass through parameter to the ServiceDispatch "Update Request for Authorization" API.ApproveOrRejectInfo

ApprovedOrAdditionalInformationRequestNotesstringNoPass through parameter to the ServiceDispatch "Update Request for Authorization" API.ApprovedOrAdditionalInformationRequestNotes

ChangedBystringNoPass through parameter to the ServiceDispatch "Update Request for Authorization" API.ChangedBy

ReasonCodestringNoPass through parameter to the ServiceDispatch "Update Request for Authorization" API.ReasonCode  

HTTP Response

Success

On success, a JSON-formatted version of the ServiceDispatch "Update Request for Authorization" API response will be returned.

Code Block
languagejs
{
    "Success": true,
    "Code": 0,
    "Message": "OK"
}

Error

On error, a JSON-formatted version of the ServiceDispatch "Update Request for Authorization" API response will be returned.

Code Block
languagejs
{
    "Success": false,
    "Code": 9,
    "Payload": {
        "returnCode": {
            "type": "Error",
            "message": "Dispatch Error Code"
        }
    }
}

Return Codes

In addition to the Standard Return Codes, and the ServiceDispatch Error codes, individual API calls made have unique codes found on their individual pages.