JiwaAPI

<back to all web services

CarrierPOSTRequest

Requires Authentication
The following routes are available for this service:
POST/CarriersCreates a carrier.
Carrier Parameters:
NameParameterData TypeRequiredDescription
CarrierIDformstringNo
CarrierNameformstringNo
AccountNoformstringNo
Enabledformbool?No
NotesformstringNo
LastSavedDateTimeformDateTime?No
ServicesformList<CarrierService>No
FreightDescriptionsformList<CarrierFreightDescription>No
CarrierService Parameters:
NameParameterData TypeRequiredDescription
ServiceIDformstringNo
ServiceNameformstringNo
DefaultItemformbool?No
LastSavedDateTimeformDateTime?No
Enabledformbool?No
CarrierFreightDescription Parameters:
NameParameterData TypeRequiredDescription
FreightDescriptionIDformstringNo
DescriptionformstringNo
DefaultItemformbool?No
LastSavedDateTimeformDateTime?No
Enabledformbool?No
Carrier Parameters:
NameParameterData TypeRequiredDescription
CarrierIDformstringNo
CarrierNameformstringNo
AccountNoformstringNo
Enabledformbool?No
NotesformstringNo
LastSavedDateTimeformDateTime?No
ServicesformList<CarrierService>No
FreightDescriptionsformList<CarrierFreightDescription>No

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /Carriers HTTP/1.1 
Host: api.jiwa.com.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CarrierPOSTRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel">
  <_x003C_AccountNo_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel.Carriers">String</_x003C_AccountNo_x003E_k__BackingField>
  <_x003C_CarrierID_x003E_k__BackingField i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel.Carriers" />
  <_x003C_CarrierName_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel.Carriers">String</_x003C_CarrierName_x003E_k__BackingField>
  <_x003C_Enabled_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel.Carriers">false</_x003C_Enabled_x003E_k__BackingField>
  <_x003C_FreightDescriptions_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel.Carriers">
    <CarrierFreightDescription>
      <_x003C_DefaultItem_x003E_k__BackingField>false</_x003C_DefaultItem_x003E_k__BackingField>
      <_x003C_Description_x003E_k__BackingField>String</_x003C_Description_x003E_k__BackingField>
      <_x003C_Enabled_x003E_k__BackingField>false</_x003C_Enabled_x003E_k__BackingField>
      <_x003C_FreightDescriptionID_x003E_k__BackingField>String</_x003C_FreightDescriptionID_x003E_k__BackingField>
      <_x003C_LastSavedDateTime_x003E_k__BackingField>0001-01-01T00:00:00</_x003C_LastSavedDateTime_x003E_k__BackingField>
    </CarrierFreightDescription>
  </_x003C_FreightDescriptions_x003E_k__BackingField>
  <_x003C_LastSavedDateTime_x003E_k__BackingField i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel.Carriers" />
  <_x003C_Notes_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel.Carriers">String</_x003C_Notes_x003E_k__BackingField>
  <_x003C_Services_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel.Carriers">
    <CarrierService>
      <_x003C_DefaultItem_x003E_k__BackingField>false</_x003C_DefaultItem_x003E_k__BackingField>
      <_x003C_Enabled_x003E_k__BackingField>false</_x003C_Enabled_x003E_k__BackingField>
      <_x003C_LastSavedDateTime_x003E_k__BackingField>0001-01-01T00:00:00</_x003C_LastSavedDateTime_x003E_k__BackingField>
      <_x003C_ServiceID_x003E_k__BackingField>String</_x003C_ServiceID_x003E_k__BackingField>
      <_x003C_ServiceName_x003E_k__BackingField>String</_x003C_ServiceName_x003E_k__BackingField>
    </CarrierService>
  </_x003C_Services_x003E_k__BackingField>
  <_x003C_CarrierID_x003E_k__BackingField>String</_x003C_CarrierID_x003E_k__BackingField>
  <_x003C_LastSavedDateTime_x003E_k__BackingField>0001-01-01T00:00:00</_x003C_LastSavedDateTime_x003E_k__BackingField>
</CarrierPOSTRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<Carrier xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel.Carriers">
  <_x003C_AccountNo_x003E_k__BackingField>String</_x003C_AccountNo_x003E_k__BackingField>
  <_x003C_CarrierID_x003E_k__BackingField>String</_x003C_CarrierID_x003E_k__BackingField>
  <_x003C_CarrierName_x003E_k__BackingField>String</_x003C_CarrierName_x003E_k__BackingField>
  <_x003C_Enabled_x003E_k__BackingField>false</_x003C_Enabled_x003E_k__BackingField>
  <_x003C_FreightDescriptions_x003E_k__BackingField>
    <CarrierFreightDescription>
      <_x003C_DefaultItem_x003E_k__BackingField>false</_x003C_DefaultItem_x003E_k__BackingField>
      <_x003C_Description_x003E_k__BackingField>String</_x003C_Description_x003E_k__BackingField>
      <_x003C_Enabled_x003E_k__BackingField>false</_x003C_Enabled_x003E_k__BackingField>
      <_x003C_FreightDescriptionID_x003E_k__BackingField>String</_x003C_FreightDescriptionID_x003E_k__BackingField>
      <_x003C_LastSavedDateTime_x003E_k__BackingField>0001-01-01T00:00:00</_x003C_LastSavedDateTime_x003E_k__BackingField>
    </CarrierFreightDescription>
  </_x003C_FreightDescriptions_x003E_k__BackingField>
  <_x003C_LastSavedDateTime_x003E_k__BackingField>0001-01-01T00:00:00</_x003C_LastSavedDateTime_x003E_k__BackingField>
  <_x003C_Notes_x003E_k__BackingField>String</_x003C_Notes_x003E_k__BackingField>
  <_x003C_Services_x003E_k__BackingField>
    <CarrierService>
      <_x003C_DefaultItem_x003E_k__BackingField>false</_x003C_DefaultItem_x003E_k__BackingField>
      <_x003C_Enabled_x003E_k__BackingField>false</_x003C_Enabled_x003E_k__BackingField>
      <_x003C_LastSavedDateTime_x003E_k__BackingField>0001-01-01T00:00:00</_x003C_LastSavedDateTime_x003E_k__BackingField>
      <_x003C_ServiceID_x003E_k__BackingField>String</_x003C_ServiceID_x003E_k__BackingField>
      <_x003C_ServiceName_x003E_k__BackingField>String</_x003C_ServiceName_x003E_k__BackingField>
    </CarrierService>
  </_x003C_Services_x003E_k__BackingField>
</Carrier>