WCycle Open Api (0.0.3)

Wcycle Open Api for 3rd parties

CivitaslogoWesternlogo

customer

getCustomer

path Parameters
salesChannelId
required
string
query Parameters
cid
string <GUID>

CustomerId

tag
string

CustomerTag

typ
integer <int32>

IdType

Responses

Response samples

Content type
application/json
{
  • "customerId": "string",
  • "type": 0,
  • "transitAccount": 0,
  • "pin": "string",
  • "language": "string",
  • "guid": "string"
}

addCustomer

path Parameters
salesChannelId
required
string
Request Body schema: application/json
customerId
required
string

Customer id

type
required
integer <int32>

Type of customerId

transitAccount
required
integer <int32>

TransitAccount

pin
required
string

Pin

language
required
string

Language

guid
string

Guid

Responses

Request samples

Content type
application/json
{
  • "customerId": "string",
  • "type": 0,
  • "transitAccount": 0,
  • "pin": "string",
  • "language": "string",
  • "guid": "string"
}

Response samples

Content type
application/json
{
  • "guid": "string"
}

deleteCustomer

path Parameters
salesChannelId
required
string

SalesChannelId

cid
required
string <GUID>

UserId

Responses

Response samples

Content type
application/json
"string"

updateCustomer

path Parameters
salesChannelId
required
string

salesChannel

cid
required
string <GUID>

UserId

Request Body schema: application/json
customerId
required
string

Customer id

type
required
integer <int32>

Type of customerId

transitAccount
required
integer <int32>

TransitAccount

pin
required
string

Pin

language
required
string

Language

guid
string

Guid

Responses

Request samples

Content type
application/json
{
  • "customerId": "string",
  • "type": 0,
  • "transitAccount": 0,
  • "pin": "string",
  • "language": "string",
  • "guid": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

getCustomers

path Parameters
sci
required
string

saleschannelid

Responses

Response samples

Content type
application/json
[
  • {
    }
]

travelRight

getTravelRight

path Parameters
salesChannelId
required
string
cid
required
string <GUID>

CustomerId

query Parameters
dev
integer <int32>

Device type

Responses

Response samples

Content type
application/json
{
  • "status": 0,
  • "reason": "string"
}

charges

getChargeable

path Parameters
salesChannelId
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

postCharged

path Parameters
salesChannelId
required
string
eventId
required
string
Request Body schema: application/json
customerId
string
eventId
string
charged
integer <int32>
partyRef
string

Responses

Request samples

Content type
application/json
{
  • "customerId": "string",
  • "eventId": "string",
  • "charged": 0,
  • "partyRef": "string"
}

ride

getRides

path Parameters
salesChannelId
required
string
query Parameters
status
integer <int32>

Ride status

Responses

Response samples

Content type
application/json
[
  • {
    }
]