POST api/Mobile/UpdateIDBadge/{auth}

Use this method to update ID Badge information for a courier

Request Information

URI Parameters

NameDescriptionTypeAdditional information
auth

The authorization GUID returned from the security API

string

Required

Body Parameters

Parameters for updating bagdge information

UpdateIDBadgeParm
NameDescriptionTypeAdditional information
PhotoImageData

string

None.

Request Formats

application/json, text/json

Sample:
{
  "PhotoImageData": "sample string 1"
}

application/xml, text/xml

Sample:
<UpdateIDBadgeParm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mnx.WebApi.Transportation.Models">
  <PhotoImageData>sample string 1</PhotoImageData>
</UpdateIDBadgeParm>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

(none)

ResponseBase
NameDescriptionTypeAdditional information
IsSuccessful

Set to true if method was successful

boolean

None.

ErrorMessage

The error message if method call was not successful

string

None.

Response Formats

application/json, text/json

Sample:
{
  "IsSuccessful": true,
  "ErrorMessage": "sample string 2"
}

application/xml, text/xml

Sample:
<ResponseBase xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mnx.WebApi.Transportation.Models">
  <ErrorMessage>sample string 2</ErrorMessage>
  <IsSuccessful>true</IsSuccessful>
</ResponseBase>