/
CreateOrUpdateRequestForAuthorization RESTified API
Document toolboxDocument toolbox

CreateOrUpdateRequestForAuthorization RESTified API

Owned by Andrew Hill (Deactivated)
Last updated: Feb 06, 2025 by Jason Andrew

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.                                

On this page:  

Related pages:

Resource URL Summary

Claim

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

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

HTTP Headers

This API uses the standard ServiceBroker HTTP Headers.

API Specific Parameters

ParameterTypeRequired?Description

${id}

integer

Yes

The Request for Authorization ID to be created or updated.

API Specifics

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

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

{
    "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

PropertyTypeRequired?DescriptionDispatch Field Mapping
CoreInfoobjectNoPass through parameter to the Dispatch "Create or Update Request for Authorization" API.CoreInfo

JobCodestringNo

Pass through parameter to the Dispatch "Create or Update Request for Authorization" API.

JobCode
WhyAdditionalManOnTheJobQuestionsarrayNoPass through parameter to the Dispatch "Create or Update Request for Authorization" API.WhyAdditionalManOnTheJobQuestions

ChoiceIdstringNoPass through parameter to the Dispatch "Create or Update Request for Authorization" API.ChoiceId

ResponseTextstringNoPass through parameter to the Dispatch "Create or Update Request for Authorization" API.ResponseText
NotesobjectNoPass through parameter to the Dispatch "Create or Update Request for Authorization" API.Notes

NotesOnlystringNoPass through parameter to the Dispatch "Create or Update Request for Authorization" API.NotesOnly

InternalNotesstringNoPass through parameter to the Dispatch "Create or Update Request for Authorization" API.InternalNotes

InternalNotesReasonstringNoPass through parameter to the Dispatch "Create or Update Request for Authorization" API.InternalNotesReason

ServicerNotesstringNoPass through parameter to the Dispatch "Create or Update Request for Authorization" API.ServicerNotes

ServicerNotesReasonstringNoPass through parameter to the Dispatch "Create or Update Request for Authorization" API.ServicerNotesReason
ShippingInfoobjectNoPass through parameter to the Dispatch "Create or Update Request for Authorization" API.ShippingInfo

AdditionalManRequiredstringNoPass through parameter to the Dispatch "Create or Update Request for Authorization" API.AdditionalManRequired

RecipientstringNoPass through parameter to the Dispatch "Create or Update Request for Authorization" API.Recipient

ShippingOptionstringNoPass through parameter to the Dispatch "Create or Update Request for Authorization" API.ShippingOption

CompanyNamestringNoPass through parameter to the Dispatch "Create or Update Request for Authorization" API.CompanyName

FirstNamestringNoPass through parameter to the Dispatch "Create or Update Request for Authorization" API.FirstName

LastNamestringNoPass through parameter to the Dispatch "Create or Update Request for Authorization" API.LastName

PhonestringNoPass through parameter to the Dispatch "Create or Update Request for Authorization" API.Phone

EmailstringNoPass through parameter to the Dispatch "Create or Update Request for Authorization" API.Email

Address1stringNoPass through parameter to the Dispatch "Create or Update Request for Authorization" API.Address1

Address2stringNoPass through parameter to the Dispatch "Create or Update Request for Authorization" API.Address2

CitystringNoPass through parameter to the Dispatch "Create or Update Request for Authorization" API.City

RegionstringNoPass through parameter to the Dispatch "Create or Update Request for Authorization" API.Region

PostalCodestringNoPass through parameter to the Dispatch "Create or Update Request for Authorization" API.PostalCode
ApproveOrRejectInfoobjectNoPass through parameter to the Dispatch "Create or Update Request for Authorization" API.ApproveOrRejectInfo

approvedOrAdditionalInformationRequestNotesstringNoPass through parameter to the Dispatch "Create or Update Request for Authorization" API.approvedOrAdditionalInformationRequestNotes

ChangedBystringNoPass through parameter to the Dispatch "Create or Update Request for Authorization" API.ChangedBy

ReasonCodestringNoPass through parameter to the Dispatch "Create or Update Request for Authorization" API.ReasonCode
OtherInfoobjectNo

Pass through parameter to the Dispatch "Create or Update Request for Authorization" API.

OtherInfo

AdditionalManRequiredstringNoPass through parameter to the Dispatch "Create or Update Request for Authorization" API.AdditionalManRequired

CostEffectiveToRepairstringNoPass through parameter to the Dispatch "Create or Update Request for Authorization" API.CostEffectiveToRepair

EstimatedHoursOnJobintegerNoPass through parameter to the Dispatch "Create or Update Request for Authorization" API.EstimatedHoursOnJob

EstimatedMinutesOnJobintegerNoPass through parameter to the Dispatch "Create or Update Request for Authorization" API.EstimatedMinutesOnJob

IsProductRepairedstringNoPass through parameter to the Dispatch "Create or Update Request for Authorization" API.IsProductRepaired

LaborInWarrantystringNoPass through parameter to the Dispatch "Create or Update Request for Authorization" API.LaborInWarranty

OemAuthorizedWithManufacturerstringNoPass through parameter to the Dispatch "Create or Update Request for Authorization" API.OemAuthorizedWithManufacturer

PartsInWarrantystringNoPass through parameter to the Dispatch "Create or Update Request for Authorization" API.PartsInWarranty

PickUpUnitRequiredstringNoPass through parameter to the Dispatch "Create or Update Request for Authorization" API.PickUpUnitRequired

WhyHigherRatestringNoPass through parameter to the Dispatch "Create or Update Request for Authorization" API.WhyHigherRate
ProblemInfoobjectNoPass through parameter to the Dispatch "Create or Update Request for Authorization" API.ProblemInfo

RepairDescriptionstringNoPass through parameter to the Dispatch "Create or Update Request for Authorization" API.RepairDescription

FaultCodestringNoPass through parameter to the Dispatch "Create or Update Request for Authorization" API.FaultCode
AssetobjectNoPass through parameter to the Dispatch "Create or Update Request for Authorization" API.Asset

MfgstringNoPass through parameter to the Dispatch "Create or Update Request for Authorization" API.Mfg

ModelstringNoPass through parameter to the Dispatch "Create or Update Request for Authorization" API.Model

SerialNumstringNoPass through parameter to the Dispatch "Create or Update Request for Authorization" API.SerialNum
ServicerInfoobjectNoPass through parameter to the Dispatch "Create or Update Request for Authorization" API.ServicerInfo

ServicerOnSitestringNoPass through parameter to the Dispatch "Create or Update Request for Authorization" API.ServicerOnSite
AmountsobjectNoPass through parameter to the Dispatch "Create or Update Request for Authorization" API.Amounts

RequestedLaborintegerNoPass through parameter to the Dispatch "Create or Update Request for Authorization" API.RequestedLabor

RequestedLaborTaxintegerNoPass through parameter to the Dispatch "Create or Update Request for Authorization" API.RequestedLaborTax

RequestedMilesintegerNoPass through parameter to the Dispatch "Create or Update Request for Authorization" API.RequestedMiles

RequestedRatePerMilefloatNoPass through parameter to the Dispatch "Create or Update Request for Authorization" API.RequestedRatePerMile

RequestedOtherintegerNoPass through parameter to the Dispatch "Create or Update Request for Authorization" API.RequestedOther

RequestedOtherTaxintegerNoPass through parameter to the Dispatch "Create or Update Request for Authorization" API.RequestedOtherTax

RequestedPartsTaxintegerNoPass through parameter to the Dispatch "Create or Update Request for Authorization" API.RequestedPartsTax

RequestedShippingintegerNoPass through parameter to the Dispatch "Create or Update Request for Authorization" API.RequestedShipping

RequestedFreightintegerNoPass through parameter to the Dispatch "Create or Update Request for Authorization" API.RequestedFreight

RequestedTaxintegerNoPass through parameter to the Dispatch "Create or Update Request for Authorization" API.RequestedTax

RequestedTravelintegerNoPass through parameter to the Dispatch "Create or Update Request for Authorization" API.RequestedTravel
RequiredPartsarrayNoPass through parameter to the Dispatch "Create or Update Request for Authorization" API.RequiredParts

ProdNumstringNoPass through parameter to the Dispatch "Create or Update Request for Authorization" API.ProdNum

QtyintegerNoPass through parameter to the Dispatch "Create or Update Request for Authorization" API.Qty

ProdAttrsobjectNoPass through parameter to the Dispatch "Create or Update Request for Authorization" API.ProdAttrs


SerialNointegerNoPass through parameter to the Dispatch "Create or Update Request for Authorization" API.SerialNo


DescstringNoPass through parameter to the Dispatch "Create or Update Request for Authorization" API.Desc


UnitCostfloatNoPass through parameter to the Dispatch "Create or Update Request for Authorization" API.UnitCost


NlaFlagstringNoPass through parameter to the Dispatch "Create or Update Request for Authorization" API.NlaFlag


UnderWarrantystringNoPass through parameter to the Dispatch "Create or Update Request for Authorization" API.UnderWarranty


SelfSourcedstringNoPass through parameter to the Dispatch "Create or Update Request for Authorization" API.SelfSourced
StatusInfoobjectNoPass through parameter to the Dispatch "Create or Update Request for Authorization" API.StatusInfo

NewStatusstringNoPass through parameter to the Dispatch "Create or Update Request for Authorization" API.NewStatus

StatusChangeReasonstringNoPass 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.

{
    "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.

{
    "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.

Related content

SubmitClaim RESTified API
SubmitClaim RESTified API
ServiceBroker 5
More like this
GetClaimsData RESTified API
GetClaimsData RESTified API
ServiceBroker 5
Read with this
UpdateRequestForAuthorizationStatus RESTified API
UpdateRequestForAuthorizationStatus RESTified API
ServiceBroker 5
More like this
GetRequestForAuthorization RESTified API
GetRequestForAuthorization RESTified API
ServiceBroker 5
More like this
UpdateServicerNotes RESTified API
UpdateServicerNotes RESTified API
ServiceBroker 5
More like this
UpdateConsumerInfo RESTified API
UpdateConsumerInfo RESTified API
ServiceBroker 5
More like this