Status

colour	Green
title	5.4.0

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

Panel

borderColor	grey
bgColor	whitesmoke
borderStyle	solid

On this page:

Table of Contents

maxLevel	2

Related pages:

Resource URL Summary

Claim

Panel

borderColor	grey
bgColor	whitesmoke
borderStyle	solid

Pass Through Call to Dispatch's "Create or Update Request for Authorization" API

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

Include Page

	_Default HTTP Headers
	_Default HTTP Headers

API Specific Parameters

Parameter	Type	Required?	Description
`${id}`	`integer`	Yes	The Request for Authorization ID to be created or updated.

API Specifics

Panel

borderColor	#D3D3D3

Pass Through Call to Dispatch's "Create or Update Request for Authorization" API

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

URL

Panel

borderColor	grey
bgColor	whitesmoke
borderStyle	solid

POST /up/v5/serviceAuthorizations/${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 Dispatch "Create or Update Request for Authorization" APi.

CreateOrUpdateRequestForAuthorization Object Format

Code Block

language	js

{
    "CoreInfo": {
        "JobCode": ""
    },
	"WhyAdditionalManOnTheJobQuestions": [
        {
            "ChoiceId": "1",
            "ResponseText": "44"
        }
    ],
    "Notes": {
        "NotesOnly": "Y",
        "InternalNotes": "INTERNAL NOTES",
        "InternalNotesReason": "OTH",
        "ServicerNotes": "SERVICERNOTES",
        "ServicerNotesReason": "OTH"
    },
    "ShippingInfo": {
        "AlternateAddressSequence": "0",
        "Recipient": "S",
        "ShippingOption": "GRD",
        "CompanyName": "4efqrafaf",
        "FirstName": "4efqrafaf",
        "LastName": "4efqrafaf",
        "Phone": "8585551212",
        "Email": "asdfa@dafda.com",
        "Address1": "13 MY STREET",
        "Address2": "SUITE 100",
        "City": "ALPINE",
        "Region": "CA",
        "PostalCode": "92100"
    },
    "ApproveOrRejectInfo": {
        "approvedOrAdditionalInformationRequestNotes": "TEST INFO",
        "ChangedBy": "AUSERID",
        "ReasonCode": ""
    },
    "OtherInfo": {
        "AdditionalManRequired": "Y",
        "CostEffectiveToRepair": "Y",
        "EstimatedHoursOnJob": 999,
        "EstimatedMinutesOnJob": 999,
        "IsProductRepaired": "N",
        "LaborInWarranty": "N",
        "OemAuthorizedWithManufacturer": "N",
        "PartsInWarranty": "N",
        "PickUpUnitRequired": "N",
        "WhyHigherRate": "THIS IS WHY I NEED A HIGHER RATE"
    },
    "ProblemInfo": {
        "RepairDescription": "THIS IS THE PROBLEM",
        "FaultCode": ""
    },
    "Asset": {
        "Mfg": "GENERAL TIME CORPORA",
        "Model": "NHT712AUC",
        "SerialNum": "789768644"
    },
    "ServicerInfo": {
        "ServicerOnSite": "N"
    },
    "Amounts": {
        "RequestedLabor": 250,
        "RequestedLaborTax": 0,
        "RequestedMiles": 75,
        "RequestedRatePerMile": 0.55,
        "RequestedOther": 0,
        "RequestedOtherTax": 0,
        "RequestedPartsTax": 0,
        "RequestedShipping": 0,
        "RequestedFreight": 0,
        "RequestedTax": 0,
        "RequestedTravel": 0
    },
    "RequiredParts": [
        {
            "ProdNum": "PARTNUM",
            "Qty": 1,
            "ProdAttrs": {
                "SerialNo": 0,
                "Desc": "PARTNUM DESC",
                "UnitCost": 5.50,
                "NlaFlag": "Y",
                "UnderWarranty": "N",
                "SelfSourced": "N"
            }
        }
    ],
    "StatusInfo": {
        "NewStatus": "APV",
        "StatusChangeReason": ""
    }
}

CreateOrUpdateRequestForAuthorization Object Properties

Property			Type	Required?	Description	Dispatch Field Mapping
`CoreInfo`			`object`	No	Pass through parameter to the Dispatch "Create or Update Request for Authorization" API.	`CoreInfo`
	`JobCode`		`string`	No	Pass through parameter to the Dispatch "Create or Update Request for Authorization" API.	`JobCode`
`WhyAdditionalManOnTheJobQuestions`			`array`	No	Pass through parameter to the Dispatch "Create or Update Request for Authorization" API.	`WhyAdditionalManOnTheJobQuestions`
	`ChoiceId`		`string`	No	Pass through parameter to the Dispatch "Create or Update Request for Authorization" API.	ChoiceId
	`ResponseText`		`string`	No	Pass through parameter to the Dispatch "Create or Update Request for Authorization" API.	ResponseText
`Notes`			`object`	No	Pass through parameter to the Dispatch "Create or Update Request for Authorization" API.	`Notes`
	`NotesOnly`		`string`	No	Pass through parameter to the Dispatch "Create or Update Request for Authorization" API.	`NotesOnly`
	`InternalNotes`		`string`	No	Pass through parameter to the Dispatch "Create or Update Request for Authorization" API.	`InternalNotes`
	`InternalNotesReason`		`string`	No	Pass through parameter to the Dispatch "Create or Update Request for Authorization" API.	`InternalNotesReason`
	`ServicerNotes`		`string`	No	Pass through parameter to the Dispatch "Create or Update Request for Authorization" API.	`ServicerNotes`
	`ServicerNotesReason`		`string`	No	Pass through parameter to the Dispatch "Create or Update Request for Authorization" API.	`ServicerNotesReason`
`ShippingInfo`			`object`	No	Pass through parameter to the Dispatch "Create or Update Request for Authorization" API.	`ShippingInfo`
	`AdditionalManRequired`		`string`	No	Pass through parameter to the Dispatch "Create or Update Request for Authorization" API.	`AdditionalManRequired`
	`Recipient`		`string`	No	Pass through parameter to the Dispatch "Create or Update Request for Authorization" API.	`Recipient`
	`ShippingOption`		`string`	No	Pass through parameter to the Dispatch "Create or Update Request for Authorization" API.	`ShippingOption`
	`CompanyName`		`string`	No	Pass through parameter to the Dispatch "Create or Update Request for Authorization" API.	`CompanyName`
	`FirstName`		`string`	No	Pass through parameter to the Dispatch "Create or Update Request for Authorization" API.	`FirstName`
	`LastName`		`string`	No	Pass through parameter to the Dispatch "Create or Update Request for Authorization" API.	`LastName`
	`Phone`		`string`	No	Pass through parameter to the Dispatch "Create or Update Request for Authorization" API.	`Phone`
	`Email`		`string`	No	Pass through parameter to the Dispatch "Create or Update Request for Authorization" API.	`Email`
	`Address1`		`string`	No	Pass through parameter to the Dispatch "Create or Update Request for Authorization" API.	`Address1`
	`Address2`		`string`	No	Pass through parameter to the Dispatch "Create or Update Request for Authorization" API.	`Address2`
	`City`		`string`	No	Pass through parameter to the Dispatch "Create or Update Request for Authorization" API.	`City`
	`Region`		`string`	No	Pass through parameter to the Dispatch "Create or Update Request for Authorization" API.	`Region`
	`PostalCode`		`string`	No	Pass through parameter to the Dispatch "Create or Update Request for Authorization" API.	`PostalCode`
`ApproveOrRejectInfo`			`object`	No	Pass through parameter to the Dispatch "Create or Update Request for Authorization" API.	`ApproveOrRejectInfo`
	`approvedOrAdditionalInformationRequestNotes`		`string`	No	Pass through parameter to the Dispatch "Create or Update Request for Authorization" API.	`approvedOrAdditionalInformationRequestNotes`
	`ChangedBy`		`string`	No	Pass through parameter to the Dispatch "Create or Update Request for Authorization" API.	`ChangedBy`
	`ReasonCode`		`string`	No	Pass through parameter to the Dispatch "Create or Update Request for Authorization" API.	`ReasonCode`
`OtherInfo`			`object`	No	Pass through parameter to the Dispatch "Create or Update Request for Authorization" API.	`OtherInfo`
	`AdditionalManRequired`		`string`	No	Pass through parameter to the Dispatch "Create or Update Request for Authorization" API.	`AdditionalManRequired`
	`CostEffectiveToRepair`		`string`	No	Pass through parameter to the Dispatch "Create or Update Request for Authorization" API.	`CostEffectiveToRepair`
	`EstimatedHoursOnJob`		`integer`	No	Pass through parameter to the Dispatch "Create or Update Request for Authorization" API.	`EstimatedHoursOnJob`
	`EstimatedMinutesOnJob`		`integer`	No	Pass through parameter to the Dispatch "Create or Update Request for Authorization" API.	`EstimatedMinutesOnJob`
	`IsProductRepaired`		`string`	No	Pass through parameter to the Dispatch "Create or Update Request for Authorization" API.	`IsProductRepaired`
	`LaborInWarranty`		`string`	No	Pass through parameter to the Dispatch "Create or Update Request for Authorization" API.	`LaborInWarranty`
	`OemAuthorizedWithManufacturer`		`string`	No	Pass through parameter to the Dispatch "Create or Update Request for Authorization" API.	`OemAuthorizedWithManufacturer`
	`PartsInWarranty`		`string`	No	Pass through parameter to the Dispatch "Create or Update Request for Authorization" API.	`PartsInWarranty`
	`PickUpUnitRequired`		`string`	No	Pass through parameter to the Dispatch "Create or Update Request for Authorization" API.	`PickUpUnitRequired`
	`WhyHigherRate`		`string`	No	Pass through parameter to the Dispatch "Create or Update Request for Authorization" API.	`WhyHigherRate`
`ProblemInfo`			`object`	No	Pass through parameter to the Dispatch "Create or Update Request for Authorization" API.	`ProblemInfo`
	`RepairDescription`		`string`	No	Pass through parameter to the Dispatch "Create or Update Request for Authorization" API.	`RepairDescription`
	`FaultCode`		`string`	No	Pass through parameter to the Dispatch "Create or Update Request for Authorization" API.	`FaultCode`
`Asset`			`object`	No	Pass through parameter to the Dispatch "Create or Update Request for Authorization" API.	`Asset`
	`Mfg`		`string`	No	Pass through parameter to the Dispatch "Create or Update Request for Authorization" API.	`Mfg`
	`Model`		`string`	No	Pass through parameter to the Dispatch "Create or Update Request for Authorization" API.	`Model`
	`SerialNum`		`string`	No	Pass through parameter to the Dispatch "Create or Update Request for Authorization" API.	`SerialNum`
`ServicerInfo`			`object`	No	Pass through parameter to the Dispatch "Create or Update Request for Authorization" API.	`ServicerInfo`
	`ServicerOnSite`		`string`	No	Pass through parameter to the Dispatch "Create or Update Request for Authorization" API.	`ServicerOnSite`
`Amounts`			`object`	No	Pass through parameter to the Dispatch "Create or Update Request for Authorization" API.	`Amounts`
	`RequestedLabor`		`integer`	No	Pass through parameter to the Dispatch "Create or Update Request for Authorization" API.	`RequestedLabor`
	`RequestedLaborTax`		`integer`	No	Pass through parameter to the Dispatch "Create or Update Request for Authorization" API.	`RequestedLaborTax`
	`RequestedMiles`		`integer`	No	Pass through parameter to the Dispatch "Create or Update Request for Authorization" API.	`RequestedMiles`
	`RequestedRatePerMile`		`float`	No	Pass through parameter to the Dispatch "Create or Update Request for Authorization" API.	`RequestedRatePerMile`
	`RequestedOther`		`integer`	No	Pass through parameter to the Dispatch "Create or Update Request for Authorization" API.	`RequestedOther`
	`RequestedOtherTax`		`integer`	No	Pass through parameter to the Dispatch "Create or Update Request for Authorization" API.	`RequestedOtherTax`
	`RequestedPartsTax`		`integer`	No	Pass through parameter to the Dispatch "Create or Update Request for Authorization" API.	`RequestedPartsTax`
	`RequestedShipping`		`integer`	No	Pass through parameter to the Dispatch "Create or Update Request for Authorization" API.	`RequestedShipping`
	`RequestedFreight`		`integer`	No	Pass through parameter to the Dispatch "Create or Update Request for Authorization" API.	`RequestedFreight`
	`RequestedTax`		`integer`	No	Pass through parameter to the Dispatch "Create or Update Request for Authorization" API.	`RequestedTax`
	`RequestedTravel`		`integer`	No	Pass through parameter to the Dispatch "Create or Update Request for Authorization" API.	`RequestedTravel`
`RequiredParts`			`array`	No	Pass through parameter to the Dispatch "Create or Update Request for Authorization" API.	`RequiredParts`
	`ProdNum`		`string`	No	Pass through parameter to the Dispatch "Create or Update Request for Authorization" API.	`ProdNum`
	`Qty`		`integer`	No	Pass through parameter to the Dispatch "Create or Update Request for Authorization" API.	`Qty`
	`ProdAttrs`		`object`	No	Pass through parameter to the Dispatch "Create or Update Request for Authorization" API.	`ProdAttrs`
		`SerialNo`	`integer`	No	Pass through parameter to the Dispatch "Create or Update Request for Authorization" API.	`SerialNo`
		`Desc`	`string`	No	Pass through parameter to the Dispatch "Create or Update Request for Authorization" API.	`Desc`
		`UnitCost`	`float`	No	Pass through parameter to the Dispatch "Create or Update Request for Authorization" API.	`UnitCost`
		`NlaFlag`	`string`	No	Pass through parameter to the Dispatch "Create or Update Request for Authorization" API.	`NlaFlag`
		`UnderWarranty`	`string`	No	Pass through parameter to the Dispatch "Create or Update Request for Authorization" API.	`UnderWarranty`
		`SelfSourced`	`string`	No	Pass through parameter to the Dispatch "Create or Update Request for Authorization" API.	`SelfSourced`
`StatusInfo`			`object`	No	Pass through parameter to the Dispatch "Create or Update Request for Authorization" API.	`StatusInfo`
	`NewStatus`		`string`	No	Pass through parameter to the Dispatch "Create or Update Request for Authorization" API.	`NewStatus`
	`StatusChangeReason`		`string`	No	Pass through parameter to the Dispatch "Create or Update Request for Authorization" API.	`StatusChangeReason`

HTTP Response

Success

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

Code Block

language	js

{
    "Success": true,
    "Code": 0,
    "Message": "OK",
    "Payload": {
        "CurrentStatus": "APV",
        "ResponseCode": "OK"
    }
}

Error

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

Code Block

language	js

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

Return Codes

In addition to the Standard Return Codes, there are Dispatch Error codes.

Version	Old Version 22	New Version Current
Changes made by	Jason Andrew	Jason Andrew
Saved on	Feb 06, 2025	Feb 06, 2025

Versions Compared

Key

Resource URL Summary

API Specific Parameters

API Specifics

Pass Through Call to Dispatch's "Create or Update Request for Authorization" API

URL

HTTP Request Body

CreateOrUpdateRequestForAuthorization Object Format

CreateOrUpdateRequestForAuthorization Object Properties

HTTP Response

Success

Error

Return Codes

Content Comparison

Versions Compared

Key

Resource URL Summary

API Specific Parameters

API Specifics

Pass Through Call to Dispatch's "Create or Update Request for Authorization" API

URL

HTTP Request Body

CreateOrUpdateRequestForAuthorization Object Format

CreateOrUpdateRequestForAuthorization Object Properties

HTTP Response

Success

Error

Return Codes