BokaMera.API.Host

<back to all web services

GetAxemaUserSyncJob

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin, bookingsupplier-administrator-read
The following routes are available for this service:
GET/codelock/axema/usersync/{Id}Get a single Axema user sync job by idReturns the sync job details including progress counters.
GetAxemaUserSyncJob Parameters:
NameParameterData TypeRequiredDescription
IdpathGuidYesThe sync job id.
CompanyIdqueryGuid?NoThe company id, if empty will use the company id for the user you are logged in with.
AxemaUserSyncJobResponse Parameters:
NameParameterData TypeRequiredDescription
IdformGuidNo
CompanyIdformGuidNo
StatusformintNo
StatusNameformstringYes
UsersFoundformint?No
UsersCreatedformint?No
UsersUpdatedformint?No
ErrorMessageformstringNo
CreatedDateformDateTimeNo
UpdatedDateformDateTimeNo

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

HTTP + CSV

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

GET /codelock/axema/usersync/{Id} HTTP/1.1 
Host: testapi.bokamera.se 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Status":0,"StatusName":"String","UsersFound":0,"UsersCreated":0,"UsersUpdated":0,"ErrorMessage":"String"}